12115442155

Committed 02 Dec 2024 08:28AM UTC coverage: 48.662% (-10.3%) from 58.948%

Build # 12115442155

Build Type

Pull #9175

github

Committed by

ellemouton

Commit Message

netann: update ChanAnn2 validation to work for P2WSH channels

This commit expands the ChannelAnnouncement2 validation for the case
where it is announcing a P2WSH channel.

Pull Request Pull Request #9175: lnwire+netann: update structure of g175 messages to be pure TLV

Run Details

6 of 314 new or added lines in 9 files covered. (1.91%)

27532 existing lines in 434 files now uncovered.

97890 of 201164 relevant lines covered (48.66%)

0.52 hits per line

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

7.04

/lnwire/channel_update_2.go

package lnwire

import (
        "bytes"
        "fmt"
        "io"

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

const (
        defaultCltvExpiryDelta           = uint16(80)
        defaultHtlcMinMsat               = MilliSatoshi(1)
        defaultFeeBaseMsat               = uint32(1000)
        defaultFeeProportionalMillionths = uint32(1)
)

// ChannelUpdate2 message is used after taproot channel has been initially
// announced. Each side independently announces its fees and minimum expiry for
// HTLCs and other parameters. This message is also used to redeclare initially
// set channel parameters.
type ChannelUpdate2 struct {
        // ChainHash denotes the target chain that this channel was opened
        // within. This value should be the genesis hash of the target chain.
        // Along with the short channel ID, this uniquely identifies the
        // channel globally in a blockchain.
        ChainHash tlv.RecordT[tlv.TlvType0, chainhash.Hash]

        // ShortChannelID is the unique description of the funding transaction.
        ShortChannelID tlv.RecordT[tlv.TlvType2, ShortChannelID]

        // BlockHeight allows ordering in the case of multiple announcements. We
        // should ignore the message if block height is not greater than the
        // last-received. The block height must always be greater or equal to
        // the block height that the channel funding transaction was confirmed
        // in.
        BlockHeight tlv.RecordT[tlv.TlvType4, uint32]

        // DisabledFlags is an optional bitfield that describes various reasons
        // that the node is communicating that the channel should be considered
        // disabled.
        DisabledFlags tlv.RecordT[tlv.TlvType6, ChanUpdateDisableFlags]

        // SecondPeer is used to indicate which node the channel node has
        // created and signed this message. If this field is present, it was
        // node 2 otherwise it was node 1.
        SecondPeer tlv.OptionalRecordT[tlv.TlvType8, TrueBoolean]

        // CLTVExpiryDelta is the minimum number of blocks this node requires to
        // be added to the expiry of HTLCs. This is a security parameter
        // determined by the node operator. This value represents the required
        // gap between the time locks of the incoming and outgoing HTLC's set
        // to this node.
        CLTVExpiryDelta tlv.RecordT[tlv.TlvType10, uint16]

        // HTLCMinimumMsat is the minimum HTLC value which will be accepted.
        HTLCMinimumMsat tlv.RecordT[tlv.TlvType12, MilliSatoshi]

        // HtlcMaximumMsat is the maximum HTLC value which will be accepted.
        HTLCMaximumMsat tlv.RecordT[tlv.TlvType14, MilliSatoshi]

        // FeeBaseMsat is the base fee that must be used for incoming HTLC's to
        // this particular channel. This value will be tacked onto the required
        // for a payment independent of the size of the payment.
        FeeBaseMsat tlv.RecordT[tlv.TlvType16, uint32]

        // FeeProportionalMillionths is the fee rate that will be charged per
        // millionth of a satoshi.
        FeeProportionalMillionths tlv.RecordT[tlv.TlvType18, uint32]

        // Signature is used to validate the announced data and prove the
        // ownership of node id.
        Signature tlv.RecordT[tlv.TlvType160, Sig]

        // Any extra fields in the signed range that we do not yet know about,
        // but we need to keep them for signature validation and to produce a
        // valid message.
        ExtraFieldsInSignedRange map[uint64][]byte
}

// Encode serializes the target ChannelUpdate2 into the passed io.Writer
// observing the protocol version specified.
//
// This is part of the lnwire.Message interface.
func (c *ChannelUpdate2) Encode(w *bytes.Buffer, _ uint32) error {
        return EncodePureTLVMessage(c, w)
}

// Decode deserializes a serialized ChannelUpdate2 stored in the passed
// io.Reader observing the specified protocol version.
//
// This is part of the lnwire.Message interface.
func (c *ChannelUpdate2) Decode(r io.Reader, _ uint32) error {
        // First extract into extra opaque data.
        var tlvRecords ExtraOpaqueData
        if err := ReadElements(r, &tlvRecords); err != nil {
                return err
        }

        var (
                chainHash  = tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()
                secondPeer = tlv.ZeroRecordT[tlv.TlvType8, TrueBoolean]()
        )
        typeMap, err := tlvRecords.ExtractRecords(
                &chainHash, &c.ShortChannelID, &c.BlockHeight, &c.DisabledFlags,
                &secondPeer, &c.CLTVExpiryDelta, &c.HTLCMinimumMsat,
                &c.HTLCMaximumMsat, &c.FeeBaseMsat,
                &c.FeeProportionalMillionths,
                &c.Signature,
        )
        if err != nil {
                return err
        }
        c.Signature.Val.ForceSchnorr()

        // By default, the chain-hash is the bitcoin mainnet genesis block hash.
        c.ChainHash.Val = *chaincfg.MainNetParams.GenesisHash
        if _, ok := typeMap[c.ChainHash.TlvType()]; ok {
                c.ChainHash.Val = chainHash.Val
        }

        // The presence of the second_peer tlv type indicates "true".
        if _, ok := typeMap[c.SecondPeer.TlvType()]; ok {
                c.SecondPeer = tlv.SomeRecordT(secondPeer)
        }

        // If the CLTV expiry delta was not encoded, then set it to the default
        // value.
        if _, ok := typeMap[c.CLTVExpiryDelta.TlvType()]; !ok {
                c.CLTVExpiryDelta.Val = defaultCltvExpiryDelta
        }

        // If the HTLC Minimum msat was not encoded, then set it to the default
        // value.
        if _, ok := typeMap[c.HTLCMinimumMsat.TlvType()]; !ok {
                c.HTLCMinimumMsat.Val = defaultHtlcMinMsat
        }

        // If the base fee was not encoded, then set it to the default value.
        if _, ok := typeMap[c.FeeBaseMsat.TlvType()]; !ok {
                c.FeeBaseMsat.Val = defaultFeeBaseMsat
        }

        // If the proportional fee was not encoded, then set it to the default
        // value.
        if _, ok := typeMap[c.FeeProportionalMillionths.TlvType()]; !ok {
                c.FeeProportionalMillionths.Val = defaultFeeProportionalMillionths //nolint:lll
        }

        c.ExtraFieldsInSignedRange = ExtraSignedFieldsFromTypeMap(typeMap)

        return nil
}

// AllRecords returns all the TLV records for the message. This will include all
// the records we know about along with any that we don't know about but that
// fall in the signed TLV range.
//
// NOTE: this is part of the PureTLVMessage interface.
func (c *ChannelUpdate2) AllRecords() []tlv.Record {
        var recordProducers []tlv.RecordProducer

        // The chain-hash record is only included if it is _not_ equal to the
        // bitcoin mainnet genisis block hash.
        if !c.ChainHash.Val.IsEqual(chaincfg.MainNetParams.GenesisHash) {
                hash := tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()
                hash.Val = c.ChainHash.Val

                recordProducers = append(recordProducers, &hash)
        }

        recordProducers = append(recordProducers,
                &c.ShortChannelID, &c.BlockHeight, &c.Signature,
        )

        // Only include the disable flags if any bit is set.
        if !c.DisabledFlags.Val.IsEnabled() {
                recordProducers = append(recordProducers, &c.DisabledFlags)
        }

        // We only need to encode the second peer boolean if it is true
        c.SecondPeer.WhenSome(func(r tlv.RecordT[tlv.TlvType8, TrueBoolean]) {
                recordProducers = append(recordProducers, &r)
        })

        // We only encode the cltv expiry delta if it is not equal to the
        // default.
        if c.CLTVExpiryDelta.Val != defaultCltvExpiryDelta {
                recordProducers = append(recordProducers, &c.CLTVExpiryDelta)
        }

        if c.HTLCMinimumMsat.Val != defaultHtlcMinMsat {
                recordProducers = append(recordProducers, &c.HTLCMinimumMsat)
        }

        recordProducers = append(recordProducers, &c.HTLCMaximumMsat)

        if c.FeeBaseMsat.Val != defaultFeeBaseMsat {
                recordProducers = append(recordProducers, &c.FeeBaseMsat)
        }

        if c.FeeProportionalMillionths.Val != defaultFeeProportionalMillionths {
                recordProducers = append(
                        recordProducers, &c.FeeProportionalMillionths,
                )
        }

        recordProducers = append(recordProducers, RecordsAsProducers(
                tlv.MapToRecords(c.ExtraFieldsInSignedRange),
        )...)

        return ProduceRecordsSorted(recordProducers...)
}

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

func (c *ChannelUpdate2) ExtraData() (ExtraOpaqueData, error) {
        var buf *bytes.Buffer
        err := EncodeRecordsTo(buf, tlv.MapToRecords(c.ExtraFieldsInSignedRange))
        if err != nil {
                return nil, err
        }

        return buf.Bytes(), nil
}

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

// SCID returns the ShortChannelID of the channel that the update applies to.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) SCID() ShortChannelID {
        return c.ShortChannelID.Val
}

