Lightning.Protocol.BOLT4.Construct

Contents

Description

Onion packet construction for BOLT4.

Synopsis

Types

Route information for a single hop.

Constructors

Hop
Fields hopPubKey :: !Projective node's public key hopPayload :: !HopPayload routing data for this hop

Instances details

Show Hop Source #
Instance details Defined in Lightning.Protocol.BOLT4.Construct Methods showsPrec :: Int -> Hop -> ShowS # show :: Hop -> String # showList :: [Hop] -> ShowS #
Eq Hop Source #
Instance details Defined in Lightning.Protocol.BOLT4.Construct Methods (==) :: Hop -> Hop -> Bool # (/=) :: Hop -> Hop -> Bool #

Errors during packet construction.

Constructors

Instances details

Show Error Source #
Instance details Defined in Lightning.Protocol.BOLT4.Construct Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Lightning.Protocol.BOLT4.Construct Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #

Packet construction

Arguments

:: ByteString	32-byte session key (random)
-> [Hop]	route (first hop to final destination)
-> ByteString	associated data
-> Either Error (OnionPacket, [SharedSecret])

Construct an onion packet for a payment route.

Takes a session key (32 bytes random), list of hops, and associated data (typically payment_hash).

Returns the onion packet and list of shared secrets (for error attribution).