• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

lightningnetwork / lnd / 13982721865

21 Mar 2025 01:30AM UTC coverage: 58.587% (-0.5%) from 59.126%
13982721865

Pull #9623

github

web-flow
Merge 05a6b6838 into 5d921723b
Pull Request #9623: Size msg test msg

0 of 1572 new or added lines in 43 files covered. (0.0%)

17 existing lines in 5 files now uncovered.

96767 of 165169 relevant lines covered (58.59%)

1.82 hits per line

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

40.63
/lnwire/channel_update.go
1
package lnwire
2

3
import (
4
        "bytes"
5
        "fmt"
6
        "io"
7

8
        "github.com/btcsuite/btcd/chaincfg/chainhash"
9
)
10

11
// ChanUpdateMsgFlags is a bitfield that signals whether optional fields are
12
// present in the ChannelUpdate.
13
type ChanUpdateMsgFlags uint8
14

15
const (
16
        // ChanUpdateRequiredMaxHtlc is a bit that indicates whether the
17
        // required htlc_maximum_msat field is present in this ChannelUpdate.
18
        ChanUpdateRequiredMaxHtlc ChanUpdateMsgFlags = 1 << iota
19
)
20

21
// String returns the bitfield flags as a string.
22
func (c ChanUpdateMsgFlags) String() string {
3✔
23
        return fmt.Sprintf("%08b", c)
3✔
24
}
3✔
25

26
// HasMaxHtlc returns true if the htlc_maximum_msat option bit is set in the
27
// message flags.
28
func (c ChanUpdateMsgFlags) HasMaxHtlc() bool {
3✔
29
        return c&ChanUpdateRequiredMaxHtlc != 0
3✔
30
}
3✔
31

32
// ChanUpdateChanFlags is a bitfield that signals various options concerning a
33
// particular channel edge. Each bit is to be examined in order to determine
34
// how the ChannelUpdate message is to be interpreted.
35
type ChanUpdateChanFlags uint8
36

37
const (
38
        // ChanUpdateDirection indicates the direction of a channel update. If
39
        // this bit is set to 0 if Node1 (the node with the "smaller" Node ID)
40
        // is updating the channel, and to 1 otherwise.
41
        ChanUpdateDirection ChanUpdateChanFlags = 1 << iota
42

43
        // ChanUpdateDisabled is a bit that indicates if the channel edge
44
        // selected by the ChanUpdateDirection bit is to be treated as being
45
        // disabled.
46
        ChanUpdateDisabled
47
)
48

49
// IsDisabled determines whether the channel flags has the disabled bit set.
50
func (c ChanUpdateChanFlags) IsDisabled() bool {
3✔
51
        return c&ChanUpdateDisabled == ChanUpdateDisabled
3✔
52
}
3✔
53

54
// String returns the bitfield flags as a string.
55
func (c ChanUpdateChanFlags) String() string {
3✔
56
        return fmt.Sprintf("%08b", c)
3✔
57
}
3✔
58

