13035292482

Committed 29 Jan 2025 03:59PM UTC coverage: 49.3% (-9.5%) from 58.777%

Build # 13035292482

Build Type

Pull #9456

github

Committed by

mohamedawnallah

Commit Message

docs: update release-notes-0.19.0.md

In this commit, we warn users about the removal
of RPCs `SendToRoute`, `SendToRouteSync`, `SendPayment`,
and `SendPaymentSync` in the next release 0.20.

Pull Request Pull Request #9456: lnrpc+docs: deprecate warning `SendToRoute`, `SendToRouteSync`, `SendPayment`, and `SendPaymentSync` in Release 0.19

Run Details

100634 of 204126 relevant lines covered (49.3%)

1.54 hits per line

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

81.82

/watchtower/wtwire/init.go

package wtwire

import (
        "fmt"
        "io"

        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/lightningnetwork/lnd/feature"
        "github.com/lightningnetwork/lnd/lnwire"
)

// Init is the first message sent over the watchtower wire protocol, and
// specifies connection features bits and level of requiredness maintained by
// the sending node. The Init message also sends the chain hash identifying the
// network that the sender is on.
type Init struct {
        // ConnFeatures are the feature bits being advertised for the duration
        // of a single connection with a peer.
        ConnFeatures *lnwire.RawFeatureVector

        // ChainHash is the genesis hash of the chain that the advertiser claims
        // to be on.
        ChainHash chainhash.Hash
}

// NewInitMessage generates a new Init message from a raw connection feature
// vector and chain hash.
func NewInitMessage(connFeatures *lnwire.RawFeatureVector,
        chainHash chainhash.Hash) *Init {

        return &Init{
                ConnFeatures: connFeatures,
                ChainHash:    chainHash,
        }
}

// Encode serializes the target Init into the passed io.Writer observing the
// protocol version specified.
//
// This is part of the wtwire.Message interface.
func (msg *Init) Encode(w io.Writer, pver uint32) error {
        return WriteElements(w,
                msg.ConnFeatures,
                msg.ChainHash,
        )
}

// Decode deserializes a serialized Init message stored in the passed io.Reader
// observing the specified protocol version.
//
// This is part of the wtwire.Message interface.
func (msg *Init) Decode(r io.Reader, pver uint32) error {
        return ReadElements(r,
                &msg.ConnFeatures,
                &msg.ChainHash,
        )
}

// MsgType returns the integer uniquely identifying this message type on the
// wire.
//
// This is part of the wtwire.Message interface.
func (msg *Init) MsgType() MessageType {
        return MsgInit
}

// MaxPayloadLength returns the maximum allowed payload size for an Init
// complete message observing the specified protocol version.
//
// This is part of the wtwire.Message interface.
func (msg *Init) MaxPayloadLength(uint32) uint32 {
        return MaxMessagePayload
}

// A compile-time constraint to ensure Init implements the Message interface.
var _ Message = (*Init)(nil)

// CheckRemoteInit performs basic validation of the remote party's Init message.
// This method checks that the remote Init's chain hash matches our advertised
// chain hash and that the remote Init does not contain any required feature
// bits that we don't understand.
func (msg *Init) CheckRemoteInit(remoteInit *Init,
        featureNames map[lnwire.FeatureBit]string) error {

        // Check that the remote peer is on the same chain.
        if msg.ChainHash != remoteInit.ChainHash {
                return NewErrUnknownChainHash(remoteInit.ChainHash)
        }

        remoteConnFeatures := lnwire.NewFeatureVector(
                remoteInit.ConnFeatures, featureNames,
        )

        // Check that the remote peer doesn't have any required connection
        // feature bits that we ourselves are unaware of.
        return feature.ValidateRequired(remoteConnFeatures)
}

// ErrUnknownChainHash signals that the remote Init has a different chain hash
// from the one we advertised.
type ErrUnknownChainHash struct {
        hash chainhash.Hash
}

// NewErrUnknownChainHash creates an ErrUnknownChainHash using the remote Init's
// chain hash.
func NewErrUnknownChainHash(hash chainhash.Hash) *ErrUnknownChainHash {
        return &ErrUnknownChainHash{hash}
}

// Error returns a human-readable error displaying the unknown chain hash.
func (e *ErrUnknownChainHash) Error() string {
        return fmt.Sprintf("remote init has unknown chain hash: %s", e.hash)
}

1	package wtwire
2
3	import (
4	"fmt"
5	"io"
6
7	"github.com/btcsuite/btcd/chaincfg/chainhash"
8	"github.com/lightningnetwork/lnd/feature"
9	"github.com/lightningnetwork/lnd/lnwire"
10	)
11
12	// Init is the first message sent over the watchtower wire protocol, and
13	// specifies connection features bits and level of requiredness maintained by
14	// the sending node. The Init message also sends the chain hash identifying the
15	// network that the sender is on.
16	type Init struct {
17	// ConnFeatures are the feature bits being advertised for the duration
18	// of a single connection with a peer.
19	ConnFeatures *lnwire.RawFeatureVector
20
21	// ChainHash is the genesis hash of the chain that the advertiser claims
22	// to be on.
23	ChainHash chainhash.Hash
24	}
25
26	// NewInitMessage generates a new Init message from a raw connection feature
27	// vector and chain hash.
28	func NewInitMessage(connFeatures *lnwire.RawFeatureVector,
29	chainHash chainhash.Hash) *Init {	3✔
30		3✔
31	return &Init{	3✔
32	ConnFeatures: connFeatures,	3✔
33	ChainHash: chainHash,	3✔
34	}	3✔
35	}	3✔
36
37	// Encode serializes the target Init into the passed io.Writer observing the
38	// protocol version specified.
39	//
40	// This is part of the wtwire.Message interface.
41	func (msg *Init) Encode(w io.Writer, pver uint32) error {	3✔
42	return WriteElements(w,	3✔
43	msg.ConnFeatures,	3✔
44	msg.ChainHash,	3✔
45	)	3✔
46	}	3✔
47
48	// Decode deserializes a serialized Init message stored in the passed io.Reader
49	// observing the specified protocol version.
50	//
51	// This is part of the wtwire.Message interface.
52	func (msg *Init) Decode(r io.Reader, pver uint32) error {	3✔
53	return ReadElements(r,	3✔
54	&msg.ConnFeatures,	3✔
55	&msg.ChainHash,	3✔
56	)	3✔
57	}	3✔
58
59	// MsgType returns the integer uniquely identifying this message type on the
60	// wire.
61	//
62	// This is part of the wtwire.Message interface.
63	func (msg *Init) MsgType() MessageType {	3✔
64	return MsgInit	3✔
65	}	3✔
66
67	// MaxPayloadLength returns the maximum allowed payload size for an Init
68	// complete message observing the specified protocol version.
69	//
70	// This is part of the wtwire.Message interface.
71	func (msg *Init) MaxPayloadLength(uint32) uint32 {	3✔
72	return MaxMessagePayload	3✔
73	}	3✔
74
75	// A compile-time constraint to ensure Init implements the Message interface.
76	var _ Message = (*Init)(nil)
77
78	// CheckRemoteInit performs basic validation of the remote party's Init message.
79	// This method checks that the remote Init's chain hash matches our advertised
80	// chain hash and that the remote Init does not contain any required feature
81	// bits that we don't understand.
82	func (msg Init) CheckRemoteInit(remoteInit Init,
83	featureNames map[lnwire.FeatureBit]string) error {	3✔
84		3✔
85	// Check that the remote peer is on the same chain.	3✔
86	if msg.ChainHash != remoteInit.ChainHash {	3✔
87	return NewErrUnknownChainHash(remoteInit.ChainHash)	×
88	}	×
89
90	remoteConnFeatures := lnwire.NewFeatureVector(	3✔
91	remoteInit.ConnFeatures, featureNames,	3✔
92	)	3✔
93		3✔
94	// Check that the remote peer doesn't have any required connection	3✔
95	// feature bits that we ourselves are unaware of.	3✔
96	return feature.ValidateRequired(remoteConnFeatures)	3✔
97	}
98
99	// ErrUnknownChainHash signals that the remote Init has a different chain hash
100	// from the one we advertised.
101	type ErrUnknownChainHash struct {
102	hash chainhash.Hash
103	}
104
105	// NewErrUnknownChainHash creates an ErrUnknownChainHash using the remote Init's
106	// chain hash.
107	func NewErrUnknownChainHash(hash chainhash.Hash) *ErrUnknownChainHash {	×
108	return &ErrUnknownChainHash{hash}	×
109	}	×
110
111	// Error returns a human-readable error displaying the unknown chain hash.
112	func (e *ErrUnknownChainHash) Error() string {	×
113	return fmt.Sprintf("remote init has unknown chain hash: %s", e.hash)	×
114	}	×

lightningnetwork / lnd / 13035292482

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