Struct miniscript::plan::Plan

pub struct Plan {
    pub absolute_timelock: Option<LockTime>,
    pub relative_timelock: Option<Sequence>,
    /* private fields */
}

Representation of a particular spending path on a descriptor. Contains the witness template and the timelocks needed for satisfying the plan. Calling plan on a Descriptor will return this structure, containing the cheapest spending path possible (considering the Assets given)

Fields

absolute_timelock: Option<LockTime>

The absolute timelock this plan uses

relative_timelock: Option<Sequence>

The relative timelock this plan uses

Implementations

impl Plan

pub fn witness_template(&self) -> &Vec<Placeholder<DefiniteDescriptorKey>>

Returns the witness template

pub fn witness_version(&self) -> Option<WitnessVersion>

Returns the witness version

pub fn satisfaction_weight(&self) -> usize

The weight, in witness units, needed for satisfying this plan (includes both the script sig weight and the witness weight)

pub fn scriptsig_size(&self) -> usize

The size in bytes of the script sig that satisfies this plan

pub fn witness_size(&self) -> usize

The size in bytes of the witness that satisfies this plan

pub fn satisfy<Sat: Satisfier<DefiniteDescriptorKey>>( &self, stfr: &Sat ) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>

Try creating the final script_sig and witness using a Satisfier

pub fn update_psbt_input(&self, input: &mut Input)

Update a PSBT input with the metadata required to complete this plan

This will only add the metadata for items required to complete this plan. For example, if there are multiple keys present in the descriptor, only the few used by this plan will be added to the PSBT.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.