Struct lightning::ln::chan_utils::ChannelTransactionParameters

pub struct ChannelTransactionParameters {
    pub holder_pubkeys: ChannelPublicKeys,
    pub holder_selected_contest_delay: u16,
    pub is_outbound_from_holder: bool,
    pub counterparty_parameters: Option<CounterpartyChannelTransactionParameters>,
    pub funding_outpoint: Option<OutPoint>,
    pub channel_type_features: ChannelTypeFeatures,
}

Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction). The fields are organized by holder/counterparty.

Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.

Fields

holder_pubkeys: ChannelPublicKeys

Holder public keys

holder_selected_contest_delay: u16

The contest delay selected by the holder, which applies to counterparty-broadcast transactions

is_outbound_from_holder: bool

Whether the holder is the initiator of this channel. This is an input to the commitment number obscure factor computation.

counterparty_parameters: Option<CounterpartyChannelTransactionParameters>

The late-bound counterparty channel transaction parameters. These parameters are populated at the point in the protocol where the counterparty provides them.

funding_outpoint: Option<OutPoint>

The late-bound funding outpoint

channel_type_features: ChannelTypeFeatures

This channel’s type, as negotiated during channel open. For old objects where this field wasn’t serialized, it will default to static_remote_key at deserialization.

Implementations

impl ChannelTransactionParameters

pub fn is_populated(&self) -> bool

Whether the late bound parameters are populated.

pub fn as_holder_broadcastable( &self ) -> DirectedChannelTransactionParameters<'_>

Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters, given that the holder is the broadcaster.

self.is_populated() must be true before calling this function.

pub fn as_counterparty_broadcastable( &self ) -> DirectedChannelTransactionParameters<'_>

Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters, given that the counterparty is the broadcaster.

self.is_populated() must be true before calling this function.

Trait Implementations

impl Clone for ChannelTransactionParameters

fn clone(&self) -> ChannelTransactionParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelTransactionParameters

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

Formats the value using the given formatter.

impl Hash for ChannelTransactionParameters

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 ChannelTransactionParameters

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

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

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

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

impl Readable for ChannelTransactionParameters

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

Reads a Self in from the given Read.

impl Writeable for ChannelTransactionParameters

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

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

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.

impl Eq for ChannelTransactionParameters

impl StructuralPartialEq for ChannelTransactionParameters