Struct OnionPacket

pub struct OnionPacket {
    pub version: u8,
    pub public_key: Result<PublicKey, Error>,
    pub hop_data: [u8; 1300],
    pub hmac: [u8; 32],
}

BOLT 4 onion packet including hop data for the next peer.

Fields

version: u8

BOLT 4 version number.

public_key: Result<PublicKey, Error>

In order to ensure we always return an error on onion decode in compliance with BOLT #4, we have to deserialize OnionPackets contained in UpdateAddHTLC messages even if the ephemeral public key (here) is bogus, so we hold a Result instead of a PublicKey as we’d like.

hop_data: [u8; 1300]

1300 bytes encrypted payload for the next hop.

hmac: [u8; 32]

HMAC to verify the integrity of hop_data.

Trait Implementations

impl Clone for OnionPacket

fn clone(&self) -> OnionPacket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OnionPacket

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

Formats the value using the given formatter.

impl Hash for OnionPacket

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 OnionPacket

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

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

where R: Read,

Reads a Self in from the given Read.

impl Writeable for OnionPacket

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 Eq for OnionPacket

impl StructuralPartialEq for OnionPacket