The bp Reference Manual

Table of Contents

The bp Reference Manual

This is the bp Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:08:17 2019 GMT+0.

1 Introduction

BP - Bitcoin Protocol

This is a Common Lisp implementation of the various components of the Bitcoin Protocol. The serialization/deserialization utils may be used for reading the block data both from peers and from local database on disk. The cryptographic utilities are aggregated from FFI bindings to the secp256k1 and ironclad. HTTP client code uses aserve, while and JSON handling is done with jsown package.

THIS BITCOIN CONSENSUS RULES IMPLEMENTATION IS NOT, AND WILL PROBABLY NEVER BE FULLY COMPLIANT WITH BITCOIN CORE IMPLEMENTATION. DO NOT RELY ON IT FOR VALIDATING YOUR MAINNET TRANSACTIONS, AS IT MAY EASILY PUT YOU OUT OF SYNC WITH THE NETWORK IN A LOT OF CORNER CASES.

Installation

Elliptic curve cryptography utilities (transaction signing and verification) use a secp256k1 library, so it must be installed before building the bp system (either manually, or using the system package manager if available):

# Ubuntu
apt install libsecp256k1 libsecp256k1-dev

# Arch Linux
pacman -Syu libsecp256k1

# macOS
brew tap cuber/homebrew-libsecp256k1
brew install libsecp256k1

Once secp256k1 is ready, bp can be installed via quicklisp tool:

(ql:quickload "bp")

Alternatively, bp system can be loaded from sources, assuming the following Common Lisp packages are available locally:

• asdf;
• aserve;
• cffi;
• ironclad;
• jsown.

In order to load bp from sources, evaluate the following form (this assumes that ASDF is able to find the system definition; more on that here):

(asdf:load-system "bp")

Interface

Currently, this library only provides utilities for stateless interaction with Bitcoin from REPL. Storage, wallet and full node capabilities are somewhere in a distant future.

Chain interface

Functions bp:get-block-hash, bp:get-block and bp:get-transaction allow to pull chain data from any external supplier specified with the bp:with-chain-supplier macro:

CL-USER> (bp:with-chain-supplier (bp:node-connection
                                  :url "http://localhost:8332"
                                  :username "btcuser"
                                  :password "btcpassword")
           (bp:get-transaction "0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098"))
#<BP/CORE/TRANSACTION:TX 0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098>

Non-nil keyword argument :encoded can be used with bp:get-block and bp:get-transaction to return serialized transaction hex-encoded in a string:

CL-USER> (bp:get-transaction "14...c3" :encoded t)
"010000000...ae00000000"

Under the hood, these operations call corresponding generic functions bp:chain-get-{block-hash,block,transaction} which take the supplier object as an explicit first argument.

Model and serialization

Bitcoin data entities are represented by the following structures:

• bp:block-header;
• bp:cblock;
• bp:tx;
• bp:txin;
• bp:txout;
• bp:script.

Functions named bp:block-* (both for bp:block-header and bp:cblock), bp:tx-*, bp:txin-* and bp:txout-* provide access to the components of the corresponding entities.

Functions bp:parse and bp:serialize can be used to read and write any Bitcoin entity from and to any octet stream respectively:

