Struct FundingTxInput

pub struct FundingTxInput { /* private fields */ }

An input to contribute to a channel’s funding transaction either when using the v2 channel establishment protocol or when splicing.

Implementations

impl FundingTxInput

pub fn new_p2wpkh(prevtx: Transaction, vout: u32) -> Result<Self, ()>

Creates an input spending a P2WPKH output from the given prevtx at index vout.

Uses Sequence::ENABLE_RBF_NO_LOCKTIME as the TxIn::sequence, which can be overridden by set_sequence.

Returns Err if no such output exists in prevtx at index vout.

pub fn new_p2wsh( prevtx: Transaction, vout: u32, witness_weight: Weight, ) -> Result<Self, ()>

Creates an input spending a P2WSH output from the given prevtx at index vout.

Requires passing the weight of witness needed to satisfy the output’s script.

Uses Sequence::ENABLE_RBF_NO_LOCKTIME as the TxIn::sequence, which can be overridden by set_sequence.

Returns Err if no such output exists in prevtx at index vout.

pub fn new_p2tr_key_spend(prevtx: Transaction, vout: u32) -> Result<Self, ()>

Creates an input spending a P2TR output from the given prevtx at index vout.

This is meant for inputs spending a taproot output using the key path. See new_p2tr_script_spend for when spending using a script path.

Uses Sequence::ENABLE_RBF_NO_LOCKTIME as the TxIn::sequence, which can be overridden by set_sequence.

Returns Err if no such output exists in prevtx at index vout.

pub fn new_p2tr_script_spend( prevtx: Transaction, vout: u32, witness_weight: Weight, ) -> Result<Self, ()>

Creates an input spending a P2TR output from the given prevtx at index vout.

Requires passing the weight of witness needed to satisfy a script path of the taproot output. See new_p2tr_key_spend for when spending using the key path.

Uses Sequence::ENABLE_RBF_NO_LOCKTIME as the TxIn::sequence, which can be overridden by set_sequence.

Returns Err if no such output exists in prevtx at index vout.

pub fn outpoint(&self) -> OutPoint

The outpoint of the UTXO being spent.

pub fn sequence(&self) -> Sequence

The sequence number to use in the TxIn.

pub fn set_sequence(&mut self, sequence: Sequence)

Sets the sequence number to use in the TxIn.

pub fn into_utxo(self) -> Utxo

Converts the FundingTxInput into a Utxo for coin selection.

Trait Implementations

impl Clone for FundingTxInput

fn clone(&self) -> FundingTxInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FundingTxInput

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

Formats the value using the given formatter.

impl Readable for FundingTxInput

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for FundingTxInput

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.