Struct PaymentPreimage 

pub struct PaymentPreimage(/* private fields */);

A 32-byte payment preimage.

The preimage is the secret that, when hashed with SHA256, produces the payment hash. Revealing the preimage proves that a payment was received.

Implementations

impl PaymentPreimage

pub fn from_bytes(bytes: [u8; 32]) -> Self

Create a new payment preimage from bytes.

pub fn from_hex(hex: &str) -> Result<Self, LightningError>

Create a new payment preimage from a hex string.

pub fn random() -> Self

Generate a random payment preimage.

pub fn as_bytes(&self) -> &[u8; 32]

Get the raw bytes.

pub fn to_hex(&self) -> String

Convert to hex string.

pub fn payment_hash(&self) -> PaymentHash

Compute the payment hash from this preimage.

Trait Implementations

impl Clone for PaymentPreimage

fn clone(&self) -> PaymentPreimage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentPreimage

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

Formats the value using the given formatter.

impl Display for PaymentPreimage

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

Formats the value using the given formatter.

impl PartialEq for PaymentPreimage

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

impl StructuralPartialEq for PaymentPreimage