2015-12-23 11:08:34 +03:00
|
|
|
package lnwire
|
|
|
|
|
|
|
|
import (
|
2017-09-19 03:27:37 +03:00
|
|
|
"bytes"
|
2015-12-23 11:08:34 +03:00
|
|
|
"encoding/binary"
|
|
|
|
"fmt"
|
2017-12-03 05:23:05 +03:00
|
|
|
"image/color"
|
2016-05-23 23:50:36 +03:00
|
|
|
"io"
|
2017-07-26 06:39:59 +03:00
|
|
|
"math"
|
2016-05-23 23:50:36 +03:00
|
|
|
|
2016-12-25 01:55:31 +03:00
|
|
|
"net"
|
|
|
|
|
2018-06-05 04:34:16 +03:00
|
|
|
"github.com/btcsuite/btcd/btcec"
|
|
|
|
"github.com/btcsuite/btcd/chaincfg/chainhash"
|
|
|
|
"github.com/btcsuite/btcd/wire"
|
|
|
|
"github.com/btcsuite/btcutil"
|
2016-12-07 18:46:22 +03:00
|
|
|
"github.com/go-errors/errors"
|
2018-04-25 20:22:47 +03:00
|
|
|
"github.com/lightningnetwork/lnd/tor"
|
2015-12-23 11:08:34 +03:00
|
|
|
)
|
|
|
|
|
2017-12-18 05:40:05 +03:00
|
|
|
// MaxSliceLength is the maximum allowed length for any opaque byte slices in
|
2016-05-23 23:50:36 +03:00
|
|
|
// the wire protocol.
|
|
|
|
const MaxSliceLength = 65535
|
2016-01-05 19:19:22 +03:00
|
|
|
|
2016-05-23 23:50:36 +03:00
|
|
|
// PkScript is simple type definition which represents a raw serialized public
|
|
|
|
// key script.
|
2015-12-23 11:08:34 +03:00
|
|
|
type PkScript []byte
|
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
// addressType specifies the network protocol and version that should be used
|
|
|
|
// when connecting to a node at a particular address.
|
|
|
|
type addressType uint8
|
|
|
|
|
|
|
|
const (
|
2017-09-19 03:27:37 +03:00
|
|
|
// noAddr denotes a blank address. An address of this type indicates
|
2018-01-30 03:07:26 +03:00
|
|
|
// that a node doesn't have any advertised addresses.
|
2017-09-19 03:27:37 +03:00
|
|
|
noAddr addressType = 0
|
|
|
|
|
|
|
|
// tcp4Addr denotes an IPv4 TCP address.
|
|
|
|
tcp4Addr addressType = 1
|
|
|
|
|
2018-01-30 04:31:48 +03:00
|
|
|
// tcp6Addr denotes an IPv6 TCP address.
|
2017-09-19 03:27:37 +03:00
|
|
|
tcp6Addr addressType = 2
|
|
|
|
|
|
|
|
// v2OnionAddr denotes a version 2 Tor onion service address.
|
|
|
|
v2OnionAddr addressType = 3
|
|
|
|
|
2018-04-25 20:22:47 +03:00
|
|
|
// v3OnionAddr denotes a version 3 Tor (prop224) onion service address.
|
2017-09-19 03:27:37 +03:00
|
|
|
v3OnionAddr addressType = 4
|
2017-02-17 12:29:23 +03:00
|
|
|
)
|
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
// AddrLen returns the number of bytes that it takes to encode the target
|
|
|
|
// address.
|
|
|
|
func (a addressType) AddrLen() uint16 {
|
|
|
|
switch a {
|
|
|
|
case noAddr:
|
|
|
|
return 0
|
|
|
|
case tcp4Addr:
|
|
|
|
return 6
|
|
|
|
case tcp6Addr:
|
|
|
|
return 18
|
|
|
|
case v2OnionAddr:
|
|
|
|
return 12
|
|
|
|
case v3OnionAddr:
|
|
|
|
return 37
|
|
|
|
default:
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-10 05:27:41 +03:00
|
|
|
// WriteElement is a one-stop shop to write the big endian representation of
|
2016-05-23 23:51:21 +03:00
|
|
|
// any element which is to be serialized for the wire protocol. The passed
|
2017-04-20 01:58:44 +03:00
|
|
|
// io.Writer should be backed by an appropriately sized byte slice, or be able
|
|
|
|
// to dynamically expand to accommodate additional data.
|
2016-05-23 23:51:21 +03:00
|
|
|
//
|
|
|
|
// TODO(roasbeef): this should eventually draw from a buffer pool for
|
|
|
|
// serialization.
|
2018-12-10 05:27:41 +03:00
|
|
|
func WriteElement(w io.Writer, element interface{}) error {
|
2015-12-23 11:08:34 +03:00
|
|
|
switch e := element.(type) {
|
2019-01-04 07:52:03 +03:00
|
|
|
case NodeAlias:
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-04-17 04:47:53 +03:00
|
|
|
case ShortChanIDEncoding:
|
|
|
|
var b [1]byte
|
|
|
|
b[0] = uint8(e)
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
case uint8:
|
|
|
|
var b [1]byte
|
2017-02-23 22:07:01 +03:00
|
|
|
b[0] = e
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2015-12-23 11:08:34 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-11-09 22:59:30 +03:00
|
|
|
case FundingFlag:
|
|
|
|
var b [1]byte
|
|
|
|
b[0] = uint8(e)
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-01-05 19:19:22 +03:00
|
|
|
case uint16:
|
|
|
|
var b [2]byte
|
2017-02-23 22:07:01 +03:00
|
|
|
binary.BigEndian.PutUint16(b[:], e)
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2016-01-05 19:19:22 +03:00
|
|
|
return err
|
|
|
|
}
|
2019-01-12 20:59:43 +03:00
|
|
|
case ChanUpdateMsgFlags:
|
|
|
|
var b [1]byte
|
|
|
|
b[0] = uint8(e)
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
case ChanUpdateChanFlags:
|
|
|
|
var b [1]byte
|
|
|
|
b[0] = uint8(e)
|
2017-12-01 09:21:27 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-08-22 08:28:24 +03:00
|
|
|
case MilliSatoshi:
|
|
|
|
var b [8]byte
|
|
|
|
binary.BigEndian.PutUint64(b[:], uint64(e))
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-02-16 15:25:36 +03:00
|
|
|
case btcutil.Amount:
|
|
|
|
var b [8]byte
|
|
|
|
binary.BigEndian.PutUint64(b[:], uint64(e))
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2016-01-05 19:19:22 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
case uint32:
|
|
|
|
var b [4]byte
|
2017-02-23 22:07:01 +03:00
|
|
|
binary.BigEndian.PutUint32(b[:], e)
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2015-12-23 11:08:34 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-30 16:38:57 +03:00
|
|
|
case uint64:
|
|
|
|
var b [8]byte
|
2017-02-23 22:07:01 +03:00
|
|
|
binary.BigEndian.PutUint64(b[:], e)
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2015-12-30 16:38:57 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
case *btcec.PublicKey:
|
2017-08-22 08:28:24 +03:00
|
|
|
if e == nil {
|
2017-08-22 11:00:07 +03:00
|
|
|
return fmt.Errorf("cannot write nil pubkey")
|
2017-08-22 08:28:24 +03:00
|
|
|
}
|
|
|
|
|
2015-12-23 11:08:34 +03:00
|
|
|
var b [33]byte
|
|
|
|
serializedPubkey := e.SerializeCompressed()
|
|
|
|
copy(b[:], serializedPubkey)
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
2015-12-23 11:08:34 +03:00
|
|
|
return err
|
|
|
|
}
|
2018-01-31 06:41:52 +03:00
|
|
|
case []Sig:
|
2017-07-29 02:26:06 +03:00
|
|
|
var b [2]byte
|
|
|
|
numSigs := uint16(len(e))
|
|
|
|
binary.BigEndian.PutUint16(b[:], numSigs)
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
for _, sig := range e {
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := WriteElement(w, sig); err != nil {
|
2017-07-29 02:26:06 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
2018-01-31 06:41:52 +03:00
|
|
|
case Sig:
|
2016-12-08 23:56:37 +03:00
|
|
|
// Write buffer
|
2018-01-31 06:41:52 +03:00
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
2015-12-30 16:38:57 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-04-17 04:11:39 +03:00
|
|
|
case PingPayload:
|
|
|
|
var l [2]byte
|
|
|
|
binary.BigEndian.PutUint16(l[:], uint16(len(e)))
|
|
|
|
if _, err := w.Write(l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
case PongPayload:
|
|
|
|
var l [2]byte
|
|
|
|
binary.BigEndian.PutUint16(l[:], uint16(len(e)))
|
|
|
|
if _, err := w.Write(l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-04-17 01:23:40 +03:00
|
|
|
case ErrorData:
|
|
|
|
var l [2]byte
|
|
|
|
binary.BigEndian.PutUint16(l[:], uint16(len(e)))
|
|
|
|
if _, err := w.Write(l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-02-21 09:02:42 +03:00
|
|
|
case OpaqueReason:
|
|
|
|
var l [2]byte
|
|
|
|
binary.BigEndian.PutUint16(l[:], uint16(len(e)))
|
|
|
|
if _, err := w.Write(l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-01-31 06:53:49 +03:00
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
case [33]byte:
|
2017-02-21 09:02:42 +03:00
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-01-05 19:19:22 +03:00
|
|
|
case []byte:
|
2017-02-16 15:25:36 +03:00
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
2016-05-31 01:42:53 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
case PkScript:
|
2017-04-20 02:04:38 +03:00
|
|
|
// The largest script we'll accept is a p2wsh which is exactly
|
|
|
|
// 34 bytes long.
|
2015-12-23 11:08:34 +03:00
|
|
|
scriptLength := len(e)
|
2017-04-20 02:04:38 +03:00
|
|
|
if scriptLength > 34 {
|
2017-02-23 22:56:47 +03:00
|
|
|
return fmt.Errorf("'PkScript' too long")
|
2015-12-23 11:08:34 +03:00
|
|
|
}
|
2016-05-23 23:51:21 +03:00
|
|
|
|
|
|
|
if err := wire.WriteVarBytes(w, 0, e); err != nil {
|
2015-12-23 11:08:34 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-10-11 21:37:54 +03:00
|
|
|
case *RawFeatureVector:
|
2017-08-22 08:28:24 +03:00
|
|
|
if e == nil {
|
|
|
|
return fmt.Errorf("cannot write nil feature vector")
|
|
|
|
}
|
|
|
|
|
2017-02-16 15:31:19 +03:00
|
|
|
if err := e.Encode(w); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-02-16 15:34:44 +03:00
|
|
|
|
|
|
|
case wire.OutPoint:
|
2017-07-26 06:39:59 +03:00
|
|
|
var h [32]byte
|
|
|
|
copy(h[:], e.Hash[:])
|
|
|
|
if _, err := w.Write(h[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if e.Index > math.MaxUint16 {
|
|
|
|
return fmt.Errorf("index for outpoint (%v) is "+
|
|
|
|
"greater than max index of %v", e.Index,
|
|
|
|
math.MaxUint16)
|
|
|
|
}
|
|
|
|
|
|
|
|
var idx [2]byte
|
|
|
|
binary.BigEndian.PutUint16(idx[:], uint16(e.Index))
|
|
|
|
if _, err := w.Write(idx[:]); err != nil {
|
2016-05-31 01:42:53 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-04-17 01:22:20 +03:00
|
|
|
|
|
|
|
case ChannelID:
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-06-28 18:22:23 +03:00
|
|
|
case FailCode:
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := WriteElement(w, uint16(e)); err != nil {
|
2017-06-28 18:22:23 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-03-27 18:22:37 +03:00
|
|
|
case ShortChannelID:
|
2016-12-07 18:46:22 +03:00
|
|
|
// Check that field fit in 3 bytes and write the blockHeight
|
|
|
|
if e.BlockHeight > ((1 << 24) - 1) {
|
|
|
|
return errors.New("block height should fit in 3 bytes")
|
|
|
|
}
|
|
|
|
|
|
|
|
var blockHeight [4]byte
|
|
|
|
binary.BigEndian.PutUint32(blockHeight[:], e.BlockHeight)
|
|
|
|
|
|
|
|
if _, err := w.Write(blockHeight[1:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check that field fit in 3 bytes and write the txIndex
|
|
|
|
if e.TxIndex > ((1 << 24) - 1) {
|
|
|
|
return errors.New("tx index should fit in 3 bytes")
|
|
|
|
}
|
|
|
|
|
|
|
|
var txIndex [4]byte
|
|
|
|
binary.BigEndian.PutUint32(txIndex[:], e.TxIndex)
|
|
|
|
if _, err := w.Write(txIndex[1:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Write the txPosition
|
|
|
|
var txPosition [2]byte
|
|
|
|
binary.BigEndian.PutUint16(txPosition[:], e.TxPosition)
|
|
|
|
if _, err := w.Write(txPosition[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
case *net.TCPAddr:
|
2017-08-22 08:28:24 +03:00
|
|
|
if e == nil {
|
|
|
|
return fmt.Errorf("cannot write nil TCPAddr")
|
|
|
|
}
|
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
if e.IP.To4() != nil {
|
|
|
|
var descriptor [1]byte
|
|
|
|
descriptor[0] = uint8(tcp4Addr)
|
|
|
|
if _, err := w.Write(descriptor[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-12-07 18:46:22 +03:00
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
var ip [4]byte
|
|
|
|
copy(ip[:], e.IP.To4())
|
|
|
|
if _, err := w.Write(ip[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
var descriptor [1]byte
|
|
|
|
descriptor[0] = uint8(tcp6Addr)
|
|
|
|
if _, err := w.Write(descriptor[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
var ip [16]byte
|
|
|
|
copy(ip[:], e.IP.To16())
|
|
|
|
if _, err := w.Write(ip[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
var port [2]byte
|
|
|
|
binary.BigEndian.PutUint16(port[:], uint16(e.Port))
|
2016-12-07 18:46:22 +03:00
|
|
|
if _, err := w.Write(port[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
|
2018-04-25 20:22:47 +03:00
|
|
|
case *tor.OnionAddr:
|
|
|
|
if e == nil {
|
|
|
|
return errors.New("cannot write nil onion address")
|
|
|
|
}
|
|
|
|
|
|
|
|
var suffixIndex int
|
|
|
|
switch len(e.OnionService) {
|
|
|
|
case tor.V2Len:
|
|
|
|
descriptor := []byte{byte(v2OnionAddr)}
|
|
|
|
if _, err := w.Write(descriptor); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
suffixIndex = tor.V2Len - tor.OnionSuffixLen
|
|
|
|
case tor.V3Len:
|
|
|
|
descriptor := []byte{byte(v3OnionAddr)}
|
|
|
|
if _, err := w.Write(descriptor); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
suffixIndex = tor.V3Len - tor.OnionSuffixLen
|
|
|
|
default:
|
|
|
|
return errors.New("unknown onion service length")
|
|
|
|
}
|
|
|
|
|
|
|
|
host, err := tor.Base32Encoding.DecodeString(
|
|
|
|
e.OnionService[:suffixIndex],
|
|
|
|
)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := w.Write(host); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var port [2]byte
|
|
|
|
binary.BigEndian.PutUint16(port[:], uint16(e.Port))
|
|
|
|
if _, err := w.Write(port[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
case []net.Addr:
|
2017-09-19 03:27:37 +03:00
|
|
|
// First, we'll encode all the addresses into an intermediate
|
|
|
|
// buffer. We need to do this in order to compute the total
|
|
|
|
// length of the addresses.
|
|
|
|
var addrBuf bytes.Buffer
|
|
|
|
for _, address := range e {
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := WriteElement(&addrBuf, address); err != nil {
|
2017-09-19 03:27:37 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// With the addresses fully encoded, we can now write out the
|
|
|
|
// number of bytes needed to encode them.
|
|
|
|
addrLen := addrBuf.Len()
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := WriteElement(w, uint16(addrLen)); err != nil {
|
2017-02-17 12:29:23 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
// Finally, we'll write out the raw addresses themselves, but
|
|
|
|
// only if we have any bytes to write.
|
|
|
|
if addrLen > 0 {
|
|
|
|
if _, err := w.Write(addrBuf.Bytes()); err != nil {
|
2017-02-17 12:29:23 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
2017-12-03 05:23:05 +03:00
|
|
|
case color.RGBA:
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := WriteElements(w, e.R, e.G, e.B); err != nil {
|
2016-12-07 18:46:22 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
|
2017-03-09 02:32:11 +03:00
|
|
|
case DeliveryAddress:
|
|
|
|
var length [2]byte
|
|
|
|
binary.BigEndian.PutUint16(length[:], uint16(len(e)))
|
|
|
|
if _, err := w.Write(length[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if _, err := w.Write(e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-12-07 18:46:22 +03:00
|
|
|
|
2019-03-11 02:28:18 +03:00
|
|
|
case bool:
|
|
|
|
var b [1]byte
|
|
|
|
if e {
|
|
|
|
b[0] = 1
|
|
|
|
}
|
|
|
|
if _, err := w.Write(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
default:
|
2020-04-14 20:56:05 +03:00
|
|
|
return fmt.Errorf("unknown type in WriteElement: %T", e)
|
2015-12-23 11:08:34 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-12-10 05:27:41 +03:00
|
|
|
// WriteElements is writes each element in the elements slice to the passed
|
|
|
|
// io.Writer using WriteElement.
|
|
|
|
func WriteElements(w io.Writer, elements ...interface{}) error {
|
2015-12-28 14:24:16 +03:00
|
|
|
for _, element := range elements {
|
2018-12-10 05:27:41 +03:00
|
|
|
err := WriteElement(w, element)
|
2015-12-28 14:24:16 +03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-12-10 05:27:41 +03:00
|
|
|
// ReadElement is a one-stop utility function to deserialize any datastructure
|
2016-05-23 23:51:21 +03:00
|
|
|
// encoded using the serialization format of lnwire.
|
2018-12-10 05:27:41 +03:00
|
|
|
func ReadElement(r io.Reader, element interface{}) error {
|
2015-12-23 11:08:34 +03:00
|
|
|
var err error
|
|
|
|
switch e := element.(type) {
|
2019-03-11 02:28:18 +03:00
|
|
|
case *bool:
|
|
|
|
var b [1]byte
|
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if b[0] == 1 {
|
|
|
|
*e = true
|
|
|
|
}
|
|
|
|
|
2019-01-04 07:52:03 +03:00
|
|
|
case *NodeAlias:
|
|
|
|
var a [32]byte
|
|
|
|
if _, err := io.ReadFull(r, a[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
alias, err := NewNodeAlias(string(a[:]))
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
*e = alias
|
2018-04-17 04:47:53 +03:00
|
|
|
case *ShortChanIDEncoding:
|
|
|
|
var b [1]uint8
|
|
|
|
if _, err := r.Read(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = ShortChanIDEncoding(b[0])
|
2015-12-27 05:20:25 +03:00
|
|
|
case *uint8:
|
2015-12-27 10:52:20 +03:00
|
|
|
var b [1]uint8
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := r.Read(b[:]); err != nil {
|
2015-12-27 05:20:25 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-27 10:52:20 +03:00
|
|
|
*e = b[0]
|
2017-11-09 22:59:30 +03:00
|
|
|
case *FundingFlag:
|
|
|
|
var b [1]uint8
|
|
|
|
if _, err := r.Read(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = FundingFlag(b[0])
|
2016-01-05 19:19:22 +03:00
|
|
|
case *uint16:
|
|
|
|
var b [2]byte
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
2016-01-05 19:19:22 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = binary.BigEndian.Uint16(b[:])
|
2019-01-12 20:59:43 +03:00
|
|
|
case *ChanUpdateMsgFlags:
|
|
|
|
var b [1]uint8
|
|
|
|
if _, err := r.Read(b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = ChanUpdateMsgFlags(b[0])
|
|
|
|
case *ChanUpdateChanFlags:
|
|
|
|
var b [1]uint8
|
|
|
|
if _, err := r.Read(b[:]); err != nil {
|
2017-12-01 09:21:27 +03:00
|
|
|
return err
|
|
|
|
}
|
2019-01-12 20:59:43 +03:00
|
|
|
*e = ChanUpdateChanFlags(b[0])
|
2015-12-23 11:08:34 +03:00
|
|
|
case *uint32:
|
|
|
|
var b [4]byte
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
2015-12-23 11:08:34 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = binary.BigEndian.Uint32(b[:])
|
2015-12-30 16:38:57 +03:00
|
|
|
case *uint64:
|
|
|
|
var b [8]byte
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
2015-12-30 16:38:57 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = binary.BigEndian.Uint64(b[:])
|
2017-08-22 08:28:24 +03:00
|
|
|
case *MilliSatoshi:
|
|
|
|
var b [8]byte
|
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = MilliSatoshi(int64(binary.BigEndian.Uint64(b[:])))
|
2015-12-27 05:20:25 +03:00
|
|
|
case *btcutil.Amount:
|
|
|
|
var b [8]byte
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err := io.ReadFull(r, b[:]); err != nil {
|
2015-12-27 05:20:25 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-27 10:52:20 +03:00
|
|
|
*e = btcutil.Amount(int64(binary.BigEndian.Uint64(b[:])))
|
|
|
|
case **btcec.PublicKey:
|
2016-12-07 18:46:22 +03:00
|
|
|
var b [btcec.PubKeyBytesLenCompressed]byte
|
2016-05-23 23:51:21 +03:00
|
|
|
if _, err = io.ReadFull(r, b[:]); err != nil {
|
2015-12-27 05:20:25 +03:00
|
|
|
return err
|
|
|
|
}
|
2016-05-23 23:51:21 +03:00
|
|
|
|
|
|
|
pubKey, err := btcec.ParsePubKey(b[:], btcec.S256())
|
2015-12-30 16:38:57 +03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-05-23 23:51:21 +03:00
|
|
|
*e = pubKey
|
2017-10-11 21:37:54 +03:00
|
|
|
case **RawFeatureVector:
|
|
|
|
f := NewRawFeatureVector()
|
|
|
|
err = f.Decode(r)
|
2017-02-16 15:31:19 +03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
*e = f
|
|
|
|
|
2018-01-31 06:41:52 +03:00
|
|
|
case *[]Sig:
|
2017-07-29 02:26:06 +03:00
|
|
|
var l [2]byte
|
|
|
|
if _, err := io.ReadFull(r, l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
numSigs := binary.BigEndian.Uint16(l[:])
|
|
|
|
|
2018-01-31 06:41:52 +03:00
|
|
|
var sigs []Sig
|
2017-07-29 02:26:06 +03:00
|
|
|
if numSigs > 0 {
|
2018-01-31 06:41:52 +03:00
|
|
|
sigs = make([]Sig, numSigs)
|
2017-07-29 02:26:06 +03:00
|
|
|
for i := 0; i < int(numSigs); i++ {
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := ReadElement(r, &sigs[i]); err != nil {
|
2017-07-29 02:26:06 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
*e = sigs
|
|
|
|
|
2018-01-31 06:41:52 +03:00
|
|
|
case *Sig:
|
|
|
|
if _, err := io.ReadFull(r, e[:]); err != nil {
|
2015-12-30 16:38:57 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-02-21 09:02:42 +03:00
|
|
|
case *OpaqueReason:
|
|
|
|
var l [2]byte
|
|
|
|
if _, err := io.ReadFull(r, l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
reasonLen := binary.BigEndian.Uint16(l[:])
|
|
|
|
|
|
|
|
*e = OpaqueReason(make([]byte, reasonLen))
|
|
|
|
if _, err := io.ReadFull(r, *e); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-04-17 01:23:40 +03:00
|
|
|
case *ErrorData:
|
|
|
|
var l [2]byte
|
|
|
|
if _, err := io.ReadFull(r, l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
errorLen := binary.BigEndian.Uint16(l[:])
|
|
|
|
|
|
|
|
*e = ErrorData(make([]byte, errorLen))
|
|
|
|
if _, err := io.ReadFull(r, *e); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-04-17 04:11:39 +03:00
|
|
|
case *PingPayload:
|
|
|
|
var l [2]byte
|
|
|
|
if _, err := io.ReadFull(r, l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
pingLen := binary.BigEndian.Uint16(l[:])
|
|
|
|
|
|
|
|
*e = PingPayload(make([]byte, pingLen))
|
|
|
|
if _, err := io.ReadFull(r, *e); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
case *PongPayload:
|
|
|
|
var l [2]byte
|
|
|
|
if _, err := io.ReadFull(r, l[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
pongLen := binary.BigEndian.Uint16(l[:])
|
|
|
|
|
|
|
|
*e = PongPayload(make([]byte, pongLen))
|
|
|
|
if _, err := io.ReadFull(r, *e); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2018-01-31 06:53:49 +03:00
|
|
|
case *[33]byte:
|
|
|
|
if _, err := io.ReadFull(r, e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-02-16 15:25:36 +03:00
|
|
|
case []byte:
|
|
|
|
if _, err := io.ReadFull(r, e); err != nil {
|
2016-01-05 19:19:22 +03:00
|
|
|
return err
|
|
|
|
}
|
2015-12-27 05:20:25 +03:00
|
|
|
case *PkScript:
|
2017-04-20 02:04:38 +03:00
|
|
|
pkScript, err := wire.ReadVarBytes(r, 0, 34, "pkscript")
|
2015-12-27 05:20:25 +03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2016-05-23 23:51:21 +03:00
|
|
|
*e = pkScript
|
2017-02-16 15:34:44 +03:00
|
|
|
case *wire.OutPoint:
|
2017-07-26 06:39:59 +03:00
|
|
|
var h [32]byte
|
|
|
|
if _, err = io.ReadFull(r, h[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
hash, err := chainhash.NewHash(h[:])
|
|
|
|
if err != nil {
|
2017-06-28 18:22:23 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-04-17 01:22:20 +03:00
|
|
|
|
2017-07-26 06:39:59 +03:00
|
|
|
var idxBytes [2]byte
|
|
|
|
_, err = io.ReadFull(r, idxBytes[:])
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
index := binary.BigEndian.Uint16(idxBytes[:])
|
|
|
|
|
|
|
|
*e = wire.OutPoint{
|
|
|
|
Hash: *hash,
|
|
|
|
Index: uint32(index),
|
|
|
|
}
|
|
|
|
case *FailCode:
|
2018-12-10 05:27:41 +03:00
|
|
|
if err := ReadElement(r, (*uint16)(e)); err != nil {
|
2017-07-26 06:39:59 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-04-17 01:22:20 +03:00
|
|
|
case *ChannelID:
|
|
|
|
if _, err := io.ReadFull(r, e[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-03-27 18:22:37 +03:00
|
|
|
case *ShortChannelID:
|
2016-12-07 18:46:22 +03:00
|
|
|
var blockHeight [4]byte
|
|
|
|
if _, err = io.ReadFull(r, blockHeight[1:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var txIndex [4]byte
|
|
|
|
if _, err = io.ReadFull(r, txIndex[1:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var txPosition [2]byte
|
|
|
|
if _, err = io.ReadFull(r, txPosition[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-03-27 18:22:37 +03:00
|
|
|
*e = ShortChannelID{
|
2016-12-07 18:46:22 +03:00
|
|
|
BlockHeight: binary.BigEndian.Uint32(blockHeight[:]),
|
|
|
|
TxIndex: binary.BigEndian.Uint32(txIndex[:]),
|
|
|
|
TxPosition: binary.BigEndian.Uint16(txPosition[:]),
|
|
|
|
}
|
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
case *[]net.Addr:
|
2017-09-19 03:27:37 +03:00
|
|
|
// First, we'll read the number of total bytes that have been
|
|
|
|
// used to encode the set of addresses.
|
2017-03-30 02:55:28 +03:00
|
|
|
var numAddrsBytes [2]byte
|
|
|
|
if _, err = io.ReadFull(r, numAddrsBytes[:]); err != nil {
|
2016-12-07 18:46:22 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
addrsLen := binary.BigEndian.Uint16(numAddrsBytes[:])
|
2016-12-07 18:46:22 +03:00
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
// With the number of addresses, read, we'll now pull in the
|
|
|
|
// buffer of the encoded addresses into memory.
|
|
|
|
addrs := make([]byte, addrsLen)
|
|
|
|
if _, err := io.ReadFull(r, addrs[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
addrBuf := bytes.NewReader(addrs)
|
2017-03-30 02:55:28 +03:00
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
// Finally, we'll parse the remaining address payload in
|
|
|
|
// series, using the first byte to denote how to decode the
|
|
|
|
// address itself.
|
|
|
|
var (
|
|
|
|
addresses []net.Addr
|
|
|
|
addrBytesRead uint16
|
|
|
|
)
|
2018-04-25 20:22:47 +03:00
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
for addrBytesRead < addrsLen {
|
2017-02-17 12:29:23 +03:00
|
|
|
var descriptor [1]byte
|
2017-09-19 03:27:37 +03:00
|
|
|
if _, err = io.ReadFull(addrBuf, descriptor[:]); err != nil {
|
2017-02-17 12:29:23 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-09-19 03:40:24 +03:00
|
|
|
addrBytesRead++
|
2017-09-19 03:27:37 +03:00
|
|
|
|
2018-04-25 20:22:47 +03:00
|
|
|
var address net.Addr
|
|
|
|
switch aType := addressType(descriptor[0]); aType {
|
2017-09-19 03:27:37 +03:00
|
|
|
case noAddr:
|
|
|
|
addrBytesRead += aType.AddrLen()
|
|
|
|
continue
|
|
|
|
|
|
|
|
case tcp4Addr:
|
2017-02-17 12:29:23 +03:00
|
|
|
var ip [4]byte
|
2018-04-25 20:22:47 +03:00
|
|
|
if _, err := io.ReadFull(addrBuf, ip[:]); err != nil {
|
2017-02-17 12:29:23 +03:00
|
|
|
return err
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
|
|
|
|
var port [2]byte
|
2018-04-25 20:22:47 +03:00
|
|
|
if _, err := io.ReadFull(addrBuf, port[:]); err != nil {
|
2017-09-19 03:27:37 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-04-25 20:22:47 +03:00
|
|
|
address = &net.TCPAddr{
|
|
|
|
IP: net.IP(ip[:]),
|
|
|
|
Port: int(binary.BigEndian.Uint16(port[:])),
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
addrBytesRead += aType.AddrLen()
|
|
|
|
|
|
|
|
case tcp6Addr:
|
2017-02-17 12:29:23 +03:00
|
|
|
var ip [16]byte
|
2018-04-25 20:22:47 +03:00
|
|
|
if _, err := io.ReadFull(addrBuf, ip[:]); err != nil {
|
2017-02-17 12:29:23 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-09-19 03:27:37 +03:00
|
|
|
var port [2]byte
|
2018-04-25 20:22:47 +03:00
|
|
|
if _, err := io.ReadFull(addrBuf, port[:]); err != nil {
|
2017-09-19 03:27:37 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-04-25 20:22:47 +03:00
|
|
|
address = &net.TCPAddr{
|
|
|
|
IP: net.IP(ip[:]),
|
|
|
|
Port: int(binary.BigEndian.Uint16(port[:])),
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
addrBytesRead += aType.AddrLen()
|
|
|
|
|
|
|
|
case v2OnionAddr:
|
2018-04-25 20:22:47 +03:00
|
|
|
var h [tor.V2DecodedLen]byte
|
|
|
|
if _, err := io.ReadFull(addrBuf, h[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var p [2]byte
|
|
|
|
if _, err := io.ReadFull(addrBuf, p[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
onionService := tor.Base32Encoding.EncodeToString(h[:])
|
|
|
|
onionService += tor.OnionSuffix
|
|
|
|
port := int(binary.BigEndian.Uint16(p[:]))
|
|
|
|
|
|
|
|
address = &tor.OnionAddr{
|
|
|
|
OnionService: onionService,
|
|
|
|
Port: port,
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
addrBytesRead += aType.AddrLen()
|
|
|
|
|
|
|
|
case v3OnionAddr:
|
2018-04-25 20:22:47 +03:00
|
|
|
var h [tor.V3DecodedLen]byte
|
|
|
|
if _, err := io.ReadFull(addrBuf, h[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var p [2]byte
|
|
|
|
if _, err := io.ReadFull(addrBuf, p[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
onionService := tor.Base32Encoding.EncodeToString(h[:])
|
|
|
|
onionService += tor.OnionSuffix
|
|
|
|
port := int(binary.BigEndian.Uint16(p[:]))
|
|
|
|
|
|
|
|
address = &tor.OnionAddr{
|
|
|
|
OnionService: onionService,
|
|
|
|
Port: port,
|
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
addrBytesRead += aType.AddrLen()
|
|
|
|
|
|
|
|
default:
|
2018-03-31 00:25:48 +03:00
|
|
|
return &ErrUnknownAddrType{aType}
|
2017-02-17 12:29:23 +03:00
|
|
|
}
|
2016-12-07 18:46:22 +03:00
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
addresses = append(addresses, address)
|
2016-12-07 18:46:22 +03:00
|
|
|
}
|
2017-09-19 03:27:37 +03:00
|
|
|
|
2017-02-17 12:29:23 +03:00
|
|
|
*e = addresses
|
2017-12-03 05:23:05 +03:00
|
|
|
case *color.RGBA:
|
2018-12-10 05:27:41 +03:00
|
|
|
err := ReadElements(r,
|
2017-12-03 05:23:05 +03:00
|
|
|
&e.R,
|
|
|
|
&e.G,
|
|
|
|
&e.B,
|
2016-12-07 18:46:22 +03:00
|
|
|
)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-03-09 02:32:11 +03:00
|
|
|
case *DeliveryAddress:
|
|
|
|
var addrLen [2]byte
|
|
|
|
if _, err = io.ReadFull(r, addrLen[:]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
length := binary.BigEndian.Uint16(addrLen[:])
|
|
|
|
|
2019-12-03 12:38:21 +03:00
|
|
|
var addrBytes [deliveryAddressMaxSize]byte
|
|
|
|
if length > deliveryAddressMaxSize {
|
2020-04-14 20:56:05 +03:00
|
|
|
return fmt.Errorf("cannot read %d bytes into addrBytes", length)
|
2017-09-01 15:26:57 +03:00
|
|
|
}
|
2017-03-09 02:32:11 +03:00
|
|
|
if _, err = io.ReadFull(r, addrBytes[:length]); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
*e = addrBytes[:length]
|
2015-12-27 05:20:25 +03:00
|
|
|
default:
|
2020-04-14 20:56:05 +03:00
|
|
|
return fmt.Errorf("unknown type in ReadElement: %T", e)
|
2015-12-27 05:20:25 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-12-10 05:27:41 +03:00
|
|
|
// ReadElements deserializes a variable number of elements into the passed
|
|
|
|
// io.Reader, with each element being deserialized according to the ReadElement
|
2016-05-23 23:51:21 +03:00
|
|
|
// function.
|
2018-12-10 05:27:41 +03:00
|
|
|
func ReadElements(r io.Reader, elements ...interface{}) error {
|
2015-12-28 14:24:16 +03:00
|
|
|
for _, element := range elements {
|
2018-12-10 05:27:41 +03:00
|
|
|
err := ReadElement(r, element)
|
2015-12-28 14:24:16 +03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2015-12-23 11:08:34 +03:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|