11292787765

Committed 11 Oct 2024 12:58PM UTC coverage: 49.179% (-9.5%) from 58.716%

Build # 11292787765

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9168 from feelancer21/fix-lncli-wallet-proto

lnrpc: fix lncli documentation tags in walletkit.proto

Run Details

97369 of 197987 relevant lines covered (49.18%)

1.04 hits per line

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

89.74

/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 {	2✔
39	return ShortChannelID{	2✔
40	BlockHeight: uint32(chanID >> 40),	2✔
41	TxIndex: uint32(chanID>>16) & 0xFFFFFF,	2✔
42	TxPosition: uint16(chanID),	2✔
43	}	2✔
44	}	2✔
45
46	// ToUint64 converts the ShortChannelID into a compact format encoded within a
47	// uint64 (8 bytes).
48	func (c ShortChannelID) ToUint64() uint64 {	2✔
49	// TODO(roasbeef): explicit error on overflow?	2✔
50	return ((uint64(c.BlockHeight) << 40) \| (uint64(c.TxIndex) << 16) \|	2✔
51	(uint64(c.TxPosition)))	2✔
52	}	2✔
53
54	// String generates a human-readable representation of the channel ID.
55	func (c ShortChannelID) String() string {	2✔
56	return fmt.Sprintf("%d:%d:%d", c.BlockHeight, c.TxIndex, c.TxPosition)	2✔
57	}	2✔
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 {	2✔
62	return tlv.MakeStaticRecord(	2✔
63	AliasScidRecordType, c, 8, EShortChannelID, DShortChannelID,	2✔
64	)	2✔
65	}	2✔
66
67	// IsDefault returns true if the ShortChannelID represents the zero value for
68	// its type.
69	func (c ShortChannelID) IsDefault() bool {	2✔
70	return c == ShortChannelID{}	2✔
71	}	2✔
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 {	2✔
76	if v, ok := val.(*ShortChannelID); ok {	4✔
77	return tlv.EUint64T(w, v.ToUint64(), buf)	2✔
78	}	2✔
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 {	2✔
86		2✔
87	if v, ok := val.(*ShortChannelID); ok {	4✔
88	var scid uint64	2✔
89	err := tlv.DUint64(r, &scid, buf, 8)	2✔
90	if err != nil {	2✔
91	return err	×
92	}	×
93
94	*v = NewShortChanIDFromInt(scid)	2✔
95	return nil	2✔
96	}
97	return tlv.NewTypeForDecodingErr(val, "lnwire.ShortChannelID", l, 8)	×
98	}

lightningnetwork / lnd / 11292787765

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