19027031130

Committed 03 Nov 2025 07:27AM UTC coverage: 56.922% (-9.7%) from 66.639%

Build # 19027031130

Build Type

Pull #9334

github

Committed by

web-flow

Commit Message

Merge b9be11a16 into f938e40af

Pull Request Pull Request #9334: Use all valid routes during blinded path construction

Run Details

9 of 11 new or added lines in 3 files covered. (81.82%)

29175 existing lines in 461 files now uncovered.

99696 of 175144 relevant lines covered (56.92%)

1.77 hits per line

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

6.93

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

        // InboundFee is an optional TLV record that contains the fee
        // information for incoming HTLCs.
        // TODO(elle): assign normal tlv type?
        InboundFee tlv.OptionalRecordT[tlv.TlvType55555, Fee]

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

// 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]()
                inboundFee = tlv.ZeroRecordT[tlv.TlvType55555, Fee]()
        )
        typeMap, err := tlvRecords.ExtractRecords(
                &chainHash, &c.ShortChannelID, &c.BlockHeight, &c.DisabledFlags,
                &secondPeer, &c.CLTVExpiryDelta, &c.HTLCMinimumMsat,
                &c.HTLCMaximumMsat, &c.FeeBaseMsat,
                &c.FeeProportionalMillionths, &inboundFee,
                &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:ll
        }

        // If the inbound fee was encoded, set it.
        if _, ok := typeMap[c.InboundFee.TlvType()]; ok {
                c.InboundFee = tlv.SomeRecordT(inboundFee)
        }

        c.ExtraSignedFields = 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,
                )
        }

        c.InboundFee.WhenSome(func(r tlv.RecordT[tlv.TlvType55555, Fee]) {
                recordProducers = append(recordProducers, &r)
        })

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

        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
}

// SerializedSize returns the serialized size of the message in bytes.
//
// This is part of the lnwire.SizeableMessage interface.
func (c *ChannelUpdate2) SerializedSize() (uint32, error) {
        return MessageSerializedSize(c)
}

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

