Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrInvalidCircuitKeyLen signals that a circuit key could not be // decoded because the byte slice is of an invalid length. ErrInvalidCircuitKeyLen = fmt.Errorf("length of serialized circuit " + "key must be 16 bytes") )
Functions ¶
This section is empty.
Types ¶
type CircuitKey ¶
type CircuitKey struct {
// ChanID is the short chanid indicating the HTLC's origin.
//
// NOTE: It is fine for this value to be blank, as this indicates a
// locally-sourced payment.
ChanID lnwire.ShortChannelID
// HtlcID is the unique htlc index predominately assigned by links,
// though can also be assigned by switch in the case of locally-sourced
// payments.
HtlcID uint64
}
CircuitKey is used by a channel to uniquely identify the HTLCs it receives from the switch, and is used to purge our in-memory state of HTLCs that have already been processed by a link. Two list of CircuitKeys are included in each CommitDiff to allow a link to determine which in-memory htlcs directed the opening and closing of circuits in the switch's circuit map.
func (CircuitKey) Bytes ¶
func (k CircuitKey) Bytes() []byte
Bytes returns the serialized bytes for this circuit key.
func (*CircuitKey) Decode ¶
func (k *CircuitKey) Decode(r io.Reader) error
Decode reads a CircuitKey from the provided io.Reader.
func (*CircuitKey) Encode ¶
func (k *CircuitKey) Encode(w io.Writer) error
Encode writes a CircuitKey to the provided io.Writer.
func (*CircuitKey) SetBytes ¶
func (k *CircuitKey) SetBytes(bs []byte) error
SetBytes deserializes the given bytes into this CircuitKey.
func (CircuitKey) String ¶
func (k CircuitKey) String() string
String returns a string representation of the CircuitKey.
Source Files
Click to show internal directories.
Click to hide internal directories.