15155511119

Committed 21 May 2025 06:52AM UTC coverage: 57.389% (-11.6%) from 68.996%

Build # 15155511119

Build Type

Pull #9844

github

Committed by

web-flow

Commit Message

Merge 8658c8597 into c52a6ddeb

Pull Request Pull Request #9844: Refactor Payment PR 3

Run Details

346 of 493 new or added lines in 4 files covered. (70.18%)

30172 existing lines in 456 files now uncovered.

95441 of 166305 relevant lines covered (57.39%)

0.61 hits per line

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

55.68

/graph/db/addr.go

package graphdb

import (
        "encoding/binary"
        "errors"
        "fmt"
        "io"
        "net"

        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/tor"
)

// addressType specifies the network protocol and version that should be used
// when connecting to a node at a particular address.
type addressType uint8

const (
        // tcp4Addr denotes an IPv4 TCP address.
        tcp4Addr addressType = 0

        // tcp6Addr denotes an IPv6 TCP address.
        tcp6Addr addressType = 1

        // v2OnionAddr denotes a version 2 Tor onion service address.
        v2OnionAddr addressType = 2

        // v3OnionAddr denotes a version 3 Tor (prop224) onion service address.
        v3OnionAddr addressType = 3

        // opaqueAddrs denotes an address (or a set of addresses) that LND was
        // not able to parse since LND is not yet aware of the address type.
        opaqueAddrs addressType = 4
)

// encodeTCPAddr serializes a TCP address into its compact raw bytes
// representation.
func encodeTCPAddr(w io.Writer, addr *net.TCPAddr) error {
        var (
                addrType byte
                ip       []byte
        )

        if addr.IP.To4() != nil {
                addrType = byte(tcp4Addr)
                ip = addr.IP.To4()
        } else {
                addrType = byte(tcp6Addr)
                ip = addr.IP.To16()
        }

        if ip == nil {
                return fmt.Errorf("unable to encode IP %v", addr.IP)
        }

        if _, err := w.Write([]byte{addrType}); err != nil {
                return err
        }

        if _, err := w.Write(ip); err != nil {
                return err
        }

        var port [2]byte
        byteOrder.PutUint16(port[:], uint16(addr.Port))
        if _, err := w.Write(port[:]); err != nil {
                return err
        }

        return nil
}

// encodeOnionAddr serializes an onion address into its compact raw bytes
// representation.
func encodeOnionAddr(w io.Writer, addr *tor.OnionAddr) error {
        var suffixIndex int
        hostLen := len(addr.OnionService)
        switch hostLen {
        case tor.V2Len:
                if _, err := w.Write([]byte{byte(v2OnionAddr)}); err != nil {
                        return err
                }
                suffixIndex = tor.V2Len - tor.OnionSuffixLen
        case tor.V3Len:
                if _, err := w.Write([]byte{byte(v3OnionAddr)}); err != nil {
                        return err
                }
                suffixIndex = tor.V3Len - tor.OnionSuffixLen
        default:
                return errors.New("unknown onion service length")
        }

        suffix := addr.OnionService[suffixIndex:]
        if suffix != tor.OnionSuffix {
                return fmt.Errorf("invalid suffix \"%v\"", suffix)
        }

        host, err := tor.Base32Encoding.DecodeString(
                addr.OnionService[:suffixIndex],
        )
        if err != nil {
                return err
        }

        // Sanity check the decoded length.
        switch {
        case hostLen == tor.V2Len && len(host) != tor.V2DecodedLen:
                return fmt.Errorf("onion service %v decoded to invalid host %x",
                        addr.OnionService, host)

        case hostLen == tor.V3Len && len(host) != tor.V3DecodedLen:
                return fmt.Errorf("onion service %v decoded to invalid host %x",
                        addr.OnionService, host)
        }

        if _, err := w.Write(host); err != nil {
                return err
        }

        var port [2]byte
        byteOrder.PutUint16(port[:], uint16(addr.Port))
        if _, err := w.Write(port[:]); err != nil {
                return err
        }

        return nil
}

// encodeOpaqueAddrs serializes the lnwire.OpaqueAddrs type to a raw set of
// bytes that we will persist.
func encodeOpaqueAddrs(w io.Writer, addr *lnwire.OpaqueAddrs) error {
        // Write the type byte.
        if _, err := w.Write([]byte{byte(opaqueAddrs)}); err != nil {
                return err
        }

        // Write the length of the payload.
        var l [2]byte
        binary.BigEndian.PutUint16(l[:], uint16(len(addr.Payload)))
        if _, err := w.Write(l[:]); err != nil {
                return err
        }

        // Write the payload.
        _, err := w.Write(addr.Payload)

        return err
}

