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

0.0

/channeldb/migration21/legacy/legacy_codec.go

package legacy

import (
        "encoding/binary"
        "fmt"
        "io"

        "github.com/btcsuite/btcd/btcec/v2"
        "github.com/btcsuite/btcd/btcutil"
        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/btcsuite/btcd/wire"
        lnwire "github.com/lightningnetwork/lnd/channeldb/migration/lnwire21"
        "github.com/lightningnetwork/lnd/channeldb/migration21/common"
        "github.com/lightningnetwork/lnd/keychain"
)

var (
        // Big endian is the preferred byte order, due to cursor scans over
        // integer keys iterating in order.
        byteOrder = binary.BigEndian
)

// writeOutpoint writes an outpoint to the passed writer using the minimal
// amount of bytes possible.
func writeOutpoint(w io.Writer, o *wire.OutPoint) error {
        if _, err := w.Write(o.Hash[:]); err != nil {
                return err
        }
        if err := binary.Write(w, byteOrder, o.Index); err != nil {
                return err
        }

        return nil
}

// readOutpoint reads an outpoint from the passed reader that was previously
// written using the writeOutpoint struct.
func readOutpoint(r io.Reader, o *wire.OutPoint) error {
        if _, err := io.ReadFull(r, o.Hash[:]); err != nil {
                return err
        }
        if err := binary.Read(r, byteOrder, &o.Index); err != nil {
                return err
        }

        return nil
}

// UnknownElementType is an error returned when the codec is unable to encode or
// decode a particular type.
type UnknownElementType struct {
        method  string
        element interface{}
}

// NewUnknownElementType creates a new UnknownElementType error from the passed
// method name and element.
func NewUnknownElementType(method string, el interface{}) UnknownElementType {
        return UnknownElementType{method: method, element: el}
}

// Error returns the name of the method that encountered the error, as well as
// the type that was unsupported.
func (e UnknownElementType) Error() string {
        return fmt.Sprintf("Unknown type in %s: %T", e.method, e.element)
}

// WriteElement is a one-stop shop to write the big endian representation of
// any element which is to be serialized for storage on disk. The passed
// io.Writer should be backed by an appropriately sized byte slice, or be able
// to dynamically expand to accommodate additional data.
func WriteElement(w io.Writer, element interface{}) error {
        switch e := element.(type) {
        case keychain.KeyDescriptor:
                if err := binary.Write(w, byteOrder, e.Family); err != nil {
                        return err
                }
                if err := binary.Write(w, byteOrder, e.Index); err != nil {
                        return err
                }

                if e.PubKey != nil {
                        if err := binary.Write(w, byteOrder, true); err != nil {
                                return fmt.Errorf("error writing serialized "+
                                        "element: %w", err)
                        }

                        return WriteElement(w, e.PubKey)
                }

                return binary.Write(w, byteOrder, false)

        case chainhash.Hash:
                if _, err := w.Write(e[:]); err != nil {
                        return err
                }

        case common.ClosureType:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case wire.OutPoint:
                return writeOutpoint(w, &e)

        case lnwire.ShortChannelID:
                if err := binary.Write(w, byteOrder, e.ToUint64()); err != nil {
                        return err
                }

        case lnwire.ChannelID:
                if _, err := w.Write(e[:]); err != nil {
                        return err
                }

        case int64, uint64:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case uint32:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case int32:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case uint16:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case uint8:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case bool:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        case btcutil.Amount:
                if err := binary.Write(w, byteOrder, uint64(e)); err != nil {
                        return err
                }

        case lnwire.MilliSatoshi:
                if err := binary.Write(w, byteOrder, uint64(e)); err != nil {
                        return err
                }

        case *btcec.PublicKey:
                b := e.SerializeCompressed()
                if _, err := w.Write(b); err != nil {
                        return err
                }

        case *wire.MsgTx:
                return e.Serialize(w)

        case [32]byte:
                if _, err := w.Write(e[:]); err != nil {
                        return err
                }

        case []byte:
                if err := wire.WriteVarBytes(w, 0, e); err != nil {
                        return err
                }

        case lnwire.Message:
                if _, err := lnwire.WriteMessage(w, e, 0); err != nil {
                        return err
                }

        case lnwire.FundingFlag:
                if err := binary.Write(w, byteOrder, e); err != nil {
                        return err
                }

        default:
                return UnknownElementType{"WriteElement", e}
        }

        return nil
}

// WriteElements is writes each element in the elements slice to the passed
// io.Writer using WriteElement.
func WriteElements(w io.Writer, elements ...interface{}) error {
        for _, element := range elements {
                err := WriteElement(w, element)
                if err != nil {
                        return err
                }
        }
        return nil
}