// IsNode1 is true if the update was produced by node 1 of the channel peers.
// Node 1 is the node with the lexicographically smaller public key.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) IsNode1() bool {
        return c.SecondPeer.IsNone()
}

// IsDisabled is true if the update is announcing that the channel should be
// considered disabled.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) IsDisabled() bool {
        return !c.DisabledFlags.Val.IsEnabled()
}

// GetChainHash returns the hash of the chain that the message is referring to.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) GetChainHash() chainhash.Hash {
        return c.ChainHash.Val
}

// ForwardingPolicy returns the set of forwarding constraints of the update.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) ForwardingPolicy() *ForwardingPolicy {
        return &ForwardingPolicy{
                TimeLockDelta: c.CLTVExpiryDelta.Val,
                BaseFee:       MilliSatoshi(c.FeeBaseMsat.Val),
                FeeRate:       MilliSatoshi(c.FeeProportionalMillionths.Val),
                MinHTLC:       c.HTLCMinimumMsat.Val,
                HasMaxHTLC:    true,
                MaxHTLC:       c.HTLCMaximumMsat.Val,
        }
}

// CmpAge can be used to determine if the update is older or newer than the
// passed update. It returns 1 if this update is newer, -1 if it is older, and
// 0 if they are the same age.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) CmpAge(update ChannelUpdate) (CompareResult, error) {
        other, ok := update.(*ChannelUpdate2)
        if !ok {
                return 0, fmt.Errorf("expected *ChannelUpdate2, got: %T",
                        update)
        }

        switch {
        case c.BlockHeight.Val > other.BlockHeight.Val:
                return GreaterThan, nil
        case c.BlockHeight.Val < other.BlockHeight.Val:
                return LessThan, nil
        default:
                return EqualTo, nil
        }
}

