13035292482

Committed 29 Jan 2025 03:59PM UTC coverage: 49.3% (-9.5%) from 58.777%

Build # 13035292482

Build Type

Pull #9456

github

Committed by

mohamedawnallah

Commit Message

docs: update release-notes-0.19.0.md

In this commit, we warn users about the removal
of RPCs `SendToRoute`, `SendToRouteSync`, `SendPayment`,
and `SendPaymentSync` in the next release 0.20.

Pull Request Pull Request #9456: lnrpc+docs: deprecate warning `SendToRoute`, `SendToRouteSync`, `SendPayment`, and `SendPaymentSync` in Release 0.19

Run Details

100634 of 204126 relevant lines covered (49.3%)

1.54 hits per line

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

81.13

/lnwire/custom_records.go

package lnwire

import (
        "bytes"
        "fmt"
        "io"
        "sort"

        "github.com/lightningnetwork/lnd/fn/v2"
        "github.com/lightningnetwork/lnd/tlv"
)

const (
        // MinCustomRecordsTlvType is the minimum custom records TLV type as
        // defined in BOLT 01.
        MinCustomRecordsTlvType = 65536
)

// CustomRecords stores a set of custom key/value pairs. Map keys are TLV types
// which must be greater than or equal to MinCustomRecordsTlvType.
type CustomRecords map[uint64][]byte

// NewCustomRecords creates a new CustomRecords instance from a
// tlv.TypeMap.
func NewCustomRecords(tlvMap tlv.TypeMap) (CustomRecords, error) {
        // Make comparisons in unit tests easy by returning nil if the map is
        // empty.
        if len(tlvMap) == 0 {
                return nil, nil
        }

        customRecords := make(CustomRecords, len(tlvMap))
        for k, v := range tlvMap {
                customRecords[uint64(k)] = v
        }

        // Validate the custom records.
        err := customRecords.Validate()
        if err != nil {
                return nil, fmt.Errorf("custom records from tlv map "+
                        "validation error: %w", err)
        }

        return customRecords, nil
}

// ParseCustomRecords creates a new CustomRecords instance from a tlv.Blob.
func ParseCustomRecords(b tlv.Blob) (CustomRecords, error) {
        return ParseCustomRecordsFrom(bytes.NewReader(b))
}

// ParseCustomRecordsFrom creates a new CustomRecords instance from a reader.
func ParseCustomRecordsFrom(r io.Reader) (CustomRecords, error) {
        typeMap, err := DecodeRecords(r)
        if err != nil {
                return nil, fmt.Errorf("error decoding HTLC record: %w", err)
        }

        return NewCustomRecords(typeMap)
}

// Validate checks that all custom records are in the custom type range.
func (c CustomRecords) Validate() error {
        if c == nil {
                return nil
        }

        for key := range c {
                if key < MinCustomRecordsTlvType {
                        return fmt.Errorf("custom records entry with TLV "+
                                "type below min: %d", MinCustomRecordsTlvType)
                }
        }

        return nil
}

// Copy returns a copy of the custom records.
func (c CustomRecords) Copy() CustomRecords {
        if c == nil {
                return nil
        }

        customRecords := make(CustomRecords, len(c))
        for k, v := range c {
                customRecords[k] = v
        }

        return customRecords
}

// MergedCopy creates a copy of the records and merges them with the given
// records. If the same key is present in both sets, the value from the other
// records will be used.
func (c CustomRecords) MergedCopy(other CustomRecords) CustomRecords {
        copiedRecords := make(CustomRecords, len(c))
        for k, v := range c {
                copiedRecords[k] = v
        }

        for k, v := range other {
                copiedRecords[k] = v
        }

        return copiedRecords
}