// ReadElement is a one-stop utility function to deserialize any datastructure
// encoded using the serialization format of the database.
func ReadElement(r io.Reader, element interface{}) error {
        switch e := element.(type) {
        case *chainhash.Hash:
                if _, err := io.ReadFull(r, e[:]); err != nil {
                        return err
                }

        case *wire.OutPoint:
                return readOutpoint(r, e)

        case *lnwire.ShortChannelID:
                var a uint64
                if err := binary.Read(r, byteOrder, &a); err != nil {
                        return err
                }
                *e = lnwire.NewShortChanIDFromInt(a)

        case *lnwire.ChannelID:
                if _, err := io.ReadFull(r, e[:]); err != nil {
                        return err
                }

        case *int64, *uint64:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *uint32:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *int32:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *uint16:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *uint8:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *bool:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *btcutil.Amount:
                var a uint64
                if err := binary.Read(r, byteOrder, &a); err != nil {
                        return err
                }

                *e = btcutil.Amount(a)

        case *lnwire.MilliSatoshi:
                var a uint64
                if err := binary.Read(r, byteOrder, &a); err != nil {
                        return err
                }

                *e = lnwire.MilliSatoshi(a)

        case **btcec.PublicKey:
                var b [btcec.PubKeyBytesLenCompressed]byte
                if _, err := io.ReadFull(r, b[:]); err != nil {
                        return err
                }

                pubKey, err := btcec.ParsePubKey(b[:])
                if err != nil {
                        return err
                }
                *e = pubKey

        case **wire.MsgTx:
                tx := wire.NewMsgTx(2)
                if err := tx.Deserialize(r); err != nil {
                        return err
                }

                *e = tx

        case *[32]byte:
                if _, err := io.ReadFull(r, e[:]); err != nil {
                        return err
                }

        case *[]byte:
                bytes, err := wire.ReadVarBytes(r, 0, 66000, "[]byte")
                if err != nil {
                        return err
                }

                *e = bytes

        case *lnwire.Message:
                msg, err := lnwire.ReadMessage(r, 0)
                if err != nil {
                        return err
                }

                *e = msg

        case *lnwire.FundingFlag:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *common.ClosureType:
                if err := binary.Read(r, byteOrder, e); err != nil {
                        return err
                }

        case *keychain.KeyDescriptor:
                if err := binary.Read(r, byteOrder, &e.Family); err != nil {
                        return err
                }
                if err := binary.Read(r, byteOrder, &e.Index); err != nil {
                        return err
                }

                var hasPubKey bool
                if err := binary.Read(r, byteOrder, &hasPubKey); err != nil {
                        return err
                }

                if hasPubKey {
                        return ReadElement(r, &e.PubKey)
                }

        default:
                return UnknownElementType{"ReadElement", e}
        }

        return nil
}

// ReadElements deserializes a variable number of elements into the passed
// io.Reader, with each element being deserialized according to the ReadElement
// function.
func ReadElements(r io.Reader, elements ...interface{}) error {
        for _, element := range elements {
                err := ReadElement(r, element)
                if err != nil {
                        return err
                }
        }
        return nil
}

