Struct PaymentOnionPacket 

pub struct PaymentOnionPacket { /* private fields */ }

An encrypted onion packet for payment routing.

Implementations

impl PaymentOnionPacket

pub fn new(data: Vec<u8>) -> Self

Create a new PaymentOnionPacket from raw data.

pub fn data(&self) -> &[u8]

Get the raw packet data.

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

Get the raw packet data as bytes slice (alias for data()).

pub fn into_data(self) -> Vec<u8>

Consume self and return the raw data.

pub fn into_bytes(self) -> Vec<u8>

Consume self and return the raw data as bytes (alias for into_data()).

pub fn into_sphinx_onion_packet(self) -> Result<OnionPacket, OnionPacketError>

Convert into the raw Sphinx onion packet.

pub fn peel<C: Verification>( self, peeler: &Privkey, assoc_data: Option<&[u8]>, secp_ctx: &Secp256k1<C>, ) -> Result<PeeledPaymentOnionPacket, OnionPacketError>

Peels the next layer of the onion packet using the privkey of the current node.

Returns errors when:

• This is the packet for the last hop.
• Fail to peel the packet using the given private key.

Trait Implementations

impl Clone for PaymentOnionPacket

fn clone(&self) -> PaymentOnionPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentOnionPacket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentOnionPacket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PaymentOnionPacket

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

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 PaymentOnionPacket

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PaymentOnionPacket

impl StructuralPartialEq for PaymentOnionPacket