Struct internet2::presentation::sphinx::SphinxPacket

pub struct SphinxPacket<const PACKET_LEN: usize>(_);

Cyphered raw sphinx packet as it is sent over the wire

Implementations

impl<const PACKET_LEN: usize> SphinxPacket<PACKET_LEN>

pub fn with<C, Payload>(
    secp: &Secp256k1<C>,
    session_key: SecretKey,
    hops: &[Hop<Payload>],
    assoc_data: &[u8]
) -> Result<(Self, Hmac<Hash>), EncodeError> where
    C: Signing,
    Payload: SphinxPayload, 

Constructs Sphinx packet for a given multi-hop route and hop-secific messages represented as an array of Hops. Requires pre-generated session_key.

pub fn hmac(&self, mu_key: [u8; 32], assoc_data: &[u8]) -> Hmac<Hash>

Computes HMAC committing to the cyphered sphinx packet data with optional associate data.

pub fn unfold<Payload>(
    &mut self,
    shared_secret: Hash
) -> Result<(Payload, Hmac<Hash>), Payload::DecodeError> where
    Payload: SphinxPayload, 

Unfolds one layer of the onion, returning decrypted data from the sphinx packet.

Panics

If Payload::PACKET_LEN <= 32 bytes.

Trait Implementations

impl<const PACKET_LEN: usize> Clone for SphinxPacket<PACKET_LEN>

fn clone(&self) -> SphinxPacket<PACKET_LEN>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const PACKET_LEN: usize> Debug for SphinxPacket<PACKET_LEN>

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

Formats the value using the given formatter.

impl<const PACKET_LEN: usize> Hash for SphinxPacket<PACKET_LEN>

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, 

Feeds a slice of this type into the given Hasher.

impl<const PACKET_LEN: usize> LightningDecode for SphinxPacket<PACKET_LEN>

fn lightning_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn lightning_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using LightningDecode::lightning_decode function.

impl<const PACKET_LEN: usize> LightningEncode for SphinxPacket<PACKET_LEN>

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn lightning_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using LightningEncode::lightning_encode function.

impl<const PACKET_LEN: usize> PartialEq<SphinxPacket<PACKET_LEN>> for SphinxPacket<PACKET_LEN>

fn eq(&self, other: &SphinxPacket<PACKET_LEN>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SphinxPacket<PACKET_LEN>) -> bool

This method tests for !=.

impl<const PACKET_LEN: usize> StrictDecode for SphinxPacket<PACKET_LEN>

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode

impl<const PACKET_LEN: usize> StrictEncode for SphinxPacket<PACKET_LEN>

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

impl<const PACKET_LEN: usize> Copy for SphinxPacket<PACKET_LEN>

impl<const PACKET_LEN: usize> Eq for SphinxPacket<PACKET_LEN>

impl<const PACKET_LEN: usize> StructuralEq for SphinxPacket<PACKET_LEN>

impl<const PACKET_LEN: usize> StructuralPartialEq for SphinxPacket<PACKET_LEN>