github.com/mit-dci/lit@v0.0.0-20221102210550-8c3d3b49f2ce/elkrem/serdes.go

package elkrem

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

	"github.com/mit-dci/lit/btcutil/chaincfg/chainhash"
)

/* Serialization and Deserialization methods for the Elkrem structs.
Senders turn into 41 byte long slices.  Receivers are variable length,
with 41 bytes for each stored hash, up to a maximum of 48.  Receivers are
prepended with the total number of hashes, so the total max size is 1969 bytes.
*/

// ToBytes turns the Elkrem Receiver into a bunch of bytes in a slice.
// first the number of nodes (1 byte), then a series of 41 byte long
// serialized nodes, which are 1 byte height, 8 byte index, 32 byte hash.
func (e *ElkremReceiver) ToBytes() ([]byte, error) {
	numOfNodes := uint8(len(e.Nodes))
	// 0 element receiver also OK.  Just an empty slice.
	if numOfNodes == 0 {
		return nil, nil
	}
	if numOfNodes > maxHeight+1 {
		return nil, fmt.Errorf("Broken ElkremReceiver has %d nodes, max 64",
			len(e.Nodes))
	}
	var buf bytes.Buffer // create buffer

	// write number of nodes (1 byte)
	err := binary.Write(&buf, binary.BigEndian, numOfNodes)
	if err != nil {
		return nil, err
	}
	for _, node := range e.Nodes {
		// write 1 byte height
		err = binary.Write(&buf, binary.BigEndian, node.H)
		if err != nil {
			return nil, err
		}
		// write 8 byte index
		err = binary.Write(&buf, binary.BigEndian, node.I)
		if err != nil {
			return nil, err
		}
		if node.Sha == nil {
			return nil, fmt.Errorf("node %d has nil hash", node.I)
		}
		// write 32 byte sha hash
		n, err := buf.Write(node.Sha.CloneBytes())
		if err != nil {
			return nil, err
		}
		if n != 32 { // make sure that was 32 bytes
			return nil, fmt.Errorf("%d byte hash, expect 32", n)
		}
	}
	if buf.Len() != (int(numOfNodes)*41)+1 {
		return nil, fmt.Errorf("Somehow made wrong size buf, got %d expect %d",
			buf.Len(), (numOfNodes*41)+1)
	}
	return buf.Bytes(), nil
}

func ElkremReceiverFromBytes(b []byte) (*ElkremReceiver, error) {
	var e ElkremReceiver
	if len(b) == 0 { // empty receiver, which is OK
		return &e, nil
	}
	buf := bytes.NewBuffer(b)
	// read 1 byte number of nodes stored in receiver
	numOfNodes, err := buf.ReadByte()
	if err != nil {
		return nil, err
	}
	if numOfNodes < 1 || numOfNodes > maxHeight+1 {
		return nil, fmt.Errorf("Read invalid number of nodes: %d", numOfNodes)
	}
	if buf.Len() != (int(numOfNodes) * 41) {
		return nil, fmt.Errorf("Remaining buf wrong size, expect %d got %d",
			(numOfNodes * 41), buf.Len())
	}

	e.Nodes = make([]ElkremNode, numOfNodes)

	for j, _ := range e.Nodes {
		e.Nodes[j].Sha = new(chainhash.Hash)
		// read 1 byte height
		err := binary.Read(buf, binary.BigEndian, &e.Nodes[j].H)
		if err != nil {
			return nil, err
		}
		// read 8 byte index
		err = binary.Read(buf, binary.BigEndian, &e.Nodes[j].I)
		if err != nil {
			return nil, err
		}
		// read 32 byte sha hash
		err = e.Nodes[j].Sha.SetBytes(buf.Next(32))
		if err != nil {
			return nil, err
		}
		// sanity check.  Note that this doesn't check that index and height
		// match.  Could add that but it's slow.
		if e.Nodes[j].H > maxHeight { // check for super high nodes
			return nil, fmt.Errorf("Read invalid node height %d", e.Nodes[j].H)
		}
		if e.Nodes[j].I > maxIndex { // check for index higher than height allows
			return nil, fmt.Errorf("Node claims index %d; %d max at height %d",
				e.Nodes[j].I, maxIndex, e.Nodes[j].H)
		}

		if j > 0 { // check that node heights are descending
			if e.Nodes[j-1].H < e.Nodes[j].H {
				return nil, fmt.Errorf("Node heights out of order")
			}
		}
	}
	return &e, nil
}

// There's no real point to the *sender* serialization because
// you just make them from scratch each time.  Only thing to save
// is the 32 byte seed and the current index.

// ToBytes turns the Elkrem Sender into a 41 byte slice:
// first the tree height (1 byte), then 8 byte index of last sent,
// then the 32 byte root sha hash.
//func (e *ElkremSender) ToBytes() ([]byte, error) {
//	var buf bytes.Buffer
//	// write 8 byte index of current sha (last sent)
//	err := binary.Write(&buf, binary.BigEndian, e.current)
//	if err != nil {
//		return nil, err
//	}
//	// write 32 byte sha hash
//	n, err := buf.Write(e.root.Bytes())
//	if err != nil {
//		return nil, err
//	}
//	if n != 32 {
//		return nil, fmt.Errorf("%d byte hash, expect 32", n)
//	}

//	return buf.Bytes(), nil
//}

// ElkremSenderFromBytes turns a 41 byte slice into a sender, picking up at
// the index where it left off.
//func ElkremSenderFromBytes(b []byte) (ElkremSender, error) {
//	var e ElkremSender
//	e.root = new(wire.ShaHash)
//	buf := bytes.NewBuffer(b)
//	if buf.Len() != 40 {
//		return e, fmt.Errorf("Got %d bytes for sender, expect 41")
//	}
//	// read 8 byte index
//	err := binary.Read(buf, binary.BigEndian, &e.current)
//	if err != nil {
//		return e, err
//	}
//	// read 32 byte sha root
//	err = e.root.SetBytes(buf.Next(32))
//	if err != nil {
//		return e, err
//	}

//	if e.current > maxIndex { // check for index higher than height allows
//		return e, fmt.Errorf("Sender claims current %d; %d max with height %d",
//			e.current, maxIndex, maxHeight)
//	}
//	return e, nil
//}