Type Alias PegInDescriptor

pub type PegInDescriptor = Descriptor<CompressedPublicKey>;

Aliased Type

enum PegInDescriptor {
    Bare(Bare<CompressedPublicKey>),
    Pkh(Pkh<CompressedPublicKey>),
    Wpkh(Wpkh<CompressedPublicKey>),
    Sh(Sh<CompressedPublicKey>),
    Wsh(Wsh<CompressedPublicKey>),
    Tr(Tr<CompressedPublicKey>),
}

Variants

Bare(Bare<CompressedPublicKey>)

A raw scriptpubkey (including pay-to-pubkey) under Legacy context

Pkh(Pkh<CompressedPublicKey>)

Pay-to-PubKey-Hash

Wpkh(Wpkh<CompressedPublicKey>)

Pay-to-Witness-PubKey-Hash

Sh(Sh<CompressedPublicKey>)

Pay-to-ScriptHash(includes nested wsh/wpkh/sorted multi)

Wsh(Wsh<CompressedPublicKey>)

Pay-to-Witness-ScriptHash with Segwitv0 context

Tr(Tr<CompressedPublicKey>)

Pay-to-Taproot

Implementations

impl<Pk> Descriptor<Pk>

where Pk: MiniscriptKey + ToPublicKey,

pub fn address(&self, network: Network) -> Result<Address, Error>

Computes the Bitcoin address of the descriptor, if one exists

Some descriptors like pk() don’t have an address.

Errors

For raw/bare descriptors that don’t have an address.

pub fn script_pubkey(&self) -> ScriptBuf

Computes the scriptpubkey of the descriptor.

pub fn unsigned_script_sig(&self) -> ScriptBuf

Computes the scriptSig that will be in place for an unsigned input spending an output with this descriptor. For pre-segwit descriptors, which use the scriptSig for signatures, this returns the empty script.

This is used in Segwit transactions to produce an unsigned transaction whose txid will not change during signing (since only the witness data will change).

pub fn explicit_script(&self) -> Result<ScriptBuf, Error>

Computes the the underlying script before any hashing is done. For Bare, Pkh and Wpkh this is the scriptPubkey; for ShWpkh and Sh this is the redeemScript; for the others it is the witness script.

Errors

If the descriptor is a taproot descriptor.

pub fn script_code(&self) -> Result<ScriptBuf, Error>

Computes the scriptCode of a transaction output.

The scriptCode is the Script of the previous transaction output being serialized in the sighash when evaluating a CHECKSIG & co. OP code.

Errors

If the descriptor is a taproot descriptor.

pub fn get_satisfaction<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>

where S: Satisfier<Pk>,

Returns satisfying non-malleable witness and scriptSig to spend an output controlled by the given descriptor if it possible to construct one using the satisfier S.

pub fn get_satisfaction_mall<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>

where S: Satisfier<Pk>,

Returns a possilbly mallable satisfying non-malleable witness and scriptSig to spend an output controlled by the given descriptor if it possible to construct one using the satisfier S.

pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>

where S: Satisfier<Pk>,

Attempts to produce a non-malleable satisfying witness and scriptSig to spend an output controlled by the given descriptor; add the data to a given TxIn output.

impl<Pk> Descriptor<Pk>

where Pk: MiniscriptKey,

pub fn new_pk(pk: Pk) -> Descriptor<Pk>

Create a new pk descriptor

pub fn new_pkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new PkH descriptor

pub fn new_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new Wpkh descriptor Will return Err if uncompressed key is used

pub fn new_sh_wpkh(pk: Pk) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wpkh from Pk. Errors when uncompressed keys are supplied

pub fn new_sh(ms: Miniscript<Pk, Legacy>) -> Result<Descriptor<Pk>, Error>

Create a new sh for a given redeem script Errors when miniscript exceeds resource limits under p2sh context or does not type check at the top level

pub fn new_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new wsh descriptor from witness script Errors when miniscript exceeds resource limits under p2sh context or does not type check at the top level

pub fn new_sh_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh descriptor with witness script Errors when miniscript exceeds resource limits under wsh context or does not type check at the top level

pub fn new_bare(ms: Miniscript<Pk, BareCtx>) -> Result<Descriptor<Pk>, Error>

Create a new bare descriptor from witness script Errors when miniscript exceeds resource limits under bare context or does not type check at the top level