// DeserializeAddr reads the serialized raw representation of an address and
// deserializes it into the actual address. This allows us to avoid address
// resolution within the channeldb package.
func DeserializeAddr(r io.Reader) (net.Addr, error) {
        var addrType [1]byte
        if _, err := r.Read(addrType[:]); err != nil {
                return nil, err
        }

        var address net.Addr
        switch addressType(addrType[0]) {
        case tcp4Addr:
                var ip [4]byte
                if _, err := r.Read(ip[:]); err != nil {
                        return nil, err
                }

                var port [2]byte
                if _, err := r.Read(port[:]); err != nil {
                        return nil, err
                }

                address = &net.TCPAddr{
                        IP:   net.IP(ip[:]),
                        Port: int(binary.BigEndian.Uint16(port[:])),
                }

        case tcp6Addr:
                var ip [16]byte
                if _, err := r.Read(ip[:]); err != nil {
                        return nil, err
                }

                var port [2]byte
                if _, err := r.Read(port[:]); err != nil {
                        return nil, err
                }

                address = &net.TCPAddr{
                        IP:   net.IP(ip[:]),
                        Port: int(binary.BigEndian.Uint16(port[:])),
                }

        case v2OnionAddr:
                var h [tor.V2DecodedLen]byte
                if _, err := r.Read(h[:]); err != nil {
                        return nil, err
                }

                var p [2]byte
                if _, err := r.Read(p[:]); err != nil {
                        return nil, err
                }

                onionService := tor.Base32Encoding.EncodeToString(h[:])
                onionService += tor.OnionSuffix
                port := int(binary.BigEndian.Uint16(p[:]))

                address = &tor.OnionAddr{
                        OnionService: onionService,
                        Port:         port,
                }

        case v3OnionAddr:
                var h [tor.V3DecodedLen]byte
                if _, err := r.Read(h[:]); err != nil {
                        return nil, err
                }

                var p [2]byte
                if _, err := r.Read(p[:]); err != nil {
                        return nil, err
                }

                onionService := tor.Base32Encoding.EncodeToString(h[:])
                onionService += tor.OnionSuffix
                port := int(binary.BigEndian.Uint16(p[:]))

                address = &tor.OnionAddr{
                        OnionService: onionService,
                        Port:         port,
                }

        case opaqueAddrs:
                // Read the length of the payload.
                var l [2]byte
                if _, err := r.Read(l[:]); err != nil {
                        return nil, err
                }

                // Read the payload.
                payload := make([]byte, binary.BigEndian.Uint16(l[:]))
                if _, err := r.Read(payload); err != nil {
                        return nil, err
                }

                address = &lnwire.OpaqueAddrs{
                        Payload: payload,
                }

        default:
                return nil, ErrUnknownAddressType
        }

        return address, nil
}

// SerializeAddr serializes an address into its raw bytes representation so that
// it can be deserialized without requiring address resolution.
func SerializeAddr(w io.Writer, address net.Addr) error {
        switch addr := address.(type) {
        case *net.TCPAddr:
                return encodeTCPAddr(w, addr)
        case *tor.OnionAddr:
                return encodeOnionAddr(w, addr)
        case *lnwire.OpaqueAddrs:
                return encodeOpaqueAddrs(w, addr)
        default:
                return ErrUnknownAddressType
        }
}

1	package graphdb
2
3	import (
4	"encoding/binary"
5	"errors"
6	"fmt"
7	"io"
8	"net"
9
10	"github.com/lightningnetwork/lnd/lnwire"
11	"github.com/lightningnetwork/lnd/tor"
12	)
13
14	// addressType specifies the network protocol and version that should be used
15	// when connecting to a node at a particular address.
16	type addressType uint8
17
18	const (
19	// tcp4Addr denotes an IPv4 TCP address.
20	tcp4Addr addressType = 0
21
22	// tcp6Addr denotes an IPv6 TCP address.
23	tcp6Addr addressType = 1
24
25	// v2OnionAddr denotes a version 2 Tor onion service address.
26	v2OnionAddr addressType = 2
27
28	// v3OnionAddr denotes a version 3 Tor (prop224) onion service address.
29	v3OnionAddr addressType = 3
30
31	// opaqueAddrs denotes an address (or a set of addresses) that LND was
32	// not able to parse since LND is not yet aware of the address type.
33	opaqueAddrs addressType = 4
34	)
35
36	// encodeTCPAddr serializes a TCP address into its compact raw bytes
37	// representation.
38	func encodeTCPAddr(w io.Writer, addr *net.TCPAddr) error {	1✔
39	var (	1✔
40	addrType byte	1✔
41	ip []byte	1✔
42	)	1✔
43		1✔
44	if addr.IP.To4() != nil {	2✔
45	addrType = byte(tcp4Addr)	1✔
46	ip = addr.IP.To4()	1✔
47	} else {	2✔
48	addrType = byte(tcp6Addr)	1✔
49	ip = addr.IP.To16()	1✔
50	}	1✔
51
52	if ip == nil {	1✔
UNCOV 53	return fmt.Errorf("unable to encode IP %v", addr.IP)	×
UNCOV 54	}	×
55
56	if _, err := w.Write([]byte{addrType}); err != nil {	1✔
57	return err	×
58	}	×
59
60	if _, err := w.Write(ip); err != nil {	1✔
61	return err	×
62	}	×
63
64	var port [2]byte	1✔
65	byteOrder.PutUint16(port[:], uint16(addr.Port))	1✔
66	if _, err := w.Write(port[:]); err != nil {	1✔
67	return err	×
68	}	×
69
70	return nil	1✔
71	}
72
73	// encodeOnionAddr serializes an onion address into its compact raw bytes
74	// representation.
75	func encodeOnionAddr(w io.Writer, addr *tor.OnionAddr) error {	1✔
76	var suffixIndex int	1✔
77	hostLen := len(addr.OnionService)	1✔
78	switch hostLen {	1✔
79	case tor.V2Len:	1✔
80	if _, err := w.Write([]byte{byte(v2OnionAddr)}); err != nil {	1✔
81	return err	×
82	}	×
83	suffixIndex = tor.V2Len - tor.OnionSuffixLen	1✔
84	case tor.V3Len:	1✔
85	if _, err := w.Write([]byte{byte(v3OnionAddr)}); err != nil {	1✔
86	return err	×
87	}	×
88	suffixIndex = tor.V3Len - tor.OnionSuffixLen	1✔
UNCOV 89	default:	×
UNCOV 90	return errors.New("unknown onion service length")	×
91	}
92
93	suffix := addr.OnionService[suffixIndex:]	1✔
94	if suffix != tor.OnionSuffix {	1✔
UNCOV 95	return fmt.Errorf("invalid suffix \"%v\"", suffix)	×
UNCOV 96	}	×
97
98	host, err := tor.Base32Encoding.DecodeString(	1✔
99	addr.OnionService[:suffixIndex],	1✔
100	)	1✔
101	if err != nil {	1✔
UNCOV 102	return err	×
UNCOV 103	}	×
104
105	// Sanity check the decoded length.
106	switch {	1✔
107	case hostLen == tor.V2Len && len(host) != tor.V2DecodedLen:	×
108	return fmt.Errorf("onion service %v decoded to invalid host %x",	×
109	addr.OnionService, host)	×
110
111	case hostLen == tor.V3Len && len(host) != tor.V3DecodedLen:	×
112	return fmt.Errorf("onion service %v decoded to invalid host %x",	×
113	addr.OnionService, host)	×
114	}
115
116	if _, err := w.Write(host); err != nil {	1✔
117	return err	×
118	}	×
119
120	var port [2]byte	1✔
121	byteOrder.PutUint16(port[:], uint16(addr.Port))	1✔
122	if _, err := w.Write(port[:]); err != nil {	1✔
123	return err	×
124	}	×
125
126	return nil	1✔
127	}
128
129	// encodeOpaqueAddrs serializes the lnwire.OpaqueAddrs type to a raw set of
130	// bytes that we will persist.
UNCOV 131	func encodeOpaqueAddrs(w io.Writer, addr *lnwire.OpaqueAddrs) error {	×
UNCOV 132	// Write the type byte.	×
UNCOV 133	if _, err := w.Write([]byte{byte(opaqueAddrs)}); err != nil {	×
134	return err	×
135	}	×
136
137	// Write the length of the payload.
UNCOV 138	var l [2]byte	×
UNCOV 139	binary.BigEndian.PutUint16(l[:], uint16(len(addr.Payload)))	×
UNCOV 140	if _, err := w.Write(l[:]); err != nil {	×
141	return err	×
142	}	×
143
144	// Write the payload.
UNCOV 145	_, err := w.Write(addr.Payload)	×
UNCOV 146		×
UNCOV 147	return err	×
148	}
149
150	// DeserializeAddr reads the serialized raw representation of an address and
151	// deserializes it into the actual address. This allows us to avoid address
152	// resolution within the channeldb package.
153	func DeserializeAddr(r io.Reader) (net.Addr, error) {	1✔
154	var addrType [1]byte	1✔
155	if _, err := r.Read(addrType[:]); err != nil {	1✔
156	return nil, err	×
157	}	×
158
159	var address net.Addr	1✔
160	switch addressType(addrType[0]) {	1✔
161	case tcp4Addr:	1✔
162	var ip [4]byte	1✔
163	if _, err := r.Read(ip[:]); err != nil {	1✔
164	return nil, err	×
165	}	×
166
167	var port [2]byte	1✔
168	if _, err := r.Read(port[:]); err != nil {	1✔
169	return nil, err	×
170	}	×
171
172	address = &net.TCPAddr{	1✔
173	IP: net.IP(ip[:]),	1✔
174	Port: int(binary.BigEndian.Uint16(port[:])),	1✔
175	}	1✔
176
177	case tcp6Addr:	1✔
178	var ip [16]byte	1✔
179	if _, err := r.Read(ip[:]); err != nil {	1✔
180	return nil, err	×
181	}	×
182
183	var port [2]byte	1✔
184	if _, err := r.Read(port[:]); err != nil {	1✔
185	return nil, err	×
186	}	×
187
188	address = &net.TCPAddr{	1✔
189	IP: net.IP(ip[:]),	1✔
190	Port: int(binary.BigEndian.Uint16(port[:])),	1✔
191	}	1✔
192
193	case v2OnionAddr:	1✔
194	var h [tor.V2DecodedLen]byte	1✔
195	if _, err := r.Read(h[:]); err != nil {	1✔
196	return nil, err	×
197	}	×
198
199	var p [2]byte	1✔
200	if _, err := r.Read(p[:]); err != nil {	1✔
201	return nil, err	×
202	}	×
203
204	onionService := tor.Base32Encoding.EncodeToString(h[:])	1✔
205	onionService += tor.OnionSuffix	1✔
206	port := int(binary.BigEndian.Uint16(p[:]))	1✔
207		1✔
208	address = &tor.OnionAddr{	1✔
209	OnionService: onionService,	1✔
210	Port: port,	1✔
211	}	1✔
212
213	case v3OnionAddr:	1✔
214	var h [tor.V3DecodedLen]byte	1✔
215	if _, err := r.Read(h[:]); err != nil {	1✔
216	return nil, err	×
217	}	×
218
219	var p [2]byte	1✔
220	if _, err := r.Read(p[:]); err != nil {	1✔
221	return nil, err	×
222	}	×
223
224	onionService := tor.Base32Encoding.EncodeToString(h[:])	1✔
225	onionService += tor.OnionSuffix	1✔
226	port := int(binary.BigEndian.Uint16(p[:]))	1✔
227		1✔
228	address = &tor.OnionAddr{	1✔
229	OnionService: onionService,	1✔
230	Port: port,	1✔
231	}	1✔
232
UNCOV 233	case opaqueAddrs:	×
UNCOV 234	// Read the length of the payload.	×
UNCOV 235	var l [2]byte	×
UNCOV 236	if _, err := r.Read(l[:]); err != nil {	×
237	return nil, err	×
238	}	×
239
240	// Read the payload.
UNCOV 241	payload := make([]byte, binary.BigEndian.Uint16(l[:]))	×
UNCOV 242	if _, err := r.Read(payload); err != nil {	×
243	return nil, err	×
244	}	×
245
UNCOV 246	address = &lnwire.OpaqueAddrs{	×
UNCOV 247	Payload: payload,	×
UNCOV 248	}	×
249
250	default:	×
251	return nil, ErrUnknownAddressType	×
252	}
253
254	return address, nil	1✔
255	}
256
257	// SerializeAddr serializes an address into its raw bytes representation so that
258	// it can be deserialized without requiring address resolution.
259	func SerializeAddr(w io.Writer, address net.Addr) error {	1✔
260	switch addr := address.(type) {	1✔
261	case *net.TCPAddr:	1✔
262	return encodeTCPAddr(w, addr)	1✔
263	case *tor.OnionAddr:	1✔
264	return encodeOnionAddr(w, addr)	1✔
UNCOV 265	case *lnwire.OpaqueAddrs:	×
UNCOV 266	return encodeOpaqueAddrs(w, addr)	×
UNCOV 267	default:	×
UNCOV 268	return ErrUnknownAddressType	×
269	}
270	}

lightningnetwork / lnd / 15155511119

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