sigil-bitcoin-miniscript
sigil bitcoin miniscript
(sigil bitcoin miniscript) — Miniscript, descriptors, and wallet policies
miniscript-fragment
procedureMiniscript fragment AST node.
miniscript-fragment?
procedureTest if a value is a `miniscript-fragment` struct.
miniscript-fragment-kind
procedureGet the `kind` field of a `miniscript-fragment` struct.
miniscript-fragment-args
procedureGet the `args` field of a `miniscript-fragment` struct.
miniscript-fragment-data
procedureGet the `data` field of a `miniscript-fragment` struct.
miniscript-type-info-record
procedureDerived metadata used by descriptor policy and signing flows.
miniscript-type-info-record?
procedureTest if a value is a `miniscript-type-info-record` struct.
miniscript-type-info-record-base
procedureGet the `base` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-properties
procedureGet the `properties` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-satisfaction-items
procedureGet the `satisfaction-items` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-requires-signature
procedureGet the `requires-signature` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-requires-preimage
procedureGet the `requires-preimage` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-has-timelock
procedureGet the `has-timelock` field of a `miniscript-type-info-record` struct.
miniscript-type-info-record-nonmalleable
procedureGet the `nonmalleable` field of a `miniscript-type-info-record` struct.
descriptor
procedureOutput descriptor AST node.
descriptor?
procedureTest if a value is a `descriptor` struct.
descriptor-kind
procedureGet the `kind` field of a `descriptor` struct.
descriptor-args
procedureGet the `args` field of a `descriptor` struct.
descriptor-data
procedureGet the `data` field of a `descriptor` struct.
musig-key
procedureBIP390 MuSig key expression placeholder.
musig-key?
procedureTest if a value is a `musig-key` struct.
musig-key-keys
procedureGet the `keys` field of a `musig-key` struct.
musig-key-suffix
procedureGet the `suffix` field of a `musig-key` struct.
wallet-policy
procedureBIP388 wallet policy with descriptor template and key list.
wallet-policy?
procedureTest if a value is a `wallet-policy` struct.
wallet-policy-template
procedureGet the `template` field of a `wallet-policy` struct.
wallet-policy-keys
procedureGet the `keys` field of a `wallet-policy` struct.
descriptor-psbt-plan
procedureDerived descriptor data ready to attach to a PSBT input or output.
descriptor-psbt-plan?
procedureTest if a value is a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-descriptor
procedureGet the `descriptor` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-script-pubkey
procedureGet the `script-pubkey` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-redeem-script
procedureGet the `redeem-script` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-witness-script
procedureGet the `witness-script` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-bip32-derivations
procedureGet the `bip32-derivations` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-taproot-bip32-derivations
procedureGet the `taproot-bip32-derivations` field of a `descriptor-psbt-plan` struct.
descriptor-psbt-plan-change?
procedureGet the `change?` field of a `descriptor-psbt-plan` struct.
taproot-leaf-hash
procedureCompute the BIP341 TapLeaf hash for a tapscript leaf.
taproot-branch-hash
procedureCompute the BIP341 TapBranch hash with lexicographically sorted children.
miniscript-pk-k
procedureConstruct a `pk_k(key)` Miniscript fragment.
miniscript-pk-h
procedureConstruct a `pk_h(key)` Miniscript fragment.
miniscript-pk
procedureConstruct the `pk(key)` alias for `c:pk_k(key)`.
miniscript-after
procedureConstruct an absolute locktime `after(n)` fragment.
miniscript-older
procedureConstruct a relative locktime `older(n)` fragment.
miniscript-sha256
procedureConstruct a `sha256(hash)` preimage fragment.
miniscript-hash256
procedureConstruct a `hash256(hash)` preimage fragment.
miniscript-ripemd160
procedureConstruct a `ripemd160(hash)` preimage fragment.
miniscript-hash160
procedureConstruct a `hash160(hash)` preimage fragment.
miniscript-multi
procedureConstruct a `multi(k, keys...)` multisig fragment.
miniscript-sortedmulti
procedureConstruct a `sortedmulti(k, keys...)` multisig fragment.
miniscript-and-v
procedureConstruct an `and_v(left, right)` fragment.
miniscript-and-b
procedureConstruct an `and_b(left, right)` fragment.
miniscript-andor
procedureConstruct an `andor(left, then, else)` fragment.
miniscript-or-b
procedureConstruct an `or_b(left, right)` fragment.
miniscript-or-c
procedureConstruct an `or_c(left, right)` fragment.
miniscript-or-d
procedureConstruct an `or_d(left, right)` fragment.
miniscript-or-i
procedureConstruct an `or_i(left, right)` fragment.
miniscript-thresh
procedureConstruct a `thresh(k, fragments...)` fragment.
miniscript-wrapper
procedureApply wrapper characters to a Miniscript fragment.
miniscript-parse
procedureParse a Miniscript expression into a fragment AST.
miniscript-type-info
procedureReturn Miniscript base type and signing/satisfaction metadata.
miniscript-type
procedureReturn the coarse Miniscript base type for a fragment.
miniscript-type-check
procedureValidate a Miniscript fragment and return its coarse base type.
miniscript->string
procedureRender a Miniscript fragment to its canonical string form.
miniscript-compile
procedureCompile a supported Miniscript fragment into script bytes.
miniscript-compile-tapscript
procedureCompile a supported Miniscript fragment into BIP342 tapscript bytes.
taproot-tree-root
procedureCompile a parsed Taproot script tree into its BIP341 Merkle root.
descriptor-checksum
procedureCompute the BIP380 8-character descriptor checksum.
descriptor-add-checksum
procedureAppend a BIP380 checksum to a descriptor string.
descriptor-checksum-valid?
procedureReturn true when a descriptor contains a valid BIP380 checksum.
descriptor-strip-checksum
procedureRemove and validate a checksum when one is present.
descriptor-parse
procedureParse an output descriptor into a descriptor AST.
descriptor->string
procedureRender a descriptor AST to a canonical descriptor string.
descriptor-script-pubkey
procedureDerive the scriptPubKey for a descriptor. Requires concrete public keys for descriptors that directly encode address scripts.
descriptor-derive
procedureDerive ranged descriptor keys into concrete public keys. `branch` selects BIP389 multipath alternatives, and `index` replaces wildcard path segments.
descriptor-derive-script-pubkey
procedureDerive a ranged descriptor and return its concrete scriptPubKey.
descriptor-derive-psbt-plan
procedureBuild a derived descriptor plan containing script and PSBT key-origin data.
wallet-policy-from-template
procedureBuild a BIP388 wallet policy from descriptor template text and keys.
wallet-policy-descriptor
procedureExpand a wallet policy into a concrete descriptor.
wallet-policy-derive-psbt-plan
procedureExpand and derive a wallet policy into a PSBT planning record.
descriptor-psbt-plan-annotate-input
procedureAttach descriptor-derived metadata to a PSBT input.
descriptor-psbt-plan-annotate-output
procedureAttach descriptor-derived metadata to a PSBT output.
descriptor-psbt-plan-sign-input
procedureAnnotate and sign a standard descriptor PSBT input.
descriptor-psbt-plan-finalize-input
procedureFinalize a standard descriptor PSBT input.
miniscript-type-info?
variableNo docstring yet.
miniscript-type-info-base
variableNo docstring yet.
miniscript-type-info-properties
variableNo docstring yet.
miniscript-type-info-satisfaction-items
variableNo docstring yet.
miniscript-type-info-requires-signature
variableNo docstring yet.
miniscript-type-info-requires-preimage
variableNo docstring yet.
miniscript-type-info-has-timelock
variableNo docstring yet.
miniscript-type-info-nonmalleable
variableNo docstring yet.