Documentation
¶
Index ¶
- Constants
- func AMPDecoder(r io.Reader, val interface{}, buf *[8]byte, l uint64) error
- func AMPEncoder(w io.Writer, val interface{}, buf *[8]byte) error
- func MPPDecoder(r io.Reader, val interface{}, buf *[8]byte, l uint64) error
- func MPPEncoder(w io.Writer, val interface{}, buf *[8]byte) error
- func NewAmtToFwdRecord(amt *uint64) tlv.Record
- func NewLockTimeRecord(lockTime *uint32) tlv.Record
- func NewNextHopIDRecord(cid *uint64) tlv.Record
- type AMP
- type CustomSet
- type MPP
Constants ¶
const ( // AmtOnionType is the type used in the onion to refrence the amount to // send to the next hop. AmtOnionType tlv.Type = 2 // LockTimeTLV is the type used in the onion to refenernce the CLTV // value that should be used for the next hop's HTLC. LockTimeOnionType tlv.Type = 4 // NextHopOnionType is the type used in the onion to reference the ID // of the next hop. NextHopOnionType tlv.Type = 6 )
const AMPOnionType tlv.Type = 14
AMPOnionType is the type used in the onion to reference the AMP fields: root_share, set_id, and child_index.
const ( // CustomTypeStart is the start of the custom tlv type range as defined // in BOLT 01. CustomTypeStart = 65536 )
const ( // KeySendType is the custom record identifier for keysend preimages. KeySendType uint64 = 5482373484 )
const MPPOnionType tlv.Type = 8
MPPOnionType is the type used in the onion to reference the MPP fields: total_amt and payment_addr.
Variables ¶
This section is empty.
Functions ¶
func AMPDecoder ¶ added in v0.3.0
AMPDecoder reads the AMP record from the provided io.Reader.
func AMPEncoder ¶ added in v0.3.0
AMPEncoder writes the AMP record to the provided io.Writer.
func MPPDecoder ¶ added in v0.3.0
MPPDecoder reads the MPP record to the provided io.Reader.
func MPPEncoder ¶ added in v0.3.0
MPPEncoder writes the MPP record to the provided io.Writer.
func NewAmtToFwdRecord ¶
NewAmtToFwdRecord creates a tlv.Record that encodes the amount_to_forward (type 2) for an onion payload.
func NewLockTimeRecord ¶
NewLockTimeRecord creates a tlv.Record that encodes the outgoing_cltv_value (type 4) for an onion payload.
func NewNextHopIDRecord ¶
NewNextHopIDRecord creates a tlv.Record that encodes the short_channel_id (type 6) for an onion payload.
Types ¶
type AMP ¶ added in v0.3.0
type AMP struct {
// contains filtered or unexported fields
}
AMP is a record that encodes the fields necessary for atomic multi-path payments.
func NewAMP ¶ added in v0.3.0
NewAMP generate a new AMP record with the given root_share, set_id, and child_index.
func (*AMP) ChildIndex ¶ added in v0.3.0
ChildIndex returns the child index contained in the AMP record.
func (*AMP) PayloadSize ¶ added in v0.3.0
PayloadSize returns the size this record takes up in encoded form.
func (*AMP) Record ¶ added in v0.3.0
Record returns a tlv.Record that can be used to encode or decode this record.
func (*AMP) RootShare ¶ added in v0.3.0
RootShare returns the root share contained in the AMP record.
type MPP ¶ added in v0.3.0
type MPP struct {
// contains filtered or unexported fields
}
MPP is a record that encodes the fields necessary for multi-path payments.
func NewMPP ¶ added in v0.3.0
NewMPP generates a new MPP record with the given total and payment address.
func (*MPP) PayloadSize ¶ added in v0.3.0
PayloadSize returns the size this record takes up in encoded form.
func (*MPP) PaymentAddr ¶ added in v0.3.0
PaymentAddr returns the payment address contained in the MPP record.
func (*MPP) Record ¶ added in v0.3.0
Record returns a tlv.Record that can be used to encode or decode this record.
func (*MPP) String ¶ added in v0.3.0
String returns a human-readable representation of the mpp payload field.
func (*MPP) TotalMAtoms ¶ added in v0.3.0
TotalMAtoms returns the total value of an MPP payment in matoms.
Source Files