Struct PaymentId

pub struct PaymentId(pub [u8; 32]);

A user-provided identifier in ChannelManager::send_payment used to uniquely identify a payment and ensure idempotency in LDK.

This is not exported to bindings users as we just use [u8; 32] directly

Tuple Fields

0: [u8; 32]

Implementations

impl PaymentId

pub const LENGTH: usize = 32usize

Number of bytes in the id.

pub fn hmac_for_offer_payment( &self, nonce: Nonce, expanded_key: &ExpandedKey, ) -> Hmac<Hash>

Constructs an HMAC to include in OffersContext::OutboundPayment for the payment id along with the given Nonce.

pub fn verify( &self, hmac: Hmac<Hash>, nonce: Nonce, expanded_key: &ExpandedKey, ) -> Result<(), ()>

Authenticates the payment id using an HMAC and a Nonce taken from an OffersContext::OutboundPayment.

Trait Implementations

impl Clone for PaymentId

fn clone(&self) -> PaymentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentId

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

Formats the value using the given formatter.

impl Display for PaymentId

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

Formats the value using the given formatter.

impl Hash for PaymentId

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

where __H: Hasher,

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 PaymentId

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

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for PaymentId

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

where W: Writer,

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 PaymentId

impl Eq for PaymentId

impl StructuralPartialEq for PaymentId