59
// ChannelUpdate1 message is used after channel has been initially announced.
60
// Each side independently announces its fees and minimum expiry for HTLCs and
61
// other parameters. Also this message is used to redeclare initially set
62
// channel parameters.
63
type ChannelUpdate1 struct {
64
        // Signature is used to validate the announced data and prove the
65
        // ownership of node id.
66
        Signature Sig
67

68
        // ChainHash denotes the target chain that this channel was opened
69
        // within. This value should be the genesis hash of the target chain.
70
        // Along with the short channel ID, this uniquely identifies the
71
        // channel globally in a blockchain.
72
        ChainHash chainhash.Hash
73

74
        // ShortChannelID is the unique description of the funding transaction.
75
        ShortChannelID ShortChannelID
76

77
        // Timestamp allows ordering in the case of multiple announcements. We
78
        // should ignore the message if timestamp is not greater than
79
        // the last-received.
80
        Timestamp uint32
81

82
        // MessageFlags is a bitfield that describes whether optional fields
83
        // are present in this update. Currently, the least-significant bit
84
        // must be set to 1 if the optional field MaxHtlc is present.
85
        MessageFlags ChanUpdateMsgFlags
86

87
        // ChannelFlags is a bitfield that describes additional meta-data
88
        // concerning how the update is to be interpreted. Currently, the
89
        // least-significant bit must be set to 0 if the creating node
90
        // corresponds to the first node in the previously sent channel
91
        // announcement and 1 otherwise. If the second bit is set, then the
92
        // channel is set to be disabled.
93
        ChannelFlags ChanUpdateChanFlags
94

95
        // TimeLockDelta is the minimum number of blocks this node requires to
96
        // be added to the expiry of HTLCs. This is a security parameter
97
        // determined by the node operator. This value represents the required
98
        // gap between the time locks of the incoming and outgoing HTLC's set
99
        // to this node.
100
        TimeLockDelta uint16
101

102
        // HtlcMinimumMsat is the minimum HTLC value which will be accepted.
103
        HtlcMinimumMsat MilliSatoshi
104

105
        // BaseFee is the base fee that must be used for incoming HTLC's to
106
        // this particular channel. This value will be tacked onto the required
107
        // for a payment independent of the size of the payment.
108
        BaseFee uint32
109

110
        // FeeRate is the fee rate that will be charged per millionth of a
111
        // satoshi.
112
        FeeRate uint32
113

114
        // HtlcMaximumMsat is the maximum HTLC value which will be accepted.
115
        HtlcMaximumMsat MilliSatoshi
116

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

123
// A compile time check to ensure ChannelUpdate implements the lnwire.Message
124
// interface.
125
var _ Message = (*ChannelUpdate1)(nil)
126

127
// A compile time check to ensure ChannelUpdate1 implements the
128
// lnwire.SizeableMessage interface.
129
var _ SizeableMessage = (*ChannelUpdate1)(nil)
130

131
// Decode deserializes a serialized ChannelUpdate stored in the passed
132
// io.Reader observing the specified protocol version.
133
//
134
// This is part of the lnwire.Message interface.
135
func (a *ChannelUpdate1) Decode(r io.Reader, pver uint32) error {
3✔
136
        err := ReadElements(r,
3✔
137
                &a.Signature,
3✔
138
                a.ChainHash[:],
3✔
139
                &a.ShortChannelID,
3✔
140
                &a.Timestamp,
3✔
141
                &a.MessageFlags,
3✔
142
                &a.ChannelFlags,
3✔
143
                &a.TimeLockDelta,
3✔
144
                &a.HtlcMinimumMsat,
3✔
145
                &a.BaseFee,
3✔
146
                &a.FeeRate,
3✔
147
        )
3✔
148
        if err != nil {
3✔
149
                return err
×
150
        }
×
151

152
        // Now check whether the max HTLC field is present and read it if so.
153
        if a.MessageFlags.HasMaxHtlc() {
6✔
154
                if err := ReadElements(r, &a.HtlcMaximumMsat); err != nil {
3✔
155
                        return err
×
156
                }
×
157
        }
158

159
        return a.ExtraOpaqueData.Decode(r)
3✔
160
}
161

162
// Encode serializes the target ChannelUpdate into the passed io.Writer
163
// observing the protocol version specified.
164
//
165
// This is part of the lnwire.Message interface.
166
func (a *ChannelUpdate1) Encode(w *bytes.Buffer, pver uint32) error {
3✔
167
        if err := WriteSig(w, a.Signature); err != nil {
3✔
168
                return err
×
169
        }
×
170

171
        if err := WriteBytes(w, a.ChainHash[:]); err != nil {
3✔
172
                return err
×
173
        }
×
174

175
        if err := WriteShortChannelID(w, a.ShortChannelID); err != nil {
3✔
176
                return err
×
177
        }
×
178

179
        if err := WriteUint32(w, a.Timestamp); err != nil {
3✔
180
                return err
×
181
        }
×
182

183
        if err := WriteChanUpdateMsgFlags(w, a.MessageFlags); err != nil {
3✔
184
                return err
×
185
        }
×
186

187
        if err := WriteChanUpdateChanFlags(w, a.ChannelFlags); err != nil {
3✔
188
                return err
×
189
        }
×
190

191
        if err := WriteUint16(w, a.TimeLockDelta); err != nil {
3✔
192
                return err
×
193
        }
×
194

195
        if err := WriteMilliSatoshi(w, a.HtlcMinimumMsat); err != nil {
3✔
196
                return err
×
197
        }
×
198

199
        if err := WriteUint32(w, a.BaseFee); err != nil {
3✔
200
                return err
×
201
        }
×
202

203
        if err := WriteUint32(w, a.FeeRate); err != nil {
3✔
204
                return err
×
205
        }
×
206

207
        // Now append optional fields if they are set. Currently, the only
208
        // optional field is max HTLC.
209
        if a.MessageFlags.HasMaxHtlc() {
6✔
210
                err := WriteMilliSatoshi(w, a.HtlcMaximumMsat)
3✔
211
                if err != nil {
3✔
212
                        return err
×
213
                }
×
214
        }
215

216
        // Finally, append any extra opaque data.
217
        return WriteBytes(w, a.ExtraOpaqueData)
3✔
218
}
219

220
// MsgType returns the integer uniquely identifying this message type on the
221
// wire.
222
//
223
// This is part of the lnwire.Message interface.
224
func (a *ChannelUpdate1) MsgType() MessageType {
3✔
225
        return MsgChannelUpdate
3✔
226
}
3✔
227

228
// DataToSign is used to retrieve part of the announcement message which should
229
// be signed.
230
func (a *ChannelUpdate1) DataToSign() ([]byte, error) {
3✔
231
        // We should not include the signatures itself.
3✔
232
        b := make([]byte, 0, MaxMsgBody)
3✔
233
        buf := bytes.NewBuffer(b)
3✔
234
        if err := WriteBytes(buf, a.ChainHash[:]); err != nil {
3✔
235
                return nil, err
×
236
        }
×
237

238
        if err := WriteShortChannelID(buf, a.ShortChannelID); err != nil {
3✔
239
                return nil, err
×
240
        }
×
241

242
        if err := WriteUint32(buf, a.Timestamp); err != nil {
3✔
243
                return nil, err
×
244
        }
×
245

246
        if err := WriteChanUpdateMsgFlags(buf, a.MessageFlags); err != nil {
3✔
247
                return nil, err
×
248
        }
×
249

250
        if err := WriteChanUpdateChanFlags(buf, a.ChannelFlags); err != nil {
3✔
251
                return nil, err
×
252
        }
×
253

254
        if err := WriteUint16(buf, a.TimeLockDelta); err != nil {
3✔
255
                return nil, err
×
256
        }
×
257

258
        if err := WriteMilliSatoshi(buf, a.HtlcMinimumMsat); err != nil {
3✔
259
                return nil, err
×
260
        }
×
261

262
        if err := WriteUint32(buf, a.BaseFee); err != nil {
3✔
263
                return nil, err
×
264
        }
×
265

266
        if err := WriteUint32(buf, a.FeeRate); err != nil {
3✔
267
                return nil, err
×
268
        }
×
269

270
        // Now append optional fields if they are set. Currently, the only
271
        // optional field is max HTLC.
272
        if a.MessageFlags.HasMaxHtlc() {
6✔
273
                err := WriteMilliSatoshi(buf, a.HtlcMaximumMsat)
3✔
274
                if err != nil {
3✔
275
                        return nil, err
×
276
                }
×
277
        }
278

279
        // Finally, append any extra opaque data.
280
        if err := WriteBytes(buf, a.ExtraOpaqueData); err != nil {
3✔
281
                return nil, err
×
282
        }
×
283

284
        return buf.Bytes(), nil
3✔
285
}
286

287
// SCID returns the ShortChannelID of the channel that the update applies to.
288
//
289
// NOTE: this is part of the ChannelUpdate interface.
290
func (a *ChannelUpdate1) SCID() ShortChannelID {
×
291
        return a.ShortChannelID
×
292
}
×
293

294
// IsNode1 is true if the update was produced by node 1 of the channel peers.
295
// Node 1 is the node with the lexicographically smaller public key.
296
//
297
// NOTE: this is part of the ChannelUpdate interface.
298
func (a *ChannelUpdate1) IsNode1() bool {
×
299
        return a.ChannelFlags&ChanUpdateDirection == 0
×
300
}
×
301

302
// IsDisabled is true if the update is announcing that the channel should be
303
// considered disabled.
304
//
305
// NOTE: this is part of the ChannelUpdate interface.
306
func (a *ChannelUpdate1) IsDisabled() bool {
×
307
        return a.ChannelFlags&ChanUpdateDisabled == ChanUpdateDisabled
×
308
}
×
309

310
// GetChainHash returns the hash of the chain that the message is referring to.
311
//
312
// NOTE: this is part of the ChannelUpdate interface.
313
func (a *ChannelUpdate1) GetChainHash() chainhash.Hash {
×
314
        return a.ChainHash
×
315
}
×
316

317
// ForwardingPolicy returns the set of forwarding constraints of the update.
318
//
319
// NOTE: this is part of the ChannelUpdate interface.
320
func (a *ChannelUpdate1) ForwardingPolicy() *ForwardingPolicy {
×
321
        return &ForwardingPolicy{
×
322
                TimeLockDelta: a.TimeLockDelta,
×
323
                BaseFee:       MilliSatoshi(a.BaseFee),
×
324
                FeeRate:       MilliSatoshi(a.FeeRate),
×
325
                MinHTLC:       a.HtlcMinimumMsat,
×
326
                HasMaxHTLC:    a.MessageFlags.HasMaxHtlc(),
×
327
                MaxHTLC:       a.HtlcMaximumMsat,
×
328
        }
×
329
}
×
330

331
// CmpAge can be used to determine if the update is older or newer than the
332
// passed update. It returns 1 if this update is newer, -1 if it is older, and
333
// 0 if they are the same age.
334
//
335
// NOTE: this is part of the ChannelUpdate interface.
336
func (a *ChannelUpdate1) CmpAge(update ChannelUpdate) (CompareResult, error) {
×
337
        other, ok := update.(*ChannelUpdate1)
×
338
        if !ok {
×
339
                return 0, fmt.Errorf("expected *ChannelUpdate1, got: %T",
×
340
                        update)
×
341
        }
×
342

343
        switch {
×
344
        case a.Timestamp > other.Timestamp:
×
345
                return GreaterThan, nil
×
346
        case a.Timestamp < other.Timestamp:
×
347
                return LessThan, nil
×
348
        default:
×
349
                return EqualTo, nil
×
350
        }
351
}
352

353
// SetDisabledFlag can be used to adjust the disabled flag of an update.
354
//
355
// NOTE: this is part of the ChannelUpdate interface.
356
func (a *ChannelUpdate1) SetDisabledFlag(disabled bool) {
×
357
        if disabled {
×
358
                a.ChannelFlags |= ChanUpdateDisabled
×
359
        } else {
×
360
                a.ChannelFlags &= ^ChanUpdateDisabled
×
361
        }
×
362
}
363

364
// SetSCID can be used to overwrite the SCID of the update.
365
//
366
// NOTE: this is part of the ChannelUpdate interface.
367
func (a *ChannelUpdate1) SetSCID(scid ShortChannelID) {
×
368
        a.ShortChannelID = scid
×
369
}
×
370

371
// A compile time assertion to ensure ChannelUpdate1 implements the
372
// ChannelUpdate interface.
373
var _ ChannelUpdate = (*ChannelUpdate1)(nil)
374

375
// SerializedSize returns the serialized size of the message in bytes.
376
//
377
// This is part of the lnwire.SizeableMessage interface.
NEW
378
func (a *ChannelUpdate1) SerializedSize() (uint32, error) {
×
NEW
379
        return MessageSerializedSize(a)
×
NEW
380
}
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc