Struct HtlcKey

pub struct HtlcKey(pub PublicKey);

A derived key built from a HtlcBasepoint and per_commitment_point.

HTLC keys are used to ensure only the recipient of an HTLC can claim it on-chain with the HTLC preimage and that only the sender of an HTLC can claim it on-chain after it has timed out. Thus, both channel counterparties’ HTLC keys will appears in each HTLC output’s script.

[See the BOLT specs] https://github.com/lightning/bolts/blob/master/03-transactions.md#localpubkey-local_htlcpubkey-remote_htlcpubkey-local_delayedpubkey-and-remote_delayedpubkey-derivation for more information on key derivation details.

Tuple Fields

0: PublicKey

Implementations

impl HtlcKey

pub fn from_basepoint<T: Signing>( secp_ctx: &Secp256k1<T>, countersignatory_basepoint: &HtlcBasepoint, per_commitment_point: &PublicKey, ) -> Self

Derive a public htlcpubkey using one node’s per_commitment_point and its countersignatory’s basepoint

pub fn from_secret_key<T: Signing>( secp_ctx: &Secp256k1<T>, sk: &SecretKey, ) -> Self

Build a htlcpubkey directly from an already-derived private key

pub fn to_public_key(&self) -> PublicKey

Get inner Public Key

Trait Implementations

impl Clone for HtlcKey

fn clone(&self) -> HtlcKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HtlcKey

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

Formats the value using the given formatter.

impl PartialEq for HtlcKey

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

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

Reads a Self in from the given Read.

impl Writeable for HtlcKey

fn write<W: Writer>(&self, w: &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 Copy for HtlcKey

impl Eq for HtlcKey

impl StructuralPartialEq for HtlcKey