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

68.38

/lnwire/message.go

// Copyright (c) 2013-2017 The btcsuite developers
// Copyright (c) 2015-2016 The Decred developers
// code derived from https://github .com/btcsuite/btcd/blob/master/wire/message.go
// Copyright (C) 2015-2022 The Lightning Network Developers

package lnwire

import (
        "bytes"
        "encoding/binary"
        "fmt"
        "io"
)

// MessageType is the unique 2 byte big-endian integer that indicates the type
// of message on the wire. All messages have a very simple header which
// consists simply of 2-byte message type. We omit a length field, and checksum
// as the Lightning Protocol is intended to be encapsulated within a
// confidential+authenticated cryptographic messaging protocol.
type MessageType uint16

// The currently defined message types within this current version of the
// Lightning protocol.
const (
        MsgWarning                 MessageType = 1
        MsgStfu                                = 2
        MsgInit                                = 16
        MsgError                               = 17
        MsgPing                                = 18
        MsgPong                                = 19
        MsgOpenChannel                         = 32
        MsgAcceptChannel                       = 33
        MsgFundingCreated                      = 34
        MsgFundingSigned                       = 35
        MsgChannelReady                        = 36
        MsgShutdown                            = 38
        MsgClosingSigned                       = 39
        MsgClosingComplete                     = 40
        MsgClosingSig                          = 41
        MsgDynPropose                          = 111
        MsgDynAck                              = 113
        MsgDynReject                           = 115
        MsgUpdateAddHTLC                       = 128
        MsgUpdateFulfillHTLC                   = 130
        MsgUpdateFailHTLC                      = 131
        MsgCommitSig                           = 132
        MsgRevokeAndAck                        = 133
        MsgUpdateFee                           = 134
        MsgUpdateFailMalformedHTLC             = 135
        MsgChannelReestablish                  = 136
        MsgChannelAnnouncement                 = 256
        MsgNodeAnnouncement                    = 257
        MsgChannelUpdate                       = 258
        MsgAnnounceSignatures                  = 259
        MsgAnnounceSignatures2                 = 260
        MsgQueryShortChanIDs                   = 261
        MsgReplyShortChanIDsEnd                = 262
        MsgQueryChannelRange                   = 263
        MsgReplyChannelRange                   = 264
        MsgGossipTimestampRange                = 265
        MsgChannelAnnouncement2                = 267
        MsgChannelUpdate2                      = 271
        MsgKickoffSig                          = 777
)

// IsChannelUpdate is a filter function that discerns channel update messages
// from the other messages in the Lightning Network Protocol.
func (t MessageType) IsChannelUpdate() bool {
        switch t {
        case MsgUpdateAddHTLC:
                return true
        case MsgUpdateFulfillHTLC:
                return true
        case MsgUpdateFailHTLC:
                return true
        case MsgUpdateFailMalformedHTLC:
                return true
        case MsgUpdateFee:
                return true
        default:
                return false
        }
}

// ErrorEncodeMessage is used when failed to encode the message payload.
func ErrorEncodeMessage(err error) error {
        return fmt.Errorf("failed to encode message to buffer, got %w", err)
}

// ErrorWriteMessageType is used when failed to write the message type.
func ErrorWriteMessageType(err error) error {
        return fmt.Errorf("failed to write message type, got %w", err)
}

// ErrorPayloadTooLarge is used when the payload size exceeds the
// MaxMsgBody.
func ErrorPayloadTooLarge(size int) error {
        return fmt.Errorf(
                "message payload is too large - encoded %d bytes, "+
                        "but maximum message payload is %d bytes",
                size, MaxMsgBody,
        )
}

// String return the string representation of message type.
func (t MessageType) String() string {
        switch t {
        case MsgWarning:
                return "Warning"
        case MsgStfu:
                return "Stfu"
        case MsgInit:
                return "Init"
        case MsgOpenChannel:
                return "MsgOpenChannel"
        case MsgAcceptChannel:
                return "MsgAcceptChannel"
        case MsgFundingCreated:
                return "MsgFundingCreated"
        case MsgFundingSigned:
                return "MsgFundingSigned"
        case MsgChannelReady:
                return "ChannelReady"
        case MsgShutdown:
                return "Shutdown"
        case MsgClosingSigned:
                return "ClosingSigned"
        case MsgDynPropose:
                return "DynPropose"
        case MsgDynAck:
                return "DynAck"
        case MsgDynReject:
                return "DynReject"
        case MsgKickoffSig:
                return "KickoffSig"
        case MsgUpdateAddHTLC:
                return "UpdateAddHTLC"
        case MsgUpdateFailHTLC:
                return "UpdateFailHTLC"
        case MsgUpdateFulfillHTLC:
                return "UpdateFulfillHTLC"
        case MsgCommitSig:
                return "CommitSig"
        case MsgRevokeAndAck:
                return "RevokeAndAck"
        case MsgUpdateFailMalformedHTLC:
                return "UpdateFailMalformedHTLC"
        case MsgChannelReestablish:
                return "ChannelReestablish"
        case MsgError:
                return "Error"
        case MsgChannelAnnouncement:
                return "ChannelAnnouncement"
        case MsgChannelUpdate:
                return "ChannelUpdate"
        case MsgNodeAnnouncement:
                return "NodeAnnouncement"
        case MsgPing:
                return "Ping"
        case MsgAnnounceSignatures:
                return "AnnounceSignatures"
        case MsgPong:
                return "Pong"
        case MsgUpdateFee:
                return "UpdateFee"
        case MsgQueryShortChanIDs:
                return "QueryShortChanIDs"
        case MsgReplyShortChanIDsEnd:
                return "ReplyShortChanIDsEnd"
        case MsgQueryChannelRange:
                return "QueryChannelRange"
        case MsgReplyChannelRange:
                return "ReplyChannelRange"
        case MsgGossipTimestampRange:
                return "GossipTimestampRange"
        case MsgClosingComplete:
                return "ClosingComplete"
        case MsgClosingSig:
                return "ClosingSig"
        case MsgAnnounceSignatures2:
                return "MsgAnnounceSignatures2"
        case MsgChannelAnnouncement2:
                return "ChannelAnnouncement2"
        case MsgChannelUpdate2:
                return "ChannelUpdate2"
        default:
                return "<unknown>"
        }
}

// UnknownMessage is an implementation of the error interface that allows the
// creation of an error in response to an unknown message.
type UnknownMessage struct {
        messageType MessageType
}

// Error returns a human readable string describing the error.
//
// This is part of the error interface.
func (u *UnknownMessage) Error() string {
        return fmt.Sprintf("unable to parse message of unknown type: %v",
                u.messageType)
}

// Serializable is an interface which defines a lightning wire serializable
// object.
type Serializable interface {
        // Decode reads the bytes stream and converts it to the object.
        Decode(io.Reader, uint32) error

        // Encode converts object to the bytes stream and write it into the
        // write buffer.
        Encode(*bytes.Buffer, uint32) error
}

// Message is an interface that defines a lightning wire protocol message. The
// interface is general in order to allow implementing types full control over
// the representation of its data.
type Message interface {
        Serializable
        MsgType() MessageType
}

// LinkUpdater is an interface implemented by most messages in BOLT 2 that are
// allowed to update the channel state.
type LinkUpdater interface {
        // All LinkUpdater messages are messages and so we embed the interface
        // so that we can treat it as a message if all we know about it is that
        // it is a LinkUpdater message.
        Message

        // TargetChanID returns the channel id of the link for which this
        // message is intended.
        TargetChanID() ChannelID
}

// makeEmptyMessage creates a new empty message of the proper concrete type
// based on the passed message type.
func makeEmptyMessage(msgType MessageType) (Message, error) {
        var msg Message

        switch msgType {
        case MsgWarning:
                msg = &Warning{}
        case MsgStfu:
                msg = &Stfu{}
        case MsgInit:
                msg = &Init{}
        case MsgOpenChannel:
                msg = &OpenChannel{}
        case MsgAcceptChannel:
                msg = &AcceptChannel{}
        case MsgFundingCreated:
                msg = &FundingCreated{}
        case MsgFundingSigned:
                msg = &FundingSigned{}
        case MsgChannelReady:
                msg = &ChannelReady{}
        case MsgShutdown:
                msg = &Shutdown{}
        case MsgClosingSigned:
                msg = &ClosingSigned{}
        case MsgDynPropose:
                msg = &DynPropose{}
        case MsgDynAck:
                msg = &DynAck{}
        case MsgDynReject:
                msg = &DynReject{}
        case MsgKickoffSig:
                msg = &KickoffSig{}
        case MsgUpdateAddHTLC:
                msg = &UpdateAddHTLC{}
        case MsgUpdateFailHTLC:
                msg = &UpdateFailHTLC{}
        case MsgUpdateFulfillHTLC:
                msg = &UpdateFulfillHTLC{}
        case MsgCommitSig:
                msg = &CommitSig{}
        case MsgRevokeAndAck:
                msg = &RevokeAndAck{}
        case MsgUpdateFee:
                msg = &UpdateFee{}
        case MsgUpdateFailMalformedHTLC:
                msg = &UpdateFailMalformedHTLC{}
        case MsgChannelReestablish:
                msg = &ChannelReestablish{}
        case MsgError:
                msg = &Error{}
        case MsgChannelAnnouncement:
                msg = &ChannelAnnouncement1{}
        case MsgChannelUpdate:
                msg = &ChannelUpdate1{}
        case MsgNodeAnnouncement:
                msg = &NodeAnnouncement{}
        case MsgPing:
                msg = &Ping{}
        case MsgAnnounceSignatures:
                msg = &AnnounceSignatures1{}
        case MsgPong:
                msg = &Pong{}
        case MsgQueryShortChanIDs:
                msg = &QueryShortChanIDs{}
        case MsgReplyShortChanIDsEnd:
                msg = &ReplyShortChanIDsEnd{}
        case MsgQueryChannelRange:
                msg = &QueryChannelRange{}
        case MsgReplyChannelRange:
                msg = &ReplyChannelRange{}
        case MsgGossipTimestampRange:
                msg = &GossipTimestampRange{}
        case MsgClosingComplete:
                msg = &ClosingComplete{}
        case MsgClosingSig:
                msg = &ClosingSig{}
        case MsgAnnounceSignatures2:
                msg = &AnnounceSignatures2{}
        case MsgChannelAnnouncement2:
                msg = &ChannelAnnouncement2{}
        case MsgChannelUpdate2:
                msg = &ChannelUpdate2{}
        default:
                // If the message is not within our custom range and has not
                // specifically been overridden, return an unknown message.
                //
                // Note that we do not allow custom message overrides to replace
                // known message types, only protocol messages that are not yet
                // known to lnd.
                if msgType < CustomTypeStart && !IsCustomOverride(msgType) {
                        return nil, &UnknownMessage{msgType}
                }

                msg = &Custom{
                        Type: msgType,
                }
        }

        return msg, nil
}

// WriteMessage writes a lightning Message to a buffer including the necessary
// header information and returns the number of bytes written. If any error is
// encountered, the buffer passed will be reset to its original state since we
// don't want any broken bytes left. In other words, no bytes will be written
// if there's an error. Either all or none of the message bytes will be written
// to the buffer.
//
// NOTE: this method is not concurrent safe.
func WriteMessage(buf *bytes.Buffer, msg Message, pver uint32) (int, error) {
        // Record the size of the bytes already written in buffer.
        oldByteSize := buf.Len()

        // cleanBrokenBytes is a helper closure that helps reset the buffer to
        // its original state. It truncates all the bytes written in current
        // scope.
        var cleanBrokenBytes = func(b *bytes.Buffer) int {
                b.Truncate(oldByteSize)
                return 0
        }

        // Write the message type.
        var mType [2]byte
        binary.BigEndian.PutUint16(mType[:], uint16(msg.MsgType()))
        msgTypeBytes, err := buf.Write(mType[:])
        if err != nil {
                return cleanBrokenBytes(buf), ErrorWriteMessageType(err)
        }

        // Use the write buffer to encode our message.
        if err := msg.Encode(buf, pver); err != nil {
                return cleanBrokenBytes(buf), ErrorEncodeMessage(err)
        }

        // Enforce maximum overall message payload. The write buffer now has
        // the size of len(originalBytes) + len(payload) + len(type). We want
        // to enforce the payload here, so we subtract it by the length of the
        // type and old bytes.
        lenp := buf.Len() - oldByteSize - msgTypeBytes
        if lenp > MaxMsgBody {
                return cleanBrokenBytes(buf), ErrorPayloadTooLarge(lenp)
        }

        return buf.Len() - oldByteSize, nil
}

// ReadMessage reads, validates, and parses the next Lightning message from r
// for the provided protocol version.
func ReadMessage(r io.Reader, pver uint32) (Message, error) {
        // First, we'll read out the first two bytes of the message so we can
        // create the proper empty message.
        var mType [2]byte
        if _, err := io.ReadFull(r, mType[:]); err != nil {
                return nil, err
        }

        msgType := MessageType(binary.BigEndian.Uint16(mType[:]))

        // Now that we know the target message type, we can create the proper
        // empty message type and decode the message into it.
        msg, err := makeEmptyMessage(msgType)
        if err != nil {
                return nil, err
        }
        if err := msg.Decode(r, pver); err != nil {
                return nil, err
        }

        return msg, nil
}

1	// Copyright (c) 2013-2017 The btcsuite developers
2	// Copyright (c) 2015-2016 The Decred developers
3	// code derived from https://github .com/btcsuite/btcd/blob/master/wire/message.go
4	// Copyright (C) 2015-2022 The Lightning Network Developers
5
6	package lnwire
7
8	import (
9	"bytes"
10	"encoding/binary"
11	"fmt"
12	"io"
13	)
14
15	// MessageType is the unique 2 byte big-endian integer that indicates the type
16	// of message on the wire. All messages have a very simple header which
17	// consists simply of 2-byte message type. We omit a length field, and checksum
18	// as the Lightning Protocol is intended to be encapsulated within a
19	// confidential+authenticated cryptographic messaging protocol.
20	type MessageType uint16
21
22	// The currently defined message types within this current version of the
23	// Lightning protocol.
24	const (
25	MsgWarning MessageType = 1
26	MsgStfu = 2
27	MsgInit = 16
28	MsgError = 17
29	MsgPing = 18
30	MsgPong = 19
31	MsgOpenChannel = 32
32	MsgAcceptChannel = 33
33	MsgFundingCreated = 34
34	MsgFundingSigned = 35
35	MsgChannelReady = 36
36	MsgShutdown = 38
37	MsgClosingSigned = 39
38	MsgClosingComplete = 40
39	MsgClosingSig = 41
40	MsgDynPropose = 111
41	MsgDynAck = 113
42	MsgDynReject = 115
43	MsgUpdateAddHTLC = 128
44	MsgUpdateFulfillHTLC = 130
45	MsgUpdateFailHTLC = 131
46	MsgCommitSig = 132
47	MsgRevokeAndAck = 133
48	MsgUpdateFee = 134
49	MsgUpdateFailMalformedHTLC = 135
50	MsgChannelReestablish = 136
51	MsgChannelAnnouncement = 256
52	MsgNodeAnnouncement = 257
53	MsgChannelUpdate = 258
54	MsgAnnounceSignatures = 259
55	MsgAnnounceSignatures2 = 260
56	MsgQueryShortChanIDs = 261
57	MsgReplyShortChanIDsEnd = 262
58	MsgQueryChannelRange = 263
59	MsgReplyChannelRange = 264
60	MsgGossipTimestampRange = 265
61	MsgChannelAnnouncement2 = 267
62	MsgChannelUpdate2 = 271
63	MsgKickoffSig = 777
64	)
65
66	// IsChannelUpdate is a filter function that discerns channel update messages
67	// from the other messages in the Lightning Network Protocol.
68	func (t MessageType) IsChannelUpdate() bool {	3✔
69	switch t {	3✔
70	case MsgUpdateAddHTLC:	3✔
71	return true	3✔
72	case MsgUpdateFulfillHTLC:	3✔
73	return true	3✔
74	case MsgUpdateFailHTLC:	3✔
75	return true	3✔
76	case MsgUpdateFailMalformedHTLC:	3✔
77	return true	3✔
78	case MsgUpdateFee:	×
79	return true	×
80	default:	3✔
81	return false	3✔
82	}
83	}
84
85	// ErrorEncodeMessage is used when failed to encode the message payload.
86	func ErrorEncodeMessage(err error) error {	×
87	return fmt.Errorf("failed to encode message to buffer, got %w", err)	×
88	}	×
89
90	// ErrorWriteMessageType is used when failed to write the message type.
91	func ErrorWriteMessageType(err error) error {	×
92	return fmt.Errorf("failed to write message type, got %w", err)	×
93	}	×
94
95	// ErrorPayloadTooLarge is used when the payload size exceeds the
96	// MaxMsgBody.
97	func ErrorPayloadTooLarge(size int) error {	×
98	return fmt.Errorf(	×
99	"message payload is too large - encoded %d bytes, "+	×
100	"but maximum message payload is %d bytes",	×
101	size, MaxMsgBody,	×
102	)	×
103	}	×
104
105	// String return the string representation of message type.
106	func (t MessageType) String() string {	3✔
107	switch t {	3✔
108	case MsgWarning:	×
109	return "Warning"	×
110	case MsgStfu:	3✔
111	return "Stfu"	3✔
112	case MsgInit:	3✔
113	return "Init"	3✔
114	case MsgOpenChannel:	3✔
115	return "MsgOpenChannel"	3✔
116	case MsgAcceptChannel:	3✔
117	return "MsgAcceptChannel"	3✔
118	case MsgFundingCreated:	3✔
119	return "MsgFundingCreated"	3✔
120	case MsgFundingSigned:	3✔
121	return "MsgFundingSigned"	3✔
122	case MsgChannelReady:	3✔
123	return "ChannelReady"	3✔
124	case MsgShutdown:	3✔
125	return "Shutdown"	3✔
126	case MsgClosingSigned:	3✔
127	return "ClosingSigned"	3✔
128	case MsgDynPropose:	×
129	return "DynPropose"	×
130	case MsgDynAck:	×
131	return "DynAck"	×
132	case MsgDynReject:	×
133	return "DynReject"	×
134	case MsgKickoffSig:	×
135	return "KickoffSig"	×
136	case MsgUpdateAddHTLC:	3✔
137	return "UpdateAddHTLC"	3✔
138	case MsgUpdateFailHTLC:	3✔
139	return "UpdateFailHTLC"	3✔
140	case MsgUpdateFulfillHTLC:	3✔
141	return "UpdateFulfillHTLC"	3✔
142	case MsgCommitSig:	3✔
143	return "CommitSig"	3✔
144	case MsgRevokeAndAck:	3✔
145	return "RevokeAndAck"	3✔
146	case MsgUpdateFailMalformedHTLC:	3✔
147	return "UpdateFailMalformedHTLC"	3✔
148	case MsgChannelReestablish:	3✔
149	return "ChannelReestablish"	3✔
150	case MsgError:	3✔
151	return "Error"	3✔
152	case MsgChannelAnnouncement:	3✔
153	return "ChannelAnnouncement"	3✔
154	case MsgChannelUpdate:	3✔
155	return "ChannelUpdate"	3✔
156	case MsgNodeAnnouncement:	3✔
157	return "NodeAnnouncement"	3✔
158	case MsgPing:	×
159	return "Ping"	×
160	case MsgAnnounceSignatures:	3✔
161	return "AnnounceSignatures"	3✔
162	case MsgPong:	×
163	return "Pong"	×
164	case MsgUpdateFee:	×
165	return "UpdateFee"	×
166	case MsgQueryShortChanIDs:	3✔
167	return "QueryShortChanIDs"	3✔
168	case MsgReplyShortChanIDsEnd:	3✔
169	return "ReplyShortChanIDsEnd"	3✔
170	case MsgQueryChannelRange:	3✔
171	return "QueryChannelRange"	3✔
172	case MsgReplyChannelRange:	3✔
173	return "ReplyChannelRange"	3✔
174	case MsgGossipTimestampRange:	3✔
175	return "GossipTimestampRange"	3✔
176	case MsgClosingComplete:	×
177	return "ClosingComplete"	×
178	case MsgClosingSig:	×
179	return "ClosingSig"	×
180	case MsgAnnounceSignatures2:	×
181	return "MsgAnnounceSignatures2"	×
182	case MsgChannelAnnouncement2:	×
183	return "ChannelAnnouncement2"	×
184	case MsgChannelUpdate2:	×
185	return "ChannelUpdate2"	×
186	default:	3✔
187	return "<unknown>"	3✔
188	}
189	}
190
191	// UnknownMessage is an implementation of the error interface that allows the
192	// creation of an error in response to an unknown message.
193	type UnknownMessage struct {
194	messageType MessageType
195	}
196
197	// Error returns a human readable string describing the error.
198	//
199	// This is part of the error interface.
200	func (u *UnknownMessage) Error() string {	3✔
201	return fmt.Sprintf("unable to parse message of unknown type: %v",	3✔
202	u.messageType)	3✔
203	}	3✔
204
205	// Serializable is an interface which defines a lightning wire serializable
206	// object.
207	type Serializable interface {
208	// Decode reads the bytes stream and converts it to the object.
209	Decode(io.Reader, uint32) error
210
211	// Encode converts object to the bytes stream and write it into the
212	// write buffer.
213	Encode(*bytes.Buffer, uint32) error
214	}
215
216	// Message is an interface that defines a lightning wire protocol message. The
217	// interface is general in order to allow implementing types full control over
218	// the representation of its data.
219	type Message interface {
220	Serializable
221	MsgType() MessageType
222	}
223
224	// LinkUpdater is an interface implemented by most messages in BOLT 2 that are
225	// allowed to update the channel state.
226	type LinkUpdater interface {
227	// All LinkUpdater messages are messages and so we embed the interface
228	// so that we can treat it as a message if all we know about it is that
229	// it is a LinkUpdater message.
230	Message
231
232	// TargetChanID returns the channel id of the link for which this
233	// message is intended.
234	TargetChanID() ChannelID
235	}
236
237	// makeEmptyMessage creates a new empty message of the proper concrete type
238	// based on the passed message type.
239	func makeEmptyMessage(msgType MessageType) (Message, error) {	3✔
240	var msg Message	3✔
241		3✔
242	switch msgType {	3✔
243	case MsgWarning:	×
244	msg = &Warning{}	×
245	case MsgStfu:	3✔
246	msg = &Stfu{}	3✔
247	case MsgInit:	3✔
248	msg = &Init{}	3✔
249	case MsgOpenChannel:	3✔
250	msg = &OpenChannel{}	3✔
251	case MsgAcceptChannel:	3✔
252	msg = &AcceptChannel{}	3✔
253	case MsgFundingCreated:	3✔
254	msg = &FundingCreated{}	3✔
255	case MsgFundingSigned:	3✔
256	msg = &FundingSigned{}	3✔
257	case MsgChannelReady:	3✔
258	msg = &ChannelReady{}	3✔
259	case MsgShutdown:	3✔
260	msg = &Shutdown{}	3✔
261	case MsgClosingSigned:	3✔
262	msg = &ClosingSigned{}	3✔
263	case MsgDynPropose:	×
264	msg = &DynPropose{}	×
265	case MsgDynAck:	×
266	msg = &DynAck{}	×
267	case MsgDynReject:	×
268	msg = &DynReject{}	×
269	case MsgKickoffSig:	×
270	msg = &KickoffSig{}	×
271	case MsgUpdateAddHTLC:	3✔
272	msg = &UpdateAddHTLC{}	3✔
273	case MsgUpdateFailHTLC:	3✔
274	msg = &UpdateFailHTLC{}	3✔
275	case MsgUpdateFulfillHTLC:	3✔
276	msg = &UpdateFulfillHTLC{}	3✔
277	case MsgCommitSig:	3✔
278	msg = &CommitSig{}	3✔
279	case MsgRevokeAndAck:	3✔
280	msg = &RevokeAndAck{}	3✔
281	case MsgUpdateFee:	×
282	msg = &UpdateFee{}	×
283	case MsgUpdateFailMalformedHTLC:	3✔
284	msg = &UpdateFailMalformedHTLC{}	3✔
285	case MsgChannelReestablish:	3✔
286	msg = &ChannelReestablish{}	3✔
287	case MsgError:	3✔
288	msg = &Error{}	3✔
289	case MsgChannelAnnouncement:	3✔
290	msg = &ChannelAnnouncement1{}	3✔
291	case MsgChannelUpdate:	3✔
292	msg = &ChannelUpdate1{}	3✔
293	case MsgNodeAnnouncement:	3✔
294	msg = &NodeAnnouncement{}	3✔
295	case MsgPing:	×
296	msg = &Ping{}	×
297	case MsgAnnounceSignatures:	3✔
298	msg = &AnnounceSignatures1{}	3✔
299	case MsgPong:	×
300	msg = &Pong{}	×
301	case MsgQueryShortChanIDs:	3✔
302	msg = &QueryShortChanIDs{}	3✔
303	case MsgReplyShortChanIDsEnd:	3✔
304	msg = &ReplyShortChanIDsEnd{}	3✔
305	case MsgQueryChannelRange:	3✔
306	msg = &QueryChannelRange{}	3✔
307	case MsgReplyChannelRange:	3✔
308	msg = &ReplyChannelRange{}	3✔
309	case MsgGossipTimestampRange:	3✔
310	msg = &GossipTimestampRange{}	3✔
311	case MsgClosingComplete:	×
312	msg = &ClosingComplete{}	×
313	case MsgClosingSig:	×
314	msg = &ClosingSig{}	×
315	case MsgAnnounceSignatures2:	×
316	msg = &AnnounceSignatures2{}	×
317	case MsgChannelAnnouncement2:	×
318	msg = &ChannelAnnouncement2{}	×
319	case MsgChannelUpdate2:	×
320	msg = &ChannelUpdate2{}	×
321	default:	3✔
322	// If the message is not within our custom range and has not	3✔
323	// specifically been overridden, return an unknown message.	3✔
324	//	3✔
325	// Note that we do not allow custom message overrides to replace	3✔
326	// known message types, only protocol messages that are not yet	3✔
327	// known to lnd.	3✔
328	if msgType < CustomTypeStart && !IsCustomOverride(msgType) {	6✔
329	return nil, &UnknownMessage{msgType}	3✔
330	}	3✔
331
332	msg = &Custom{	3✔
333	Type: msgType,	3✔
334	}	3✔
335	}
336
337	return msg, nil	3✔
338	}
339
340	// WriteMessage writes a lightning Message to a buffer including the necessary
341	// header information and returns the number of bytes written. If any error is
342	// encountered, the buffer passed will be reset to its original state since we
343	// don't want any broken bytes left. In other words, no bytes will be written
344	// if there's an error. Either all or none of the message bytes will be written
345	// to the buffer.
346	//
347	// NOTE: this method is not concurrent safe.
348	func WriteMessage(buf *bytes.Buffer, msg Message, pver uint32) (int, error) {	3✔
349	// Record the size of the bytes already written in buffer.	3✔
350	oldByteSize := buf.Len()	3✔
351		3✔
352	// cleanBrokenBytes is a helper closure that helps reset the buffer to	3✔
353	// its original state. It truncates all the bytes written in current	3✔
354	// scope.	3✔
355	var cleanBrokenBytes = func(b *bytes.Buffer) int {	3✔
356	b.Truncate(oldByteSize)	×
357	return 0	×
358	}	×
359
360	// Write the message type.
361	var mType [2]byte	3✔
362	binary.BigEndian.PutUint16(mType[:], uint16(msg.MsgType()))	3✔
363	msgTypeBytes, err := buf.Write(mType[:])	3✔
364	if err != nil {	3✔
365	return cleanBrokenBytes(buf), ErrorWriteMessageType(err)	×
366	}	×
367
368	// Use the write buffer to encode our message.
369	if err := msg.Encode(buf, pver); err != nil {	3✔
370	return cleanBrokenBytes(buf), ErrorEncodeMessage(err)	×
371	}	×
372
373	// Enforce maximum overall message payload. The write buffer now has
374	// the size of len(originalBytes) + len(payload) + len(type). We want
375	// to enforce the payload here, so we subtract it by the length of the
376	// type and old bytes.
377	lenp := buf.Len() - oldByteSize - msgTypeBytes	3✔
378	if lenp > MaxMsgBody {	3✔
379	return cleanBrokenBytes(buf), ErrorPayloadTooLarge(lenp)	×
380	}	×
381
382	return buf.Len() - oldByteSize, nil	3✔
383	}
384
385	// ReadMessage reads, validates, and parses the next Lightning message from r
386	// for the provided protocol version.
387	func ReadMessage(r io.Reader, pver uint32) (Message, error) {	3✔
388	// First, we'll read out the first two bytes of the message so we can	3✔
389	// create the proper empty message.	3✔
390	var mType [2]byte	3✔
391	if _, err := io.ReadFull(r, mType[:]); err != nil {	3✔
392	return nil, err	×
393	}	×
394
395	msgType := MessageType(binary.BigEndian.Uint16(mType[:]))	3✔
396		3✔
397	// Now that we know the target message type, we can create the proper	3✔
398	// empty message type and decode the message into it.	3✔
399	msg, err := makeEmptyMessage(msgType)	3✔
400	if err != nil {	6✔
401	return nil, err	3✔
402	}	3✔
403	if err := msg.Decode(r, pver); err != nil {	3✔
404	return nil, err	×
405	}	×
406
407	return msg, nil	3✔
408	}

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