Struct lightning::ln::chan_utils::CommitmentTransaction

pub struct CommitmentTransaction { /* private fields */ }

This class tracks the per-transaction information needed to build a commitment transaction and will actually build it and sign. It is used for holder transactions that we sign only when needed and for transactions we sign for the counterparty.

This class can be used inside a signer implementation to generate a signature given the relevant secret key.

Implementations

impl CommitmentTransaction

pub fn new_with_auxiliary_htlc_data<T>(
    commitment_number: u64,
    to_broadcaster_value_sat: u64,
    to_countersignatory_value_sat: u64,
    opt_anchors: bool,
    broadcaster_funding_key: PublicKey,
    countersignatory_funding_key: PublicKey,
    keys: TxCreationKeys,
    feerate_per_kw: u32,
    htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>,
    channel_parameters: &DirectedChannelTransactionParameters<'_>
) -> CommitmentTransaction

Construct an object of the class while assigning transaction output indices to HTLCs.

Populates HTLCOutputInCommitment.transaction_output_index in htlcs_with_aux.

The generic T allows the caller to match the HTLC output index with auxiliary data. This auxiliary data is not stored in this object.

Only include HTLCs that are above the dust limit for the channel.

(C-not exported) due to the generic though we likely should expose a version without

pub fn commitment_number(&self) -> u64

The backwards-counting commitment number

pub fn to_broadcaster_value_sat(&self) -> u64

The value to be sent to the broadcaster

pub fn to_countersignatory_value_sat(&self) -> u64

The value to be sent to the counterparty

pub fn feerate_per_kw(&self) -> u32

The feerate paid per 1000-weight-unit in this commitment transaction.

pub fn htlcs(&self) -> &Vec<HTLCOutputInCommitment>

The non-dust HTLCs (direction, amt, height expiration, hash, transaction output index) which were included in this commitment transaction in output order. The transaction index is always populated.

(C-not exported) as we cannot currently convert Vec references to/from C, though we should expose a less effecient version which creates a Vec of references in the future.

pub fn trust(&self) -> TrustedCommitmentTransaction<'_>

Trust our pre-built transaction and derived transaction creation public keys.

Applies a wrapper which allows access to these fields.

This should only be used if you fully trust the builder of this object. It should not be used by an external signer - instead use the verify function.

pub fn verify<T: Signing + Verification>(
    &self,
    channel_parameters: &DirectedChannelTransactionParameters<'_>,
    broadcaster_keys: &ChannelPublicKeys,
    countersignatory_keys: &ChannelPublicKeys,
    secp_ctx: &Secp256k1<T>
) -> Result<TrustedCommitmentTransaction<'_>, ()>

Verify our pre-built transaction and derived transaction creation public keys.

Applies a wrapper which allows access to these fields.

An external validating signer must call this method before signing or using the built transaction.

Trait Implementations

impl Clone for CommitmentTransaction

fn clone(&self) -> CommitmentTransaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CommitmentTransaction> for CommitmentTransaction

fn eq(&self, o: &Self) -> 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 !=.

impl Readable for CommitmentTransaction

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

Reads a Self in from the given Read

impl Writeable for CommitmentTransaction

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