Module elements_miniscript::descriptor

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.

Modules

• checksum
  Descriptor checksum
• pegin
  Pegin Descriptor Support

Structs

• Bare
  Create a Bare Descriptor. That is descriptor that is not wrapped in sh or wsh. This covers the Pk descriptor
• Blinded
  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.
• DerivPaths
  The derivation paths in a multipath key expression.
• DescriptorKeyParseError
  Descriptor Key parsing errors
• DescriptorMultiXKey
  Instance of one or more extended keys, as specified in BIP 389.
• DescriptorXKey
  An extended key with origin, derivation path, and wildcard.
• LegacyCSFSCov
  The covenant descriptor
• LegacyCovSatisfier
  A satisfier for Covenant descriptors that can do transaction introspection ’tx denotes the lifetime of the transaction being satisfied and ’ptx denotes the lifetime of the previous transaction inputs
• 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
• CovError
  Covenant related Errors
• Descriptor
  Script descriptor
• DescriptorInfo
  Method for determining Type of descriptor when parsing from String
• DescriptorPublicKey
  The MiniscriptKey corresponding to Descriptors. This can either be Single public key or a 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

Constants

• ELMTS_STR
  Elements Descriptor String Prefix

Traits

• CovOperations
  Additional operations required on script builder for Covenant operations support
• InnerXKey
  Trait for “extended key” types like xpub and xprv. Used internally to generalize parsing and handling of bip32::ExtendedPubKey and bip32::ExtendedPrivKey.

Type Definitions

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