Struct MetaPacket

pub struct MetaPacket<S, H, const P: usize> { /* private fields */ }

An encrypted packet with a payload of size P. The final packet size is given by MetaPacket::SIZE.

A sender can create a new packet via MetaPacket::new and send it. Once received by the recipient, it is parsed first by calling MetaPacket::try_from and then it can be transformed into ForwardedMetaPacket by calling the MetaPacket::into_forwarded method. The ForwardedMetaPacket then contains the information about the next recipient of this packet or the payload for the final destination.

The packet format is directly dependent on the used SphinxSuite.

Implementations

impl<S: SphinxSuite, H: SphinxHeaderSpec, const P: usize> MetaPacket<S, H, P>

pub const PACKET_LEN: usize

The fixed length of the padded packet.

pub fn new<M: KeyIdMapper<S, H>>( payload: PaddedPayload<P>, routing: MetaPacketRouting<'_, S, H>, key_mapper: &M, ) -> Result<Self, SphinxError>

Creates a new outgoing packet with the given payload msg and routing.

The size of the msg must be less or equal P, otherwise the constructor will return an error.

pub fn into_forwarded<K, F>( self, node_keypair: &S::P, key_mapper: &K, reply_openers: F, ) -> Result<ForwardedMetaPacket<S, H, P>, SphinxError>

where K: KeyIdMapper<S, H>, F: FnMut(&H::PacketReceiverData) -> Option<ReplyOpener>,

Attempts to remove the layer of encryption in this packet by using the given node_keypair. This will transform this packet into the ForwardedMetaPacket.

Trait Implementations

impl<S: SphinxSuite, H: SphinxHeaderSpec, const P: usize> AsRef<[u8]> for MetaPacket<S, H, P>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: SphinxSuite, H: SphinxHeaderSpec, const P: usize> BytesRepresentable for MetaPacket<S, H, P>

const SIZE: usize

Size of the encoded byte array.

fn into_boxed(self) -> Box<[u8]>

Convenience function to copy this type’s binary representation into a Box.

impl<S, H, const P: usize> Clone for MetaPacket<S, H, P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: SphinxSuite, H: SphinxHeaderSpec, const P: usize> Debug for MetaPacket<S, H, P>

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

Formats the value using the given formatter.

impl<S: SphinxSuite, H: SphinxHeaderSpec, const P: usize> TryFrom<&[u8]> for MetaPacket<S, H, P>

type Error = GeneralError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.