18914042383

Committed 29 Oct 2025 03:53PM UTC coverage: 54.594%. First build

Build # 18914042383

Build Type

Pull #10089

github

Committed by

web-flow

Commit Message

Merge 5a7e61d97 into e8a486fa6

Pull Request Pull Request #10089: Onion message forwarding

Run Details

93 of 590 new or added lines in 10 files covered. (15.76%)

110416 of 202249 relevant lines covered (54.59%)

21682.71 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.67

/record/hop.go

package record

import (
        "github.com/btcsuite/btcd/btcec/v2"
        "github.com/lightningnetwork/lnd/tlv"
)

const (
        // Onion Routing Packet types.

        // AmtOnionType is the type used in the onion to reference the amount to
        // send to the next hop.
        AmtOnionType tlv.Type = 2

        // LockTimeTLV is the type used in the onion to reference 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

        // EncryptedDataOnionType is the type used to include encrypted data
        // provided by the receiver in the onion for use in blinded paths.
        EncryptedDataOnionType tlv.Type = 10

        // BlindingPointOnionType is the type used to include receiver provided
        // ephemeral keys in the onion that are used in blinded paths.
        BlindingPointOnionType tlv.Type = 12

        // MetadataOnionType is the type used in the onion for the payment
        // metadata.
        MetadataOnionType tlv.Type = 16

        // TotalAmtMsatBlindedType is the type used in the onion for the total
        // amount field that is included in the final hop for blinded payments.
        TotalAmtMsatBlindedType tlv.Type = 18

        // Onion Message Packet types.

        // ReplyPathType is the type used in the onion message to indicate the
        // blinded path to be used for replies.
        ReplyPathType tlv.Type = 2

        // EncryptedRecipientDataType is the type used in the onion message to
        // include encrypted data in the onion for use in blinded paths.
        EncryptedRecipientDataType tlv.Type = 4

        // InvoiceRequestType is the type used in the onion message to include
        // invoice requests.
        InvoiceRequestType tlv.Type = 64

        // InvoiceType is the type used in the onion message to include
        // invoices.
        InvoiceType tlv.Type = 66

        // InvoiceErrorType is the type used in the onion message to include
        // invoice errors.
        InvoiceErrorType tlv.Type = 68
)

// NewAmtToFwdRecord creates a tlv.Record that encodes the amount_to_forward
// (type 2) for an onion payload.
func NewAmtToFwdRecord(amt *uint64) tlv.Record {
        return tlv.MakeDynamicRecord(
                AmtOnionType, amt, func() uint64 {
                        return tlv.SizeTUint64(*amt)
                },
                tlv.ETUint64, tlv.DTUint64,
        )
}

// NewLockTimeRecord creates a tlv.Record that encodes the outgoing_cltv_value
// (type 4) for an onion payload.
func NewLockTimeRecord(lockTime *uint32) tlv.Record {
        return tlv.MakeDynamicRecord(
                LockTimeOnionType, lockTime, func() uint64 {
                        return tlv.SizeTUint32(*lockTime)
                },
                tlv.ETUint32, tlv.DTUint32,
        )
}

// NewNextHopIDRecord creates a tlv.Record that encodes the short_channel_id
// (type 6) for an onion payload.
func NewNextHopIDRecord(cid *uint64) tlv.Record {
        return tlv.MakePrimitiveRecord(NextHopOnionType, cid)
}

// NewEncryptedDataRecord creates a tlv.Record that encodes the encrypted_data
// (type 10) record for an onion payload.
func NewEncryptedDataRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(EncryptedDataOnionType, data)
}

// NewEncryptedRecipientDataRecord creates a tlv.Record that encodes the
// encrypted_data (type 4) record for an onion message payload.
func NewEncryptedRecipientDataRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(EncryptedRecipientDataType, data)
}

// NewReplyPathRecord creates a tlv.Record that encodes the reply_path (type 2)
// record for an onion message payload.
func NewReplyPathRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(ReplyPathType, data)
}

// NewInvoiceRequestRecord creates a tlv.Record that encodes the
// invoice_request (type 64) record for an onion message payload.
func NewInvoiceRequestRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(InvoiceRequestType, data)
}

// NewInvoiceRecord creates a tlv.Record that encodes the
// invoice (type 66) record for an onion message payload.
func NewInvoiceRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(InvoiceType, data)
}

// NewInvoiceErrorRecord creates a tlv.Record that encodes the
// invoice_error (type 68) record for an onion message payload.
func NewInvoiceErrorRecord(data *[]byte) tlv.Record {
        return tlv.MakePrimitiveRecord(InvoiceErrorType, data)
}

// NewBlindingPointRecord creates a tlv.Record that encodes the blinding_point
// (type 12) record for an onion payload.
func NewBlindingPointRecord(point **btcec.PublicKey) tlv.Record {
        return tlv.MakePrimitiveRecord(BlindingPointOnionType, point)
}

// NewMetadataRecord creates a tlv.Record that encodes the metadata (type 10)
// for an onion payload.
func NewMetadataRecord(metadata *[]byte) tlv.Record {
        return tlv.MakeDynamicRecord(
                MetadataOnionType, metadata,
                func() uint64 {
                        return uint64(len(*metadata))
                },
                tlv.EVarBytes, tlv.DVarBytes,
        )
}

// NewTotalAmtMsatBlinded creates a tlv.Record that encodes the
// total_amount_msat for the final an onion payload within a blinded route.
func NewTotalAmtMsatBlinded(amt *uint64) tlv.Record {
        return tlv.MakeDynamicRecord(
                TotalAmtMsatBlindedType, amt, func() uint64 {
                        return tlv.SizeTUint64(*amt)
                },
                tlv.ETUint64, tlv.DTUint64,
        )
}

