Enum bdk::descriptor::Descriptor

pub enum Descriptor<Pk> where
    Pk: MiniscriptKey,  {
    Bare(Bare<Pk>),
    Pkh(Pkh<Pk>),
    Wpkh(Wpkh<Pk>),
    Sh(Sh<Pk>),
    Wsh(Wsh<Pk>),
}

Script descriptor

Variants

Bare(Bare<Pk>)

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

Pkh(Pkh<Pk>)

Pay-to-PubKey-Hash

Wpkh(Wpkh<Pk>)

Pay-to-Witness-PubKey-Hash

Sh(Sh<Pk>)

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

Wsh(Wsh<Pk>)

Pay-to-Witness-ScriptHash with Segwitv0 context

Implementations

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) -> Descriptor<Pk>

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_sortedmulti(
    k: usize,
    pks: Vec<Pk, Global>
) -> 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, Global>
) -> 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, Global>
) -> Result<Descriptor<Pk>, Error>

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

pub fn desc_type(&self) -> DescriptorType

Get the DescriptorType of Descriptor

impl Descriptor<DescriptorPublicKey>

pub fn is_deriveable(&self) -> bool

Whether or not the descriptor has any wildcards

pub fn derive(&self, index: u32) -> Descriptor<DescriptorPublicKey>

Derives all wildcard keys in the descriptor using the supplied index

Panics if given an index ≥ 2^31

pub fn parse_descriptor<C>(
    secp: &Secp256k1<C>,
    s: &str
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error> where
    C: Signing, 

Parse a descriptor that may contain secret keys

Internally turns every secret key found into the corresponding public key and then returns a a descriptor that only contains public keys and a map to lookup the secret key given a public key.

pub fn to_string_with_secret(
    &self,
    key_map: &HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>
) -> String

Serialize a descriptor to string with its secret keys

Trait Implementations

impl<Pk> Clone for Descriptor<Pk> where
    Pk: Clone + MiniscriptKey, 

pub 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, 

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

Formats the value using the given formatter.

impl<Pk> DescriptorTrait<Pk> for Descriptor<Pk> where
    Pk: MiniscriptKey, 

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

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 signauture on all spend paths And whether the script is malleable. In general, all the guarantees of miniscript hold only for safe scripts. All the analysis guarantees of miniscript only hold safe scripts. The signer may not be able to find satisfactions even if one exists

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

Computes the Bitcoin address of the descriptor, if one exists

pub fn script_pubkey(&self) -> Script where
    Pk: ToPublicKey, 

Computes the scriptpubkey of the descriptor

pub fn unsigned_script_sig(&self) -> Script where
    Pk: ToPublicKey, 

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) -> Script where
    Pk: ToPublicKey, 

Computes the “witness script” of the descriptor, i.e. 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.

pub fn get_satisfaction<S>(
    &self,
    satisfier: S
) -> Result<(Vec<Vec<u8, Global>, Global>, Script), Error> where
    Pk: ToPublicKey,
    S: Satisfier<Pk>, 

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

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

Computes an upper bound on the weight of a satisfying witness to the transaction. Assumes all signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

pub fn script_code(&self) -> Script where
    Pk: ToPublicKey, 

Get 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.

fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error> where
    Pk: ToPublicKey,
    S: Satisfier<Pk>, 

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

impl<Pk> Display for Descriptor<Pk> where
    Pk: MiniscriptKey, 

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

Formats the value using the given formatter.

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

fn extract_policy(
    &self,
    signers: &SignersContainer,
    build_sat: BuildSatisfaction<'_>,
    secp: &Secp256k1<All>
) -> Result<Option<Policy>, Error>

Extract the spending policy

impl<Pk> ForEachKey<Pk> for Descriptor<Pk> where
    Pk: MiniscriptKey, 

pub fn for_each_key<'a, F>(&'a self, pred: F) -> bool where
    F: FnMut(ForEach<'a, Pk>) -> bool,
    Pk: 'a,
    <Pk as MiniscriptKey>::Hash: 'a, 

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(ForEach<'a, Pk>) -> bool,
    Pk: 'a,
    <Pk as MiniscriptKey>::Hash: 'a, 

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

impl<Pk> FromStr for Descriptor<Pk> where
    Pk: MiniscriptKey + FromStr,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

type Err = Error

The associated error which can be returned from parsing.

pub 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: MiniscriptKey + FromStr,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

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

Parse an expression tree into a descriptor

impl<Pk> Liftable<Pk> for Descriptor<Pk> where
    Pk: MiniscriptKey, 

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

Convert the object into an abstract policy

impl<Pk> Ord for Descriptor<Pk> where
    Pk: Ord + MiniscriptKey, 

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl<Pk> PartialEq<Descriptor<Pk>> for Descriptor<Pk> where
    Pk: PartialEq<Pk> + MiniscriptKey, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<Pk> PartialOrd<Descriptor<Pk>> for Descriptor<Pk> where
    Pk: PartialOrd<Pk> + MiniscriptKey, 

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl<P, Q> TranslatePk<P, Q> for Descriptor<P> where
    P: MiniscriptKey,
    Q: MiniscriptKey, 

pub fn translate_pk<Fpk, Fpkh, E>(
    &self,
    translatefpk: Fpk,
    translatefpkh: Fpkh
) -> Result<Descriptor<Q>, E> where
    Q: MiniscriptKey,
    Fpk: FnMut(&P) -> Result<Q, E>,
    Fpkh: FnMut(&<P as MiniscriptKey>::Hash) -> Result<<Q as MiniscriptKey>::Hash, E>, 

Convert a descriptor using abstract keys to one using specific keys This will panic if translatefpk returns an uncompressed key when converting to a Segwit descriptor. To prevent this panic, ensure translatefpk returns an error in this case instead.

type Output = Descriptor<Q>

The associated output type. This must be Self

fn translate_pk_infallible<Fpk, Fpkh>(
    &self,
    translatefpk: Fpk,
    translatefpkh: Fpkh
) -> Self::Output where
    Fpk: FnMut(&P) -> Q,
    Fpkh: FnMut(&<P as MiniscriptKey>::Hash) -> <Q as MiniscriptKey>::Hash, 

Calls translate_pk with conversion functions that cannot fail

impl<Pk> Eq for Descriptor<Pk> where
    Pk: Eq + MiniscriptKey, 

impl<Pk> StructuralEq for Descriptor<Pk> where
    Pk: MiniscriptKey, 

impl<Pk> StructuralPartialEq for Descriptor<Pk> where
    Pk: MiniscriptKey,