6c7880ef76
This commit modifies most of the wire messages to uniquely identify any *active* channels by their funding output. This allows the wire protocol to support funding transactions which open several channels in parallel. Any pending channels created by partial completion of the funding workflow are to be identified by a uint64 initialized by both sides as follows: the initiator of the connection starts from 0, while the listening node starts from (1 << 63). These pending channel identifiers are expected to be monotonically increasing with each new funding workflow between two nodes. This identifier is volatile w.r.t to each connection initiation.
101 lines
2.8 KiB
Go
101 lines
2.8 KiB
Go
package lnwire
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/roasbeef/btcd/wire"
|
|
)
|
|
|
|
// HTLCTimeoutRequest is sent by Alice to Bob in order to timeout a previously
|
|
// added HTLC. Upon receipt of an HTLCTimeoutRequest the HTLC should be removed
|
|
// from the next commitment transaction, with the HTLCTimeoutRequest propgated
|
|
// backwards in the route to fully clear the HTLC.
|
|
type HTLCTimeoutRequest struct {
|
|
// ChannelPoint is the particular active channel that this HTLCTimeoutRequest
|
|
// is binded to.
|
|
ChannelPoint *wire.OutPoint
|
|
|
|
// HTLCKey references which HTLC on the remote node's commitment
|
|
// transaction has timed out.
|
|
HTLCKey HTLCKey
|
|
}
|
|
|
|
// Decode deserializes a serialized HTLCTimeoutRequest message stored in the passed
|
|
// io.Reader observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) Decode(r io.Reader, pver uint32) error {
|
|
// ChannelPoint(8)
|
|
// HTLCKey(8)
|
|
err := readElements(r,
|
|
&c.ChannelPoint,
|
|
&c.HTLCKey,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// NewHTLCTimeoutRequest creates a new HTLCTimeoutRequest message.
|
|
func NewHTLCTimeoutRequest() *HTLCTimeoutRequest {
|
|
return &HTLCTimeoutRequest{}
|
|
}
|
|
|
|
// A compile time check to ensure HTLCTimeoutRequest implements the lnwire.Message
|
|
// interface.
|
|
var _ Message = (*HTLCTimeoutRequest)(nil)
|
|
|
|
// Encode serializes the target HTLCTimeoutRequest into the passed io.Writer observing
|
|
// the protocol version specified.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) Encode(w io.Writer, pver uint32) error {
|
|
err := writeElements(w,
|
|
c.ChannelPoint,
|
|
c.HTLCKey,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Command returns the integer uniquely identifying this message type on the
|
|
// wire.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) Command() uint32 {
|
|
return CmdHTLCTimeoutRequest
|
|
}
|
|
|
|
// MaxPayloadLength returns the maximum allowed payload size for a HTLCTimeoutRequest
|
|
// complete message observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) MaxPayloadLength(uint32) uint32 {
|
|
// 36 + 8
|
|
return 44
|
|
}
|
|
|
|
// Validate performs any necessary sanity checks to ensure all fields present
|
|
// on the HTLCTimeoutRequest are valid.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) Validate() error {
|
|
// We're good!
|
|
return nil
|
|
}
|
|
|
|
// String returns the string representation of the target HTLCTimeoutRequest. //
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *HTLCTimeoutRequest) String() string {
|
|
return fmt.Sprintf("\n--- Begin HTLCTimeoutRequest ---\n") +
|
|
fmt.Sprintf("ChannelPoint:\t%d\n", c.ChannelPoint) +
|
|
fmt.Sprintf("HTLCKey:\t%d\n", c.HTLCKey) +
|
|
fmt.Sprintf("--- End HTLCTimeoutRequest ---\n")
|
|
}
|