13999301927

Committed 21 Mar 2025 07:18PM UTC coverage: 68.989% (+9.9%) from 59.126%

Build # 13999301927

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9623 from Roasbeef/size-msg-test-msg

Size msg test msg

Run Details

1461 of 1572 new or added lines in 43 files covered. (92.94%)

28 existing lines in 6 files now uncovered.

132898 of 192637 relevant lines covered (68.99%)

22200.59 hits per line

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

82.88

/lnwire/reply_channel_range.go

package lnwire

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

        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/lightningnetwork/lnd/tlv"
)

// ReplyChannelRange is the response to the QueryChannelRange message. It
// includes the original query, and the next streaming chunk of encoded short
// channel ID's as the response. We'll also include a byte that indicates if
// this is the last query in the message.
type ReplyChannelRange struct {
        // ChainHash denotes the target chain that we're trying to synchronize
        // channel graph state for.
        ChainHash chainhash.Hash

        // FirstBlockHeight is the first block in the query range. The
        // responder should send all new short channel IDs from this block
        // until this block plus the specified number of blocks.
        FirstBlockHeight uint32

        // NumBlocks is the number of blocks beyond the first block that short
        // channel ID's should be sent for.
        NumBlocks uint32

        // Complete denotes if this is the conclusion of the set of streaming
        // responses to the original query.
        Complete uint8

        // EncodingType is a signal to the receiver of the message that
        // indicates exactly how the set of short channel ID's that follow have
        // been encoded.
        EncodingType QueryEncoding

        // ShortChanIDs is a slice of decoded short channel ID's.
        ShortChanIDs []ShortChannelID

        // Timestamps is an optional set of timestamps corresponding to the
        // latest timestamps for the channel update messages corresponding to
        // those referenced in the ShortChanIDs list. If this field is used,
        // then the length must match the length of ShortChanIDs.
        Timestamps Timestamps

        // ExtraData is the set of data that was appended to this message to
        // fill out the full maximum transport message size. These fields can
        // be used to specify optional data such as custom TLV fields.
        ExtraData ExtraOpaqueData

        // noSort indicates whether or not to sort the short channel ids before
        // writing them out.
        //
        // NOTE: This should only be used for testing.
        noSort bool
}

// NewReplyChannelRange creates a new empty ReplyChannelRange message.
func NewReplyChannelRange() *ReplyChannelRange {
        return &ReplyChannelRange{
                ExtraData: make([]byte, 0),
        }
}

// A compile time check to ensure ReplyChannelRange implements the
// lnwire.Message interface.
var _ Message = (*ReplyChannelRange)(nil)

// A compile time check to ensure ReplyChannelRange implements the
// lnwire.SizeableMessage interface.
var _ SizeableMessage = (*ReplyChannelRange)(nil)

// Decode deserializes a serialized ReplyChannelRange message stored in the
// passed io.Reader observing the specified protocol version.
//
// This is part of the lnwire.Message interface.
func (c *ReplyChannelRange) Decode(r io.Reader, pver uint32) error {
        err := ReadElements(r,
                c.ChainHash[:],
                &c.FirstBlockHeight,
                &c.NumBlocks,
                &c.Complete,
        )
        if err != nil {
                return err
        }

        c.EncodingType, c.ShortChanIDs, err = decodeShortChanIDs(r)
        if err != nil {
                return err
        }

        var tlvRecords ExtraOpaqueData
        if err := ReadElements(r, &tlvRecords); err != nil {
                return err
        }

        var timeStamps Timestamps
        typeMap, err := tlvRecords.ExtractRecords(&timeStamps)
        if err != nil {
                return err
        }

        // Set the corresponding TLV types if they were included in the stream.
        if val, ok := typeMap[TimestampsRecordType]; ok && val == nil {
                c.Timestamps = timeStamps

                // Check that a timestamp was provided for each SCID.
                if len(c.Timestamps) != len(c.ShortChanIDs) {
                        return fmt.Errorf("number of timestamps does not " +
                                "match number of SCIDs")
                }
        }

        if len(tlvRecords) != 0 {
                c.ExtraData = tlvRecords
        }

        return nil
}

