Struct PaymentHash 

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

The payment hash is the hash of the PaymentPreimage which is the value used to lock funds in HTLCs while they transit the lightning network.

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

Tuple Fields

0: [u8; 32]

Trait Implementations

impl Borrow<[u8]> for PaymentHash

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for PaymentHash

fn clone(&self) -> PaymentHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentHash

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

Formats the value using the given formatter.

impl Display for PaymentHash

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

Formats the value using the given formatter.

impl From<PaymentPreimage> for PaymentHash

Converts a PaymentPreimage into a PaymentHash by hashing the preimage with SHA256.

fn from(value: PaymentPreimage) -> PaymentHash

Converts to this type from the input type.

impl Hash for PaymentHash

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 LowerHex for PaymentHash

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

Formats the value using the given formatter.

impl Ord for PaymentHash

fn cmp(&self, other: &PaymentHash) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PaymentHash

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

fn partial_cmp(&self, other: &PaymentHash) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Readable for PaymentHash

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

where R: Read,

Reads a Self in from the given Read.

impl UpperHex for PaymentHash

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

Formats the value using the given formatter.

impl Verification for PaymentHash

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

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

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

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

impl Writeable for PaymentHash

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 PaymentHash

impl Eq for PaymentHash

impl StructuralPartialEq for PaymentHash