1	package legacy
2
3	import (
4	"encoding/binary"
5	"fmt"
6	"io"
7
8	"github.com/btcsuite/btcd/btcec/v2"
9	"github.com/btcsuite/btcd/btcutil"
10	"github.com/btcsuite/btcd/chaincfg/chainhash"
11	"github.com/btcsuite/btcd/wire"
12	lnwire "github.com/lightningnetwork/lnd/channeldb/migration/lnwire21"
13	"github.com/lightningnetwork/lnd/channeldb/migration21/common"
14	"github.com/lightningnetwork/lnd/keychain"
15	)
16
17	var (
18	// Big endian is the preferred byte order, due to cursor scans over
19	// integer keys iterating in order.
20	byteOrder = binary.BigEndian
21	)
22
23	// writeOutpoint writes an outpoint to the passed writer using the minimal
24	// amount of bytes possible.
25	func writeOutpoint(w io.Writer, o *wire.OutPoint) error {	×
26	if _, err := w.Write(o.Hash[:]); err != nil {	×
27	return err	×
28	}	×
29	if err := binary.Write(w, byteOrder, o.Index); err != nil {	×
30	return err	×
31	}	×
32
33	return nil	×
34	}
35
36	// readOutpoint reads an outpoint from the passed reader that was previously
37	// written using the writeOutpoint struct.
38	func readOutpoint(r io.Reader, o *wire.OutPoint) error {	×
39	if _, err := io.ReadFull(r, o.Hash[:]); err != nil {	×
40	return err	×
41	}	×
42	if err := binary.Read(r, byteOrder, &o.Index); err != nil {	×
43	return err	×
44	}	×
45
46	return nil	×
47	}
48
49	// UnknownElementType is an error returned when the codec is unable to encode or
50	// decode a particular type.
51	type UnknownElementType struct {
52	method string
53	element interface{}
54	}
55
56	// NewUnknownElementType creates a new UnknownElementType error from the passed
57	// method name and element.
58	func NewUnknownElementType(method string, el interface{}) UnknownElementType {	×
59	return UnknownElementType{method: method, element: el}	×
60	}	×
61
62	// Error returns the name of the method that encountered the error, as well as
63	// the type that was unsupported.
64	func (e UnknownElementType) Error() string {	×
65	return fmt.Sprintf("Unknown type in %s: %T", e.method, e.element)	×
66	}	×
67
68	// WriteElement is a one-stop shop to write the big endian representation of
69	// any element which is to be serialized for storage on disk. The passed
70	// io.Writer should be backed by an appropriately sized byte slice, or be able
71	// to dynamically expand to accommodate additional data.
72	func WriteElement(w io.Writer, element interface{}) error {	×
73	switch e := element.(type) {	×
74	case keychain.KeyDescriptor:	×
75	if err := binary.Write(w, byteOrder, e.Family); err != nil {	×
76	return err	×
77	}	×
78	if err := binary.Write(w, byteOrder, e.Index); err != nil {	×
79	return err	×
80	}	×
81
82	if e.PubKey != nil {	×
83	if err := binary.Write(w, byteOrder, true); err != nil {	×
84	return fmt.Errorf("error writing serialized "+	×
85	"element: %w", err)	×
86	}	×
87
88	return WriteElement(w, e.PubKey)	×
89	}
90
91	return binary.Write(w, byteOrder, false)	×
92
93	case chainhash.Hash:	×
94	if _, err := w.Write(e[:]); err != nil {	×
95	return err	×
96	}	×
97
98	case common.ClosureType:	×
99	if err := binary.Write(w, byteOrder, e); err != nil {	×
100	return err	×
101	}	×
102
103	case wire.OutPoint:	×
104	return writeOutpoint(w, &e)	×
105
106	case lnwire.ShortChannelID:	×
107	if err := binary.Write(w, byteOrder, e.ToUint64()); err != nil {	×
108	return err	×
109	}	×
110
111	case lnwire.ChannelID:	×
112	if _, err := w.Write(e[:]); err != nil {	×
113	return err	×
114	}	×
115
116	case int64, uint64:	×
117	if err := binary.Write(w, byteOrder, e); err != nil {	×
118	return err	×
119	}	×
120
121	case uint32:	×
122	if err := binary.Write(w, byteOrder, e); err != nil {	×
123	return err	×
124	}	×
125
126	case int32:	×
127	if err := binary.Write(w, byteOrder, e); err != nil {	×
128	return err	×
129	}	×
130
131	case uint16:	×
132	if err := binary.Write(w, byteOrder, e); err != nil {	×
133	return err	×
134	}	×
135
136	case uint8:	×
137	if err := binary.Write(w, byteOrder, e); err != nil {	×
138	return err	×
139	}	×
140
141	case bool:	×
142	if err := binary.Write(w, byteOrder, e); err != nil {	×
143	return err	×
144	}	×
145
146	case btcutil.Amount:	×
147	if err := binary.Write(w, byteOrder, uint64(e)); err != nil {	×
148	return err	×
149	}	×
150
151	case lnwire.MilliSatoshi:	×
152	if err := binary.Write(w, byteOrder, uint64(e)); err != nil {	×
153	return err	×
154	}	×
155
156	case *btcec.PublicKey:	×
157	b := e.SerializeCompressed()	×
158	if _, err := w.Write(b); err != nil {	×
159	return err	×
160	}	×
161
162	case *wire.MsgTx:	×
163	return e.Serialize(w)	×
164
165	case [32]byte:	×
166	if _, err := w.Write(e[:]); err != nil {	×
167	return err	×
168	}	×
169
170	case []byte:	×
171	if err := wire.WriteVarBytes(w, 0, e); err != nil {	×
172	return err	×
173	}	×
174
175	case lnwire.Message:	×
176	if _, err := lnwire.WriteMessage(w, e, 0); err != nil {	×
177	return err	×
178	}	×
179
180	case lnwire.FundingFlag:	×
181	if err := binary.Write(w, byteOrder, e); err != nil {	×
182	return err	×
183	}	×
184
185	default:	×
186	return UnknownElementType{"WriteElement", e}	×
187	}
188
189	return nil	×
190	}
191
192	// WriteElements is writes each element in the elements slice to the passed
193	// io.Writer using WriteElement.
194	func WriteElements(w io.Writer, elements ...interface{}) error {	×
195	for _, element := range elements {	×
196	err := WriteElement(w, element)	×
197	if err != nil {	×
198	return err	×
199	}	×
200	}
201	return nil	×
202	}
203
204	// ReadElement is a one-stop utility function to deserialize any datastructure
205	// encoded using the serialization format of the database.
206	func ReadElement(r io.Reader, element interface{}) error {	×
207	switch e := element.(type) {	×
208	case *chainhash.Hash:	×
209	if _, err := io.ReadFull(r, e[:]); err != nil {	×
210	return err	×
211	}	×
212
213	case *wire.OutPoint:	×
214	return readOutpoint(r, e)	×
215
216	case *lnwire.ShortChannelID:	×
217	var a uint64	×
218	if err := binary.Read(r, byteOrder, &a); err != nil {	×
219	return err	×
220	}	×
221	*e = lnwire.NewShortChanIDFromInt(a)	×
222
223	case *lnwire.ChannelID:	×
224	if _, err := io.ReadFull(r, e[:]); err != nil {	×
225	return err	×
226	}	×
227
228	case int64, uint64:	×
229	if err := binary.Read(r, byteOrder, e); err != nil {	×
230	return err	×
231	}	×
232
233	case *uint32:	×
234	if err := binary.Read(r, byteOrder, e); err != nil {	×
235	return err	×
236	}	×
237
238	case *int32:	×
239	if err := binary.Read(r, byteOrder, e); err != nil {	×
240	return err	×
241	}	×
242
243	case *uint16:	×
244	if err := binary.Read(r, byteOrder, e); err != nil {	×
245	return err	×
246	}	×
247
248	case *uint8:	×
249	if err := binary.Read(r, byteOrder, e); err != nil {	×
250	return err	×
251	}	×
252
253	case *bool:	×
254	if err := binary.Read(r, byteOrder, e); err != nil {	×
255	return err	×
256	}	×
257
258	case *btcutil.Amount:	×
259	var a uint64	×
260	if err := binary.Read(r, byteOrder, &a); err != nil {	×
261	return err	×
262	}	×
263
264	*e = btcutil.Amount(a)	×
265
266	case *lnwire.MilliSatoshi:	×
267	var a uint64	×
268	if err := binary.Read(r, byteOrder, &a); err != nil {	×
269	return err	×
270	}	×
271
272	*e = lnwire.MilliSatoshi(a)	×
273
274	case **btcec.PublicKey:	×
275	var b [btcec.PubKeyBytesLenCompressed]byte	×
276	if _, err := io.ReadFull(r, b[:]); err != nil {	×
277	return err	×
278	}	×
279
280	pubKey, err := btcec.ParsePubKey(b[:])	×
281	if err != nil {	×
282	return err	×
283	}	×
284	*e = pubKey	×
285
286	case **wire.MsgTx:	×
287	tx := wire.NewMsgTx(2)	×
288	if err := tx.Deserialize(r); err != nil {	×
289	return err	×
290	}	×
291
292	*e = tx	×
293
294	case *[32]byte:	×
295	if _, err := io.ReadFull(r, e[:]); err != nil {	×
296	return err	×
297	}	×
298
299	case *[]byte:	×
300	bytes, err := wire.ReadVarBytes(r, 0, 66000, "[]byte")	×
301	if err != nil {	×
302	return err	×
303	}	×
304
305	*e = bytes	×
306
307	case *lnwire.Message:	×
308	msg, err := lnwire.ReadMessage(r, 0)	×
309	if err != nil {	×
310	return err	×
311	}	×
312
313	*e = msg	×
314
315	case *lnwire.FundingFlag:	×
316	if err := binary.Read(r, byteOrder, e); err != nil {	×
317	return err	×
318	}	×
319
320	case *common.ClosureType:	×
321	if err := binary.Read(r, byteOrder, e); err != nil {	×
322	return err	×
323	}	×
324
325	case *keychain.KeyDescriptor:	×
326	if err := binary.Read(r, byteOrder, &e.Family); err != nil {	×
327	return err	×
328	}	×
329	if err := binary.Read(r, byteOrder, &e.Index); err != nil {	×
330	return err	×
331	}	×
332
333	var hasPubKey bool	×
334	if err := binary.Read(r, byteOrder, &hasPubKey); err != nil {	×
335	return err	×
336	}	×
337
338	if hasPubKey {	×
339	return ReadElement(r, &e.PubKey)	×
340	}	×
341
342	default:	×
343	return UnknownElementType{"ReadElement", e}	×
344	}
345
346	return nil	×
347	}
348
349	// ReadElements deserializes a variable number of elements into the passed
350	// io.Reader, with each element being deserialized according to the ReadElement
351	// function.
352	func ReadElements(r io.Reader, elements ...interface{}) error {	×
353	for _, element := range elements {	×
354	err := ReadElement(r, element)	×
355	if err != nil {	×
356	return err	×
357	}	×
358	}
359	return nil	×
360	}

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