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.
115 lines
3.3 KiB
Go
115 lines
3.3 KiB
Go
package lnwire
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/roasbeef/btcd/btcec"
|
|
"github.com/roasbeef/btcd/wire"
|
|
|
|
"io"
|
|
)
|
|
|
|
// CloseComplete is sent by Bob signalling a fufillment and completion of
|
|
// Alice's prior CloseRequest message. After Alice receives Bob's CloseComplete
|
|
// message, she is able to broadcast the fully signed transaction executing a
|
|
// cooperative closure of the channel.
|
|
//
|
|
// NOTE: The responder is able to only send a signature without any additional
|
|
// message as all transactions are assembled observing BIP 69 which defines a
|
|
// cannonical ordering for input/outputs. Therefore, both sides are able to
|
|
// arrive at an identical closure transaction as they know the order of the
|
|
// inputs/outputs.
|
|
type CloseComplete struct {
|
|
// ChannelPoint serves to identify which channel is to be closed.
|
|
ChannelPoint *wire.OutPoint
|
|
|
|
// ResponderCloseSig is the signature of the responder for the
|
|
// transaction which closes the previously active channel.
|
|
ResponderCloseSig *btcec.Signature
|
|
}
|
|
|
|
// NewCloseComplete creates a new empty CloseComplete message.
|
|
// TODO(roasbeef): add params to all constructors...
|
|
func NewCloseComplete() *CloseComplete {
|
|
return &CloseComplete{}
|
|
}
|
|
|
|
// A compile time check to ensure CloseComplete implements the lnwire.Message
|
|
// interface.
|
|
var _ Message = (*CloseComplete)(nil)
|
|
|
|
// Decode deserializes a serialized CloseComplete message stored in the passed
|
|
// io.Reader observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *CloseComplete) Decode(r io.Reader, pver uint32) error {
|
|
// ChannelPoint (8)
|
|
// ResponderCloseSig (73)
|
|
err := readElements(r,
|
|
&c.ChannelPoint,
|
|
&c.ResponderCloseSig)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Encode serializes the target CloseComplete into the passed io.Writer observing
|
|
// the protocol version specified.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *CloseComplete) Encode(w io.Writer, pver uint32) error {
|
|
// ChannelPoint (8)
|
|
// ResponderCloseSig (73)
|
|
err := writeElements(w,
|
|
c.ChannelPoint,
|
|
c.ResponderCloseSig)
|
|
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 *CloseComplete) Command() uint32 {
|
|
return CmdCloseComplete
|
|
}
|
|
|
|
// MaxPayloadLength returns the maximum allowed payload size for a CloseComplete
|
|
// complete message observing the specified protocol version.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *CloseComplete) MaxPayloadLength(uint32) uint32 {
|
|
// 141 + 73 + 32
|
|
return 141
|
|
}
|
|
|
|
// Validate performs any necessary sanity checks to ensure all fields present
|
|
// on the CloseComplete are valid.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *CloseComplete) Validate() error {
|
|
// We're good!
|
|
return nil
|
|
}
|
|
|
|
// String returns the string representation of the target CloseComplete.
|
|
//
|
|
// This is part of the lnwire.Message interface.
|
|
func (c *CloseComplete) String() string {
|
|
var serializedSig []byte
|
|
if c.ResponderCloseSig != nil {
|
|
serializedSig = c.ResponderCloseSig.Serialize()
|
|
}
|
|
|
|
return fmt.Sprintf("\n--- Begin CloseComplete ---\n") +
|
|
fmt.Sprintf("ReservationID:\t\t%d\n", c.ChannelPoint) +
|
|
fmt.Sprintf("ResponderCloseSig:\t%x\n", serializedSig) +
|
|
fmt.Sprintf("--- End CloseComplete ---\n")
|
|
}
|