// SetDisabledFlag can be used to adjust the disabled flag of an update.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) SetDisabledFlag(disabled bool) {
        if disabled {
                c.DisabledFlags.Val |= ChanUpdateDisableIncoming
                c.DisabledFlags.Val |= ChanUpdateDisableOutgoing
        } else {
                c.DisabledFlags.Val &^= ChanUpdateDisableIncoming
                c.DisabledFlags.Val &^= ChanUpdateDisableOutgoing
        }
}

// SetSCID can be used to overwrite the SCID of the update.
//
// NOTE: this is part of the ChannelUpdate interface.
func (c *ChannelUpdate2) SetSCID(scid ShortChannelID) {
        c.ShortChannelID.Val = scid
}

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

// ChanUpdateDisableFlags is a bit vector that can be used to indicate various
// reasons for the channel being marked as disabled.
type ChanUpdateDisableFlags uint8

const (
        // ChanUpdateDisableIncoming is a bit indicates that a channel is
        // disabled in the inbound direction meaning that the node broadcasting
        // the update is communicating that they cannot receive funds.
        ChanUpdateDisableIncoming ChanUpdateDisableFlags = 1 << iota

        // ChanUpdateDisableOutgoing is a bit indicates that a channel is
        // disabled in the outbound direction meaning that the node broadcasting
        // the update is communicating that they cannot send or route funds.
        ChanUpdateDisableOutgoing = 2
)

// IncomingDisabled returns true if the ChanUpdateDisableIncoming bit is set.
func (c ChanUpdateDisableFlags) IncomingDisabled() bool {
        return c&ChanUpdateDisableIncoming == ChanUpdateDisableIncoming
}

// OutgoingDisabled returns true if the ChanUpdateDisableOutgoing bit is set.
func (c ChanUpdateDisableFlags) OutgoingDisabled() bool {
        return c&ChanUpdateDisableOutgoing == ChanUpdateDisableOutgoing
}

// IsEnabled returns true if none of the disable bits are set.
func (c ChanUpdateDisableFlags) IsEnabled() bool {
        return c == 0
}

// String returns the bitfield flags as a string.
func (c ChanUpdateDisableFlags) String() string {
        return fmt.Sprintf("%08b", c)
}

// Record returns the tlv record for the disable flags.
func (c *ChanUpdateDisableFlags) Record() tlv.Record {
        return tlv.MakeStaticRecord(0, c, 1, encodeDisableFlags,
                decodeDisableFlags)
}

func encodeDisableFlags(w io.Writer, val interface{}, buf *[8]byte) error {
        if v, ok := val.(*ChanUpdateDisableFlags); ok {
                flagsInt := uint8(*v)

                return tlv.EUint8(w, &flagsInt, buf)
        }

        return tlv.NewTypeForEncodingErr(val, "lnwire.ChanUpdateDisableFlags")
}

func decodeDisableFlags(r io.Reader, val interface{}, buf *[8]byte,
        l uint64) error {

        if v, ok := val.(*ChanUpdateDisableFlags); ok {
                var flagsInt uint8
                err := tlv.DUint8(r, &flagsInt, buf, l)
                if err != nil {
                        return err
                }

                *v = ChanUpdateDisableFlags(flagsInt)

                return nil
        }

        return tlv.NewTypeForDecodingErr(val, "lnwire.ChanUpdateDisableFlags",
                l, l)
}

// TrueBoolean is a record that indicates true or false using the presence of
// the record. If the record is absent, it indicates false. If it is present,
// it indicates true.
type TrueBoolean struct{}

// Record returns the tlv record for the boolean entry.
func (b *TrueBoolean) Record() tlv.Record {
        return tlv.MakeStaticRecord(
                0, b, 0, booleanEncoder, booleanDecoder,
        )
}

func booleanEncoder(_ io.Writer, val interface{}, _ *[8]byte) error {
        if _, ok := val.(*TrueBoolean); ok {
                return nil
        }

        return tlv.NewTypeForEncodingErr(val, "TrueBoolean")
}

func booleanDecoder(_ io.Reader, val interface{}, _ *[8]byte,
        l uint64) error {

        if _, ok := val.(*TrueBoolean); ok && (l == 0 || l == 1) {
                return nil
        }

        return tlv.NewTypeForEncodingErr(val, "TrueBoolean")
}

1	package lnwire
2
3	import (
4	"bytes"
5	"fmt"
6	"io"
7
8	"github.com/btcsuite/btcd/chaincfg"
9	"github.com/btcsuite/btcd/chaincfg/chainhash"
10	"github.com/lightningnetwork/lnd/tlv"
11	)
12
13	const (
14	defaultCltvExpiryDelta = uint16(80)
15	defaultHtlcMinMsat = MilliSatoshi(1)
16	defaultFeeBaseMsat = uint32(1000)
17	defaultFeeProportionalMillionths = uint32(1)
18	)
19
20	// ChannelUpdate2 message is used after taproot channel has been initially
21	// announced. Each side independently announces its fees and minimum expiry for
22	// HTLCs and other parameters. This message is also used to redeclare initially
23	// set channel parameters.
24	type ChannelUpdate2 struct {
25	// ChainHash denotes the target chain that this channel was opened
26	// within. This value should be the genesis hash of the target chain.
27	// Along with the short channel ID, this uniquely identifies the
28	// channel globally in a blockchain.
29	ChainHash tlv.RecordT[tlv.TlvType0, chainhash.Hash]
30
31	// ShortChannelID is the unique description of the funding transaction.
32	ShortChannelID tlv.RecordT[tlv.TlvType2, ShortChannelID]
33
34	// BlockHeight allows ordering in the case of multiple announcements. We
35	// should ignore the message if block height is not greater than the
36	// last-received. The block height must always be greater or equal to
37	// the block height that the channel funding transaction was confirmed
38	// in.
39	BlockHeight tlv.RecordT[tlv.TlvType4, uint32]
40
41	// DisabledFlags is an optional bitfield that describes various reasons
42	// that the node is communicating that the channel should be considered
43	// disabled.
44	DisabledFlags tlv.RecordT[tlv.TlvType6, ChanUpdateDisableFlags]
45
46	// SecondPeer is used to indicate which node the channel node has
47	// created and signed this message. If this field is present, it was
48	// node 2 otherwise it was node 1.
49	SecondPeer tlv.OptionalRecordT[tlv.TlvType8, TrueBoolean]
50
51	// CLTVExpiryDelta is the minimum number of blocks this node requires to
52	// be added to the expiry of HTLCs. This is a security parameter
53	// determined by the node operator. This value represents the required
54	// gap between the time locks of the incoming and outgoing HTLC's set
55	// to this node.
56	CLTVExpiryDelta tlv.RecordT[tlv.TlvType10, uint16]
57
58	// HTLCMinimumMsat is the minimum HTLC value which will be accepted.
59	HTLCMinimumMsat tlv.RecordT[tlv.TlvType12, MilliSatoshi]
60
61	// HtlcMaximumMsat is the maximum HTLC value which will be accepted.
62	HTLCMaximumMsat tlv.RecordT[tlv.TlvType14, MilliSatoshi]
63
64	// FeeBaseMsat is the base fee that must be used for incoming HTLC's to
65	// this particular channel. This value will be tacked onto the required
66	// for a payment independent of the size of the payment.
67	FeeBaseMsat tlv.RecordT[tlv.TlvType16, uint32]
68
69	// FeeProportionalMillionths is the fee rate that will be charged per
70	// millionth of a satoshi.
71	FeeProportionalMillionths tlv.RecordT[tlv.TlvType18, uint32]
72
73	// Signature is used to validate the announced data and prove the
74	// ownership of node id.
75	Signature tlv.RecordT[tlv.TlvType160, Sig]
76
77	// Any extra fields in the signed range that we do not yet know about,
78	// but we need to keep them for signature validation and to produce a
79	// valid message.
80	ExtraFieldsInSignedRange map[uint64][]byte
81	}
82
83	// Encode serializes the target ChannelUpdate2 into the passed io.Writer
84	// observing the protocol version specified.
85	//
86	// This is part of the lnwire.Message interface.
NEW 87	func (c ChannelUpdate2) Encode(w bytes.Buffer, _ uint32) error {	×
NEW 88	return EncodePureTLVMessage(c, w)	×
UNCOV 89	}	×
90
91	// Decode deserializes a serialized ChannelUpdate2 stored in the passed
92	// io.Reader observing the specified protocol version.
93	//
94	// This is part of the lnwire.Message interface.
UNCOV 95	func (c *ChannelUpdate2) Decode(r io.Reader, _ uint32) error {	×
UNCOV 96	// First extract into extra opaque data.	×
UNCOV 97	var tlvRecords ExtraOpaqueData	×
UNCOV 98	if err := ReadElements(r, &tlvRecords); err != nil {	×
99	return err	×
100	}	×
101
UNCOV 102	var (	×
UNCOV 103	chainHash = tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()	×
UNCOV 104	secondPeer = tlv.ZeroRecordT[tlv.TlvType8, TrueBoolean]()	×
UNCOV 105	)	×
UNCOV 106	typeMap, err := tlvRecords.ExtractRecords(	×
UNCOV 107	&chainHash, &c.ShortChannelID, &c.BlockHeight, &c.DisabledFlags,	×
UNCOV 108	&secondPeer, &c.CLTVExpiryDelta, &c.HTLCMinimumMsat,	×
UNCOV 109	&c.HTLCMaximumMsat, &c.FeeBaseMsat,	×
UNCOV 110	&c.FeeProportionalMillionths,	×
NEW 111	&c.Signature,	×
UNCOV 112	)	×
UNCOV 113	if err != nil {	×
114	return err	×
115	}	×
NEW 116	c.Signature.Val.ForceSchnorr()	×
UNCOV 117		×
UNCOV 118	// By default, the chain-hash is the bitcoin mainnet genesis block hash.	×
UNCOV 119	c.ChainHash.Val = *chaincfg.MainNetParams.GenesisHash	×
UNCOV 120	if _, ok := typeMap[c.ChainHash.TlvType()]; ok {	×
UNCOV 121	c.ChainHash.Val = chainHash.Val	×
UNCOV 122	}	×
123
124	// The presence of the second_peer tlv type indicates "true".
UNCOV 125	if _, ok := typeMap[c.SecondPeer.TlvType()]; ok {	×
UNCOV 126	c.SecondPeer = tlv.SomeRecordT(secondPeer)	×
UNCOV 127	}	×
128
129	// If the CLTV expiry delta was not encoded, then set it to the default
130	// value.
UNCOV 131	if _, ok := typeMap[c.CLTVExpiryDelta.TlvType()]; !ok {	×
UNCOV 132	c.CLTVExpiryDelta.Val = defaultCltvExpiryDelta	×
UNCOV 133	}	×
134
135	// If the HTLC Minimum msat was not encoded, then set it to the default
136	// value.
UNCOV 137	if _, ok := typeMap[c.HTLCMinimumMsat.TlvType()]; !ok {	×
UNCOV 138	c.HTLCMinimumMsat.Val = defaultHtlcMinMsat	×
UNCOV 139	}	×
140
141	// If the base fee was not encoded, then set it to the default value.
UNCOV 142	if _, ok := typeMap[c.FeeBaseMsat.TlvType()]; !ok {	×
UNCOV 143	c.FeeBaseMsat.Val = defaultFeeBaseMsat	×
UNCOV 144	}	×
145
146	// If the proportional fee was not encoded, then set it to the default
147	// value.
UNCOV 148	if _, ok := typeMap[c.FeeProportionalMillionths.TlvType()]; !ok {	×
UNCOV 149	c.FeeProportionalMillionths.Val = defaultFeeProportionalMillionths //nolint:lll	×
UNCOV 150	}	×
151
NEW 152	c.ExtraFieldsInSignedRange = ExtraSignedFieldsFromTypeMap(typeMap)	×
UNCOV 153		×
UNCOV 154	return nil	×
155	}
156
157	// AllRecords returns all the TLV records for the message. This will include all
158	// the records we know about along with any that we don't know about but that
159	// fall in the signed TLV range.
160	//
161	// NOTE: this is part of the PureTLVMessage interface.
NEW 162	func (c *ChannelUpdate2) AllRecords() []tlv.Record {	×
NEW 163	var recordProducers []tlv.RecordProducer	×
UNCOV 164		×
UNCOV 165	// The chain-hash record is only included if it is _not_ equal to the	×
UNCOV 166	// bitcoin mainnet genisis block hash.	×
UNCOV 167	if !c.ChainHash.Val.IsEqual(chaincfg.MainNetParams.GenesisHash) {	×
UNCOV 168	hash := tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()	×
UNCOV 169	hash.Val = c.ChainHash.Val	×
UNCOV 170		×
UNCOV 171	recordProducers = append(recordProducers, &hash)	×
UNCOV 172	}	×
173
UNCOV 174	recordProducers = append(recordProducers,	×
NEW 175	&c.ShortChannelID, &c.BlockHeight, &c.Signature,	×
UNCOV 176	)	×
UNCOV 177		×
UNCOV 178	// Only include the disable flags if any bit is set.	×
UNCOV 179	if !c.DisabledFlags.Val.IsEnabled() {	×
UNCOV 180	recordProducers = append(recordProducers, &c.DisabledFlags)	×
UNCOV 181	}	×
182
183	// We only need to encode the second peer boolean if it is true
UNCOV 184	c.SecondPeer.WhenSome(func(r tlv.RecordT[tlv.TlvType8, TrueBoolean]) {	×
UNCOV 185	recordProducers = append(recordProducers, &r)	×
UNCOV 186	})	×
187
188	// We only encode the cltv expiry delta if it is not equal to the
189	// default.
UNCOV 190	if c.CLTVExpiryDelta.Val != defaultCltvExpiryDelta {	×
UNCOV 191	recordProducers = append(recordProducers, &c.CLTVExpiryDelta)	×
UNCOV 192	}	×
193
UNCOV 194	if c.HTLCMinimumMsat.Val != defaultHtlcMinMsat {	×
UNCOV 195	recordProducers = append(recordProducers, &c.HTLCMinimumMsat)	×
UNCOV 196	}	×
197
UNCOV 198	recordProducers = append(recordProducers, &c.HTLCMaximumMsat)	×
UNCOV 199		×
UNCOV 200	if c.FeeBaseMsat.Val != defaultFeeBaseMsat {	×
UNCOV 201	recordProducers = append(recordProducers, &c.FeeBaseMsat)	×
UNCOV 202	}	×
203
UNCOV 204	if c.FeeProportionalMillionths.Val != defaultFeeProportionalMillionths {	×
UNCOV 205	recordProducers = append(	×
UNCOV 206	recordProducers, &c.FeeProportionalMillionths,	×
UNCOV 207	)	×
UNCOV 208	}	×
209
NEW 210	recordProducers = append(recordProducers, RecordsAsProducers(	×
NEW 211	tlv.MapToRecords(c.ExtraFieldsInSignedRange),	×
NEW 212	)...)	×
UNCOV 213		×
NEW 214	return ProduceRecordsSorted(recordProducers...)	×
215	}
216
217	// MsgType returns the integer uniquely identifying this message type on the
218	// wire.
219	//
220	// This is part of the lnwire.Message interface.
UNCOV 221	func (c *ChannelUpdate2) MsgType() MessageType {	×
UNCOV 222	return MsgChannelUpdate2	×
UNCOV 223	}	×
224
NEW 225	func (c *ChannelUpdate2) ExtraData() (ExtraOpaqueData, error) {	×
NEW 226	var buf *bytes.Buffer	×
NEW 227	err := EncodeRecordsTo(buf, tlv.MapToRecords(c.ExtraFieldsInSignedRange))	×
NEW 228	if err != nil {	×
NEW 229	return nil, err	×
NEW 230	}	×
231
NEW 232	return buf.Bytes(), nil	×
233	}
234
235	// A compile time check to ensure ChannelUpdate2 implements the
236	// lnwire.Message interface.
237	var _ Message = (*ChannelUpdate2)(nil)
238
239	// SCID returns the ShortChannelID of the channel that the update applies to.
240	//
241	// NOTE: this is part of the ChannelUpdate interface.
242	func (c *ChannelUpdate2) SCID() ShortChannelID {	×
243	return c.ShortChannelID.Val	×
244	}	×
245
246	// IsNode1 is true if the update was produced by node 1 of the channel peers.
247	// Node 1 is the node with the lexicographically smaller public key.
248	//
249	// NOTE: this is part of the ChannelUpdate interface.
250	func (c *ChannelUpdate2) IsNode1() bool {	×
251	return c.SecondPeer.IsNone()	×
252	}	×
253
254	// IsDisabled is true if the update is announcing that the channel should be
255	// considered disabled.
256	//
257	// NOTE: this is part of the ChannelUpdate interface.
258	func (c *ChannelUpdate2) IsDisabled() bool {	×
259	return !c.DisabledFlags.Val.IsEnabled()	×
260	}	×
261
262	// GetChainHash returns the hash of the chain that the message is referring to.
263	//
264	// NOTE: this is part of the ChannelUpdate interface.
265	func (c *ChannelUpdate2) GetChainHash() chainhash.Hash {	×
266	return c.ChainHash.Val	×
267	}	×
268
269	// ForwardingPolicy returns the set of forwarding constraints of the update.
270	//
271	// NOTE: this is part of the ChannelUpdate interface.
272	func (c ChannelUpdate2) ForwardingPolicy() ForwardingPolicy {	×
273	return &ForwardingPolicy{	×
274	TimeLockDelta: c.CLTVExpiryDelta.Val,	×
275	BaseFee: MilliSatoshi(c.FeeBaseMsat.Val),	×
276	FeeRate: MilliSatoshi(c.FeeProportionalMillionths.Val),	×
277	MinHTLC: c.HTLCMinimumMsat.Val,	×
278	HasMaxHTLC: true,	×
279	MaxHTLC: c.HTLCMaximumMsat.Val,	×
280	}	×
281	}	×
282
283	// CmpAge can be used to determine if the update is older or newer than the
284	// passed update. It returns 1 if this update is newer, -1 if it is older, and
285	// 0 if they are the same age.
286	//
287	// NOTE: this is part of the ChannelUpdate interface.
288	func (c *ChannelUpdate2) CmpAge(update ChannelUpdate) (CompareResult, error) {	×
289	other, ok := update.(*ChannelUpdate2)	×
290	if !ok {	×
291	return 0, fmt.Errorf("expected *ChannelUpdate2, got: %T",	×
292	update)	×
293	}	×
294
295	switch {	×
296	case c.BlockHeight.Val > other.BlockHeight.Val:	×
297	return GreaterThan, nil	×
298	case c.BlockHeight.Val < other.BlockHeight.Val:	×
299	return LessThan, nil	×
300	default:	×
301	return EqualTo, nil	×
302	}
303	}
304
305	// SetDisabledFlag can be used to adjust the disabled flag of an update.
306	//
307	// NOTE: this is part of the ChannelUpdate interface.
308	func (c *ChannelUpdate2) SetDisabledFlag(disabled bool) {	×
309	if disabled {	×
310	c.DisabledFlags.Val \|= ChanUpdateDisableIncoming	×
311	c.DisabledFlags.Val \|= ChanUpdateDisableOutgoing	×
312	} else {	×
313	c.DisabledFlags.Val &^= ChanUpdateDisableIncoming	×
314	c.DisabledFlags.Val &^= ChanUpdateDisableOutgoing	×
315	}	×
316	}
317
318	// SetSCID can be used to overwrite the SCID of the update.
319	//
320	// NOTE: this is part of the ChannelUpdate interface.
321	func (c *ChannelUpdate2) SetSCID(scid ShortChannelID) {	×
322	c.ShortChannelID.Val = scid	×
323	}	×
324
325	// A compile time check to ensure ChannelUpdate2 implements the
326	// lnwire.ChannelUpdate interface.
327	var _ ChannelUpdate = (*ChannelUpdate2)(nil)
328
329	// ChanUpdateDisableFlags is a bit vector that can be used to indicate various
330	// reasons for the channel being marked as disabled.
331	type ChanUpdateDisableFlags uint8
332
333	const (
334	// ChanUpdateDisableIncoming is a bit indicates that a channel is
335	// disabled in the inbound direction meaning that the node broadcasting
336	// the update is communicating that they cannot receive funds.
337	ChanUpdateDisableIncoming ChanUpdateDisableFlags = 1 << iota
338
339	// ChanUpdateDisableOutgoing is a bit indicates that a channel is
340	// disabled in the outbound direction meaning that the node broadcasting
341	// the update is communicating that they cannot send or route funds.
342	ChanUpdateDisableOutgoing = 2
343	)
344
345	// IncomingDisabled returns true if the ChanUpdateDisableIncoming bit is set.
346	func (c ChanUpdateDisableFlags) IncomingDisabled() bool {	×
347	return c&ChanUpdateDisableIncoming == ChanUpdateDisableIncoming	×
348	}	×
349
350	// OutgoingDisabled returns true if the ChanUpdateDisableOutgoing bit is set.
351	func (c ChanUpdateDisableFlags) OutgoingDisabled() bool {	×
352	return c&ChanUpdateDisableOutgoing == ChanUpdateDisableOutgoing	×
353	}	×
354
355	// IsEnabled returns true if none of the disable bits are set.
UNCOV 356	func (c ChanUpdateDisableFlags) IsEnabled() bool {	×
UNCOV 357	return c == 0	×
UNCOV 358	}	×
359
360	// String returns the bitfield flags as a string.
361	func (c ChanUpdateDisableFlags) String() string {	×
362	return fmt.Sprintf("%08b", c)	×
363	}	×
364
365	// Record returns the tlv record for the disable flags.
UNCOV 366	func (c *ChanUpdateDisableFlags) Record() tlv.Record {	×
UNCOV 367	return tlv.MakeStaticRecord(0, c, 1, encodeDisableFlags,	×
UNCOV 368	decodeDisableFlags)	×
UNCOV 369	}	×
370
UNCOV 371	func encodeDisableFlags(w io.Writer, val interface{}, buf *[8]byte) error {	×
UNCOV 372	if v, ok := val.(*ChanUpdateDisableFlags); ok {	×
UNCOV 373	flagsInt := uint8(*v)	×
UNCOV 374		×
UNCOV 375	return tlv.EUint8(w, &flagsInt, buf)	×
UNCOV 376	}	×
377
378	return tlv.NewTypeForEncodingErr(val, "lnwire.ChanUpdateDisableFlags")	×
379	}
380
381	func decodeDisableFlags(r io.Reader, val interface{}, buf *[8]byte,
UNCOV 382	l uint64) error {	×
UNCOV 383		×
UNCOV 384	if v, ok := val.(*ChanUpdateDisableFlags); ok {	×
UNCOV 385	var flagsInt uint8	×
UNCOV 386	err := tlv.DUint8(r, &flagsInt, buf, l)	×
UNCOV 387	if err != nil {	×
388	return err	×
389	}	×
390
UNCOV 391	*v = ChanUpdateDisableFlags(flagsInt)	×
UNCOV 392		×
UNCOV 393	return nil	×
394	}
395
396	return tlv.NewTypeForDecodingErr(val, "lnwire.ChanUpdateDisableFlags",	×
397	l, l)	×
398	}
399
400	// TrueBoolean is a record that indicates true or false using the presence of
401	// the record. If the record is absent, it indicates false. If it is present,
402	// it indicates true.
403	type TrueBoolean struct{}
404
405	// Record returns the tlv record for the boolean entry.
406	func (b *TrueBoolean) Record() tlv.Record {	1✔
407	return tlv.MakeStaticRecord(	1✔
408	0, b, 0, booleanEncoder, booleanDecoder,	1✔
409	)	1✔
410	}	1✔
411
412	func booleanEncoder(_ io.Writer, val interface{}, _ *[8]byte) error {	1✔
413	if _, ok := val.(*TrueBoolean); ok {	2✔
414	return nil	1✔
415	}	1✔
416
417	return tlv.NewTypeForEncodingErr(val, "TrueBoolean")	×
418	}
419
420	func booleanDecoder(_ io.Reader, val interface{}, _ *[8]byte,
421	l uint64) error {	1✔
422		1✔
423	if _, ok := val.(*TrueBoolean); ok && (l == 0 \|\| l == 1) {	2✔
424	return nil	1✔
425	}	1✔
426
427	return tlv.NewTypeForEncodingErr(val, "TrueBoolean")	×
428	}

lightningnetwork / lnd / 12115442155

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