pub fn new_sh_with_wpkh(wpkh: Wpkh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wpkh descriptor

pub fn new_sh_with_wsh(wsh: Wsh<Pk>) -> Descriptor<Pk>

Create a new sh wrapper for the given wsh descriptor

pub fn new_sh_sortedmulti( k: usize, pks: Vec<Pk>, ) -> Result<Descriptor<Pk>, Error>

Create a new sh sortedmulti descriptor with threshold k and Vec of pks. Errors when miniscript exceeds resource limits under p2sh context

pub fn new_sh_wsh_sortedmulti( k: usize, pks: Vec<Pk>, ) -> Result<Descriptor<Pk>, Error>

Create a new sh wrapped wsh sortedmulti descriptor from threshold k and Vec of pks Errors when miniscript exceeds resource limits under segwit context

pub fn new_wsh_sortedmulti( k: usize, pks: Vec<Pk>, ) -> Result<Descriptor<Pk>, Error>

Create a new wsh sorted multi descriptor Errors when miniscript exceeds resource limits under p2sh context

pub fn new_tr( key: Pk, script: Option<TapTree<Pk>>, ) -> Result<Descriptor<Pk>, Error>

Create new tr descriptor Errors when miniscript exceeds resource limits under Tap context

pub fn desc_type(&self) -> DescriptorType

Get the [DescriptorType] of [Descriptor]

pub fn sanity_check(&self) -> Result<(), Error>

Checks whether the descriptor is safe.

Checks whether all the spend paths in the descriptor are possible on the bitcoin network under the current standardness and consensus rules. Also checks whether the descriptor requires signatures on all spend paths and whether the script is malleable.

In general, all the guarantees of miniscript hold only for safe scripts. The signer may not be able to find satisfactions even if one exists.

pub fn max_weight_to_satisfy(&self) -> Result<Weight, Error>

Computes an upper bound on the difference between a non-satisfied TxIn’s segwit_weight and a satisfied TxIn’s segwit_weight

Since this method uses segwit_weight instead of legacy_weight, if you want to include only legacy inputs in your transaction, you should remove 1WU from each input’s max_weight_to_satisfy for a more accurate estimate.

In other words, for segwit inputs or legacy inputs included in segwit transactions, the following will hold for each input if that input was satisfied with the largest possible witness:

for i in 0..transaction.input.len() {
    assert_eq!(
        descriptor_for_input[i].max_weight_to_satisfy(),
        transaction.input[i].segwit_weight() - TxIn::default().segwit_weight()
    );
}

Instead, for legacy transactions, the following will hold for each input if that input was satisfied with the largest possible witness:

for i in 0..transaction.input.len() {
    assert_eq!(
        descriptor_for_input[i].max_weight_to_satisfy(),
        transaction.input[i].legacy_weight() - TxIn::default().legacy_weight()
    );
}

Assumes all ECDSA signatures are 73 bytes, including push opcode and sighash suffix. Assumes all Schnorr signatures are 66 bytes, including push opcode and sighash suffix.

Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

pub fn max_satisfaction_weight(&self) -> Result<usize, Error>

👎Deprecated since 10.0.0: Use max_weight_to_satisfy instead. The method to count bytes was redesigned and the results will differ from max_weight_to_satisfy. For more details check rust-bitcoin/rust-miniscript#476.

Computes an upper bound on the weight of a satisfying witness to the transaction.

Assumes all ec-signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

Trait Implementations

impl<Pk> Clone for Descriptor<Pk>

where Pk: Clone + MiniscriptKey,

fn clone(&self) -> Descriptor<Pk>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Pk> Debug for Descriptor<Pk>

where Pk: MiniscriptKey,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<K> Decodable for Descriptor<K>

where Descriptor<K>: FromStr, <Descriptor<K> as FromStr>::Err: ToString + Error + Send + Sync + 'static, K: MiniscriptKey,

fn consensus_decode_partial_from_finite_reader<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Descriptor<K>, DecodeError>

where D: Read,

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

fn consensus_decode_partial<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

impl<'de, Pk> Deserialize<'de> for Descriptor<Pk>

where Pk: FromStrKey,

fn deserialize<D>( deserializer: D, ) -> Result<Descriptor<Pk>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Pk> Display for Descriptor<Pk>

where Pk: MiniscriptKey,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<K> Encodable for Descriptor<K>

where K: MiniscriptKey,

fn consensus_encode<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> u64

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl<Pk> ForEachKey<Pk> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn for_each_key<'a, F>(&'a self, pred: F) -> bool

where F: FnMut(&'a Pk) -> bool,

Run a predicate on every key in the descriptor, returning whether the predicate returned true for every key

fn for_any_key<'a, F>(&'a self, pred: F) -> bool

where F: FnMut(&'a Pk) -> bool, Pk: 'a,

Run a predicate on every key in the descriptor, returning whether the predicate returned true for any key

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Bare<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Pkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Sh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Tr<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn from(inner: Wsh<Pk>) -> Descriptor<Pk>

Converts to this type from the input type.

impl<Pk> FromStr for Descriptor<Pk>

where Pk: FromStrKey,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Descriptor<Pk>, Error>

Parses a string s to return a value of this type.

impl<Pk> FromTree for Descriptor<Pk>

where Pk: FromStrKey,

fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>

Parse an expression tree into a descriptor.

impl<Pk> Hash for Descriptor<Pk>

where Pk: Hash + MiniscriptKey,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Pk> Liftable<Pk> for Descriptor<Pk>

where Pk: MiniscriptKey,

fn lift(&self) -> Result<Policy<Pk>, Error>

Converts this object into an abstract policy.

impl<Pk> Ord for Descriptor<Pk>

where Pk: Ord + MiniscriptKey,

fn cmp(&self, other: &Descriptor<Pk>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Pk> PartialEq for Descriptor<Pk>

where Pk: PartialEq + MiniscriptKey,

fn eq(&self, other: &Descriptor<Pk>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Pk> PartialOrd for Descriptor<Pk>

where Pk: PartialOrd + MiniscriptKey,

fn partial_cmp(&self, other: &Descriptor<Pk>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'de, Pk> Serialize for Descriptor<Pk>

where Pk: MiniscriptKey,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<P, Q> TranslatePk<P, Q> for Descriptor<P>

where P: MiniscriptKey, Q: MiniscriptKey,

fn translate_pk<T, E>( &self, t: &mut T, ) -> Result<<Descriptor<P> as TranslatePk<P, Q>>::Output, TranslateErr<E>>

where T: Translator<P, Q, E>,

Converts a descriptor using abstract keys to one using specific keys.

type Output = Descriptor<Q>

The associated output type. This must be Self<Q>.

impl Tweakable for Descriptor<CompressedPublicKey>

fn tweak<Ctx: Verification + Signing, Ctr: Contract>( &self, tweak: &Ctr, secp: &Secp256k1<Ctx>, ) -> Self

Tweak the key with a tweak contract

impl<Pk> Eq for Descriptor<Pk>

where Pk: Eq + MiniscriptKey,

impl<Pk> StructuralPartialEq for Descriptor<Pk>

where Pk: MiniscriptKey,