12058234999

Committed 27 Nov 2024 09:06PM UTC coverage: 57.847% (-1.1%) from 58.921%

Build # 12058234999

Build Type

Pull #9148

github

Committed by

ProofOfKeags

Commit Message

lnwire: convert DynPropose and DynCommit to use typed tlv records

Pull Request Pull Request #9148: DynComms [2/n]: lnwire: add authenticated wire messages for Dyn*

Run Details

142 of 177 new or added lines in 4 files covered. (80.23%)

19365 existing lines in 251 files now uncovered.

100876 of 174383 relevant lines covered (57.85%)

25338.28 hits per line

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

87.18

/lnwire/short_channel_id.go

package lnwire

import (
        "fmt"
        "io"

        "github.com/lightningnetwork/lnd/tlv"
)

const (
        // AliasScidRecordType is the type of the experimental record to denote
        // the alias being used in an option_scid_alias channel.
        AliasScidRecordType tlv.Type = 1
)

// ShortChannelID represents the set of data which is needed to retrieve all
// necessary data to validate the channel existence.
type ShortChannelID struct {
        // BlockHeight is the height of the block where funding transaction
        // located.
        //
        // NOTE: This field is limited to 3 bytes.
        BlockHeight uint32

        // TxIndex is a position of funding transaction within a block.
        //
        // NOTE: This field is limited to 3 bytes.
        TxIndex uint32

        // TxPosition indicating transaction output which pays to the channel.
        TxPosition uint16
}

// NewShortChanIDFromInt returns a new ShortChannelID which is the decoded
// version of the compact channel ID encoded within the uint64. The format of
// the compact channel ID is as follows: 3 bytes for the block height, 3 bytes
// for the transaction index, and 2 bytes for the output index.
func NewShortChanIDFromInt(chanID uint64) ShortChannelID {
        return ShortChannelID{
                BlockHeight: uint32(chanID >> 40),
                TxIndex:     uint32(chanID>>16) & 0xFFFFFF,
                TxPosition:  uint16(chanID),
        }
}

// ToUint64 converts the ShortChannelID into a compact format encoded within a
// uint64 (8 bytes).
func (c ShortChannelID) ToUint64() uint64 {
        // TODO(roasbeef): explicit error on overflow?
        return ((uint64(c.BlockHeight) << 40) | (uint64(c.TxIndex) << 16) |
                (uint64(c.TxPosition)))
}

// String generates a human-readable representation of the channel ID.
func (c ShortChannelID) String() string {
        return fmt.Sprintf("%d:%d:%d", c.BlockHeight, c.TxIndex, c.TxPosition)
}

// Record returns a TLV record that can be used to encode/decode a
// ShortChannelID to/from a TLV stream.
func (c *ShortChannelID) Record() tlv.Record {
        return tlv.MakeStaticRecord(
                AliasScidRecordType, c, 8, EShortChannelID, DShortChannelID,
        )
}

// IsDefault returns true if the ShortChannelID represents the zero value for
// its type.
func (c ShortChannelID) IsDefault() bool {
        return c == ShortChannelID{}
}

// EShortChannelID is an encoder for ShortChannelID. It is exported so other
// packages can use the encoding scheme.
func EShortChannelID(w io.Writer, val interface{}, buf *[8]byte) error {
        if v, ok := val.(*ShortChannelID); ok {
                return tlv.EUint64T(w, v.ToUint64(), buf)
        }
        return tlv.NewTypeForEncodingErr(val, "lnwire.ShortChannelID")
}

// DShortChannelID is a decoder for ShortChannelID. It is exported so other
// packages can use the decoding scheme.
func DShortChannelID(r io.Reader, val interface{}, buf *[8]byte,
        l uint64) error {

        if v, ok := val.(*ShortChannelID); ok {
                var scid uint64
                err := tlv.DUint64(r, &scid, buf, 8)
                if err != nil {
                        return err
                }

                *v = NewShortChanIDFromInt(scid)
                return nil
        }
        return tlv.NewTypeForDecodingErr(val, "lnwire.ShortChannelID", l, 8)
}

1	package lnwire
2
3	import (
4	"fmt"
5	"io"
6
7	"github.com/lightningnetwork/lnd/tlv"
8	)
9
10	const (
11	// AliasScidRecordType is the type of the experimental record to denote
12	// the alias being used in an option_scid_alias channel.
13	AliasScidRecordType tlv.Type = 1
14	)
15
16	// ShortChannelID represents the set of data which is needed to retrieve all
17	// necessary data to validate the channel existence.
18	type ShortChannelID struct {
19	// BlockHeight is the height of the block where funding transaction
20	// located.
21	//
22	// NOTE: This field is limited to 3 bytes.
23	BlockHeight uint32
24
25	// TxIndex is a position of funding transaction within a block.
26	//
27	// NOTE: This field is limited to 3 bytes.
28	TxIndex uint32
29
30	// TxPosition indicating transaction output which pays to the channel.
31	TxPosition uint16
32	}
33
34	// NewShortChanIDFromInt returns a new ShortChannelID which is the decoded
35	// version of the compact channel ID encoded within the uint64. The format of
36	// the compact channel ID is as follows: 3 bytes for the block height, 3 bytes
37	// for the transaction index, and 2 bytes for the output index.
38	func NewShortChanIDFromInt(chanID uint64) ShortChannelID {	464,500✔
39	return ShortChannelID{	464,500✔
40	BlockHeight: uint32(chanID >> 40),	464,500✔
41	TxIndex: uint32(chanID>>16) & 0xFFFFFF,	464,500✔
42	TxPosition: uint16(chanID),	464,500✔
43	}	464,500✔
44	}	464,500✔
45
46	// ToUint64 converts the ShortChannelID into a compact format encoded within a
47	// uint64 (8 bytes).
48	func (c ShortChannelID) ToUint64() uint64 {	11,564,816✔
49	// TODO(roasbeef): explicit error on overflow?	11,564,816✔
50	return ((uint64(c.BlockHeight) << 40) \| (uint64(c.TxIndex) << 16) \|	11,564,816✔
51	(uint64(c.TxPosition)))	11,564,816✔
52	}	11,564,816✔
53
54	// String generates a human-readable representation of the channel ID.
55	func (c ShortChannelID) String() string {	4,854✔
56	return fmt.Sprintf("%d:%d:%d", c.BlockHeight, c.TxIndex, c.TxPosition)	4,854✔
57	}	4,854✔
58
59	// Record returns a TLV record that can be used to encode/decode a
60	// ShortChannelID to/from a TLV stream.
61	func (c *ShortChannelID) Record() tlv.Record {	11,055✔
62	return tlv.MakeStaticRecord(	11,055✔
63	AliasScidRecordType, c, 8, EShortChannelID, DShortChannelID,	11,055✔
64	)	11,055✔
65	}	11,055✔
66
67	// IsDefault returns true if the ShortChannelID represents the zero value for
68	// its type.
UNCOV 69	func (c ShortChannelID) IsDefault() bool {	×
UNCOV 70	return c == ShortChannelID{}	×
UNCOV 71	}	×
72
73	// EShortChannelID is an encoder for ShortChannelID. It is exported so other
74	// packages can use the encoding scheme.
75	func EShortChannelID(w io.Writer, val interface{}, buf *[8]byte) error {	3,507✔
76	if v, ok := val.(*ShortChannelID); ok {	7,014✔
77	return tlv.EUint64T(w, v.ToUint64(), buf)	3,507✔
78	}	3,507✔
79	return tlv.NewTypeForEncodingErr(val, "lnwire.ShortChannelID")	×
80	}
81
82	// DShortChannelID is a decoder for ShortChannelID. It is exported so other
83	// packages can use the decoding scheme.
84	func DShortChannelID(r io.Reader, val interface{}, buf *[8]byte,
85	l uint64) error {	7,421✔
86		7,421✔
87	if v, ok := val.(*ShortChannelID); ok {	14,842✔
88	var scid uint64	7,421✔
89	err := tlv.DUint64(r, &scid, buf, 8)	7,421✔
90	if err != nil {	7,423✔
91	return err	2✔
92	}	2✔
93
94	*v = NewShortChanIDFromInt(scid)	7,419✔
95	return nil	7,419✔
96	}
97	return tlv.NewTypeForDecodingErr(val, "lnwire.ShortChannelID", l, 8)	×
98	}

lightningnetwork / lnd / 12058234999

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