// A compile time check to ensure ChannelUpdate2 implements the
// lnwire.PureTLVMessage interface.
var _ PureTLVMessage = (*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	// InboundFee is an optional TLV record that contains the fee
74	// information for incoming HTLCs.
75	// TODO(elle): assign normal tlv type?
76	InboundFee tlv.OptionalRecordT[tlv.TlvType55555, Fee]
77
78	// Signature is used to validate the announced data and prove the
79	// ownership of node id.
80	Signature tlv.RecordT[tlv.TlvType160, Sig]
81
82	// Any extra fields in the signed range that we do not yet know about,
83	// but we need to keep them for signature validation and to produce a
84	// valid message.
85	ExtraSignedFields
86	}
87
88	// Encode serializes the target ChannelUpdate2 into the passed io.Writer
89	// observing the protocol version specified.
90	//
91	// This is part of the lnwire.Message interface.
UNCOV 92	func (c ChannelUpdate2) Encode(w bytes.Buffer, _ uint32) error {	×
UNCOV 93	return EncodePureTLVMessage(c, w)	×
UNCOV 94	}	×
95
96	// Decode deserializes a serialized ChannelUpdate2 stored in the passed
97	// io.Reader observing the specified protocol version.
98	//
99	// This is part of the lnwire.Message interface.
UNCOV 100	func (c *ChannelUpdate2) Decode(r io.Reader, _ uint32) error {	×
UNCOV 101	// First extract into extra opaque data.	×
UNCOV 102	var tlvRecords ExtraOpaqueData	×
UNCOV 103	if err := ReadElements(r, &tlvRecords); err != nil {	×
104	return err	×
105	}	×
106
UNCOV 107	var (	×
UNCOV 108	chainHash = tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()	×
UNCOV 109	secondPeer = tlv.ZeroRecordT[tlv.TlvType8, TrueBoolean]()	×
UNCOV 110	inboundFee = tlv.ZeroRecordT[tlv.TlvType55555, Fee]()	×
UNCOV 111	)	×
UNCOV 112	typeMap, err := tlvRecords.ExtractRecords(	×
UNCOV 113	&chainHash, &c.ShortChannelID, &c.BlockHeight, &c.DisabledFlags,	×
UNCOV 114	&secondPeer, &c.CLTVExpiryDelta, &c.HTLCMinimumMsat,	×
UNCOV 115	&c.HTLCMaximumMsat, &c.FeeBaseMsat,	×
UNCOV 116	&c.FeeProportionalMillionths, &inboundFee,	×
UNCOV 117	&c.Signature,	×
UNCOV 118	)	×
UNCOV 119	if err != nil {	×
UNCOV 120	return err	×
UNCOV 121	}	×
UNCOV 122	c.Signature.Val.ForceSchnorr()	×
UNCOV 123		×
UNCOV 124	// By default, the chain-hash is the bitcoin mainnet genesis block hash.	×
UNCOV 125	c.ChainHash.Val = *chaincfg.MainNetParams.GenesisHash	×
UNCOV 126	if _, ok := typeMap[c.ChainHash.TlvType()]; ok {	×
UNCOV 127	c.ChainHash.Val = chainHash.Val	×
UNCOV 128	}	×
129
130	// The presence of the second_peer tlv type indicates "true".
UNCOV 131	if _, ok := typeMap[c.SecondPeer.TlvType()]; ok {	×
UNCOV 132	c.SecondPeer = tlv.SomeRecordT(secondPeer)	×
UNCOV 133	}	×
134
135	// If the CLTV expiry delta was not encoded, then set it to the default
136	// value.
UNCOV 137	if _, ok := typeMap[c.CLTVExpiryDelta.TlvType()]; !ok {	×
UNCOV 138	c.CLTVExpiryDelta.Val = defaultCltvExpiryDelta	×
UNCOV 139	}	×
140
141	// If the HTLC Minimum msat was not encoded, then set it to the default
142	// value.
UNCOV 143	if _, ok := typeMap[c.HTLCMinimumMsat.TlvType()]; !ok {	×
UNCOV 144	c.HTLCMinimumMsat.Val = defaultHtlcMinMsat	×
UNCOV 145	}	×
146
147	// If the base fee was not encoded, then set it to the default value.
UNCOV 148	if _, ok := typeMap[c.FeeBaseMsat.TlvType()]; !ok {	×
UNCOV 149	c.FeeBaseMsat.Val = defaultFeeBaseMsat	×
UNCOV 150	}	×
151
152	// If the proportional fee was not encoded, then set it to the default
153	// value.
UNCOV 154	if _, ok := typeMap[c.FeeProportionalMillionths.TlvType()]; !ok {	×
UNCOV 155	c.FeeProportionalMillionths.Val = defaultFeeProportionalMillionths //nolint:ll	×
UNCOV 156	}	×
157
158	// If the inbound fee was encoded, set it.
UNCOV 159	if _, ok := typeMap[c.InboundFee.TlvType()]; ok {	×
UNCOV 160	c.InboundFee = tlv.SomeRecordT(inboundFee)	×
UNCOV 161	}	×
162
UNCOV 163	c.ExtraSignedFields = ExtraSignedFieldsFromTypeMap(typeMap)	×
UNCOV 164		×
UNCOV 165	return nil	×
166	}
167
168	// AllRecords returns all the TLV records for the message. This will include all
169	// the records we know about along with any that we don't know about but that
170	// fall in the signed TLV range.
171	//
172	// NOTE: this is part of the PureTLVMessage interface.
UNCOV 173	func (c *ChannelUpdate2) AllRecords() []tlv.Record {	×
UNCOV 174	var recordProducers []tlv.RecordProducer	×
UNCOV 175		×
UNCOV 176	// The chain-hash record is only included if it is _not_ equal to the	×
UNCOV 177	// bitcoin mainnet genisis block hash.	×
UNCOV 178	if !c.ChainHash.Val.IsEqual(chaincfg.MainNetParams.GenesisHash) {	×
UNCOV 179	hash := tlv.ZeroRecordT[tlv.TlvType0, [32]byte]()	×
UNCOV 180	hash.Val = c.ChainHash.Val	×
UNCOV 181		×
UNCOV 182	recordProducers = append(recordProducers, &hash)	×
UNCOV 183	}	×
184
UNCOV 185	recordProducers = append(recordProducers,	×
UNCOV 186	&c.ShortChannelID, &c.BlockHeight, &c.Signature,	×
UNCOV 187	)	×
UNCOV 188		×
UNCOV 189	// Only include the disable flags if any bit is set.	×
UNCOV 190	if !c.DisabledFlags.Val.IsEnabled() {	×
UNCOV 191	recordProducers = append(recordProducers, &c.DisabledFlags)	×
UNCOV 192	}	×
193
194	// We only need to encode the second peer boolean if it is true
UNCOV 195	c.SecondPeer.WhenSome(func(r tlv.RecordT[tlv.TlvType8, TrueBoolean]) {	×
UNCOV 196	recordProducers = append(recordProducers, &r)	×
UNCOV 197	})	×
198
199	// We only encode the cltv expiry delta if it is not equal to the
200	// default.
UNCOV 201	if c.CLTVExpiryDelta.Val != defaultCltvExpiryDelta {	×
UNCOV 202	recordProducers = append(recordProducers, &c.CLTVExpiryDelta)	×
UNCOV 203	}	×
204
UNCOV 205	if c.HTLCMinimumMsat.Val != defaultHtlcMinMsat {	×
UNCOV 206	recordProducers = append(recordProducers, &c.HTLCMinimumMsat)	×
UNCOV 207	}	×
208
UNCOV 209	recordProducers = append(recordProducers, &c.HTLCMaximumMsat)	×
UNCOV 210		×
UNCOV 211	if c.FeeBaseMsat.Val != defaultFeeBaseMsat {	×
UNCOV 212	recordProducers = append(recordProducers, &c.FeeBaseMsat)	×
UNCOV 213	}	×
214
UNCOV 215	if c.FeeProportionalMillionths.Val != defaultFeeProportionalMillionths {	×
UNCOV 216	recordProducers = append(	×
UNCOV 217	recordProducers, &c.FeeProportionalMillionths,	×
UNCOV 218	)	×
UNCOV 219	}	×
220
UNCOV 221	c.InboundFee.WhenSome(func(r tlv.RecordT[tlv.TlvType55555, Fee]) {	×
UNCOV 222	recordProducers = append(recordProducers, &r)	×
UNCOV 223	})	×
224
UNCOV 225	recordProducers = append(recordProducers, RecordsAsProducers(	×
UNCOV 226	tlv.MapToRecords(c.ExtraSignedFields),	×
UNCOV 227	)...)	×
UNCOV 228		×
UNCOV 229	return ProduceRecordsSorted(recordProducers...)	×
230	}
231
232	// MsgType returns the integer uniquely identifying this message type on the
233	// wire.
234	//
235	// This is part of the lnwire.Message interface.
UNCOV 236	func (c *ChannelUpdate2) MsgType() MessageType {	×
UNCOV 237	return MsgChannelUpdate2	×
UNCOV 238	}	×
239
240	// SerializedSize returns the serialized size of the message in bytes.
241	//
242	// This is part of the lnwire.SizeableMessage interface.
243	func (c *ChannelUpdate2) SerializedSize() (uint32, error) {	×
244	return MessageSerializedSize(c)	×
245	}	×
246
247	// A compile time check to ensure ChannelUpdate2 implements the
248	// lnwire.Message interface.
249	var _ Message = (*ChannelUpdate2)(nil)
250
251	// A compile time check to ensure ChannelUpdate2 implements the
252	// lnwire.PureTLVMessage interface.
253	var _ PureTLVMessage = (*ChannelUpdate2)(nil)
254
255	// SCID returns the ShortChannelID of the channel that the update applies to.
256	//
257	// NOTE: this is part of the ChannelUpdate interface.
258	func (c *ChannelUpdate2) SCID() ShortChannelID {	×
259	return c.ShortChannelID.Val	×
260	}	×
261
262	// IsNode1 is true if the update was produced by node 1 of the channel peers.
263	// Node 1 is the node with the lexicographically smaller public key.
264	//
265	// NOTE: this is part of the ChannelUpdate interface.
266	func (c *ChannelUpdate2) IsNode1() bool {	×
267	return c.SecondPeer.IsNone()	×
268	}	×
269
270	// IsDisabled is true if the update is announcing that the channel should be
271	// considered disabled.
272	//
273	// NOTE: this is part of the ChannelUpdate interface.
274	func (c *ChannelUpdate2) IsDisabled() bool {	×
275	return !c.DisabledFlags.Val.IsEnabled()	×
276	}	×
277
278	// GetChainHash returns the hash of the chain that the message is referring to.
279	//
280	// NOTE: this is part of the ChannelUpdate interface.
281	func (c *ChannelUpdate2) GetChainHash() chainhash.Hash {	×
282	return c.ChainHash.Val	×
283	}	×
284
285	// ForwardingPolicy returns the set of forwarding constraints of the update.
286	//
287	// NOTE: this is part of the ChannelUpdate interface.
288	func (c ChannelUpdate2) ForwardingPolicy() ForwardingPolicy {	×
289	return &ForwardingPolicy{	×
290	TimeLockDelta: c.CLTVExpiryDelta.Val,	×
291	BaseFee: MilliSatoshi(c.FeeBaseMsat.Val),	×
292	FeeRate: MilliSatoshi(c.FeeProportionalMillionths.Val),	×
293	MinHTLC: c.HTLCMinimumMsat.Val,	×
294	HasMaxHTLC: true,	×
295	MaxHTLC: c.HTLCMaximumMsat.Val,	×
296	}	×
297	}	×
298
299	// CmpAge can be used to determine if the update is older or newer than the
300	// passed update. It returns 1 if this update is newer, -1 if it is older, and
301	// 0 if they are the same age.
302	//
303	// NOTE: this is part of the ChannelUpdate interface.
304	func (c *ChannelUpdate2) CmpAge(update ChannelUpdate) (CompareResult, error) {	×
305	other, ok := update.(*ChannelUpdate2)	×
306	if !ok {	×
307	return 0, fmt.Errorf("expected *ChannelUpdate2, got: %T",	×
308	update)	×
309	}	×
310
311	switch {	×
312	case c.BlockHeight.Val > other.BlockHeight.Val:	×
313	return GreaterThan, nil	×
314	case c.BlockHeight.Val < other.BlockHeight.Val:	×
315	return LessThan, nil	×
316	default:	×
317	return EqualTo, nil	×
318	}
319	}
320
321	// SetDisabledFlag can be used to adjust the disabled flag of an update.
322	//
323	// NOTE: this is part of the ChannelUpdate interface.
324	func (c *ChannelUpdate2) SetDisabledFlag(disabled bool) {	×
325	if disabled {	×
326	c.DisabledFlags.Val \|= ChanUpdateDisableIncoming	×
327	c.DisabledFlags.Val \|= ChanUpdateDisableOutgoing	×
328	} else {	×
329	c.DisabledFlags.Val &^= ChanUpdateDisableIncoming	×
330	c.DisabledFlags.Val &^= ChanUpdateDisableOutgoing	×
331	}	×
332	}
333
334	// SetSCID can be used to overwrite the SCID of the update.
335	//
336	// NOTE: this is part of the ChannelUpdate interface.
337	func (c *ChannelUpdate2) SetSCID(scid ShortChannelID) {	×
338	c.ShortChannelID.Val = scid	×
339	}	×
340
341	// A compile time check to ensure ChannelUpdate2 implements the
342	// lnwire.ChannelUpdate interface.
343	var _ ChannelUpdate = (*ChannelUpdate2)(nil)
344
345	// ChanUpdateDisableFlags is a bit vector that can be used to indicate various
346	// reasons for the channel being marked as disabled.
347	type ChanUpdateDisableFlags uint8
348
349	const (
350	// ChanUpdateDisableIncoming is a bit indicates that a channel is
351	// disabled in the inbound direction meaning that the node broadcasting
352	// the update is communicating that they cannot receive funds.
353	ChanUpdateDisableIncoming ChanUpdateDisableFlags = 1 << iota
354
355	// ChanUpdateDisableOutgoing is a bit indicates that a channel is
356	// disabled in the outbound direction meaning that the node broadcasting
357	// the update is communicating that they cannot send or route funds.
358	ChanUpdateDisableOutgoing = 2
359	)
360
361	// IncomingDisabled returns true if the ChanUpdateDisableIncoming bit is set.
362	func (c ChanUpdateDisableFlags) IncomingDisabled() bool {	×
363	return c&ChanUpdateDisableIncoming == ChanUpdateDisableIncoming	×
364	}	×
365
366	// OutgoingDisabled returns true if the ChanUpdateDisableOutgoing bit is set.
367	func (c ChanUpdateDisableFlags) OutgoingDisabled() bool {	×
368	return c&ChanUpdateDisableOutgoing == ChanUpdateDisableOutgoing	×
369	}	×
370
371	// IsEnabled returns true if none of the disable bits are set.
UNCOV 372	func (c ChanUpdateDisableFlags) IsEnabled() bool {	×
UNCOV 373	return c == 0	×
UNCOV 374	}	×
375
376	// String returns the bitfield flags as a string.
377	func (c ChanUpdateDisableFlags) String() string {	×
378	return fmt.Sprintf("%08b", c)	×
379	}	×
380
381	// Record returns the tlv record for the disable flags.
UNCOV 382	func (c *ChanUpdateDisableFlags) Record() tlv.Record {	×
UNCOV 383	return tlv.MakeStaticRecord(0, c, 1, encodeDisableFlags,	×
UNCOV 384	decodeDisableFlags)	×
UNCOV 385	}	×
386
UNCOV 387	func encodeDisableFlags(w io.Writer, val interface{}, buf *[8]byte) error {	×
UNCOV 388	if v, ok := val.(*ChanUpdateDisableFlags); ok {	×
UNCOV 389	flagsInt := uint8(*v)	×
UNCOV 390		×
UNCOV 391	return tlv.EUint8(w, &flagsInt, buf)	×
UNCOV 392	}	×
393
394	return tlv.NewTypeForEncodingErr(val, "lnwire.ChanUpdateDisableFlags")	×
395	}
396
397	func decodeDisableFlags(r io.Reader, val interface{}, buf *[8]byte,
UNCOV 398	l uint64) error {	×
UNCOV 399		×
UNCOV 400	if v, ok := val.(*ChanUpdateDisableFlags); ok {	×
UNCOV 401	var flagsInt uint8	×
UNCOV 402	err := tlv.DUint8(r, &flagsInt, buf, l)	×
UNCOV 403	if err != nil {	×
404	return err	×
405	}	×
406
UNCOV 407	*v = ChanUpdateDisableFlags(flagsInt)	×
UNCOV 408		×
UNCOV 409	return nil	×
410	}
411
412	return tlv.NewTypeForDecodingErr(val, "lnwire.ChanUpdateDisableFlags",	×
413	l, l)	×
414	}
415
416	// TrueBoolean is a record that indicates true or false using the presence of
417	// the record. If the record is absent, it indicates false. If it is present,
418	// it indicates true.
419	type TrueBoolean struct{}
420
421	// Record returns the tlv record for the boolean entry.
422	func (b *TrueBoolean) Record() tlv.Record {	3✔
423	return tlv.MakeStaticRecord(	3✔
424	0, b, 0, booleanEncoder, booleanDecoder,	3✔
425	)	3✔
426	}	3✔
427
428	func booleanEncoder(_ io.Writer, val interface{}, _ *[8]byte) error {	3✔
429	if _, ok := val.(*TrueBoolean); ok {	6✔
430	return nil	3✔
431	}	3✔
432
433	return tlv.NewTypeForEncodingErr(val, "TrueBoolean")	×
434	}
435
436	func booleanDecoder(_ io.Reader, val interface{}, _ *[8]byte,
437	l uint64) error {	2✔
438		2✔
439	if _, ok := val.(*TrueBoolean); ok && (l == 0 \|\| l == 1) {	4✔
440	return nil	2✔
441	}	2✔
442
443	return tlv.NewTypeForEncodingErr(val, "TrueBoolean")	×
444	}

lightningnetwork / lnd / 19027031130

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