core: transaction meta serialization (#31)

* core: transaction meta serialization * test: txmeta queue origin set to 0
cerc-io · Sep 23, 2020 · e165f58 · e165f58
1 parent 42d5a18
commit e165f58
Show file tree

Hide file tree

Showing 3 changed files with 133 additions and 11 deletions.
diff --git a/core/types/gen_tx_meta_json.go b/core/types/gen_tx_meta_json.go
diff --git a/core/types/transaction_meta.go b/core/types/transaction_meta.go
@@ -7,33 +7,43 @@ package types
 import (
 	"bytes"
 	"encoding/binary"
+	"math/big"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 )
 
+//go:generate gencodec -type TransactionMeta -out gen_tx_meta_json.go
+
 type TransactionMeta struct {
-	L1RollupTxId      *hexutil.Uint64   `json:"l1RollupTxId"`
-	L1MessageSender   *common.Address   `json:"l1MessageSender"`
-	SignatureHashType SignatureHashType `json:"signatureHashType"`
+	L1RollupTxId      *hexutil.Uint64   `json:"l1RollupTxId" gencodec:"required"`
+	L1MessageSender   *common.Address   `json:"l1MessageSender" gencodec:"required"`
+	SignatureHashType SignatureHashType `json:"signatureHashType" gencodec:"required"`
+	QueueOrigin       *big.Int          `json:"queueOrigin" gencodec:"required"`
 }
 
+// Hard code the queue origin as 2 since it represents the origin as the
+// sequencer. Add the queue origin to the function signature once l1 transaction
+// ingestion is ready.
 func NewTransactionMeta(L1RollupTxId *hexutil.Uint64, L1MessageSender *common.Address, sighashType SignatureHashType) *TransactionMeta {
-	return &TransactionMeta{L1RollupTxId: L1RollupTxId, L1MessageSender: L1MessageSender, SignatureHashType: sighashType}
+	queueOrigin := new(big.Int).SetUint64(2)
+	return &TransactionMeta{L1RollupTxId: L1RollupTxId, L1MessageSender: L1MessageSender, SignatureHashType: sighashType, QueueOrigin: queueOrigin}
 }
 
 // TxMetaDecode deserializes bytes as a TransactionMeta struct.
 // The schema is:
-// varbytes(SignatureHashType) || varbytes(L1RollupTxId) || varbytes(L1MessageSender)
+//   varbytes(SignatureHashType) ||
+//   varbytes(L1RollupTxId) ||
+//   varbytes(L1MessageSender) ||
+//   varbytes(QueueOrigin)
 func TxMetaDecode(input []byte) (*TransactionMeta, error) {
 	var err error
 	meta := TransactionMeta{}
-
 	b := bytes.NewReader(input)
 
 	sb, err := common.ReadVarBytes(b, 0, 1024, "SignatureHashType")
 	if err != nil {
-		return &TransactionMeta{}, err
+		return nil, err
 	}
 
 	var sighashType SignatureHashType
@@ -42,9 +52,8 @@ func TxMetaDecode(input []byte) (*TransactionMeta, error) {
 
 	lb, err := common.ReadVarBytes(b, 0, 1024, "L1RollupTxId")
 	if err != nil {
-		return &TransactionMeta{}, err
+		return nil, err
 	}
-
 	if !isNullValue(lb) {
 		var l1RollupTxId hexutil.Uint64
 		binary.Read(bytes.NewReader(lb), binary.LittleEndian, &l1RollupTxId)
@@ -53,15 +62,23 @@ func TxMetaDecode(input []byte) (*TransactionMeta, error) {
 
 	mb, err := common.ReadVarBytes(b, 0, 1024, "L1MessageSender")
 	if err != nil {
-		return &TransactionMeta{}, err
+		return nil, err
 	}
-
 	if !isNullValue(mb) {
 		var l1MessageSender common.Address
 		binary.Read(bytes.NewReader(mb), binary.LittleEndian, &l1MessageSender)
 		meta.L1MessageSender = &l1MessageSender
 	}
 
+	qo, err := common.ReadVarBytes(b, 0, 1024, "QueueOrigin")
+	if err != nil {
+		return nil, err
+	}
+	if !isNullValue(qo) {
+		queueOrigin := new(big.Int).SetBytes(qo)
+		meta.QueueOrigin = queueOrigin
+	}
+
 	return &meta, nil
 }
 
@@ -91,9 +108,19 @@ func TxMetaEncode(meta *TransactionMeta) []byte {
 		common.WriteVarBytes(b, 0, l.Bytes())
 	}
 
+	queueOrigin := meta.QueueOrigin
+	if queueOrigin == nil {
+		common.WriteVarBytes(b, 0, getNullValue())
+	} else {
+		q := new(bytes.Buffer)
+		binary.Write(q, binary.LittleEndian, queueOrigin.Bytes())
+		common.WriteVarBytes(b, 0, q.Bytes())
+	}
+
 	return b.Bytes()
 }
 
+// This may collide with a uint8
 func isNullValue(b []byte) bool {
 	nullValue := []byte{0x00}
 	return bytes.Equal(b, nullValue)

diff --git a/core/types/transaction_meta_test.go b/core/types/transaction_meta_test.go
@@ -2,6 +2,7 @@ package types
 
 import (
 	"bytes"
+	"math/big"
 	"testing"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -16,21 +17,43 @@ var (
 		txid        *hexutil.Uint64
 		msgSender   *common.Address
 		sighashType SignatureHashType
+		queueOrigin *big.Int
 	}{
 		{
 			txid:        &txid,
 			msgSender:   &addr,
 			sighashType: SighashEthSign,
+			queueOrigin: big.NewInt(2),
 		},
 		{
 			txid:        nil,
 			msgSender:   &addr,
 			sighashType: SighashEthSign,
+			queueOrigin: big.NewInt(2),
 		},
 		{
 			txid:        &txid,
 			msgSender:   nil,
 			sighashType: SighashEthSign,
+			queueOrigin: big.NewInt(2),
+		},
+		{
+			txid:        &txid,
+			msgSender:   &addr,
+			sighashType: SighashEthSign,
+			queueOrigin: nil,
+		},
+		{
+			txid:        nil,
+			msgSender:   nil,
+			sighashType: SighashEthSign,
+			queueOrigin: nil,
+		},
+		{
+			txid:        &txid,
+			msgSender:   &addr,
+			sighashType: SighashEthSign,
+			queueOrigin: big.NewInt(0),
 		},
 	}
 
@@ -52,6 +75,8 @@ var (
 func TestTransactionMetaEncode(t *testing.T) {
 	for _, test := range txMetaSerializationTests {
 		txmeta := NewTransactionMeta(test.txid, test.msgSender, test.sighashType)
+		txmeta.QueueOrigin = test.queueOrigin
+
 		encoded := TxMetaEncode(txmeta)
 		decoded, err := TxMetaDecode(encoded)
 
@@ -106,5 +131,16 @@ func isTxMetaEqual(meta1 *TransactionMeta, meta2 *TransactionMeta) bool {
 		return false
 	}
 
+	if meta1.QueueOrigin == nil || meta2.QueueOrigin == nil {
+		// Note: this only works because it is the final comparison
+		if meta1.QueueOrigin == nil && meta2.QueueOrigin == nil {
+			return true
+		}
+	}
+
+	if !bytes.Equal(meta1.QueueOrigin.Bytes(), meta2.QueueOrigin.Bytes()) {
+		return false
+	}
+
 	return true
 }