Module descriptor

Source
Expand description

§Output Descriptors

Tools for representing Bitcoin output’s scriptPubKeys as abstract spending policies known as “output descriptors”. These include a Miniscript which describes the actual signing policy, as well as the blockchain format (P2SH, Segwit v0, etc.)

The format represents EC public keys abstractly to allow wallets to replace these with BIP32 paths, pay-to-contract instructions, etc.

Structs§

Bare
Create a Bare Descriptor. That is descriptor that is not wrapped in sh or wsh. This covers the Pk descriptor
DefiniteDescriptorKey
A DescriptorPublicKey without any wildcards.
DescriptorKeyParseError
Descriptor Key parsing errors
DescriptorXKey
An extended key with origin, derivation path, and wildcard.
Pkh
A bare PkH descriptor at top level
Sh
A Legacy p2sh Descriptor
SinglePriv
A descriptor bitcoin::PrivateKey with optional origin information.
SinglePub
A descriptor SinglePubKey with optional origin information.
SortedMultiVec
Contents of a “sortedmulti” descriptor
Tr
A taproot descriptor
Wpkh
A bare Wpkh descriptor at top level
Wsh
A Segwitv0 wsh descriptor

Enums§

ConversionError
Descriptor key conversion error
Descriptor
Script descriptor
DescriptorPublicKey
The descriptor pubkey, either a single pubkey or an xpub.
DescriptorSecretKey
The descriptor secret key, either a single private key or an xprv.
DescriptorType
Descriptor Type of the descriptor
ShInner
Sh Inner
SinglePubKey
Single public key without any origin or range information.
TapTree
A Taproot Tree representation.
Wildcard
Whether a descriptor has a wildcard in it
WshInner
Wsh Inner

Traits§

InnerXKey
Trait for “extended key” types like xpub and xprv. Used internally to generalize parsing and handling of bip32::ExtendedPubKey and bip32::ExtendedPrivKey.

Type Aliases§

KeyMap
Alias type for a map of public key to secret key