Enum wallet::descriptor::ContractDescriptor

pub enum ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display,  {
    SingleSig {
        category: ContentType,
        pk: Pk,
    },
    MultiSig {
        category: ContentType,
        threshold: usize,
        signers: Vec<Pk>,
        sorted: bool,
    },
    Script {
        ms_cache: CompiledMiniscript<Pk>,
        policy: Concrete<Pk>,
    },
}

NB: Sorted bare multisigs are not supported and will produce unsorted bare multisig instead

Variants

SingleSig

Fields of SingleSig

category: ContentTypepk: Pk

MultiSig

Fields of MultiSig

category: ContentTypethreshold: usizesigners: Vec<Pk>sorted: bool

Script

Fields of Script

ms_cache: CompiledMiniscript<Pk>policy: Concrete<Pk>

Implementations

impl<Pk> ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

pub fn with<Ctx: ScriptContext>(
    ms: Miniscript<Pk, Ctx>,
    category: ContentType,
    policy_source: &str
) -> Result<ContractDescriptor<Pk>, Error>

pub fn to_descriptor(&self, nested: bool) -> Descriptor<Pk>

pub fn outer_descriptor_type(&self) -> OuterType

Trait Implementations

impl<Pk: Clone> Clone for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Pk: Debug> Debug for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

Formats the value using the given formatter.

impl<Pk> DescriptorTrait<Pk> for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

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

Computes the Bitcoin address of the descriptor, if one exists Some descriptors like pk() don’t have any address.

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

Computes the scriptpubkey of the descriptor

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.

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.

fn get_satisfaction<S>(
    &self,
    satisfier: S
) -> Result<(Vec<Vec<u8>>, 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.

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. Returns Error when the descriptor is impossible to safisfy (ex: sh(OP_FALSE))

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

Get the scriptCode of a transaction output.

pub 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 ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

Formats the value using the given formatter.

impl<Pk: Eq> Eq for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

impl<Pk> FromStr for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<Pk: Hash> Hash for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<Pk: Ord> Ord for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Pk: PartialEq> PartialEq<ContractDescriptor<Pk>> for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

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

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

This method tests for !=.

impl<Pk: PartialOrd> PartialOrd<ContractDescriptor<Pk>> for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<Pk> StrictDecode for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl<Pk> StrictEncode for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl<Pk> StructuralEq for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display, 

impl<Pk> StructuralPartialEq for ContractDescriptor<Pk> where
    Pk: MiniscriptKey + FromStr + StrictEncode + StrictDecode,
    <Pk as FromStr>::Err: Display,
    <Pk as MiniscriptKey>::Hash: FromStr,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: Display,