sphinx

package module

Go to main page

Versions in this module

v1

v1.3.0

Feb 4, 2026

Changes in this version

+ const MaxOnionMessagePayloadSize

+ const MaxRoutingPayloadSize

+ var ErrIOReadFull = errors.New("io read full error")

+ var ErrMissingHMAC = errors.New("onion packet is too small, missing HMAC")

+ var ErrNegativePayloadSize = errors.New(...)

+ var ErrNegativeRoutingInfoSize = errors.New(...)

+ var ErrPayloadSizeExceeded = errors.New("max payload size exceeded")

+ var ErrSharedSecretDerivation = errors.New("error generating shared secret")

+ var ErrZeroHops = errors.New("route of length zero passed in")

+ func NextEphemeral(privKey SingleKeyECDH, ephemPub *btcec.PublicKey) (*btcec.PublicKey, error)

+ func NextEphemeralPriv(ephemPriv *PrivKeyECDH, pubKey *btcec.PublicKey) (*btcec.PrivateKey, error)

+ type BlindedHopInfo struct

+ BlindedNodePub *btcec.PublicKey

+ CipherText []byte

+ type BlindedPath struct

+ BlindedHops []*BlindedHopInfo

+ BlindingPoint *btcec.PublicKey

+ IntroductionPoint *btcec.PublicKey

+ type BlindedPathInfo struct

+ LastEphemeralKey *btcec.PublicKey

+ Path *BlindedPath

+ SessionKey *btcec.PrivateKey

+ func BuildBlindedPath(sessionKey *btcec.PrivateKey, paymentPath []*HopInfo) (*BlindedPathInfo, error)

+ type HopInfo struct

+ NodePub *btcec.PublicKey

+ PlainText []byte

+ func (i *HopInfo) Encrypt(sharedSecret Hash256) (*BlindedHopInfo, error)

type HopPayload

+ func DecodeHopPayload(r io.Reader, tlvGuaranteed bool) (*HopPayload, error)

+ func NewLegacyHopPayload(hopData *HopData) (HopPayload, error)

+ func NewTLVHopPayload(payload []byte) (HopPayload, error)

+ type NewOnionPacketOpt func(cfg *newOnionPacketCfg)

+ func WithMaxPayloadSize(size int) NewOnionPacketOpt

+ type NoOpReplayLog struct

+ func NewNoOpReplayLog() *NoOpReplayLog

+ func (NoOpReplayLog) Delete(*HashPrefix) error

+ func (NoOpReplayLog) Get(*HashPrefix) (uint32, error)

+ func (NoOpReplayLog) Put(*HashPrefix, uint32) error

+ func (NoOpReplayLog) PutBatch(batch *Batch) (*ReplaySet, error)

+ func (NoOpReplayLog) Start() error

+ func (NoOpReplayLog) Stop() error

+ type ProcessOnionOpt func(cfg *processOnionCfg)

+ func WithBlindingPoint(point *btcec.PublicKey) ProcessOnionOpt

+ func WithTLVPayloadOnly() ProcessOnionOpt

type Router

+ func (r *Router) DecryptBlindedHopData(ephemPub *btcec.PublicKey, encryptedData []byte) ([]byte, error)

+ func (r *Router) NextEphemeral(ephemPub *btcec.PublicKey) (*btcec.PublicKey, error)

+ func (r *Router) OnionPublicKey() *btcec.PublicKey

v1.2.0

Feb 11, 2022

Changes in this version

+ type PrivKeyECDH struct

+ PrivKey *btcec.PrivateKey

+ func (p *PrivKeyECDH) ECDH(pub *btcec.PublicKey) ([32]byte, error)

+ func (p *PrivKeyECDH) PubKey() *btcec.PublicKey

+ type SingleKeyECDH interface

+ ECDH func(pubKey *btcec.PublicKey) ([32]byte, error)

+ PubKey func() *btcec.PublicKey

v1.0.1

Jan 7, 2020

Changes in this version

+ func BlankPacketFiller(_ *btcec.PrivateKey, _ *[routingInfoSize]byte) error

+ func DeterministicPacketFiller(sessionKey *btcec.PrivateKey, mixHeader *[routingInfoSize]byte) error

+ func RandPacketFiller(_ *btcec.PrivateKey, mixHeader *[routingInfoSize]byte) error

+ type PacketFiller func(*btcec.PrivateKey, *[routingInfoSize]byte) error

v1.0.0

Dec 14, 2019

Changes in this version

+ const AddressSize

+ const AmtForwardSize

+ const ExitNode

+ const Failure

+ const HMACSize

+ const HashPrefixSize

+ const LegacyHopDataSize

+ const MaxPayloadSize

+ const MoreHops

+ const NumMaxHops

+ const NumPaddingBytes

+ const OutgoingCLTVSize

+ const RealmByteSize

+ var ErrAlreadyCommitted = errors.New("cannot add to batch after committing")

+ var ErrInvalidOnionHMAC = fmt.Errorf("invalid mismatched mac")

+ var ErrInvalidOnionKey = fmt.Errorf(...)

+ var ErrInvalidOnionVersion = fmt.Errorf("invalid onion packet version")

+ var ErrLogEntryNotFound = fmt.Errorf("sphinx packet is not in log")

+ var ErrMaxRoutingInfoSizeExceeded = fmt.Errorf("max routing info size of %v bytes exceeded", routingInfoSize)

+ var ErrReplayedPacket = fmt.Errorf("sphinx packet replay attempted")

+ var ErrVarIntNotCanonical = errors.New("decoded varint is not canonical")

+ func DisableLog()

+ func ReadVarInt(r io.Reader, buf *[8]byte) (uint64, error)

+ func UseLogger(logger btclog.Logger)