// ExtendRecordProducers extends the given records slice with the custom
// records. The resultant records slice will be sorted if the given records
// slice contains TLV types greater than or equal to MinCustomRecordsTlvType.
func (c CustomRecords) ExtendRecordProducers(
        producers []tlv.RecordProducer) ([]tlv.RecordProducer, error) {

        // If the custom records are nil or empty, there is nothing to do.
        if len(c) == 0 {
                return producers, nil
        }

        // Validate the custom records.
        err := c.Validate()
        if err != nil {
                return nil, err
        }

        // Ensure that the existing records slice TLV types are not also present
        // in the custom records. If they are, the resultant extended records
        // slice would erroneously contain duplicate TLV types.
        for _, rp := range producers {
                record := rp.Record()
                recordTlvType := uint64(record.Type())

                _, foundDuplicateTlvType := c[recordTlvType]
                if foundDuplicateTlvType {
                        return nil, fmt.Errorf("custom records contains a TLV "+
                                "type that is already present in the "+
                                "existing records: %d", recordTlvType)
                }
        }

        // Convert the custom records map to a TLV record producer slice and
        // append them to the exiting records slice.
        customRecordProducers := RecordsAsProducers(tlv.MapToRecords(c))
        producers = append(producers, customRecordProducers...)

        // If the records slice which was given as an argument included TLV
        // values greater than or equal to the minimum custom records TLV type
        // we will sort the extended records slice to ensure that it is ordered
        // correctly.
        SortProducers(producers)

        return producers, nil
}

// RecordProducers returns a slice of record producers for the custom records.
func (c CustomRecords) RecordProducers() []tlv.RecordProducer {
        // If the custom records are nil or empty, return an empty slice.
        if len(c) == 0 {
                return nil
        }

        // Convert the custom records map to a TLV record producer slice.
        records := tlv.MapToRecords(c)

        return RecordsAsProducers(records)
}

// Serialize serializes the custom records into a byte slice.
func (c CustomRecords) Serialize() ([]byte, error) {
        records := tlv.MapToRecords(c)
        return EncodeRecords(records)
}

// SerializeTo serializes the custom records into the given writer.
func (c CustomRecords) SerializeTo(w io.Writer) error {
        records := tlv.MapToRecords(c)
        return EncodeRecordsTo(w, records)
}

// ProduceRecordsSorted converts a slice of record producers into a slice of
// records and then sorts it by type.
func ProduceRecordsSorted(recordProducers ...tlv.RecordProducer) []tlv.Record {
        records := fn.Map(
                recordProducers,
                func(producer tlv.RecordProducer) tlv.Record {
                        return producer.Record()
                },
        )

        // Ensure that the set of records are sorted before we attempt to
        // decode from the stream, to ensure they're canonical.
        tlv.SortRecords(records)

        return records
}

// SortProducers sorts the given record producers by their type.
func SortProducers(producers []tlv.RecordProducer) {
        sort.Slice(producers, func(i, j int) bool {
                recordI := producers[i].Record()
                recordJ := producers[j].Record()
                return recordI.Type() < recordJ.Type()
        })
}

// TlvMapToRecords converts a TLV map into a slice of records.
func TlvMapToRecords(tlvMap tlv.TypeMap) []tlv.Record {
        tlvMapGeneric := make(map[uint64][]byte)
        for k, v := range tlvMap {
                tlvMapGeneric[uint64(k)] = v
        }

        return tlv.MapToRecords(tlvMapGeneric)
}

// RecordsAsProducers converts a slice of records into a slice of record
// producers.
func RecordsAsProducers(records []tlv.Record) []tlv.RecordProducer {
        return fn.Map(records, func(record tlv.Record) tlv.RecordProducer {
                return &record
        })
}

// EncodeRecords encodes the given records into a byte slice.
func EncodeRecords(records []tlv.Record) ([]byte, error) {
        var buf bytes.Buffer
        if err := EncodeRecordsTo(&buf, records); err != nil {
                return nil, err
        }

        return buf.Bytes(), nil
}

// EncodeRecordsTo encodes the given records into the given writer.
func EncodeRecordsTo(w io.Writer, records []tlv.Record) error {
        tlvStream, err := tlv.NewStream(records...)
        if err != nil {
                return err
        }

        return tlvStream.Encode(w)
}

// DecodeRecords decodes the given byte slice into the given records and returns
// the rest as a TLV type map.
func DecodeRecords(r io.Reader,
        records ...tlv.Record) (tlv.TypeMap, error) {

        tlvStream, err := tlv.NewStream(records...)
        if err != nil {
                return nil, err
        }

        return tlvStream.DecodeWithParsedTypes(r)
}

// DecodeRecordsP2P decodes the given byte slice into the given records and
// returns the rest as a TLV type map. This function is identical to
// DecodeRecords except that the record size is capped at 65535.
func DecodeRecordsP2P(r *bytes.Reader,
        records ...tlv.Record) (tlv.TypeMap, error) {

        tlvStream, err := tlv.NewStream(records...)
        if err != nil {
                return nil, err
        }

        return tlvStream.DecodeWithParsedTypesP2P(r)
}

// AssertUniqueTypes asserts that the given records have unique types.
func AssertUniqueTypes(r []tlv.Record) error {
        seen := make(fn.Set[tlv.Type], len(r))
        for _, record := range r {
                t := record.Type()
                if seen.Contains(t) {
                        return fmt.Errorf("duplicate record type: %d", t)
                }
                seen.Add(t)
        }

        return nil
}

1	package lnwire
2
3	import (
4	"bytes"
5	"fmt"
6	"io"
7	"sort"
8
9	"github.com/lightningnetwork/lnd/fn/v2"
10	"github.com/lightningnetwork/lnd/tlv"
11	)
12
13	const (
14	// MinCustomRecordsTlvType is the minimum custom records TLV type as
15	// defined in BOLT 01.
16	MinCustomRecordsTlvType = 65536
17	)
18
19	// CustomRecords stores a set of custom key/value pairs. Map keys are TLV types
20	// which must be greater than or equal to MinCustomRecordsTlvType.
21	type CustomRecords map[uint64][]byte
22
23	// NewCustomRecords creates a new CustomRecords instance from a
24	// tlv.TypeMap.
25	func NewCustomRecords(tlvMap tlv.TypeMap) (CustomRecords, error) {	3✔
26	// Make comparisons in unit tests easy by returning nil if the map is	3✔
27	// empty.	3✔
28	if len(tlvMap) == 0 {	6✔
29	return nil, nil	3✔
30	}	3✔
31
32	customRecords := make(CustomRecords, len(tlvMap))	3✔
33	for k, v := range tlvMap {	6✔
34	customRecords[uint64(k)] = v	3✔
35	}	3✔
36
37	// Validate the custom records.
38	err := customRecords.Validate()	3✔
39	if err != nil {	3✔
40	return nil, fmt.Errorf("custom records from tlv map "+	×
41	"validation error: %w", err)	×
42	}	×
43
44	return customRecords, nil	3✔
45	}
46
47	// ParseCustomRecords creates a new CustomRecords instance from a tlv.Blob.
48	func ParseCustomRecords(b tlv.Blob) (CustomRecords, error) {	3✔
49	return ParseCustomRecordsFrom(bytes.NewReader(b))	3✔
50	}	3✔
51
52	// ParseCustomRecordsFrom creates a new CustomRecords instance from a reader.
53	func ParseCustomRecordsFrom(r io.Reader) (CustomRecords, error) {	3✔
54	typeMap, err := DecodeRecords(r)	3✔
55	if err != nil {	3✔
56	return nil, fmt.Errorf("error decoding HTLC record: %w", err)	×
57	}	×
58
59	return NewCustomRecords(typeMap)	3✔
60	}
61
62	// Validate checks that all custom records are in the custom type range.
63	func (c CustomRecords) Validate() error {	3✔
64	if c == nil {	6✔
65	return nil	3✔
66	}	3✔
67
68	for key := range c {	6✔
69	if key < MinCustomRecordsTlvType {	3✔
70	return fmt.Errorf("custom records entry with TLV "+	×
71	"type below min: %d", MinCustomRecordsTlvType)	×
72	}	×
73	}
74
75	return nil	3✔
76	}
77
78	// Copy returns a copy of the custom records.
79	func (c CustomRecords) Copy() CustomRecords {	3✔
80	if c == nil {	6✔
81	return nil	3✔
82	}	3✔
83
84	customRecords := make(CustomRecords, len(c))	3✔
85	for k, v := range c {	6✔
86	customRecords[k] = v	3✔
87	}	3✔
88
89	return customRecords	3✔
90	}
91
92	// MergedCopy creates a copy of the records and merges them with the given
93	// records. If the same key is present in both sets, the value from the other
94	// records will be used.
95	func (c CustomRecords) MergedCopy(other CustomRecords) CustomRecords {	3✔
96	copiedRecords := make(CustomRecords, len(c))	3✔
97	for k, v := range c {	6✔
98	copiedRecords[k] = v	3✔
99	}	3✔
100
101	for k, v := range other {	6✔
102	copiedRecords[k] = v	3✔
103	}	3✔
104
105	return copiedRecords	3✔
106	}
107
108	// ExtendRecordProducers extends the given records slice with the custom
109	// records. The resultant records slice will be sorted if the given records
110	// slice contains TLV types greater than or equal to MinCustomRecordsTlvType.
111	func (c CustomRecords) ExtendRecordProducers(
112	producers []tlv.RecordProducer) ([]tlv.RecordProducer, error) {	3✔
113		3✔
114	// If the custom records are nil or empty, there is nothing to do.	3✔
115	if len(c) == 0 {	6✔
116	return producers, nil	3✔
117	}	3✔
118
119	// Validate the custom records.
120	err := c.Validate()	3✔
121	if err != nil {	3✔
122	return nil, err	×
123	}	×
124
125	// Ensure that the existing records slice TLV types are not also present
126	// in the custom records. If they are, the resultant extended records
127	// slice would erroneously contain duplicate TLV types.
128	for _, rp := range producers {	6✔
129	record := rp.Record()	3✔
130	recordTlvType := uint64(record.Type())	3✔
131		3✔
132	_, foundDuplicateTlvType := c[recordTlvType]	3✔
133	if foundDuplicateTlvType {	3✔
134	return nil, fmt.Errorf("custom records contains a TLV "+	×
135	"type that is already present in the "+	×
136	"existing records: %d", recordTlvType)	×
137	}	×
138	}
139
140	// Convert the custom records map to a TLV record producer slice and
141	// append them to the exiting records slice.
142	customRecordProducers := RecordsAsProducers(tlv.MapToRecords(c))	3✔
143	producers = append(producers, customRecordProducers...)	3✔
144		3✔
145	// If the records slice which was given as an argument included TLV	3✔
146	// values greater than or equal to the minimum custom records TLV type	3✔
147	// we will sort the extended records slice to ensure that it is ordered	3✔
148	// correctly.	3✔
149	SortProducers(producers)	3✔
150		3✔
151	return producers, nil	3✔
152	}
153
154	// RecordProducers returns a slice of record producers for the custom records.
155	func (c CustomRecords) RecordProducers() []tlv.RecordProducer {	3✔
156	// If the custom records are nil or empty, return an empty slice.	3✔
157	if len(c) == 0 {	6✔
158	return nil	3✔
159	}	3✔
160
161	// Convert the custom records map to a TLV record producer slice.
162	records := tlv.MapToRecords(c)	3✔
163		3✔
164	return RecordsAsProducers(records)	3✔
165	}
166
167	// Serialize serializes the custom records into a byte slice.
168	func (c CustomRecords) Serialize() ([]byte, error) {	3✔
169	records := tlv.MapToRecords(c)	3✔
170	return EncodeRecords(records)	3✔
171	}	3✔
172
173	// SerializeTo serializes the custom records into the given writer.
174	func (c CustomRecords) SerializeTo(w io.Writer) error {	3✔
175	records := tlv.MapToRecords(c)	3✔
176	return EncodeRecordsTo(w, records)	3✔
177	}	3✔
178
179	// ProduceRecordsSorted converts a slice of record producers into a slice of
180	// records and then sorts it by type.
181	func ProduceRecordsSorted(recordProducers ...tlv.RecordProducer) []tlv.Record {	3✔
182	records := fn.Map(	3✔
183	recordProducers,	3✔
184	func(producer tlv.RecordProducer) tlv.Record {	6✔
185	return producer.Record()	3✔
186	},	3✔
187	)
188
189	// Ensure that the set of records are sorted before we attempt to
190	// decode from the stream, to ensure they're canonical.
191	tlv.SortRecords(records)	3✔
192		3✔
193	return records	3✔
194	}
195
196	// SortProducers sorts the given record producers by their type.
197	func SortProducers(producers []tlv.RecordProducer) {	3✔
198	sort.Slice(producers, func(i, j int) bool {	6✔
199	recordI := producers[i].Record()	3✔
200	recordJ := producers[j].Record()	3✔
201	return recordI.Type() < recordJ.Type()	3✔
202	})	3✔
203	}
204
205	// TlvMapToRecords converts a TLV map into a slice of records.
206	func TlvMapToRecords(tlvMap tlv.TypeMap) []tlv.Record {	×
207	tlvMapGeneric := make(map[uint64][]byte)	×
208	for k, v := range tlvMap {	×
209	tlvMapGeneric[uint64(k)] = v	×
210	}	×
211
212	return tlv.MapToRecords(tlvMapGeneric)	×
213	}
214
215	// RecordsAsProducers converts a slice of records into a slice of record
216	// producers.
217	func RecordsAsProducers(records []tlv.Record) []tlv.RecordProducer {	3✔
218	return fn.Map(records, func(record tlv.Record) tlv.RecordProducer {	6✔
219	return &record	3✔
220	})	3✔
221	}
222
223	// EncodeRecords encodes the given records into a byte slice.
224	func EncodeRecords(records []tlv.Record) ([]byte, error) {	3✔
225	var buf bytes.Buffer	3✔
226	if err := EncodeRecordsTo(&buf, records); err != nil {	3✔
227	return nil, err	×
228	}	×
229
230	return buf.Bytes(), nil	3✔
231	}
232
233	// EncodeRecordsTo encodes the given records into the given writer.
234	func EncodeRecordsTo(w io.Writer, records []tlv.Record) error {	3✔
235	tlvStream, err := tlv.NewStream(records...)	3✔
236	if err != nil {	3✔
237	return err	×
238	}	×
239
240	return tlvStream.Encode(w)	3✔
241	}
242
243	// DecodeRecords decodes the given byte slice into the given records and returns
244	// the rest as a TLV type map.
245	func DecodeRecords(r io.Reader,
246	records ...tlv.Record) (tlv.TypeMap, error) {	3✔
247		3✔
248	tlvStream, err := tlv.NewStream(records...)	3✔
249	if err != nil {	3✔
250	return nil, err	×
251	}	×
252
253	return tlvStream.DecodeWithParsedTypes(r)	3✔
254	}
255
256	// DecodeRecordsP2P decodes the given byte slice into the given records and
257	// returns the rest as a TLV type map. This function is identical to
258	// DecodeRecords except that the record size is capped at 65535.
259	func DecodeRecordsP2P(r *bytes.Reader,
260	records ...tlv.Record) (tlv.TypeMap, error) {	3✔
261		3✔
262	tlvStream, err := tlv.NewStream(records...)	3✔
263	if err != nil {	3✔
264	return nil, err	×
265	}	×
266
267	return tlvStream.DecodeWithParsedTypesP2P(r)	3✔
268	}
269
270	// AssertUniqueTypes asserts that the given records have unique types.
271	func AssertUniqueTypes(r []tlv.Record) error {	3✔
272	seen := make(fn.Set[tlv.Type], len(r))	3✔
273	for _, record := range r {	6✔
274	t := record.Type()	3✔
275	if seen.Contains(t) {	3✔
276	return fmt.Errorf("duplicate record type: %d", t)	×
277	}	×
278	seen.Add(t)	3✔
279	}
280
281	return nil	3✔
282	}

lightningnetwork / lnd / 13035292482

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