CL-USER> (ironclad:with-octet-input-stream (stream #(1 0 ... 0 0))
           (bp:parse 'bp:tx in-stream))
#<BP/CORE/TRANSACTION:TX 17e590f116d3deeb9b121bbb1c37b7916e6b7859461a3af7edf74e2348a9b347>
CL-USER> (ironclad:with-octet-output-stream (stream)
           (bp:parse 'tx out-stream))
#(1 0 ... 0 0)

Note that while bp:serialize function take an entity as its first argument, bp:parse takes the symbol naming the class of the entity, behaving as class method.

Functions bp:decode and bp:encode wrap above functions to decode and encode Bitcoin entities from and to hex-encoded strings:

CL-USER> (bp:decode 'bp:tx "0100000002f8615378...e097a988ac00000000")
#<BP/CORE/TRANSACTION:TX 17e590f116d3deeb9b121bbb1c37b7916e6b7859461a3af7edf74e2348a9b347>
CL-USER> (bp:encode *)
"0100000002f8615378...e097a988ac00000000"

Validation

Functions bp:validate and bp:validp take an entity as well as the optional context parameters, and validate it according to an approximation of Bitcoin consensus rules.

Both functions return t if the entity is valid, but the bp:validate function signals an error otherwise, while the bp:validp function simply returns nil.

Both functions assume the chain supplier context (i.e. they are called within the body of bp:with-chain-supplier).

Dynamic variable bp:*trace-script-execution* can be used to enable printing the steps of script execution (chain supplier macro omitted):

CL-USER> (setf bp:*trace-script-execution* t)
t
CL-USER> (bp:validate
          (bp:get-transaction "17e590f116d3deeb9b121bbb1c37b7916e6b7859461a3af7edf74e2348a9b347"))
op:       OP_PUSH22
payload:  #(0 14 a4 b4 ca 48 de b 3f ff c1 54 4 a1 ac dc 8d ba ae 22 69
            55)
commands: <>
stack:    ()

op:       OP_HASH160
payload:  -
commands: <OP_PUSH20 OP_EQUAL>
stack:    (#(0 14 a4 b4 ca 48 de b 3f ff c1 54 4 a1 ac dc 8d ba ae 22
             69 55))

op:       OP_PUSH20
payload:  #(29 28 f4 3a f1 8d 2d 60 e8 a8 43 54 d 80 86 b3 5 34 13 39)
commands: <OP_EQUAL>
stack:    (#(29 28 f4 3a f1 8d 2d 60 e8 a8 43 54 d 80 86 b3 5 34 13 39))

op:       OP_EQUAL
payload:  -
commands: <>
stack:    (#(29 28 f4 3a f1 8d 2d 60 e8 a8 43 54 d 80 86 b3 5 34 13 39)
           #(29 28 f4 3a f1 8d 2d 60 e8 a8 43 54 d 80 86 b3 5 34 13 39))

op:       OP_FALSE
payload:  -
commands: <OP_PUSH20>
stack:    ()

op:       OP_PUSH20
payload:  #(a4 b4 ca 48 de b 3f ff c1 54 4 a1 ac dc 8d ba ae 22 69 55)
commands: <>
stack:    (#())

t

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 bp

Author

whythat <whythat@protonmail.com>

License

MIT

Description

Bitcoin Protocol components in Common Lisp

Version

0.0.1

Dependencies

• cffi
• aserve
• jsown
• ironclad
• bp/core/all (system)
• bp/crypto/all (system)

Source

bp.asd (file)

2.2 bp/core/all

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/core/encoding (system)
• bp/core/transaction (system)
• bp/core/script (system)
• bp/core/block (system)
• bp/core/chain (system)
• bp/core/consensus (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.3 bp/core/consensus

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/core/encoding (system)
• bp/core/chain (system)
• bp/core/block (system)
• bp/core/transaction (system)
• bp/core/script (system)
• bp/crypto/hash (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.4 bp/core/chain

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• aserve
• jsown
• bp/core/block (system)
• bp/core/transaction (system)
• bp/core/encoding (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.5 bp/core/block

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/core/encoding (system)
• bp/core/transaction (system)
• bp/crypto/hash (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.6 bp/core/transaction

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/core/encoding (system)
• bp/core/script (system)
• bp/crypto/hash (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.7 bp/core/script

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/core/encoding (system)
• bp/crypto/hash (system)
• bp/crypto/secp256k1 (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.8 bp/core/encoding

Author

whythat <whythat@protonmail.com>

License

MIT

Dependency

ironclad

Source

bp.asd (file)

Component

lisp.lisp (file)

2.9 bp/crypto/all

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• bp/crypto/hash (system)
• bp/crypto/secp256k1 (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.10 bp/crypto/hash

Author

whythat <whythat@protonmail.com>

License

MIT

Dependency

ironclad

Source

bp.asd (file)

Component

lisp.lisp (file)

2.11 bp/crypto/secp256k1

Author

whythat <whythat@protonmail.com>

License

MIT

Dependencies

• cffi
• ironclad
• bp/crypto/random (system)

Source

bp.asd (file)

Component

lisp.lisp (file)

2.12 bp/crypto/random

Author

whythat <whythat@protonmail.com>

License

MIT

Source

bp.asd (file)

Component

lisp.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 bp.asd

Location

bp.asd

Systems

• bp (system)
• bp/core/all (system)
• bp/core/consensus (system)
• bp/core/chain (system)
• bp/core/block (system)
• bp/core/transaction (system)
• bp/core/script (system)
• bp/core/encoding (system)
• bp/crypto/all (system)
• bp/crypto/hash (system)
• bp/crypto/secp256k1 (system)
• bp/crypto/random (system)

3.1.2 bp/core/all/lisp.lisp

Parent

bp/core/all (system)

Location

core/all.lisp

Packages

bp/core/all

3.1.3 bp/core/consensus/lisp.lisp

Parent

bp/core/consensus (system)

Location

core/consensus.lisp

Packages

bp/core/consensus

Exported Definitions

• validate (generic function)
• validate (method)
• validate (method)
• validate (method)
• validate (method)
• validate (method)
• validp (function)

Internal Definitions

• +sighash-all+ (constant)
• +sighash-anyonecanpay+ (constant)
• +sighash-none+ (constant)
• +sighash-single+ (constant)
• bits-to-target (function)
• block-difficulty (function)
• block-target (function)
• tx-outputs-hash (function)
• tx-previous-outputs-hash (function)
• tx-sequence-hash (function)
• tx-sighash (function)
• tx-sighash-base (function)
• tx-sighash-witness-v0 (function)

3.1.4 bp/core/chain/lisp.lisp

Parent

bp/core/chain (system)

Location

core/chain.lisp

Packages

bp/core/chain

Exported Definitions

• chain-get-block (generic function)
• chain-get-block (method)
• chain-get-block-hash (generic function)
• chain-get-block-hash (method)
• chain-get-transaction (generic function)
• chain-get-transaction (method)
• get-block (function)
• get-block-hash (function)
• get-transaction (function)
• node-connection (class)
• with-chain-supplier (macro)

Internal Definitions

• *chain-supplier* (special variable)
• chain-supplier (class)
• chain-supplier-network (method)
• (setf chain-supplier-network) (method)
• do-simple-rpc-call (function)
• node-connection-password (method)
• (setf node-connection-password) (method)
• node-connection-url (method)
• (setf node-connection-url) (method)
• node-connection-username (method)
• (setf node-connection-username) (method)

3.1.5 bp/core/block/lisp.lisp

Parent

bp/core/block (system)

Location

core/block.lisp

Packages

bp/core/block

Exported Definitions

• block-bits (generic function)
• block-bits (method)
• block-bits (method)
• block-hash (generic function)
• block-hash (method)
• block-hash (method)
• block-header (function)
• (setf block-header) (function)
• block-header (structure)
• block-id (function)
• block-merkle-root (generic function)
• block-merkle-root (method)
• block-merkle-root (method)
• block-nonce (generic function)
• block-nonce (method)
• block-nonce (method)
• block-previous-block-hash (generic function)
• block-previous-block-hash (method)
• block-previous-block-hash (method)
• block-timestamp (generic function)
• block-timestamp (method)
• block-timestamp (method)
• block-transaction (function)
• block-transactions (function)
• (setf block-transactions) (function)
• block-version (generic function)
• block-version (method)
• block-version (method)
• cblock (structure)
• parse (method)
• parse (method)
• serialize (method)
• serialize (method)

Internal Definitions

• block-header-bits (function)
• (setf block-header-bits) (function)
• block-header-merkle-root (function)
• (setf block-header-merkle-root) (function)
• block-header-nonce (function)
• (setf block-header-nonce) (function)
• block-header-p (function)
• block-header-previous-block-hash (function)
• (setf block-header-previous-block-hash) (function)
• block-header-timestamp (function)
• (setf block-header-timestamp) (function)
• block-header-version (function)
• (setf block-header-version) (function)
• cblock-p (function)
• copy-block-header (function)
• copy-cblock (function)
• make-block-header (function)
• make-cblock (function)

3.1.6 bp/core/transaction/lisp.lisp

Parent

bp/core/transaction (system)

Location

core/transaction.lisp

Packages

bp/core/transaction

Exported Definitions

• parse (method)
• parse (method)
• parse (method)
• parse (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• tx (structure)
• tx-hash (function)
• tx-id (function)
• tx-input (function)
• tx-inputs (function)
• (setf tx-inputs) (function)
• tx-locktime (function)
• (setf tx-locktime) (function)
• tx-output (function)
• tx-outputs (function)
• (setf tx-outputs) (function)
• tx-version (function)
• (setf tx-version) (function)
• tx-wid (function)
• tx-witness (function)
• tx-witnesses (function)
• (setf tx-witnesses) (function)
• txin (structure)
• txin-previous-tx-id (function)
• (setf txin-previous-tx-id) (function)
• txin-previous-tx-index (function)
• (setf txin-previous-tx-index) (function)
• txin-script-sig (function)
• (setf txin-script-sig) (function)
• txin-sequence (function)
• (setf txin-sequence) (function)
• txout (structure)
• txout-amount (function)
• (setf txout-amount) (function)
• txout-script-pubkey (function)
• (setf txout-script-pubkey) (function)
• witness (structure)
• witness-items (function)
• (setf witness-items) (function)

Internal Definitions

• copy-tx (function)
• copy-txin (function)
• copy-txout (function)
• copy-witness (function)
• make-tx (function)
• make-txin (function)
• make-txout (function)
• make-witness (function)
• read-num-inputs-or-segwit-flag (function)
• tx-p (function)
• txin-p (function)
• txout-p (function)
• witness-p (function)

3.1.7 bp/core/script/lisp.lisp

Parent

bp/core/script (system)

Location

core/script.lisp

Packages

bp/core/script

Exported Definitions

• *trace-script-execution* (special variable)
• execute-script (function)
• execute-scripts (function)
• make-script (function)
• make-script-state (function)
• parse (method)
• script (function)
• script (structure)
• script-commands (function)
• (setf script-commands) (function)
• serialize (method)

Internal Definitions

• *opcodes-by-code* (special variable)
• *opcodes-by-name* (special variable)
• @altstack (function)
• (setf @altstack) (function)
• @commands (function)
• (setf @commands) (function)
• @conditions (function)
• (setf @conditions) (function)
• @discard (function)
• (setf @discard) (function)
• @execp (function)
• @sighash (function)
• @sighashf (function)
• (setf @sighashf) (function)
• @sigversion (function)
• (setf @sigversion) (function)
• @stack (function)
• (setf @stack) (function)
• @witness (function)
• (setf @witness) (function)
• command-op (function)
• command-payload (function)
• copy-script (function)
• copy-script-state (function)
• decode-integer (function)
• define-disabled-opcode (macro)
• define-opcode (macro)
• define-opcode-alias (macro)
• define-opcode-range (macro)
• encode-integer (function)
• execute-p2sh (function)
• execute-p2wpkh (function)
• execute-p2wsh (function)
• op_0 (function)
• op_0notequal (function)
• op_1 (function)
• op_10 (function)
• op_11 (function)
• op_12 (function)
• op_13 (function)
• op_14 (function)
• op_15 (function)
• op_16 (function)
• op_1add (function)
• op_1negate (function)
• op_1sub (function)
• op_2 (function)
• op_2div (function)
• op_2drop (function)
• op_2dup (function)
• op_2mul (function)
• op_2over (function)
• op_2rot (function)
• op_2swap (function)
• op_3 (function)
• op_3dup (function)
• op_4 (function)
• op_5 (function)
• op_6 (function)
• op_7 (function)
• op_8 (function)
• op_9 (function)
• op_abs (function)
• op_add (function)
• op_and (function)
• op_booland (function)
• op_boolor (function)
• op_cat (function)
• op_checklocktimeverify (function)
• op_checkmultisig (function)
• op_checkmultisigverify (function)
• op_checksequenceverify (function)
• op_checksig (function)
• op_checksigverify (function)
• op_codeseparator (function)
• op_depth (function)
• op_div (function)
• op_drop (function)
• op_dup (function)
• op_else (function)
• op_endif (function)
• op_equal (function)
• op_equalverify (function)
• op_fromaltstack (function)
• op_greaterthan (function)
• op_greaterthanorequal (function)
• op_hash160 (function)
• op_hash256 (function)
• op_if (function)
• op_ifdup (function)
• op_invalidopcode (function)
• op_invert (function)
• op_left (function)
• op_lessthan (function)
• op_lessthanorequal (function)
• op_lshift (function)
• op_max (function)
• op_min (function)
• op_mod (function)
• op_mul (function)
• op_negate (function)
• op_nip (function)
• op_nop (function)
• op_nop1 (function)
• op_nop10 (function)
• op_nop4 (function)
• op_nop5 (function)
• op_nop6 (function)
• op_nop7 (function)
• op_nop8 (function)
• op_nop9 (function)
• op_not (function)
• op_notif (function)
• op_numequal (function)
• op_numequalverify (function)
• op_numnotequal (function)
• op_or (function)
• op_over (function)
• op_pick (function)
• op_pubkey (function)
• op_pubkeyhash (function)
• op_push1 (function)
• op_push10 (function)
• op_push11 (function)
• op_push12 (function)
• op_push13 (function)
• op_push14 (function)
• op_push15 (function)
• op_push16 (function)
• op_push17 (function)
• op_push18 (function)
• op_push19 (function)
• op_push2 (function)
• op_push20 (function)
• op_push21 (function)
• op_push22 (function)
• op_push23 (function)
• op_push24 (function)
• op_push25 (function)
• op_push26 (function)
• op_push27 (function)
• op_push28 (function)
• op_push29 (function)
• op_push3 (function)
• op_push30 (function)
• op_push31 (function)
• op_push32 (function)
• op_push33 (function)
• op_push34 (function)
• op_push35 (function)
• op_push36 (function)
• op_push37 (function)
• op_push38 (function)
• op_push39 (function)
• op_push4 (function)
• op_push40 (function)
• op_push41 (function)
• op_push42 (function)
• op_push43 (function)
• op_push44 (function)
• op_push45 (function)
• op_push46 (function)
• op_push47 (function)
• op_push48 (function)
• op_push49 (function)
• op_push5 (function)
• op_push50 (function)
• op_push51 (function)
• op_push52 (function)
• op_push53 (function)
• op_push54 (function)
• op_push55 (function)
• op_push56 (function)
• op_push57 (function)
• op_push58 (function)
• op_push59 (function)
• op_push6 (function)
• op_push60 (function)
• op_push61 (function)
• op_push62 (function)
• op_push63 (function)
• op_push64 (function)
• op_push65 (function)
• op_push66 (function)
• op_push67 (function)
• op_push68 (function)
• op_push69 (function)
• op_push7 (function)
• op_push70 (function)
• op_push71 (function)
• op_push72 (function)
• op_push73 (function)
• op_push74 (function)
• op_push75 (function)
• op_push8 (function)
• op_push9 (function)
• op_pushdata1 (function)
• op_pushdata2 (function)
• op_pushdata4 (function)
• op_reserved (function)
• op_reserved1 (function)
• op_reserved2 (function)
• op_return (function)
• op_right (function)
• op_ripemd160 (function)
• op_roll (function)
• op_rot (function)
• op_rshift (function)
• op_sha1 (function)
• op_sha256 (function)
• op_size (function)
• op_sub (function)
• op_substr (function)
• op_swap (function)
• op_toaltstack (function)
• op_tuck (function)
• op_ver (function)
• op_verif (function)
• op_verify (function)
• op_vernotif (function)
• op_within (function)
• op_xor (function)
• opcode (function)
• p2sh-p (function)
• p2wpkh-p (function)
• p2wsh-p (function)
• print-script-execution-state (function)
• register-opcode (function)
• script-p (function)
• script-sigversion (function)
• script-state (structure)
• script-state-p (function)
• segwit-p (function)

3.1.8 bp/core/encoding/lisp.lisp

Parent

bp/core/encoding (system)

Location

core/encoding.lisp

Packages

bp/core/encoding

Exported Definitions

• decode (function)
• encode (function)
• from-hex (function)
• parse (generic function)
• read-bytes (function)
• read-int (function)
• read-varint (function)
• serialize (generic function)
• to-hex (function)
• write-bytes (function)
• write-int (function)
• write-varint (function)

3.1.9 bp/crypto/all/lisp.lisp

Parent

bp/crypto/all (system)

Location

crypto/all.lisp

Packages

bp/crypto/all

3.1.10 bp/crypto/hash/lisp.lisp

Parent

bp/crypto/hash (system)

Location

crypto/hash.lisp

Packages

bp/crypto/hash

Exported Definitions

• hash160 (function)
• hash256 (function)
• ripemd160 (function)

3.1.11 bp/crypto/secp256k1/lisp.lisp

Parent

bp/crypto/secp256k1 (system)

Location

crypto/secp256k1.lisp

Packages

bp/crypto/secp256k1

Exported Definitions

• context-create-none (function)
• context-create-sign (function)
• context-create-verify (function)
• ec-privkey-negate (function)
• ec-pubkey-create (function)
• ec-pubkey-negate (function)
• ec-pubkey-parse (function)
• ec-pubkey-serialize (function)
• ec-seckey-verify (function)
• ecdsa-sign (function)
• ecdsa-signature-normalize (function)
• ecdsa-signature-parse-compact (function)
• ecdsa-signature-parse-der (function)
• ecdsa-signature-serialize-compact (function)
• ecdsa-signature-serialize-der (function)
• ecdsa-verify (function)
• key (structure)
• make-key (function)
• make-pubkey (function)
• make-signature (function)
• parse-pubkey (function)
• parse-signature (function)
• pubkey (structure)
• serialize-pubkey (function)
• serialize-signature (function)
• signature (structure)
• verify-signature (function)

Internal Definitions

• %make-key (function)
• %make-pubkey (function)
• %make-signature (function)
• *context-none* (special variable)
• *context-sign* (special variable)
• *context-verify* (special variable)
• +secp256k1-context-none+ (constant)
• +secp256k1-context-sign+ (constant)
• +secp256k1-context-verify+ (constant)
• +secp256k1-ec-compressed+ (constant)
• +secp256k1-ec-uncompressed+ (constant)
• +secp256k1-flags-bit-compression+ (constant)
• +secp256k1-flags-bit-context-sign+ (constant)
• +secp256k1-flags-bit-context-verify+ (constant)
• +secp256k1-flags-type-compression+ (constant)
• +secp256k1-flags-type-context+ (constant)
• +secp256k1-flags-type-mask+ (constant)
• +secp256k1-tag-pubkey-even+ (constant)
• +secp256k1-tag-pubkey-hybrid-even+ (constant)
• +secp256k1-tag-pubkey-hybrid-odd+ (constant)
• +secp256k1-tag-pubkey-odd+ (constant)
• +secp256k1-tag-pubkey-uncompressed+ (constant)
• bytes-from-foreign (macro)
• bytes-to-foreign (macro)
• copy-key (function)
• copy-pubkey (function)
• copy-signature (function)
• ecdsa-signature-parse-der-lax (function)
• key-bytes (function)
• (setf key-bytes) (function)
• key-p (function)
• pubkey-bytes (function)
• (setf pubkey-bytes) (function)
• pubkey-p (function)
• secp256k1-context-clone (function)
• secp256k1-context-create (function)
• secp256k1-context-destroy (function)
• secp256k1-context-randomize (function)
• secp256k1-ec-privkey-negate (function)
• secp256k1-ec-privkey-tweak-add (function)
• secp256k1-ec-privkey-tweak-mul (function)
• secp256k1-ec-pubkey-combine (function)
• secp256k1-ec-pubkey-create (function)
• secp256k1-ec-pubkey-negate (function)
• secp256k1-ec-pubkey-parse (function)
• secp256k1-ec-pubkey-serialize (function)
• secp256k1-ec-pubkey-tweak-add (function)
• secp256k1-ec-pubkey-tweak-mul (function)
• secp256k1-ec-seckey-verify (function)
• secp256k1-ecdsa-sign (function)
• secp256k1-ecdsa-signature-normalize (function)
• secp256k1-ecdsa-signature-parse-compact (function)
• secp256k1-ecdsa-signature-parse-der (function)
• secp256k1-ecdsa-signature-serialize-compact (function)
• secp256k1-ecdsa-signature-serialize-der (function)
• secp256k1-ecdsa-signature-tclass (class)
• secp256k1-ecdsa-verify (function)
• secp256k1-pubkey-tclass (class)
• secp256k1-scratch-space-create (function)
• secp256k1-scratch-space-destroy (function)
• signature-bytes (function)
• (setf signature-bytes) (function)
• signature-p (function)

3.1.12 bp/crypto/random/lisp.lisp

Parent

bp/crypto/random (system)

Location

crypto/random.lisp

Packages

bp/crypto/random

Exported Definitions

random-bytes (function)

4 Packages

Packages are listed by definition order.

4.1 bp/core/all

Source

lisp.lisp (file)

Nickname

bp

Use List

• bp/core/consensus
• bp/core/chain
• bp/core/block
• bp/core/script
• bp/core/transaction
• bp/core/encoding
• common-lisp

4.2 bp/core/consensus

Source

lisp.lisp (file)

Use List

• bp/crypto/hash
• bp/core/script
• bp/core/transaction
• bp/core/block
• bp/core/chain
• bp/core/encoding
• common-lisp

Used By List

bp/core/all

Exported Definitions

• validate (generic function)
• validate (method)
• validate (method)
• validate (method)
• validate (method)
• validate (method)
• validp (function)

Internal Definitions

• +sighash-all+ (constant)
• +sighash-anyonecanpay+ (constant)
• +sighash-none+ (constant)
• +sighash-single+ (constant)
• bits-to-target (function)
• block-difficulty (function)
• block-target (function)
• tx-outputs-hash (function)
• tx-previous-outputs-hash (function)
• tx-sequence-hash (function)
• tx-sighash (function)
• tx-sighash-base (function)
• tx-sighash-witness-v0 (function)

4.3 bp/core/chain

Source

lisp.lisp (file)

Use List

• bp/core/encoding
• bp/core/transaction
• bp/core/block
• common-lisp

Used By List

• bp/core/all
• bp/core/consensus

Exported Definitions

• chain-get-block (generic function)
• chain-get-block (method)
• chain-get-block-hash (generic function)
• chain-get-block-hash (method)
• chain-get-transaction (generic function)
• chain-get-transaction (method)
• get-block (function)
• get-block-hash (function)
• get-transaction (function)
• node-connection (class)
• with-chain-supplier (macro)

Internal Definitions

• *chain-supplier* (special variable)
• chain-supplier (class)
• chain-supplier-network (generic function)
• chain-supplier-network (method)
• (setf chain-supplier-network) (method)
• (setf chain-supplier-network) (generic function)
• do-simple-rpc-call (function)
• node-connection-password (generic function)
• node-connection-password (method)
• (setf node-connection-password) (method)
• (setf node-connection-password) (generic function)
• node-connection-url (generic function)
• node-connection-url (method)
• (setf node-connection-url) (method)
• (setf node-connection-url) (generic function)
• node-connection-username (generic function)
• node-connection-username (method)
• (setf node-connection-username) (method)
• (setf node-connection-username) (generic function)

4.4 bp/core/block

Source

lisp.lisp (file)

Use List

• bp/crypto/hash
• bp/core/transaction
• bp/core/encoding
• common-lisp

Used By List

• bp/core/all
• bp/core/consensus
• bp/core/chain

Exported Definitions

• block-bits (generic function)
• block-bits (method)
• block-bits (method)
• block-hash (generic function)
• block-hash (method)
• block-hash (method)
• block-header (function)
• (setf block-header) (function)
• block-header (structure)
• block-id (function)
• block-merkle-root (generic function)
• block-merkle-root (method)
• block-merkle-root (method)
• block-nonce (generic function)
• block-nonce (method)
• block-nonce (method)
• block-previous-block-hash (generic function)
• block-previous-block-hash (method)
• block-previous-block-hash (method)
• block-timestamp (generic function)
• block-timestamp (method)
• block-timestamp (method)
• block-transaction (function)
• block-transactions (function)
• (setf block-transactions) (function)
• block-version (generic function)
• block-version (method)
• block-version (method)
• cblock (structure)

Internal Definitions

• block-header-bits (function)
• (setf block-header-bits) (function)
• block-header-merkle-root (function)
• (setf block-header-merkle-root) (function)
• block-header-nonce (function)
• (setf block-header-nonce) (function)
• block-header-p (function)
• block-header-previous-block-hash (function)
• (setf block-header-previous-block-hash) (function)
• block-header-timestamp (function)
• (setf block-header-timestamp) (function)
• block-header-version (function)
• (setf block-header-version) (function)
• cblock-p (function)
• copy-block-header (function)
• copy-cblock (function)
• make-block-header (function)
• make-cblock (function)

4.5 bp/core/transaction

Source

lisp.lisp (file)

Use List

• bp/crypto/hash
• bp/core/script
• bp/core/encoding
• common-lisp

Used By List

• bp/core/all
• bp/core/consensus
• bp/core/chain
• bp/core/block

Exported Definitions

• tx (structure)
• tx-hash (function)
• tx-id (function)
• tx-input (function)
• tx-inputs (function)
• (setf tx-inputs) (function)
• tx-locktime (function)
• (setf tx-locktime) (function)
• tx-output (function)
• tx-outputs (function)
• (setf tx-outputs) (function)
• tx-version (function)
• (setf tx-version) (function)
• tx-wid (function)
• tx-witness (function)
• tx-witnesses (function)
• (setf tx-witnesses) (function)
• txin (structure)
• txin-previous-tx-id (function)
• (setf txin-previous-tx-id) (function)
• txin-previous-tx-index (function)
• (setf txin-previous-tx-index) (function)
• txin-script-sig (function)
• (setf txin-script-sig) (function)
• txin-sequence (function)
• (setf txin-sequence) (function)
• txout (structure)
• txout-amount (function)
• (setf txout-amount) (function)
• txout-script-pubkey (function)
• (setf txout-script-pubkey) (function)
• witness (structure)
• witness-items (function)
• (setf witness-items) (function)

Internal Definitions

• copy-tx (function)
• copy-txin (function)
• copy-txout (function)
• copy-witness (function)
• make-tx (function)
• make-txin (function)
• make-txout (function)
• make-witness (function)
• read-num-inputs-or-segwit-flag (function)
• tx-p (function)
• txin-p (function)
• txout-p (function)
• witness-p (function)

4.6 bp/core/script

Source

lisp.lisp (file)

Use List

• bp/crypto/secp256k1
• bp/crypto/hash
• bp/core/encoding
• common-lisp

Used By List

• bp/core/all
• bp/core/consensus
• bp/core/transaction

Exported Definitions

• *trace-script-execution* (special variable)
• execute-script (function)
• execute-scripts (function)
• make-script (function)
• make-script-state (function)
• script (function)
• script (structure)
• script-commands (function)
• (setf script-commands) (function)

Internal Definitions

• *opcodes-by-code* (special variable)
• *opcodes-by-name* (special variable)
• @altstack (function)
• (setf @altstack) (function)
• @commands (function)
• (setf @commands) (function)
• @conditions (function)
• (setf @conditions) (function)
• @discard (function)
• (setf @discard) (function)
• @execp (function)
• @sighash (function)
• @sighashf (function)
• (setf @sighashf) (function)
• @sigversion (function)
• (setf @sigversion) (function)
• @stack (function)
• (setf @stack) (function)
• @witness (function)
• (setf @witness) (function)
• command-op (function)
• command-payload (function)
• copy-script (function)
• copy-script-state (function)
• decode-integer (function)
• define-disabled-opcode (macro)
• define-opcode (macro)
• define-opcode-alias (macro)
• define-opcode-range (macro)
• encode-integer (function)
• execute-p2sh (function)
• execute-p2wpkh (function)
• execute-p2wsh (function)
• op_0 (function)
• op_0notequal (function)
• op_1 (function)
• op_10 (function)
• op_11 (function)
• op_12 (function)
• op_13 (function)
• op_14 (function)
• op_15 (function)
• op_16 (function)
• op_1add (function)
• op_1negate (function)
• op_1sub (function)
• op_2 (function)
• op_2div (function)
• op_2drop (function)
• op_2dup (function)
• op_2mul (function)
• op_2over (function)
• op_2rot (function)
• op_2swap (function)
• op_3 (function)
• op_3dup (function)
• op_4 (function)
• op_5 (function)
• op_6 (function)
• op_7 (function)
• op_8 (function)
• op_9 (function)
• op_abs (function)
• op_add (function)
• op_and (function)
• op_booland (function)
• op_boolor (function)
• op_cat (function)
• op_checklocktimeverify (function)
• op_checkmultisig (function)
• op_checkmultisigverify (function)
• op_checksequenceverify (function)
• op_checksig (function)
• op_checksigverify (function)
• op_codeseparator (function)
• op_depth (function)
• op_div (function)
• op_drop (function)
• op_dup (function)
• op_else (function)
• op_endif (function)
• op_equal (function)
• op_equalverify (function)
• op_fromaltstack (function)
• op_greaterthan (function)
• op_greaterthanorequal (function)
• op_hash160 (function)
• op_hash256 (function)
• op_if (function)
• op_ifdup (function)
• op_invalidopcode (function)
• op_invert (function)
• op_left (function)
• op_lessthan (function)
• op_lessthanorequal (function)
• op_lshift (function)
• op_max (function)
• op_min (function)
• op_mod (function)
• op_mul (function)
• op_negate (function)
• op_nip (function)
• op_nop (function)
• op_nop1 (function)
• op_nop10 (function)
• op_nop4 (function)
• op_nop5 (function)
• op_nop6 (function)
• op_nop7 (function)
• op_nop8 (function)
• op_nop9 (function)
• op_not (function)
• op_notif (function)
• op_numequal (function)
• op_numequalverify (function)
• op_numnotequal (function)
• op_or (function)
• op_over (function)
• op_pick (function)
• op_pubkey (function)
• op_pubkeyhash (function)
• op_push1 (function)
• op_push10 (function)
• op_push11 (function)
• op_push12 (function)
• op_push13 (function)
• op_push14 (function)
• op_push15 (function)
• op_push16 (function)
• op_push17 (function)
• op_push18 (function)
• op_push19 (function)
• op_push2 (function)
• op_push20 (function)
• op_push21 (function)
• op_push22 (function)
• op_push23 (function)
• op_push24 (function)
• op_push25 (function)
• op_push26 (function)
• op_push27 (function)
• op_push28 (function)
• op_push29 (function)
• op_push3 (function)
• op_push30 (function)
• op_push31 (function)
• op_push32 (function)
• op_push33 (function)
• op_push34 (function)
• op_push35 (function)
• op_push36 (function)
• op_push37 (function)
• op_push38 (function)
• op_push39 (function)
• op_push4 (function)
• op_push40 (function)
• op_push41 (function)
• op_push42 (function)
• op_push43 (function)
• op_push44 (function)
• op_push45 (function)
• op_push46 (function)
• op_push47 (function)
• op_push48 (function)
• op_push49 (function)
• op_push5 (function)
• op_push50 (function)
• op_push51 (function)
• op_push52 (function)
• op_push53 (function)
• op_push54 (function)
• op_push55 (function)
• op_push56 (function)
• op_push57 (function)
• op_push58 (function)
• op_push59 (function)
• op_push6 (function)
• op_push60 (function)
• op_push61 (function)
• op_push62 (function)
• op_push63 (function)
• op_push64 (function)
• op_push65 (function)
• op_push66 (function)
• op_push67 (function)
• op_push68 (function)
• op_push69 (function)
• op_push7 (function)
• op_push70 (function)
• op_push71 (function)
• op_push72 (function)
• op_push73 (function)
• op_push74 (function)
• op_push75 (function)
• op_push8 (function)
• op_push9 (function)
• op_pushdata1 (function)
• op_pushdata2 (function)
• op_pushdata4 (function)
• op_reserved (function)
• op_reserved1 (function)
• op_reserved2 (function)
• op_return (function)
• op_right (function)
• op_ripemd160 (function)
• op_roll (function)
• op_rot (function)
• op_rshift (function)
• op_sha1 (function)
• op_sha256 (function)
• op_size (function)
• op_sub (function)
• op_substr (function)
• op_swap (function)
• op_toaltstack (function)
• op_tuck (function)
• op_ver (function)
• op_verif (function)
• op_verify (function)
• op_vernotif (function)
• op_within (function)
• op_xor (function)
• opcode (function)
• p2sh-p (function)
• p2wpkh-p (function)
• p2wsh-p (function)
• print-script-execution-state (function)
• register-opcode (function)
• script-p (function)
• script-sigversion (function)
• script-state (structure)
• script-state-p (function)
• segwit-p (function)

4.7 bp/core/encoding

Source

lisp.lisp (file)

Use List

• ironclad
• common-lisp

Used By List

• bp/core/all
• bp/core/consensus
• bp/core/chain
• bp/core/block
• bp/core/transaction
• bp/core/script

Exported Definitions

• decode (function)
• encode (function)
• from-hex (function)
• parse (generic function)
• parse (method)
• parse (method)
• parse (method)
• parse (method)
• parse (method)
• parse (method)
• parse (method)
• read-bytes (function)
• read-int (function)
• read-varint (function)
• serialize (generic function)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• to-hex (function)
• write-bytes (function)
• write-int (function)
• write-varint (function)

4.8 bp/crypto/all

Source

lisp.lisp (file)

Nickname

bpcrypto

Use List

• bp/crypto/secp256k1
• bp/crypto/hash
• common-lisp

4.9 bp/crypto/hash

Source

lisp.lisp (file)

Use List

• ironclad
• common-lisp

Used By List

• bp/crypto/all
• bp/core/consensus
• bp/core/block
• bp/core/transaction
• bp/core/script

Exported Definitions

• hash160 (function)
• hash256 (function)
• ripemd160 (function)

4.10 bp/crypto/secp256k1

Source

lisp.lisp (file)

Nickname

secp256k1

Use List

• bp/crypto/random
• ironclad
• cffi
• common-lisp

Used By List

• bp/crypto/all
• bp/core/script

Exported Definitions

• context-create-none (function)
• context-create-sign (function)
• context-create-verify (function)
• ec-privkey-negate (function)
• ec-pubkey-create (function)
• ec-pubkey-negate (function)
• ec-pubkey-parse (function)
• ec-pubkey-serialize (function)
• ec-seckey-verify (function)
• ecdsa-sign (function)
• ecdsa-signature-normalize (function)
• ecdsa-signature-parse-compact (function)
• ecdsa-signature-parse-der (function)
• ecdsa-signature-serialize-compact (function)
• ecdsa-signature-serialize-der (function)
• ecdsa-verify (function)
• key (structure)
• make-key (function)
• make-pubkey (function)
• make-signature (function)
• parse-pubkey (function)
• parse-signature (function)
• pubkey (structure)
• serialize-pubkey (function)
• serialize-signature (function)
• signature (structure)
• verify-signature (function)

Internal Definitions

• %make-key (function)
• %make-pubkey (function)
• %make-signature (function)
• *context-none* (special variable)
• *context-sign* (special variable)
• *context-verify* (special variable)
• +secp256k1-context-none+ (constant)
• +secp256k1-context-sign+ (constant)
• +secp256k1-context-verify+ (constant)
• +secp256k1-ec-compressed+ (constant)
• +secp256k1-ec-uncompressed+ (constant)
• +secp256k1-flags-bit-compression+ (constant)
• +secp256k1-flags-bit-context-sign+ (constant)
• +secp256k1-flags-bit-context-verify+ (constant)
• +secp256k1-flags-type-compression+ (constant)
• +secp256k1-flags-type-context+ (constant)
• +secp256k1-flags-type-mask+ (constant)
• +secp256k1-tag-pubkey-even+ (constant)
• +secp256k1-tag-pubkey-hybrid-even+ (constant)
• +secp256k1-tag-pubkey-hybrid-odd+ (constant)
• +secp256k1-tag-pubkey-odd+ (constant)
• +secp256k1-tag-pubkey-uncompressed+ (constant)
• bytes-from-foreign (macro)
• bytes-to-foreign (macro)
• copy-key (function)
• copy-pubkey (function)
• copy-signature (function)
• ecdsa-signature-parse-der-lax (function)
• key-bytes (function)
• (setf key-bytes) (function)
• key-p (function)
• pubkey-bytes (function)
• (setf pubkey-bytes) (function)
• pubkey-p (function)
• secp256k1-context-clone (function)
• secp256k1-context-create (function)
• secp256k1-context-destroy (function)
• secp256k1-context-randomize (function)
• secp256k1-ec-privkey-negate (function)
• secp256k1-ec-privkey-tweak-add (function)
• secp256k1-ec-privkey-tweak-mul (function)
• secp256k1-ec-pubkey-combine (function)
• secp256k1-ec-pubkey-create (function)
• secp256k1-ec-pubkey-negate (function)
• secp256k1-ec-pubkey-parse (function)
• secp256k1-ec-pubkey-serialize (function)
• secp256k1-ec-pubkey-tweak-add (function)
• secp256k1-ec-pubkey-tweak-mul (function)
• secp256k1-ec-seckey-verify (function)
• secp256k1-ecdsa-sign (function)
• secp256k1-ecdsa-signature-normalize (function)
• secp256k1-ecdsa-signature-parse-compact (function)
• secp256k1-ecdsa-signature-parse-der (function)
• secp256k1-ecdsa-signature-serialize-compact (function)
• secp256k1-ecdsa-signature-serialize-der (function)
• secp256k1-ecdsa-signature-tclass (class)
• secp256k1-ecdsa-verify (function)
• secp256k1-pubkey-tclass (class)
• secp256k1-scratch-space-create (function)
• secp256k1-scratch-space-destroy (function)
• signature-bytes (function)
• (setf signature-bytes) (function)
• signature-p (function)

4.11 bp/crypto/random

Source

lisp.lisp (file)

Use List

common-lisp

Used By List

bp/crypto/secp256k1

Exported Definitions

random-bytes (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *trace-script-execution*

Dynamic variable to control printing the steps of script execution.

Package

bp/core/script

Source

lisp.lisp (file)

5.1.2 Macros

Macro: with-chain-supplier (TYPE &rest ARGS &key &allow-other-keys) &body BODY

Package

bp/core/chain

Source

lisp.lisp (file)

5.1.3 Functions

Function: block-header INSTANCE

Function: (setf block-header) VALUE INSTANCE

Package

bp/core/block

Source

lisp.lisp (file)

Function: block-id BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Function: block-transaction CBLOCK INDEX

Package

bp/core/block

Source

lisp.lisp (file)

Function: block-transactions INSTANCE

Function: (setf block-transactions) VALUE INSTANCE

Package

bp/core/block

Source

lisp.lisp (file)

Function: context-create-none ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: context-create-sign ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: context-create-verify ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: decode ENTITY-CLASS STRING

Decode Bitcoin Protocol entity given by its class name ENTITY-CLASS from hex STRING.

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: ec-privkey-negate SECKEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ec-pubkey-create SECKEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ec-pubkey-negate PUBKEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ec-pubkey-parse INPUT

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ec-pubkey-serialize PUBKEY &key COMPRESSED

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ec-seckey-verify SECKEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-sign MSG32 SECKEY

Create an ECDSA signature.

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-signature-normalize SIGIN

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-signature-parse-compact INPUT64

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-signature-parse-der INPUT

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-signature-serialize-compact SIGNATURE

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-signature-serialize-der SIGNATURE

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: ecdsa-verify SIGNATURE MSG32 PUBKEY

Verify an ECDSA signature.

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: encode ENTITY

Encode Bitcoin Protocol ENTITY into a hex string.

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: execute-script SCRIPT &key STATE

Execute a script using a state that can be provided externally.

Package

bp/core/script

Source

lisp.lisp (file)

Function: execute-scripts SCRIPT-SIG SCRIPT-PUBKEY &key STATE

Execute SCRIPT-SIG and SCRIPT-PUBKEY in succession, preserving the stack and performing the special rule detection (P2SH, SegWit).

Package

bp/core/script

Source

lisp.lisp (file)

Function: from-hex STRING

Shortcut to avoid using long symbol IRONCLAD:HEX-STRING-TO-BYTE-ARRAY.

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: get-block HASH &key ENCODED

Package

bp/core/chain

Source

lisp.lisp (file)

Function: get-block-hash HEIGHT

Package

bp/core/chain

Source

lisp.lisp (file)

Function: get-transaction ID &key ENCODED

Package

bp/core/chain

Source

lisp.lisp (file)

Function: hash160 BYTES

Package

bp/crypto/hash

Source

lisp.lisp (file)

Function: hash256 BYTES

Package

bp/crypto/hash

Source

lisp.lisp (file)

Function: make-key ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: make-pubkey KEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: make-script &key (COMMANDS COMMANDS)

Package

bp/core/script

Source

lisp.lisp (file)

Function: make-script-state &key (COMMANDS COMMANDS) (DISCARD DISCARD) (STACK STACK) (ALTSTACK ALTSTACK) (CONDITIONS CONDITIONS) (WITNESS WITNESS) (SIGHASHF SIGHASHF) (SIGVERSION SIGVERSION)

Package

bp/core/script

Source

lisp.lisp (file)

Function: make-signature KEY HASH

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: parse-pubkey BYTES

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: parse-signature BYTES &key TYPE

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: random-bytes SIZE

Package

bp/crypto/random

Source

lisp.lisp (file)

Function: read-bytes STREAM SIZE

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: read-int STREAM &key SIZE BYTE-ORDER

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: read-varint STREAM

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: ripemd160 BYTES

Package

bp/crypto/hash

Source

lisp.lisp (file)

Function: script &rest SYMBOLIC-COMMANDS

Construct a SCRIPT object from a sequence of Lisp objects, doing the best effort to detect/convert the provided values.

Package

bp/core/script

Source

lisp.lisp (file)

Function: script-commands INSTANCE

Function: (setf script-commands) VALUE INSTANCE

Package

bp/core/script

Source

lisp.lisp (file)

Function: serialize-pubkey KEY

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: serialize-signature SIGNATURE &key TYPE

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: to-hex BYTES

Shortcut to avoid using long symbol IRONCLAD:BYTE-ARRAY-TO-HEX-STRING.

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: tx-hash TX

Raw transaction ID is a double SHA256 of its binary serialization.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-id TX

Return hex-encoded txid - little-endian hash of the transaction serialization without witness structures.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-input TX INDEX

Return INDEXth input of the given transaction.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-inputs INSTANCE

Function: (setf tx-inputs) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-locktime INSTANCE

Function: (setf tx-locktime) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-output TX INDEX

Return INDEXth output of the given transaction.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-outputs INSTANCE

Function: (setf tx-outputs) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-version INSTANCE

Function: (setf tx-version) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-wid TX

Return hex-encoded wtxid - little-endian hash of the transaction serialization including witness structures.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-witness TX INDEX

Return INDEXth witness of the given transaction, if it is a SegWit transaction, otherwise return NIL.

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: tx-witnesses INSTANCE

Function: (setf tx-witnesses) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txin-previous-tx-id INSTANCE

Function: (setf txin-previous-tx-id) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txin-previous-tx-index INSTANCE

Function: (setf txin-previous-tx-index) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txin-script-sig INSTANCE

Function: (setf txin-script-sig) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txin-sequence INSTANCE

Function: (setf txin-sequence) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txout-amount INSTANCE

Function: (setf txout-amount) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: txout-script-pubkey INSTANCE

Function: (setf txout-script-pubkey) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: validp ENTITY &rest CONTEXT &key &allow-other-keys

Return T if the ENTITY is valid, NIL otherwise.

Package

bp/core/consensus

Source

lisp.lisp (file)

Function: verify-signature PUBKEY HASH SIGNATURE

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Function: witness-items INSTANCE

Function: (setf witness-items) VALUE INSTANCE

Package

bp/core/transaction

Source

lisp.lisp (file)

Function: write-bytes BYTES STREAM SIZE

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: write-int I STREAM &key SIZE BYTE-ORDER

Package

bp/core/encoding

Source

lisp.lisp (file)

Function: write-varint I STREAM

Package

bp/core/encoding

Source

lisp.lisp (file)

5.1.4 Generic functions

Generic Function: block-bits BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-bits (CBLOCK cblock)

Method: block-bits (BLOCK-HEADER block-header)

Generic Function: block-hash BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-hash (CBLOCK cblock)

Method: block-hash (BLOCK-HEADER block-header)

Generic Function: block-merkle-root BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-merkle-root (CBLOCK cblock)

Method: block-merkle-root (BLOCK-HEADER block-header)

Generic Function: block-nonce BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-nonce (CBLOCK cblock)

Method: block-nonce (BLOCK-HEADER block-header)

Generic Function: block-previous-block-hash BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-previous-block-hash (CBLOCK cblock)

Method: block-previous-block-hash (BLOCK-HEADER block-header)

Generic Function: block-timestamp BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-timestamp (CBLOCK cblock)

Method: block-timestamp (BLOCK-HEADER block-header)

Generic Function: block-version BLOCK

Package

bp/core/block

Source

lisp.lisp (file)

Methods

Method: block-version (CBLOCK cblock)

Method: block-version (BLOCK-HEADER block-header)

Generic Function: chain-get-block SUPPLIER HASH &key ENCODED

Get raw block data from SUPPLIER by its HASH. HASH
can be either a hex-encoded string or a byte array. If ENCODED is non-NIL, returns a hex-encoded string, otherwise returns CBLOCK object.

Package

bp/core/chain

Source

lisp.lisp (file)

Methods

Method: chain-get-block (SUPPLIER node-connection) HASH &key ENCODED

Generic Function: chain-get-block-hash SUPPLIER HEIGHT

Get the hash of the block from SUPPLIER by its HEIGHT in the chain. HEIGHT must be an integer.

Package

bp/core/chain

Source

lisp.lisp (file)

Methods

Method: chain-get-block-hash (SUPPLIER node-connection) HEIGHT

Generic Function: chain-get-transaction SUPPLIER ID &key ENCODED

Get raw transaction data from SUPPLIER by its
ID. ID can be either a hex-encoded string or a byte array. If ENCODED is non-NIL, returns a hex-encoded string, otherwise returns TX object.

Package

bp/core/chain

Source

lisp.lisp (file)

Methods

Method: chain-get-transaction (SUPPLIER node-connection) ID &key ENCODED

Generic Function: parse ENTITY-CLASS STREAM

Parse bytes from the STREAM into an instance of the class named ENTITY-CLASS.

Package

bp/core/encoding

Source

lisp.lisp (file)

Methods

Method: parse (ENTITY-TYPE (eql cblock)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-TYPE (eql block-header)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-TYPE (eql witness)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-TYPE (eql txout)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-TYPE (eql txin)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-TYPE (eql tx)) STREAM

Source

lisp.lisp (file)

Method: parse (ENTITY-NAME (eql script)) STREAM

Source

lisp.lisp (file)

Generic Function: serialize ENTITY STREAM

Serialize ENTITY into the stream.

Package

bp/core/encoding

Source

lisp.lisp (file)

Methods

Method: serialize (CBLOCK cblock) STREAM

Source

lisp.lisp (file)

Method: serialize (BLOCK-HEADER block-header) STREAM

Source

lisp.lisp (file)

Method: serialize (WITNESS witness) STREAM

Source

lisp.lisp (file)

Method: serialize (TXOUT txout) STREAM

Source

lisp.lisp (file)

Method: serialize (TXIN txin) STREAM

Source

lisp.lisp (file)

Method: serialize (TX tx) STREAM

Source

lisp.lisp (file)

Method: serialize (SCRIPT script) STREAM

Source

lisp.lisp (file)

Generic Function: validate ENTITY &key TX TXIN-INDEX &allow-other-keys

Validate entity according to the Bitcoin Protocol
consensus rules, throw an error if an entity is invalid for any reason.

Package

bp/core/consensus

Source

lisp.lisp (file)

Methods

Method: validate (TXOUT txout) &key

Method: validate (TXIN txin) &key TX TXIN-INDEX

Method: validate (TX tx) &key

Method: validate (CBLOCK cblock) &key

Method: validate (BLOCK-HEADER block-header) &key

5.1.5 Structures

Structure: block-header ()

Package

bp/core/block

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• validate (method)
• block-hash (method)
• block-nonce (method)
• block-bits (method)
• block-timestamp (method)
• block-merkle-root (method)
• block-previous-block-hash (method)
• block-version (method)
• print-object (method)
• serialize (method)

Direct slots

Slot: version

Readers

block-header-version (function)

Writers

(setf block-header-version) (function)

Slot: previous-block-hash

Readers

block-header-previous-block-hash (function)

Writers

(setf block-header-previous-block-hash) (function)

Slot: merkle-root

Readers

block-header-merkle-root (function)

Writers

(setf block-header-merkle-root) (function)

Slot: timestamp

Readers

block-header-timestamp (function)

Writers

(setf block-header-timestamp) (function)

Slot: bits

Readers

block-header-bits (function)

Writers

(setf block-header-bits) (function)

Slot: nonce

Readers

block-header-nonce (function)

Writers

(setf block-header-nonce) (function)

Structure: cblock ()

Package

bp/core/block

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• validate (method)
• block-hash (method)
• block-nonce (method)
• block-bits (method)
• block-timestamp (method)
• block-merkle-root (method)
• block-previous-block-hash (method)
• block-version (method)
• print-object (method)
• serialize (method)

Direct slots

Slot: header

Readers

block-header (function)

Writers

(setf block-header) (function)

Slot: transactions

Readers

block-transactions (function)

Writers

(setf block-transactions) (function)

Structure: key ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: bytes

Readers

key-bytes (function)

Writers

(setf key-bytes) (function)

Structure: pubkey ()

Package

bp/crypto/secp256k1

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: bytes

Readers

pubkey-bytes (function)

Writers

(setf pubkey-bytes) (function)

Structure: script ()

Package

bp/core/script

Source

lisp.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• print-object (method)
• serialize (method)

Direct slots

Slot: commands

Readers

script-commands (function)

Writers

(setf script-commands) (function)