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.

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

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

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 sorted_node<ToPkCtx>(&self, to_pk_ctx: ToPkCtx) -> Terminal<Pk, Ctx> where
    Pk: ToPublicKey<ToPkCtx>,
    ToPkCtx: Copy, 

Create Terminal::Multi containing sorted pubkeys

pub fn encode<ToPkCtx>(&self, to_pk_ctx: ToPkCtx) -> Script where
    Pk: ToPublicKey<ToPkCtx>,
    ToPkCtx: Copy, 

Encode as a Bitcoin script

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

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

pub fn script_size<ToPkCtx>(&self, to_pk_ctx: ToPkCtx) -> usize where
    Pk: ToPublicKey<ToPkCtx>,
    ToPkCtx: Copy, 

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) -> usize

Maximum size, in bytes, of a satisfying witness. For Segwit outputs one_cost should be set to 2, since the number 1 requires two bytes to encode. For non-segwit outputs one_cost should be set to 1, since OP_1 is available in scriptSigs.

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.

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

Trait Implementations

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

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

Returns a copy of the value.

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

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: MiniscriptKey + Ord,
    Ctx: ScriptContext + Ord, 

pub fn cmp(&self, other: &SortedMultiVec<Pk, Ctx>) -> 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, Ctx> PartialEq<SortedMultiVec<Pk, Ctx>> for SortedMultiVec<Pk, Ctx> where
    Pk: MiniscriptKey + PartialEq<Pk>,
    Ctx: ScriptContext + PartialEq<Ctx>, 

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: MiniscriptKey + PartialOrd<Pk>,
    Ctx: ScriptContext + PartialOrd<Ctx>, 

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

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

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

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

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

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

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

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

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

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

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,