// Encode serializes the target ReplyChannelRange into the passed io.Writer
// observing the protocol version specified.
//
// This is part of the lnwire.Message interface.
func (c *ReplyChannelRange) Encode(w *bytes.Buffer, pver uint32) error {
        if err := WriteBytes(w, c.ChainHash[:]); err != nil {
                return err
        }

        if err := WriteUint32(w, c.FirstBlockHeight); err != nil {
                return err
        }

        if err := WriteUint32(w, c.NumBlocks); err != nil {
                return err
        }

        if err := WriteUint8(w, c.Complete); err != nil {
                return err
        }

        // For both of the current encoding types, the channel ID's are to be
        // sorted in place, so we'll do that now. The sorting is applied unless
        // we were specifically requested not to for testing purposes.
        if !c.noSort {
                var scidPreSortIndex map[uint64]int
                if len(c.Timestamps) != 0 {
                        // Sanity check that a timestamp was provided for each
                        // SCID.
                        if len(c.Timestamps) != len(c.ShortChanIDs) {
                                return fmt.Errorf("must provide a timestamp " +
                                        "pair for each of the given SCIDs")
                        }

                        // Create a map from SCID value to the original index of
                        // the SCID in the unsorted list.
                        scidPreSortIndex = make(
                                map[uint64]int, len(c.ShortChanIDs),
                        )
                        for i, scid := range c.ShortChanIDs {
                                scidPreSortIndex[scid.ToUint64()] = i
                        }

                        // Sanity check that there were no duplicates in the
                        // SCID list.
                        if len(scidPreSortIndex) != len(c.ShortChanIDs) {
                                return fmt.Errorf("scid list should not " +
                                        "contain duplicates")
                        }
                }

                // Now sort the SCIDs.
                sort.Slice(c.ShortChanIDs, func(i, j int) bool {
                        return c.ShortChanIDs[i].ToUint64() <
                                c.ShortChanIDs[j].ToUint64()
                })

                if len(c.Timestamps) != 0 {
                        timestamps := make(Timestamps, len(c.Timestamps))

                        for i, scid := range c.ShortChanIDs {
                                timestamps[i] = []ChanUpdateTimestamps(
                                        c.Timestamps,
                                )[scidPreSortIndex[scid.ToUint64()]]
                        }
                        c.Timestamps = timestamps
                }
        }

        err := encodeShortChanIDs(w, c.EncodingType, c.ShortChanIDs)
        if err != nil {
                return err
        }

        recordProducers := make([]tlv.RecordProducer, 0, 1)
        if len(c.Timestamps) != 0 {
                recordProducers = append(recordProducers, &c.Timestamps)
        }
        err = EncodeMessageExtraData(&c.ExtraData, recordProducers...)
        if err != nil {
                return err
        }

        return WriteBytes(w, c.ExtraData)
}

// MsgType returns the integer uniquely identifying this message type on the
// wire.
//
// This is part of the lnwire.Message interface.
func (c *ReplyChannelRange) MsgType() MessageType {
        return MsgReplyChannelRange
}

// LastBlockHeight returns the last block height covered by the range of a
// QueryChannelRange message.
func (c *ReplyChannelRange) LastBlockHeight() uint32 {
        // Handle overflows by casting to uint64.
        lastBlockHeight := uint64(c.FirstBlockHeight) + uint64(c.NumBlocks) - 1
        if lastBlockHeight > math.MaxUint32 {
                return math.MaxUint32
        }
        return uint32(lastBlockHeight)
}

// SerializedSize returns the serialized size of the message in bytes.
//
// This is part of the lnwire.SizeableMessage interface.
func (c *ReplyChannelRange) SerializedSize() (uint32, error) {
        return MessageSerializedSize(c)
}

