Struct StaticPaymentOutputDescriptor

pub struct StaticPaymentOutputDescriptor {
    pub outpoint: OutPoint,
    pub output: TxOut,
    pub channel_keys_id: [u8; 32],
    pub channel_value_satoshis: u64,
    pub channel_transaction_parameters: Option<ChannelTransactionParameters>,
}

Information about a spendable output to our “payment key”.

See SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.

Fields

outpoint: OutPoint

The outpoint which is spendable.

output: TxOut

The output which is referenced by the given outpoint.

channel_keys_id: [u8; 32]

Arbitrary identification information returned by a call to ChannelSigner::channel_keys_id. This may be useful in re-deriving keys used in the channel to spend the output.

channel_value_satoshis: u64

The value of the channel which this transactions spends.

channel_transaction_parameters: Option<ChannelTransactionParameters>

The necessary channel parameters that need to be provided to the signer.

Added as optional, but always Some if the descriptor was produced in v0.0.117 or later.

Implementations

impl StaticPaymentOutputDescriptor

pub fn witness_script(&self) -> Option<ScriptBuf>

Returns the witness_script of the spendable output.

Note that this will only return Some for StaticPaymentOutputDescriptors that originated from an anchor outputs channel, as they take the form of a P2WSH script.

pub fn max_witness_length(&self) -> u64

The maximum length a well-formed witness spending one of these should have.

Note: If you have the grind_signatures feature enabled, this will be at least 1 byte shorter.

pub fn needs_csv_1_for_spend(&self) -> bool

Returns true if spending this output requires a transaction with a CheckSequenceVerify value of at least 1.

Trait Implementations

impl Clone for StaticPaymentOutputDescriptor

fn clone(&self) -> StaticPaymentOutputDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StaticPaymentOutputDescriptor

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

Formats the value using the given formatter.

impl Hash for StaticPaymentOutputDescriptor

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StaticPaymentOutputDescriptor

fn eq(&self, other: &StaticPaymentOutputDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Readable for StaticPaymentOutputDescriptor

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

Reads a Self in from the given Read.

impl Writeable for StaticPaymentOutputDescriptor

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

impl Eq for StaticPaymentOutputDescriptor

impl StructuralPartialEq for StaticPaymentOutputDescriptor