Struct bdk::keys::SortedMultiVec

pub struct SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext,  {
    pub k: usize,
    pub pks: Vec<Pk, Global>,
    // some fields omitted
}

Contents of a “sortedmulti” descriptor

Fields

k: usize

signatures required

pks: Vec<Pk, Global>

public keys inside sorted Multi

Implementations

impl<Pk, Ctx> SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

pub fn new(
    k: usize,
    pks: Vec<Pk, Global>
) -> Result<SortedMultiVec<Pk, Ctx>, Error>

Create a new instance of SortedMultiVec given a list of keys and the threshold

Internally checks all the applicable size limits and pubkey types limitations according to the current Ctx.

pub fn from_tree(tree: &Tree<'_>) -> Result<SortedMultiVec<Pk, Ctx>, Error> where
    Pk: FromStr,
    <Pk as FromStr>::Err: ToString, 

Parse an expression tree into a SortedMultiVec

pub fn translate_pk<FPk, Q, FuncError>(
    &self,
    translatefpk: &mut FPk
) -> Result<SortedMultiVec<Q, Ctx>, FuncError> where
    FPk: FnMut(&Pk) -> Result<Q, FuncError>,
    Q: MiniscriptKey, 

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.

impl<Pk, Ctx> SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

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

utility function to sanity a sorted multi vec

impl<Pk, Ctx> SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

pub fn sorted_node(&self) -> Terminal<Pk, Ctx> where
    Pk: ToPublicKey, 

Create Terminal::Multi containing sorted pubkeys

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

Encode as a Bitcoin script

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

Attempt to produce a satisfying witness for the witness script represented by the parse tree

pub fn script_size(&self) -> usize

Size, in bytes of the script-pubkey. If this Miniscript is used outside of segwit (e.g. in a bare or P2SH descriptor), this quantity should be multiplied by 4 to compute the weight.

In general, it is not recommended to use this function directly, but to instead call the corresponding function on a Descriptor, which will handle the segwit/non-segwit technicalities for you.

pub fn max_satisfaction_witness_elements(&self) -> usize

Maximum number of witness elements used to satisfy the Miniscript fragment, including the witness script itself. Used to estimate the weight of the VarInt that specifies this number in a serialized transaction.

This function may panic on malformed Miniscript objects which do not correspond to semantically sane Scripts. (Such scripts should be rejected at parse time. Any exceptions are bugs.)

pub fn max_satisfaction_size(&self) -> usize

Maximum size, in bytes, of a satisfying witness. In general, it is not recommended to use this function directly, but to instead call the corresponding function on a Descriptor, which will handle the segwit/non-segwit technicalities for you.

All signatures are assumed to be 73 bytes in size, including the length prefix (segwit) or push opcode (pre-segwit) and sighash postfix.

Trait Implementations

impl<Pk, Ctx> Clone for SortedMultiVec<Pk, Ctx> where
    Pk: Clone + MiniscriptKey,
    Ctx: Clone + ScriptContext, 

pub fn clone(&self) -> SortedMultiVec<Pk, Ctx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Pk, Ctx> Debug for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

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

Formats the value using the given formatter.

impl<Pk, Ctx> Display for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

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

Formats the value using the given formatter.

impl<Pk, Ctx> ForEachKey<Pk> for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

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, Ctx> Hash for SortedMultiVec<Pk, Ctx> where
    Pk: Hash + MiniscriptKey,
    Ctx: Hash + ScriptContext, 

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

Feeds a slice of this type into the given Hasher.

impl<Pk, Ctx> Liftable<Pk> for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

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

Convert the object into an abstract policy

impl<Pk, Ctx> Ord for SortedMultiVec<Pk, Ctx> where
    Pk: Ord + MiniscriptKey,
    Ctx: Ord + ScriptContext, 

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<Pk, Ctx> PartialEq<SortedMultiVec<Pk, Ctx>> for SortedMultiVec<Pk, Ctx> where
    Pk: PartialEq<Pk> + MiniscriptKey,
    Ctx: PartialEq<Ctx> + ScriptContext, 

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

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

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

This method tests for !=.

impl<Pk, Ctx> PartialOrd<SortedMultiVec<Pk, Ctx>> for SortedMultiVec<Pk, Ctx> where
    Pk: PartialOrd<Pk> + MiniscriptKey,
    Ctx: PartialOrd<Ctx> + ScriptContext, 

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

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

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

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

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

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

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

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

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, Ctx> Eq for SortedMultiVec<Pk, Ctx> where
    Pk: Eq + MiniscriptKey,
    Ctx: Eq + ScriptContext, 

impl<Pk, Ctx> StructuralEq for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

impl<Pk, Ctx> StructuralPartialEq for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey,
    Ctx: ScriptContext,