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

64.06

/lnwire/query_channel_range.go

package lnwire

import (
        "bytes"
        "io"
        "math"

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

// QueryChannelRange is a message sent by a node in order to query the
// receiving node of the set of open channel they know of with short channel
// ID's after the specified block height, capped at the number of blocks beyond
// that block height. This will be used by nodes upon initial connect to
// synchronize their views of the network.
type QueryChannelRange 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

        // QueryOptions is an optional feature bit vector that can be used to
        // specify additional query options.
        QueryOptions *QueryOptions

        // 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
}

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

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

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

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

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

        // Set the corresponding TLV types if they were included in the stream.
        if val, ok := typeMap[QueryOptionsRecordType]; ok && val == nil {
                q.QueryOptions = &queryOptions
        }

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

        return nil
}

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

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

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

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

        return WriteBytes(w, q.ExtraData)
}

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

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

// WithTimestamps returns true if the query has asked for timestamps too.
func (q *QueryChannelRange) WithTimestamps() bool {
        if q.QueryOptions == nil {
                return false
        }

        queryOpts := RawFeatureVector(*q.QueryOptions)

        return queryOpts.IsSet(QueryOptionTimestampBit)
}

1	package lnwire
2
3	import (
4	"bytes"
5	"io"
6	"math"
7
8	"github.com/btcsuite/btcd/chaincfg/chainhash"
9	"github.com/lightningnetwork/lnd/tlv"
10	)
11
12	// QueryChannelRange is a message sent by a node in order to query the
13	// receiving node of the set of open channel they know of with short channel
14	// ID's after the specified block height, capped at the number of blocks beyond
15	// that block height. This will be used by nodes upon initial connect to
16	// synchronize their views of the network.
17	type QueryChannelRange struct {
18	// ChainHash denotes the target chain that we're trying to synchronize
19	// channel graph state for.
20	ChainHash chainhash.Hash
21
22	// FirstBlockHeight is the first block in the query range. The
23	// responder should send all new short channel IDs from this block
24	// until this block plus the specified number of blocks.
25	FirstBlockHeight uint32
26
27	// NumBlocks is the number of blocks beyond the first block that short
28	// channel ID's should be sent for.
29	NumBlocks uint32
30
31	// QueryOptions is an optional feature bit vector that can be used to
32	// specify additional query options.
33	QueryOptions *QueryOptions
34
35	// ExtraData is the set of data that was appended to this message to
36	// fill out the full maximum transport message size. These fields can
37	// be used to specify optional data such as custom TLV fields.
38	ExtraData ExtraOpaqueData
39	}
40
41	// NewQueryChannelRange creates a new empty QueryChannelRange message.
42	func NewQueryChannelRange() *QueryChannelRange {	×
43	return &QueryChannelRange{	×
44	ExtraData: make([]byte, 0),	×
45	}	×
46	}	×
47
48	// A compile time check to ensure QueryChannelRange implements the
49	// lnwire.Message interface.
50	var _ Message = (*QueryChannelRange)(nil)
51
52	// Decode deserializes a serialized QueryChannelRange message stored in the
53	// passed io.Reader observing the specified protocol version.
54	//
55	// This is part of the lnwire.Message interface.
56	func (q *QueryChannelRange) Decode(r io.Reader, _ uint32) error {	3✔
57	err := ReadElements(	3✔
58	r, q.ChainHash[:], &q.FirstBlockHeight, &q.NumBlocks,	3✔
59	)	3✔
60	if err != nil {	3✔
61	return err	×
62	}	×
63
64	var tlvRecords ExtraOpaqueData	3✔
65	if err := ReadElements(r, &tlvRecords); err != nil {	3✔
66	return err	×
67	}	×
68
69	var queryOptions QueryOptions	3✔
70	typeMap, err := tlvRecords.ExtractRecords(&queryOptions)	3✔
71	if err != nil {	3✔
72	return err	×
73	}	×
74
75	// Set the corresponding TLV types if they were included in the stream.
76	if val, ok := typeMap[QueryOptionsRecordType]; ok && val == nil {	6✔
77	q.QueryOptions = &queryOptions	3✔
78	}	3✔
79
80	if len(tlvRecords) != 0 {	6✔
81	q.ExtraData = tlvRecords	3✔
82	}	3✔
83
84	return nil	3✔
85	}
86
87	// Encode serializes the target QueryChannelRange into the passed io.Writer
88	// observing the protocol version specified.
89	//
90	// This is part of the lnwire.Message interface.
91	func (q QueryChannelRange) Encode(w bytes.Buffer, _ uint32) error {	3✔
92	if err := WriteBytes(w, q.ChainHash[:]); err != nil {	3✔
93	return err	×
94	}	×
95
96	if err := WriteUint32(w, q.FirstBlockHeight); err != nil {	3✔
97	return err	×
98	}	×
99
100	if err := WriteUint32(w, q.NumBlocks); err != nil {	3✔
101	return err	×
102	}	×
103
104	recordProducers := make([]tlv.RecordProducer, 0, 1)	3✔
105	if q.QueryOptions != nil {	6✔
106	recordProducers = append(recordProducers, q.QueryOptions)	3✔
107	}	3✔
108	err := EncodeMessageExtraData(&q.ExtraData, recordProducers...)	3✔
109	if err != nil {	3✔
110	return err	×
111	}	×
112
113	return WriteBytes(w, q.ExtraData)	3✔
114	}
115
116	// MsgType returns the integer uniquely identifying this message type on the
117	// wire.
118	//
119	// This is part of the lnwire.Message interface.
120	func (q *QueryChannelRange) MsgType() MessageType {	3✔
121	return MsgQueryChannelRange	3✔
122	}	3✔
123
124	// LastBlockHeight returns the last block height covered by the range of a
125	// QueryChannelRange message.
126	func (q *QueryChannelRange) LastBlockHeight() uint32 {	3✔
127	// Handle overflows by casting to uint64.	3✔
128	lastBlockHeight := uint64(q.FirstBlockHeight) + uint64(q.NumBlocks) - 1	3✔
129	if lastBlockHeight > math.MaxUint32 {	3✔
130	return math.MaxUint32	×
131	}	×
132	return uint32(lastBlockHeight)	3✔
133	}
134
135	// WithTimestamps returns true if the query has asked for timestamps too.
136	func (q *QueryChannelRange) WithTimestamps() bool {	3✔
137	if q.QueryOptions == nil {	3✔
138	return false	×
139	}	×
140
141	queryOpts := RawFeatureVector(*q.QueryOptions)	3✔
142		3✔
143	return queryOpts.IsSet(QueryOptionTimestampBit)	3✔
144	}

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