+ func WriteVarInt(w io.Writer, val uint64, buf *[8]byte) error

+ type Batch struct

+ ID []byte

+ IsCommitted bool

+ ReplaySet *ReplaySet

+ func NewBatch(id []byte) *Batch

+ func (b *Batch) ForEach(fn func(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error) error

+ func (b *Batch) Put(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error

+ type Circuit struct

+ PaymentPath []*btcec.PublicKey

+ SessionKey *btcec.PrivateKey

+ func (c *Circuit) Decode(r io.Reader) error

+ func (c *Circuit) Encode(w io.Writer) error

+ type DecryptedError struct

+ Message []byte

+ Sender *btcec.PublicKey

+ SenderIdx int

+ type Hash256 [sha256.Size]byte

+ type HashPrefix [HashPrefixSize]byte

+ type HopData struct

+ ExtraBytes [NumPaddingBytes]byte

+ ForwardAmount uint64

+ NextAddress [AddressSize]byte

+ OutgoingCltv uint32

+ Realm [RealmByteSize]byte

+ func (hd *HopData) Decode(r io.Reader) error

+ func (hd *HopData) Encode(w io.Writer) error

+ type HopPayload struct

+ HMAC [HMACSize]byte

+ Payload []byte

+ Type PayloadType

+ func NewHopPayload(hopData *HopData, eob []byte) (HopPayload, error)

+ func (hp *HopPayload) Decode(r io.Reader) error

+ func (hp *HopPayload) Encode(w io.Writer) error

+ func (hp *HopPayload) HopData() (*HopData, error)

+ func (hp *HopPayload) NumBytes() int

+ type MemoryReplayLog struct

+ func NewMemoryReplayLog() *MemoryReplayLog

+ func (rl *MemoryReplayLog) Delete(hash *HashPrefix) error

+ func (rl *MemoryReplayLog) Get(hash *HashPrefix) (uint32, error)

+ func (rl *MemoryReplayLog) Put(hash *HashPrefix, cltv uint32) error

+ func (rl *MemoryReplayLog) PutBatch(batch *Batch) (*ReplaySet, error)

+ func (rl *MemoryReplayLog) Start() error

+ func (rl *MemoryReplayLog) Stop() error

+ type OnionErrorDecrypter struct

+ func NewOnionErrorDecrypter(circuit *Circuit) *OnionErrorDecrypter

+ func (o *OnionErrorDecrypter) DecryptError(encryptedData []byte) (*DecryptedError, error)

+ type OnionErrorEncrypter struct

+ func NewOnionErrorEncrypter(router *Router, ephemeralKey *btcec.PublicKey) (*OnionErrorEncrypter, error)

+ func (o *OnionErrorEncrypter) Decode(r io.Reader) error

+ func (o *OnionErrorEncrypter) Encode(w io.Writer) error

+ func (o *OnionErrorEncrypter) EncryptError(initial bool, data []byte) []byte

+ type OnionHop struct

+ HopPayload HopPayload

+ NodePub btcec.PublicKey

+ func (o OnionHop) IsEmpty() bool

+ type OnionPacket struct

+ EphemeralKey *btcec.PublicKey

+ HeaderMAC [HMACSize]byte

+ RoutingInfo [routingInfoSize]byte

+ Version byte

+ func NewOnionPacket(paymentPath *PaymentPath, sessionKey *btcec.PrivateKey, assocData []byte) (*OnionPacket, error)

+ func (f *OnionPacket) Decode(r io.Reader) error

+ func (f *OnionPacket) Encode(w io.Writer) error

+ type PayloadType uint8

+ const PayloadLegacy

+ const PayloadTLV

+ type PaymentPath [NumMaxHops]OnionHop

+ func (p *PaymentPath) NodeKeys() []*btcec.PublicKey

+ func (p *PaymentPath) TotalPayloadSize() int

+ func (p *PaymentPath) TrueRouteLength() int

+ type ProcessCode int

+ func (p ProcessCode) String() string

+ type ProcessedPacket struct

+ Action ProcessCode

+ ForwardingInstructions *HopData

+ NextPacket *OnionPacket

+ Payload HopPayload

+ type ReplayLog interface

+ Delete func(*HashPrefix) error

+ Get func(*HashPrefix) (uint32, error)

+ Put func(*HashPrefix, uint32) error

+ PutBatch func(*Batch) (*ReplaySet, error)

+ Start func() error

+ Stop func() error

+ type ReplaySet struct

+ func NewReplaySet() *ReplaySet

+ func (rs *ReplaySet) Add(idx uint16)

+ func (rs *ReplaySet) Contains(idx uint16) bool

+ func (rs *ReplaySet) Decode(r io.Reader) error

+ func (rs *ReplaySet) Encode(w io.Writer) error

+ func (rs *ReplaySet) Merge(rs2 *ReplaySet)

+ func (rs *ReplaySet) Size() int

+ type Router struct

+ func NewRouter(nodeKey *btcec.PrivateKey, net *chaincfg.Params, log ReplayLog) *Router

+ func (r *Router) BeginTxn(id []byte, nels int) *Tx

+ func (r *Router) ProcessOnionPacket(onionPkt *OnionPacket, assocData []byte, incomingCltv uint32) (*ProcessedPacket, error)

+ func (r *Router) ReconstructOnionPacket(onionPkt *OnionPacket, assocData []byte) (*ProcessedPacket, error)

+ func (r *Router) Start() error

+ func (r *Router) Stop()

+ type Tx struct

+ func (t *Tx) Commit() ([]ProcessedPacket, *ReplaySet, error)

+ func (t *Tx) ProcessOnionPacket(seqNum uint16, onionPkt *OnionPacket, assocData []byte, incomingCltv uint32) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL