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/migration27/channel.go

package migration27

import (
        "bytes"
        "fmt"

        lnwire "github.com/lightningnetwork/lnd/channeldb/migration/lnwire21"
        mig25 "github.com/lightningnetwork/lnd/channeldb/migration25"
        mig26 "github.com/lightningnetwork/lnd/channeldb/migration26"
        mig "github.com/lightningnetwork/lnd/channeldb/migration_01_to_11"
        "github.com/lightningnetwork/lnd/kvdb"
        "github.com/lightningnetwork/lnd/tlv"
)

const (
        // A tlv type definition used to serialize and deserialize a KeyLocator
        // from the database.
        keyLocType tlv.Type = 1

        // A tlv type used to serialize and deserialize the
        // `InitialLocalBalance` field.
        initialLocalBalanceType tlv.Type = 2

        // A tlv type used to serialize and deserialize the
        // `InitialRemoteBalance` field.
        initialRemoteBalanceType tlv.Type = 3
)

var (
        // chanInfoKey can be accessed within the bucket for a channel
        // (identified by its chanPoint). This key stores all the static
        // information for a channel which is decided at the end of  the
        // funding flow.
        chanInfoKey = []byte("chan-info-key")

        // localUpfrontShutdownKey can be accessed within the bucket for a
        // channel (identified by its chanPoint). This key stores an optional
        // upfront shutdown script for the local peer.
        localUpfrontShutdownKey = []byte("local-upfront-shutdown-key")

        // remoteUpfrontShutdownKey can be accessed within the bucket for a
        // channel (identified by its chanPoint). This key stores an optional
        // upfront shutdown script for the remote peer.
        remoteUpfrontShutdownKey = []byte("remote-upfront-shutdown-key")

        // lastWasRevokeKey is a key that stores true when the last update we
        // sent was a revocation and false when it was a commitment signature.
        // This is nil in the case of new channels with no updates exchanged.
        lastWasRevokeKey = []byte("last-was-revoke")

        // ErrNoChanInfoFound is returned when a particular channel does not
        // have any channels state.
        ErrNoChanInfoFound = fmt.Errorf("no chan info found")
)

// OpenChannel embeds a mig26.OpenChannel with the extra update-to-date
// serialization and deserialization methods.
//
// NOTE: doesn't have the Packager field as it's not used in current migration.
type OpenChannel struct {
        mig26.OpenChannel
}

// FetchChanInfo deserializes the channel info based on the legacy boolean.
func FetchChanInfo(chanBucket kvdb.RBucket, c *OpenChannel, legacy bool) error {
        infoBytes := chanBucket.Get(chanInfoKey)
        if infoBytes == nil {
                return ErrNoChanInfoFound
        }
        r := bytes.NewReader(infoBytes)

        var (
                chanType   mig.ChannelType
                chanStatus mig.ChannelStatus
        )

        if err := mig.ReadElements(r,
                &chanType, &c.ChainHash, &c.FundingOutpoint,
                &c.ShortChannelID, &c.IsPending, &c.IsInitiator,
                &chanStatus, &c.FundingBroadcastHeight,
                &c.NumConfsRequired, &c.ChannelFlags,
                &c.IdentityPub, &c.Capacity, &c.TotalMSatSent,
                &c.TotalMSatReceived,
        ); err != nil {
                return fmt.Errorf("ReadElements got: %w", err)
        }

        c.ChanType = mig25.ChannelType(chanType)
        c.ChanStatus = mig25.ChannelStatus(chanStatus)

        // For single funder channels that we initiated and have the funding
        // transaction to, read the funding txn.
        if c.FundingTxPresent() {
                if err := mig.ReadElement(r, &c.FundingTxn); err != nil {
                        return fmt.Errorf("read FundingTxn got: %w", err)
                }
        }

        if err := mig.ReadChanConfig(r, &c.LocalChanCfg); err != nil {
                return fmt.Errorf("read LocalChanCfg got: %w", err)
        }
        if err := mig.ReadChanConfig(r, &c.RemoteChanCfg); err != nil {
                return fmt.Errorf("read RemoteChanCfg got: %w", err)
        }

        // Retrieve the boolean stored under lastWasRevokeKey.
        lastWasRevokeBytes := chanBucket.Get(lastWasRevokeKey)
        if lastWasRevokeBytes == nil {
                // If nothing has been stored under this key, we store false in
                // the OpenChannel struct.
                c.LastWasRevoke = false
        } else {
                // Otherwise, read the value into the LastWasRevoke field.
                revokeReader := bytes.NewReader(lastWasRevokeBytes)
                err := mig.ReadElements(revokeReader, &c.LastWasRevoke)
                if err != nil {
                        return fmt.Errorf("read LastWasRevoke got: %w", err)
                }
        }

        // Make the tlv stream based on the legacy param.
        var (
                ts            *tlv.Stream
                err           error
                localBalance  uint64
                remoteBalance uint64
        )

        keyLocRecord := mig25.MakeKeyLocRecord(
                keyLocType, &c.RevocationKeyLocator,
        )

        // If it's legacy, create the stream with a single tlv record.
        if legacy {
                ts, err = tlv.NewStream(keyLocRecord)
        } else {
                // Otherwise, for the new format, we will encode the balance
                // fields in the tlv stream too.
                ts, err = tlv.NewStream(
                        keyLocRecord,
                        tlv.MakePrimitiveRecord(
                                initialLocalBalanceType, &localBalance,
                        ),
                        tlv.MakePrimitiveRecord(
                                initialRemoteBalanceType, &remoteBalance,
                        ),
                )
        }
        if err != nil {
                return fmt.Errorf("create tlv stream got: %w", err)
        }

        if err := ts.Decode(r); err != nil {
                return fmt.Errorf("decode tlv stream got: %w", err)
        }

        // For the new format, attach the balance fields.
        if !legacy {
                c.InitialLocalBalance = lnwire.MilliSatoshi(localBalance)
                c.InitialRemoteBalance = lnwire.MilliSatoshi(remoteBalance)
        }

        // Finally, read the optional shutdown scripts.
        if err := mig25.GetOptionalUpfrontShutdownScript(
                chanBucket, localUpfrontShutdownKey, &c.LocalShutdownScript,
        ); err != nil {
                return fmt.Errorf("local shutdown script got: %w", err)
        }

        return mig25.GetOptionalUpfrontShutdownScript(
                chanBucket, remoteUpfrontShutdownKey, &c.RemoteShutdownScript,
        )
}

// PutChanInfo serializes the channel info based on the legacy boolean.
func PutChanInfo(chanBucket kvdb.RwBucket, c *OpenChannel, legacy bool) error {
        var w bytes.Buffer
        if err := mig.WriteElements(&w,
                mig.ChannelType(c.ChanType), c.ChainHash, c.FundingOutpoint,
                c.ShortChannelID, c.IsPending, c.IsInitiator,
                mig.ChannelStatus(c.ChanStatus), c.FundingBroadcastHeight,
                c.NumConfsRequired, c.ChannelFlags,
                c.IdentityPub, c.Capacity, c.TotalMSatSent,
                c.TotalMSatReceived,
        ); err != nil {
                return err
        }

        // For single funder channels that we initiated, and we have the
        // funding transaction, then write the funding txn.
        if c.FundingTxPresent() {
                if err := mig.WriteElement(&w, c.FundingTxn); err != nil {
                        return err
                }
        }

        if err := mig.WriteChanConfig(&w, &c.LocalChanCfg); err != nil {
                return err
        }
        if err := mig.WriteChanConfig(&w, &c.RemoteChanCfg); err != nil {
                return err
        }

        // Make the tlv stream based on the legacy param.
        tlvStream, err := mig26.MakeTlvStream(&c.OpenChannel, legacy)
        if err != nil {
                return err
        }

        if err := tlvStream.Encode(&w); err != nil {
                return err
        }

        if err := chanBucket.Put(chanInfoKey, w.Bytes()); err != nil {
                return err
        }

        // Finally, add optional shutdown scripts for the local and remote peer
        // if they are present.
        if err := mig25.PutOptionalUpfrontShutdownScript(
                chanBucket, localUpfrontShutdownKey, c.LocalShutdownScript,
        ); err != nil {
                return err
        }

        return mig25.PutOptionalUpfrontShutdownScript(
                chanBucket, remoteUpfrontShutdownKey, c.RemoteShutdownScript,
        )
}

1	package migration27
2
3	import (
4	"bytes"
5	"fmt"
6
7	lnwire "github.com/lightningnetwork/lnd/channeldb/migration/lnwire21"
8	mig25 "github.com/lightningnetwork/lnd/channeldb/migration25"
9	mig26 "github.com/lightningnetwork/lnd/channeldb/migration26"
10	mig "github.com/lightningnetwork/lnd/channeldb/migration_01_to_11"
11	"github.com/lightningnetwork/lnd/kvdb"
12	"github.com/lightningnetwork/lnd/tlv"
13	)
14
15	const (
16	// A tlv type definition used to serialize and deserialize a KeyLocator
17	// from the database.
18	keyLocType tlv.Type = 1
19
20	// A tlv type used to serialize and deserialize the
21	// `InitialLocalBalance` field.
22	initialLocalBalanceType tlv.Type = 2
23
24	// A tlv type used to serialize and deserialize the
25	// `InitialRemoteBalance` field.
26	initialRemoteBalanceType tlv.Type = 3
27	)
28
29	var (
30	// chanInfoKey can be accessed within the bucket for a channel
31	// (identified by its chanPoint). This key stores all the static
32	// information for a channel which is decided at the end of the
33	// funding flow.
34	chanInfoKey = []byte("chan-info-key")
35
36	// localUpfrontShutdownKey can be accessed within the bucket for a
37	// channel (identified by its chanPoint). This key stores an optional
38	// upfront shutdown script for the local peer.
39	localUpfrontShutdownKey = []byte("local-upfront-shutdown-key")
40
41	// remoteUpfrontShutdownKey can be accessed within the bucket for a
42	// channel (identified by its chanPoint). This key stores an optional
43	// upfront shutdown script for the remote peer.
44	remoteUpfrontShutdownKey = []byte("remote-upfront-shutdown-key")
45
46	// lastWasRevokeKey is a key that stores true when the last update we
47	// sent was a revocation and false when it was a commitment signature.
48	// This is nil in the case of new channels with no updates exchanged.
49	lastWasRevokeKey = []byte("last-was-revoke")
50
51	// ErrNoChanInfoFound is returned when a particular channel does not
52	// have any channels state.
53	ErrNoChanInfoFound = fmt.Errorf("no chan info found")
54	)
55
56	// OpenChannel embeds a mig26.OpenChannel with the extra update-to-date
57	// serialization and deserialization methods.
58	//
59	// NOTE: doesn't have the Packager field as it's not used in current migration.
60	type OpenChannel struct {
61	mig26.OpenChannel
62	}
63
64	// FetchChanInfo deserializes the channel info based on the legacy boolean.
65	func FetchChanInfo(chanBucket kvdb.RBucket, c *OpenChannel, legacy bool) error {	×
66	infoBytes := chanBucket.Get(chanInfoKey)	×
67	if infoBytes == nil {	×
68	return ErrNoChanInfoFound	×
69	}	×
70	r := bytes.NewReader(infoBytes)	×
71		×
72	var (	×
73	chanType mig.ChannelType	×
74	chanStatus mig.ChannelStatus	×
75	)	×
76		×
77	if err := mig.ReadElements(r,	×
78	&chanType, &c.ChainHash, &c.FundingOutpoint,	×
79	&c.ShortChannelID, &c.IsPending, &c.IsInitiator,	×
80	&chanStatus, &c.FundingBroadcastHeight,	×
81	&c.NumConfsRequired, &c.ChannelFlags,	×
82	&c.IdentityPub, &c.Capacity, &c.TotalMSatSent,	×
83	&c.TotalMSatReceived,	×
84	); err != nil {	×
85	return fmt.Errorf("ReadElements got: %w", err)	×
86	}	×
87
88	c.ChanType = mig25.ChannelType(chanType)	×
89	c.ChanStatus = mig25.ChannelStatus(chanStatus)	×
90		×
91	// For single funder channels that we initiated and have the funding	×
92	// transaction to, read the funding txn.	×
93	if c.FundingTxPresent() {	×
94	if err := mig.ReadElement(r, &c.FundingTxn); err != nil {	×
95	return fmt.Errorf("read FundingTxn got: %w", err)	×
96	}	×
97	}
98
99	if err := mig.ReadChanConfig(r, &c.LocalChanCfg); err != nil {	×
100	return fmt.Errorf("read LocalChanCfg got: %w", err)	×
101	}	×
102	if err := mig.ReadChanConfig(r, &c.RemoteChanCfg); err != nil {	×
103	return fmt.Errorf("read RemoteChanCfg got: %w", err)	×
104	}	×
105
106	// Retrieve the boolean stored under lastWasRevokeKey.
107	lastWasRevokeBytes := chanBucket.Get(lastWasRevokeKey)	×
108	if lastWasRevokeBytes == nil {	×
109	// If nothing has been stored under this key, we store false in	×
110	// the OpenChannel struct.	×
111	c.LastWasRevoke = false	×
112	} else {	×
113	// Otherwise, read the value into the LastWasRevoke field.	×
114	revokeReader := bytes.NewReader(lastWasRevokeBytes)	×
115	err := mig.ReadElements(revokeReader, &c.LastWasRevoke)	×
116	if err != nil {	×
117	return fmt.Errorf("read LastWasRevoke got: %w", err)	×
118	}	×
119	}
120
121	// Make the tlv stream based on the legacy param.
122	var (	×
123	ts *tlv.Stream	×
124	err error	×
125	localBalance uint64	×
126	remoteBalance uint64	×
127	)	×
128		×
129	keyLocRecord := mig25.MakeKeyLocRecord(	×
130	keyLocType, &c.RevocationKeyLocator,	×
131	)	×
132		×
133	// If it's legacy, create the stream with a single tlv record.	×
134	if legacy {	×
135	ts, err = tlv.NewStream(keyLocRecord)	×
136	} else {	×
137	// Otherwise, for the new format, we will encode the balance	×
138	// fields in the tlv stream too.	×
139	ts, err = tlv.NewStream(	×
140	keyLocRecord,	×
141	tlv.MakePrimitiveRecord(	×
142	initialLocalBalanceType, &localBalance,	×
143	),	×
144	tlv.MakePrimitiveRecord(	×
145	initialRemoteBalanceType, &remoteBalance,	×
146	),	×
147	)	×
148	}	×
149	if err != nil {	×
150	return fmt.Errorf("create tlv stream got: %w", err)	×
151	}	×
152
153	if err := ts.Decode(r); err != nil {	×
154	return fmt.Errorf("decode tlv stream got: %w", err)	×
155	}	×
156
157	// For the new format, attach the balance fields.
158	if !legacy {	×
159	c.InitialLocalBalance = lnwire.MilliSatoshi(localBalance)	×
160	c.InitialRemoteBalance = lnwire.MilliSatoshi(remoteBalance)	×
161	}	×
162
163	// Finally, read the optional shutdown scripts.
164	if err := mig25.GetOptionalUpfrontShutdownScript(	×
165	chanBucket, localUpfrontShutdownKey, &c.LocalShutdownScript,	×
166	); err != nil {	×
167	return fmt.Errorf("local shutdown script got: %w", err)	×
168	}	×
169
170	return mig25.GetOptionalUpfrontShutdownScript(	×
171	chanBucket, remoteUpfrontShutdownKey, &c.RemoteShutdownScript,	×
172	)	×
173	}
174
175	// PutChanInfo serializes the channel info based on the legacy boolean.
176	func PutChanInfo(chanBucket kvdb.RwBucket, c *OpenChannel, legacy bool) error {	×
177	var w bytes.Buffer	×
178	if err := mig.WriteElements(&w,	×
179	mig.ChannelType(c.ChanType), c.ChainHash, c.FundingOutpoint,	×
180	c.ShortChannelID, c.IsPending, c.IsInitiator,	×
181	mig.ChannelStatus(c.ChanStatus), c.FundingBroadcastHeight,	×
182	c.NumConfsRequired, c.ChannelFlags,	×
183	c.IdentityPub, c.Capacity, c.TotalMSatSent,	×
184	c.TotalMSatReceived,	×
185	); err != nil {	×
186	return err	×
187	}	×
188
189	// For single funder channels that we initiated, and we have the
190	// funding transaction, then write the funding txn.
191	if c.FundingTxPresent() {	×
192	if err := mig.WriteElement(&w, c.FundingTxn); err != nil {	×
193	return err	×
194	}	×
195	}
196
197	if err := mig.WriteChanConfig(&w, &c.LocalChanCfg); err != nil {	×
198	return err	×
199	}	×
200	if err := mig.WriteChanConfig(&w, &c.RemoteChanCfg); err != nil {	×
201	return err	×
202	}	×
203
204	// Make the tlv stream based on the legacy param.
205	tlvStream, err := mig26.MakeTlvStream(&c.OpenChannel, legacy)	×
206	if err != nil {	×
207	return err	×
208	}	×
209
210	if err := tlvStream.Encode(&w); err != nil {	×
211	return err	×
212	}	×
213
214	if err := chanBucket.Put(chanInfoKey, w.Bytes()); err != nil {	×
215	return err	×
216	}	×
217
218	// Finally, add optional shutdown scripts for the local and remote peer
219	// if they are present.
220	if err := mig25.PutOptionalUpfrontShutdownScript(	×
221	chanBucket, localUpfrontShutdownKey, c.LocalShutdownScript,	×
222	); err != nil {	×
223	return err	×
224	}	×
225
226	return mig25.PutOptionalUpfrontShutdownScript(	×
227	chanBucket, remoteUpfrontShutdownKey, c.RemoteShutdownScript,	×
228	)	×
229	}

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