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

lightningnetwork / lnd / 15249422085

26 May 2025 08:11AM UTC coverage: 57.977% (-11.0%) from 69.015%
15249422085

push

github

web-flow
Merge pull request #9853 from lightningnetwork/elle-graphSQL8-prep

graph/db: init SQLStore caches and batch schedulers

9 of 34 new or added lines in 4 files covered. (26.47%)

29283 existing lines in 458 files now uncovered.

96475 of 166402 relevant lines covered (57.98%)

1.22 hits per line

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

83.33
/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 {
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
// AltString generates a human-readable representation of the channel ID
60
// with 'x' as a separator.
UNCOV
61
func (c ShortChannelID) AltString() string {
×
UNCOV
62
        return fmt.Sprintf("%dx%dx%d", c.BlockHeight, c.TxIndex, c.TxPosition)
×
UNCOV
63
}
×
64

65
// Record returns a TLV record that can be used to encode/decode a
66
// ShortChannelID to/from a TLV stream.
67
func (c *ShortChannelID) Record() tlv.Record {
2✔
68
        return tlv.MakeStaticRecord(
2✔
69
                AliasScidRecordType, c, 8, EShortChannelID, DShortChannelID,
2✔
70
        )
2✔
71
}
2✔
72

73
// IsDefault returns true if the ShortChannelID represents the zero value for
74
// its type.
75
func (c ShortChannelID) IsDefault() bool {
2✔
76
        return c == ShortChannelID{}
2✔
77
}
2✔
78

79
// EShortChannelID is an encoder for ShortChannelID. It is exported so other
80
// packages can use the encoding scheme.
81
func EShortChannelID(w io.Writer, val interface{}, buf *[8]byte) error {
2✔
82
        if v, ok := val.(*ShortChannelID); ok {
4✔
83
                return tlv.EUint64T(w, v.ToUint64(), buf)
2✔
84
        }
2✔
85
        return tlv.NewTypeForEncodingErr(val, "lnwire.ShortChannelID")
×
86
}
87

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

2✔
93
        if v, ok := val.(*ShortChannelID); ok {
4✔
94
                var scid uint64
2✔
95
                err := tlv.DUint64(r, &scid, buf, 8)
2✔
96
                if err != nil {
2✔
UNCOV
97
                        return err
×
UNCOV
98
                }
×
99

100
                *v = NewShortChanIDFromInt(scid)
2✔
101
                return nil
2✔
102
        }
103
        return tlv.NewTypeForDecodingErr(val, "lnwire.ShortChannelID", l, 8)
×
104
}
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