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

lightningnetwork / lnd / 12293715361

12 Dec 2024 09:38AM UTC coverage: 57.483% (+7.9%) from 49.538%
12293715361

Pull #9348

github

ziggie1984
github: update goveralls tool

The goverall tool had a bug regarding the module versioning of
golang packages see also
https://github.com/mattn/goveralls/pull/222 for more background.
Goveralls is wrapped by another library to make it available for
github actions. So the relevant PR which is referenced here in
LND is:
https://github.com/shogo82148/actions-goveralls/pull/521.
Pull Request #9348: github: update goveralls tool

101897 of 177264 relevant lines covered (57.48%)

24982.4 hits per line

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

87.18
/lnwire/short_channel_id.go
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 {
495,895✔
39
        return ShortChannelID{
495,895✔
40
                BlockHeight: uint32(chanID >> 40),
495,895✔
41
                TxIndex:     uint32(chanID>>16) & 0xFFFFFF,
495,895✔
42
                TxPosition:  uint16(chanID),
495,895✔
43
        }
495,895✔
44
}
495,895✔
45

46
// ToUint64 converts the ShortChannelID into a compact format encoded within a
47
// uint64 (8 bytes).
48
func (c ShortChannelID) ToUint64() uint64 {
12,417,052✔
49
        // TODO(roasbeef): explicit error on overflow?
12,417,052✔
50
        return ((uint64(c.BlockHeight) << 40) | (uint64(c.TxIndex) << 16) |
12,417,052✔
51
                (uint64(c.TxPosition)))
12,417,052✔
52
}
12,417,052✔
53

54
// String generates a human-readable representation of the channel ID.
55
func (c ShortChannelID) String() string {
4,906✔
56
        return fmt.Sprintf("%d:%d:%d", c.BlockHeight, c.TxIndex, c.TxPosition)
4,906✔
57
}
4,906✔
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,168✔
62
        return tlv.MakeStaticRecord(
11,168✔
63
                AliasScidRecordType, c, 8, EShortChannelID, DShortChannelID,
11,168✔
64
        )
11,168✔
65
}
11,168✔
66

67
// IsDefault returns true if the ShortChannelID represents the zero value for
68
// its type.
69
func (c ShortChannelID) IsDefault() bool {
×
70
        return c == ShortChannelID{}
×
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,535✔
76
        if v, ok := val.(*ShortChannelID); ok {
7,070✔
77
                return tlv.EUint64T(w, v.ToUint64(), buf)
3,535✔
78
        }
3,535✔
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,501✔
86

7,501✔
87
        if v, ok := val.(*ShortChannelID); ok {
15,002✔
88
                var scid uint64
7,501✔
89
                err := tlv.DUint64(r, &scid, buf, 8)
7,501✔
90
                if err != nil {
7,503✔
91
                        return err
2✔
92
                }
2✔
93

94
                *v = NewShortChanIDFromInt(scid)
7,499✔
95
                return nil
7,499✔
96
        }
97
        return tlv.NewTypeForDecodingErr(val, "lnwire.ShortChannelID", l, 8)
×
98
}
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