Struct FinalOnionHopData

pub struct FinalOnionHopData {
    pub payment_secret: PaymentSecret,
    pub total_msat: u64,
}

Information communicated in the onion to the recipient for multi-part tracking and proof that the payment is associated with an invoice.

Fields

payment_secret: PaymentSecret

When sending a multi-part payment, this secret is used to identify a payment across HTLCs. Because it is generated by the recipient and included in the invoice, it also provides proof to the recipient that the payment was sent by someone with the generated invoice.

total_msat: u64

The intended total amount that this payment is for.

Message serialization may panic if this value is more than 21 million Bitcoin.

Trait Implementations

impl Clone for FinalOnionHopData

fn clone(&self) -> FinalOnionHopData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Readable for FinalOnionHopData

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for FinalOnionHopData

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.