1	package lnwire
2
3	import (
4	"bytes"
5	"fmt"
6	"io"
7	"math"
8	"sort"
9
10	"github.com/btcsuite/btcd/chaincfg/chainhash"
11	"github.com/lightningnetwork/lnd/tlv"
12	)
13
14	// ReplyChannelRange is the response to the QueryChannelRange message. It
15	// includes the original query, and the next streaming chunk of encoded short
16	// channel ID's as the response. We'll also include a byte that indicates if
17	// this is the last query in the message.
18	type ReplyChannelRange struct {
19	// ChainHash denotes the target chain that we're trying to synchronize
20	// channel graph state for.
21	ChainHash chainhash.Hash
22
23	// FirstBlockHeight is the first block in the query range. The
24	// responder should send all new short channel IDs from this block
25	// until this block plus the specified number of blocks.
26	FirstBlockHeight uint32
27
28	// NumBlocks is the number of blocks beyond the first block that short
29	// channel ID's should be sent for.
30	NumBlocks uint32
31
32	// Complete denotes if this is the conclusion of the set of streaming
33	// responses to the original query.
34	Complete uint8
35
36	// EncodingType is a signal to the receiver of the message that
37	// indicates exactly how the set of short channel ID's that follow have
38	// been encoded.
39	EncodingType QueryEncoding
40
41	// ShortChanIDs is a slice of decoded short channel ID's.
42	ShortChanIDs []ShortChannelID
43
44	// Timestamps is an optional set of timestamps corresponding to the
45	// latest timestamps for the channel update messages corresponding to
46	// those referenced in the ShortChanIDs list. If this field is used,
47	// then the length must match the length of ShortChanIDs.
48	Timestamps Timestamps
49
50	// ExtraData is the set of data that was appended to this message to
51	// fill out the full maximum transport message size. These fields can
52	// be used to specify optional data such as custom TLV fields.
53	ExtraData ExtraOpaqueData
54
55	// noSort indicates whether or not to sort the short channel ids before
56	// writing them out.
57	//
58	// NOTE: This should only be used for testing.
59	noSort bool
60	}
61
62	// NewReplyChannelRange creates a new empty ReplyChannelRange message.
63	func NewReplyChannelRange() *ReplyChannelRange {	2✔
64	return &ReplyChannelRange{	2✔
65	ExtraData: make([]byte, 0),	2✔
66	}	2✔
67	}	2✔
68
69	// A compile time check to ensure ReplyChannelRange implements the
70	// lnwire.Message interface.
71	var _ Message = (*ReplyChannelRange)(nil)
72
73	// A compile time check to ensure ReplyChannelRange implements the
74	// lnwire.SizeableMessage interface.
75	var _ SizeableMessage = (*ReplyChannelRange)(nil)
76
77	// Decode deserializes a serialized ReplyChannelRange message stored in the
78	// passed io.Reader observing the specified protocol version.
79	//
80	// This is part of the lnwire.Message interface.
81	func (c *ReplyChannelRange) Decode(r io.Reader, pver uint32) error {	1,225✔
82	err := ReadElements(r,	1,225✔
83	c.ChainHash[:],	1,225✔
84	&c.FirstBlockHeight,	1,225✔
85	&c.NumBlocks,	1,225✔
86	&c.Complete,	1,225✔
87	)	1,225✔
88	if err != nil {	1,231✔
89	return err	6✔
90	}	6✔
91
92	c.EncodingType, c.ShortChanIDs, err = decodeShortChanIDs(r)	1,219✔
93	if err != nil {	1,601✔
94	return err	382✔
95	}	382✔
96
97	var tlvRecords ExtraOpaqueData	837✔
98	if err := ReadElements(r, &tlvRecords); err != nil {	837✔
99	return err	×
100	}	×
101
102	var timeStamps Timestamps	837✔
103	typeMap, err := tlvRecords.ExtractRecords(&timeStamps)	837✔
104	if err != nil {	907✔
105	return err	70✔
106	}	70✔
107
108	// Set the corresponding TLV types if they were included in the stream.
109	if val, ok := typeMap[TimestampsRecordType]; ok && val == nil {	812✔
110	c.Timestamps = timeStamps	45✔
111		45✔
112	// Check that a timestamp was provided for each SCID.	45✔
113	if len(c.Timestamps) != len(c.ShortChanIDs) {	48✔
114	return fmt.Errorf("number of timestamps does not " +	3✔
115	"match number of SCIDs")	3✔
116	}	3✔
117	}
118
119	if len(tlvRecords) != 0 {	812✔
120	c.ExtraData = tlvRecords	48✔
121	}	48✔
122
123	return nil	764✔
124	}
125
126	// Encode serializes the target ReplyChannelRange into the passed io.Writer
127	// observing the protocol version specified.
128	//
129	// This is part of the lnwire.Message interface.
130	func (c ReplyChannelRange) Encode(w bytes.Buffer, pver uint32) error {	441✔
131	if err := WriteBytes(w, c.ChainHash[:]); err != nil {	441✔
132	return err	×
133	}	×
134
135	if err := WriteUint32(w, c.FirstBlockHeight); err != nil {	441✔
136	return err	×
137	}	×
138
139	if err := WriteUint32(w, c.NumBlocks); err != nil {	441✔
140	return err	×
141	}	×
142
143	if err := WriteUint8(w, c.Complete); err != nil {	441✔
144	return err	×
145	}	×
146
147	// For both of the current encoding types, the channel ID's are to be
148	// sorted in place, so we'll do that now. The sorting is applied unless
149	// we were specifically requested not to for testing purposes.
150	if !c.noSort {	878✔
151	var scidPreSortIndex map[uint64]int	437✔
152	if len(c.Timestamps) != 0 {	478✔
153	// Sanity check that a timestamp was provided for each	41✔
154	// SCID.	41✔
155	if len(c.Timestamps) != len(c.ShortChanIDs) {	42✔
156	return fmt.Errorf("must provide a timestamp " +	1✔
157	"pair for each of the given SCIDs")	1✔
158	}	1✔
159
160	// Create a map from SCID value to the original index of
161	// the SCID in the unsorted list.
162	scidPreSortIndex = make(	40✔
163	map[uint64]int, len(c.ShortChanIDs),	40✔
164	)	40✔
165	for i, scid := range c.ShortChanIDs {	356✔
166	scidPreSortIndex[scid.ToUint64()] = i	316✔
167	}	316✔
168
169	// Sanity check that there were no duplicates in the
170	// SCID list.
171	if len(scidPreSortIndex) != len(c.ShortChanIDs) {	41✔
172	return fmt.Errorf("scid list should not " +	1✔
173	"contain duplicates")	1✔
174	}	1✔
175	}
176
177	// Now sort the SCIDs.
178	sort.Slice(c.ShortChanIDs, func(i, j int) bool {	4,061✔
179	return c.ShortChanIDs[i].ToUint64() <	3,626✔
180	c.ShortChanIDs[j].ToUint64()	3,626✔
181	})	3,626✔
182
183	if len(c.Timestamps) != 0 {	474✔
184	timestamps := make(Timestamps, len(c.Timestamps))	39✔
185		39✔
186	for i, scid := range c.ShortChanIDs {	352✔
187	timestamps[i] = []ChanUpdateTimestamps(	313✔
188	c.Timestamps,	313✔
189	)[scidPreSortIndex[scid.ToUint64()]]	313✔
190	}	313✔
191	c.Timestamps = timestamps	39✔
192	}
193	}
194
195	err := encodeShortChanIDs(w, c.EncodingType, c.ShortChanIDs)	439✔
196	if err != nil {	439✔
197	return err	×
198	}	×
199
200	recordProducers := make([]tlv.RecordProducer, 0, 1)	439✔
201	if len(c.Timestamps) != 0 {	478✔
202	recordProducers = append(recordProducers, &c.Timestamps)	39✔
203	}	39✔
204	err = EncodeMessageExtraData(&c.ExtraData, recordProducers...)	439✔
205	if err != nil {	439✔
206	return err	×
207	}	×
208
209	return WriteBytes(w, c.ExtraData)	439✔
210	}
211
212	// MsgType returns the integer uniquely identifying this message type on the
213	// wire.
214	//
215	// This is part of the lnwire.Message interface.
216	func (c *ReplyChannelRange) MsgType() MessageType {	435✔
217	return MsgReplyChannelRange	435✔
218	}	435✔
219
220	// LastBlockHeight returns the last block height covered by the range of a
221	// QueryChannelRange message.
222	func (c *ReplyChannelRange) LastBlockHeight() uint32 {	362✔
223	// Handle overflows by casting to uint64.	362✔
224	lastBlockHeight := uint64(c.FirstBlockHeight) + uint64(c.NumBlocks) - 1	362✔
225	if lastBlockHeight > math.MaxUint32 {	362✔
226	return math.MaxUint32	×
227	}	×
228	return uint32(lastBlockHeight)	362✔
229	}
230
231	// SerializedSize returns the serialized size of the message in bytes.
232	//
233	// This is part of the lnwire.SizeableMessage interface.
NEW 234	func (c *ReplyChannelRange) SerializedSize() (uint32, error) {	×
NEW 235	return MessageSerializedSize(c)	×
NEW 236	}	×

lightningnetwork / lnd / 13999301927

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