Struct breez_sdk_core::lightning::sign::HTLCDescriptor

pub struct HTLCDescriptor {
    pub channel_derivation_parameters: ChannelDerivationParameters,
    pub commitment_txid: Txid,
    pub per_commitment_number: u64,
    pub per_commitment_point: PublicKey,
    pub feerate_per_kw: u32,
    pub htlc: HTLCOutputInCommitment,
    pub preimage: Option<PaymentPreimage>,
    pub counterparty_sig: Signature,
}

A descriptor used to sign for a commitment transaction’s HTLC output.

Fields

channel_derivation_parameters: ChannelDerivationParameters

The parameters required to derive the signer for the HTLC input.

commitment_txid: Txid

The txid of the commitment transaction in which the HTLC output lives.

per_commitment_number: u64

The number of the commitment transaction in which the HTLC output lives.

per_commitment_point: PublicKey

The key tweak corresponding to the number of the commitment transaction in which the HTLC output lives. This tweak is applied to all the basepoints for both parties in the channel to arrive at unique keys per commitment.

See https://github.com/lightning/bolts/blob/master/03-transactions.md#keys for more info.

feerate_per_kw: u32

The feerate to use on the HTLC claiming transaction. This is always 0 for HTLCs originating from a channel supporting anchor outputs, otherwise it is the channel’s negotiated feerate at the time the commitment transaction was built.

htlc: HTLCOutputInCommitment

The details of the HTLC as it appears in the commitment transaction.

preimage: Option<PaymentPreimage>

The preimage, if Some, to claim the HTLC output with. If None, the timeout path must be taken.

counterparty_sig: Signature

The counterparty’s signature required to spend the HTLC output.

Implementations

impl HTLCDescriptor

pub fn outpoint(&self) -> OutPoint

Returns the outpoint of the HTLC output in the commitment transaction. This is the outpoint being spent by the HTLC input in the HTLC transaction.

pub fn previous_utxo<C>(&self, secp: &Secp256k1<C>) -> TxOut

where C: Signing + Verification,

Returns the UTXO to be spent by the HTLC input, which can be obtained via Self::unsigned_tx_input.

pub fn unsigned_tx_input(&self) -> TxIn

Returns the unsigned transaction input spending the HTLC output in the commitment transaction.

pub fn tx_output<C>(&self, secp: &Secp256k1<C>) -> TxOut

where C: Signing + Verification,

Returns the delayed output created as a result of spending the HTLC output in the commitment transaction.

pub fn witness_script<C>(&self, secp: &Secp256k1<C>) -> Script

where C: Signing + Verification,

Returns the witness script of the HTLC output in the commitment transaction.

pub fn tx_input_witness( &self, signature: &Signature, witness_script: &Script, ) -> Witness

Returns the fully signed witness required to spend the HTLC output in the commitment transaction.

pub fn derive_channel_signer<S, SP>(&self, signer_provider: &SP) -> S

where S: WriteableEcdsaChannelSigner, SP: Deref, <SP as Deref>::Target: SignerProvider<Signer = S>,

Derives the channel signer required to sign the HTLC input.

Trait Implementations

impl Clone for HTLCDescriptor

fn clone(&self) -> HTLCDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HTLCDescriptor

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

Formats the value using the given formatter.

impl PartialEq for HTLCDescriptor

fn eq(&self, other: &HTLCDescriptor) -> 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 HTLCDescriptor

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for HTLCDescriptor

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

where W: Writer,

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 HTLCDescriptor

impl StructuralPartialEq for HTLCDescriptor