1	package record
2
3	import (
4	"github.com/btcsuite/btcd/btcec/v2"
5	"github.com/lightningnetwork/lnd/tlv"
6	)
7
8	const (
9	// Onion Routing Packet types.
10
11	// AmtOnionType is the type used in the onion to reference the amount to
12	// send to the next hop.
13	AmtOnionType tlv.Type = 2
14
15	// LockTimeTLV is the type used in the onion to reference the CLTV
16	// value that should be used for the next hop's HTLC.
17	LockTimeOnionType tlv.Type = 4
18
19	// NextHopOnionType is the type used in the onion to reference the ID
20	// of the next hop.
21	NextHopOnionType tlv.Type = 6
22
23	// EncryptedDataOnionType is the type used to include encrypted data
24	// provided by the receiver in the onion for use in blinded paths.
25	EncryptedDataOnionType tlv.Type = 10
26
27	// BlindingPointOnionType is the type used to include receiver provided
28	// ephemeral keys in the onion that are used in blinded paths.
29	BlindingPointOnionType tlv.Type = 12
30
31	// MetadataOnionType is the type used in the onion for the payment
32	// metadata.
33	MetadataOnionType tlv.Type = 16
34
35	// TotalAmtMsatBlindedType is the type used in the onion for the total
36	// amount field that is included in the final hop for blinded payments.
37	TotalAmtMsatBlindedType tlv.Type = 18
38
39	// Onion Message Packet types.
40
41	// ReplyPathType is the type used in the onion message to indicate the
42	// blinded path to be used for replies.
43	ReplyPathType tlv.Type = 2
44
45	// EncryptedRecipientDataType is the type used in the onion message to
46	// include encrypted data in the onion for use in blinded paths.
47	EncryptedRecipientDataType tlv.Type = 4
48
49	// InvoiceRequestType is the type used in the onion message to include
50	// invoice requests.
51	InvoiceRequestType tlv.Type = 64
52
53	// InvoiceType is the type used in the onion message to include
54	// invoices.
55	InvoiceType tlv.Type = 66
56
57	// InvoiceErrorType is the type used in the onion message to include
58	// invoice errors.
59	InvoiceErrorType tlv.Type = 68
60	)
61
62	// NewAmtToFwdRecord creates a tlv.Record that encodes the amount_to_forward
63	// (type 2) for an onion payload.
64	func NewAmtToFwdRecord(amt *uint64) tlv.Record {	869✔
65	return tlv.MakeDynamicRecord(	869✔
66	AmtOnionType, amt, func() uint64 {	1,160✔
67	return tlv.SizeTUint64(*amt)	291✔
68	},	291✔
69	tlv.ETUint64, tlv.DTUint64,
70	)
71	}
72
73	// NewLockTimeRecord creates a tlv.Record that encodes the outgoing_cltv_value
74	// (type 4) for an onion payload.
75	func NewLockTimeRecord(lockTime *uint32) tlv.Record {	869✔
76	return tlv.MakeDynamicRecord(	869✔
77	LockTimeOnionType, lockTime, func() uint64 {	1,160✔
78	return tlv.SizeTUint32(*lockTime)	291✔
79	},	291✔
80	tlv.ETUint32, tlv.DTUint32,
81	)
82	}
83
84	// NewNextHopIDRecord creates a tlv.Record that encodes the short_channel_id
85	// (type 6) for an onion payload.
86	func NewNextHopIDRecord(cid *uint64) tlv.Record {	611✔
87	return tlv.MakePrimitiveRecord(NextHopOnionType, cid)	611✔
88	}	611✔
89
90	// NewEncryptedDataRecord creates a tlv.Record that encodes the encrypted_data
91	// (type 10) record for an onion payload.
92	func NewEncryptedDataRecord(data *[]byte) tlv.Record {	591✔
93	return tlv.MakePrimitiveRecord(EncryptedDataOnionType, data)	591✔
94	}	591✔
95
96	// NewEncryptedRecipientDataRecord creates a tlv.Record that encodes the
97	// encrypted_data (type 4) record for an onion message payload.
NEW 98	func NewEncryptedRecipientDataRecord(data *[]byte) tlv.Record {	×
NEW 99	return tlv.MakePrimitiveRecord(EncryptedRecipientDataType, data)	×
NEW 100	}	×
101
102	// NewReplyPathRecord creates a tlv.Record that encodes the reply_path (type 2)
103	// record for an onion message payload.
NEW 104	func NewReplyPathRecord(data *[]byte) tlv.Record {	×
NEW 105	return tlv.MakePrimitiveRecord(ReplyPathType, data)	×
NEW 106	}	×
107
108	// NewInvoiceRequestRecord creates a tlv.Record that encodes the
109	// invoice_request (type 64) record for an onion message payload.
NEW 110	func NewInvoiceRequestRecord(data *[]byte) tlv.Record {	×
NEW 111	return tlv.MakePrimitiveRecord(InvoiceRequestType, data)	×
NEW 112	}	×
113
114	// NewInvoiceRecord creates a tlv.Record that encodes the
115	// invoice (type 66) record for an onion message payload.
NEW 116	func NewInvoiceRecord(data *[]byte) tlv.Record {	×
NEW 117	return tlv.MakePrimitiveRecord(InvoiceType, data)	×
NEW 118	}	×
119
120	// NewInvoiceErrorRecord creates a tlv.Record that encodes the
121	// invoice_error (type 68) record for an onion message payload.
NEW 122	func NewInvoiceErrorRecord(data *[]byte) tlv.Record {	×
NEW 123	return tlv.MakePrimitiveRecord(InvoiceErrorType, data)	×
NEW 124	}	×
125
126	// NewBlindingPointRecord creates a tlv.Record that encodes the blinding_point
127	// (type 12) record for an onion payload.
128	func NewBlindingPointRecord(point **btcec.PublicKey) tlv.Record {	580✔
129	return tlv.MakePrimitiveRecord(BlindingPointOnionType, point)	580✔
130	}	580✔
131
132	// NewMetadataRecord creates a tlv.Record that encodes the metadata (type 10)
133	// for an onion payload.
134	func NewMetadataRecord(metadata *[]byte) tlv.Record {	809✔
135	return tlv.MakeDynamicRecord(	809✔
136	MetadataOnionType, metadata,	809✔
137	func() uint64 {	978✔
138	return uint64(len(*metadata))	169✔
139	},	169✔
140	tlv.EVarBytes, tlv.DVarBytes,
141	)
142	}
143
144	// NewTotalAmtMsatBlinded creates a tlv.Record that encodes the
145	// total_amount_msat for the final an onion payload within a blinded route.
146	func NewTotalAmtMsatBlinded(amt *uint64) tlv.Record {	585✔
147	return tlv.MakeDynamicRecord(	585✔
148	TotalAmtMsatBlindedType, amt, func() uint64 {	596✔
149	return tlv.SizeTUint64(*amt)	11✔
150	},	11✔
151	tlv.ETUint64, tlv.DTUint64,
152	)
153	}

lightningnetwork / lnd / 18914042383

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous