Struct TlcErrPacket 

pub struct TlcErrPacket {
    pub onion_packet: Vec<u8>,
}

An encrypted error packet for TLC failures. The sender should decode it and then decide what to do with the error. Note: this is supposed to be only accessible by the sender, and it’s not reliable since it is not placed on-chain due to the possibility of hop failure.

Fields

onion_packet: Vec<u8>

Implementations

impl TlcErrPacket

pub fn from_payload(payload: Vec<u8>, shared_secret: &[u8; 32]) -> Self

Create a new TlcErrPacket from raw payload bytes. Erring node creates the error packet using the shared secret used in forwarding onion packet. Use all zeros (NO_SHARED_SECRET) for the origin node.

pub fn is_plaintext(&self) -> bool

Check if this packet is plaintext (not encrypted).

pub fn backward(self, shared_secret: &[u8; 32]) -> Self

Intermediate node backwards the error to the previous hop using the shared secret used in forwarding the onion packet.

impl TlcErrPacket

pub fn new(tlc_fail: TlcErr, shared_secret: &[u8; 32]) -> Self

Erring node creates the error packet using the shared secret used in forwarding onion packet. Use all zeros for the origin node. Takes a structured TlcErr and serializes it.

pub fn decode( &self, session_key: &[u8; 32], hops_public_keys: Vec<Pubkey>, ) -> Option<TlcErr>

Decode the onion error packet using the session key and hop public keys.

Trait Implementations

impl Clone for TlcErrPacket

fn clone(&self) -> TlcErrPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TlcErrPacket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TlcErrPacket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TlcErrPacket

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

Formats the value using the given formatter.

impl From<TlcErrPacket> for TlcErrPacket

fn from(tlc_err_packet: TlcErrPacket) -> Self

Converts to this type from the input type.

impl From<TlcErrPacket> for TlcErrPacket

fn from(tlc_err_packet: TlcErrPacket) -> Self

Converts to this type from the input type.

impl Hash for TlcErrPacket

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 TlcErrPacket

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

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 TlcErrPacket

impl StructuralPartialEq for TlcErrPacket