dd6f0ba931
In order to prep for allowing TLV extensions for the `ReplyChannelRange` and `QueryChannelRange` messages, we'll need to remove the struct embedding as is. If we don't remove this, then we'll attempt to decode TLV extensions from both the embedded and outer struct. All relevant call sites have been updated to reflect this minor change.
128 lines
3.5 KiB
Go
128 lines
3.5 KiB
Go
package lnwire
|
|
|
|
import (
|
|
"io"
|
|
"math"
|
|
|
|
"github.com/btcsuite/btcd/chaincfg/chainhash"
|
|
)
|
|
|
|
// ReplyChannelRange is the response to the QueryChannelRange message. It
|
|
// includes the original query, and the next streaming chunk of encoded short
|
|
// channel ID's as the response. We'll also include a byte that indicates if
|
|
// this is the last query in the message.
|
|
type ReplyChannelRange struct {
|
|
// ChainHash denotes the target chain that we're trying to synchronize
|
|
// channel graph state for.
|
|
ChainHash chainhash.Hash
|
|
|
|
// FirstBlockHeight is the first block in the query range. The
|
|
// responder should send all new short channel IDs from this block
|
|
// until this block plus the specified number of blocks.
|
|
FirstBlockHeight uint32
|
|
|
|
// NumBlocks is the number of blocks beyond the first block that short
|
|
// channel ID's should be sent for.
|
|
NumBlocks uint32
|
|
|
|
// Complete denotes if this is the conclusion of the set of streaming
|
|
// responses to the original query.
|
|
Complete uint8
|
|
|
|
// EncodingType is a signal to the receiver of the message that
|
|
// indicates exactly how the set of short channel ID's that follow have
|
|
// been encoded.
|
|
EncodingType ShortChanIDEncoding
|
|
|
|
// ShortChanIDs is a slice of decoded short channel ID's.
|
|
ShortChanIDs []ShortChannelID
|
|
|
|
// noSort indicates whether or not to sort the short channel ids before
|
|
// writing them out.
|
|
//
|
|
// NOTE: This should only be used for testing.
|
|
noSort bool
|
|
}
|
|
|
|
// NewReplyChannelRange creates a new empty ReplyChannelRange message.
|
|
func NewReplyChannelRange() *ReplyChannelRange {
|
|
return &ReplyChannelRange{}
|
|
}
|
|
|
|
// A compile time check to ensure ReplyChannelRange implements the
|
|
// lnwire.Message interface.
|
|
var _ Message = (*ReplyChannelRange)(nil)
|
|
|
|
// Decode deserializes a serialized ReplyChannelRange message stored in the
|
|
// passed io.Reader observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *ReplyChannelRange) Decode(r io.Reader, pver uint32) error {
|
|
err := ReadElements(r,
|
|
c.ChainHash[:],
|
|
&c.FirstBlockHeight,
|
|
&c.NumBlocks,
|
|
&c.Complete,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
c.EncodingType, c.ShortChanIDs, err = decodeShortChanIDs(r)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
// Encode serializes the target ReplyChannelRange into the passed io.Writer
|
|
// observing the protocol version specified.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *ReplyChannelRange) Encode(w io.Writer, pver uint32) error {
|
|
err := WriteElements(w,
|
|
c.ChainHash[:],
|
|
c.FirstBlockHeight,
|
|
c.NumBlocks,
|
|
c.Complete,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = encodeShortChanIDs(w, c.EncodingType, c.ShortChanIDs, c.noSort)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// MsgType returns the integer uniquely identifying this message type on the
|
|
// wire.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *ReplyChannelRange) MsgType() MessageType {
|
|
return MsgReplyChannelRange
|
|
}
|
|
|
|
// MaxPayloadLength returns the maximum allowed payload size for a
|
|
// ReplyChannelRange complete message observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *ReplyChannelRange) MaxPayloadLength(uint32) uint32 {
|
|
return MaxMessagePayload
|
|
}
|
|
|
|
// LastBlockHeight returns the last block height covered by the range of a
|
|
// QueryChannelRange message.
|
|
func (c *ReplyChannelRange) LastBlockHeight() uint32 {
|
|
// Handle overflows by casting to uint64.
|
|
lastBlockHeight := uint64(c.FirstBlockHeight) + uint64(c.NumBlocks) - 1
|
|
if lastBlockHeight > math.MaxUint32 {
|
|
return math.MaxUint32
|
|
}
|
|
return uint32(lastBlockHeight)
|
|
}
|