add test cases for receipt json marshal/unmarshal

Author: roberto-bayardo

core/types/receipt_test.go

@@ -82,27 +82,15 @@ var (
 		},
 		Type: DynamicFeeTxType,
 	}
-)
-
-func TestDecodeEmptyTypedReceipt(t *testing.T) {
-	input := []byte{0x80}
-	var r Receipt
-	err := rlp.DecodeBytes(input, &r)
-	if err != errShortTypedReceipt {
-		t.Fatal("wrong error:", err)
-	}
-}
 
-// Tests that receipt data can be correctly derived from the contextual infos
-func TestDeriveFields(t *testing.T) {
 	// Create a few transactions to have receipts for
-	to2 := common.HexToAddress("0x2")
-	to3 := common.HexToAddress("0x3")
-	to4 := common.HexToAddress("0x4")
-	to5 := common.HexToAddress("0x5")
-	to6 := common.HexToAddress("0x6")
-	to7 := common.HexToAddress("0x7")
-	txs := Transactions{
+	to2     = common.HexToAddress("0x2")
+	to3     = common.HexToAddress("0x3")
+	to4     = common.HexToAddress("0x4")
+	to5     = common.HexToAddress("0x5")
+	to6     = common.HexToAddress("0x6")
+	to7     = common.HexToAddress("0x7")
+	testTxs = Transactions{
 		NewTx(&LegacyTx{
 			Nonce:    1,
 			Value:    big.NewInt(1),
@@ -161,37 +149,38 @@ func TestDeriveFields(t *testing.T) {
 		}),
 	}
 
-	blockNumber := big.NewInt(1)
-	blockTime := uint64(2)
-	blockHash := common.BytesToHash([]byte{0x03, 0x14})
-
-	// Create the corresponding receipts
-	receipts := Receipts{
+	// Create corresponding receipts for the testTxs
+	blockNumber  = big.NewInt(1)
+	blockTime    = uint64(2)
+	blockHash    = common.BytesToHash([]byte{0x03, 0x14})
+	testReceipts = Receipts{
 		&Receipt{
 			Status:            ReceiptStatusFailed,
 			CumulativeGasUsed: 1,
 			Logs: []*Log{
 				{
 					Address: common.BytesToAddress([]byte{0x11}),
+					Topics:  []common.Hash{common.HexToHash("dead"), common.HexToHash("beef")},
 					// derived fields:
 					BlockNumber: blockNumber.Uint64(),
-					TxHash:      txs[0].Hash(),
+					TxHash:      testTxs[0].Hash(),
 					TxIndex:     0,
 					BlockHash:   blockHash,
 					Index:       0,
 				},
 				{
 					Address: common.BytesToAddress([]byte{0x01, 0x11}),
+					Topics:  []common.Hash{common.HexToHash("dead"), common.HexToHash("beef")},
 					// derived fields:
 					BlockNumber: blockNumber.Uint64(),
-					TxHash:      txs[0].Hash(),
+					TxHash:      testTxs[0].Hash(),
 					TxIndex:     0,
 					BlockHash:   blockHash,
 					Index:       1,
 				},
 			},
 			// derived fields:
-			TxHash:            txs[0].Hash(),
+			TxHash:            testTxs[0].Hash(),
 			ContractAddress:   common.HexToAddress("0x5a443704dd4b594b382c22a083e2bd3090a6fef3"),
 			GasUsed:           1,
 			EffectiveGasPrice: big.NewInt(11),
@@ -205,25 +194,27 @@ func TestDeriveFields(t *testing.T) {
 			Logs: []*Log{
 				{
 					Address: common.BytesToAddress([]byte{0x22}),
+					Topics:  []common.Hash{common.HexToHash("dead"), common.HexToHash("beef")},
 					// derived fields:
 					BlockNumber: blockNumber.Uint64(),
-					TxHash:      txs[1].Hash(),
+					TxHash:      testTxs[1].Hash(),
 					TxIndex:     1,
 					BlockHash:   blockHash,
 					Index:       2,
 				},
 				{
 					Address: common.BytesToAddress([]byte{0x02, 0x22}),
+					Topics:  []common.Hash{common.HexToHash("dead"), common.HexToHash("beef")},
 					// derived fields:
 					BlockNumber: blockNumber.Uint64(),
-					TxHash:      txs[1].Hash(),
+					TxHash:      testTxs[1].Hash(),
 					TxIndex:     1,
 					BlockHash:   blockHash,
 					Index:       3,
 				},
 			},
 			// derived fields:
-			TxHash:            txs[1].Hash(),
+			TxHash:            testTxs[1].Hash(),
 			GasUsed:           2,
 			EffectiveGasPrice: big.NewInt(22),
 			BlockHash:         blockHash,
@@ -236,7 +227,7 @@ func TestDeriveFields(t *testing.T) {
 			CumulativeGasUsed: 6,
 			Logs:              []*Log{},
 			// derived fields:
-			TxHash:            txs[2].Hash(),
+			TxHash:            testTxs[2].Hash(),
 			GasUsed:           3,
 			EffectiveGasPrice: big.NewInt(33),
 			BlockHash:         blockHash,
@@ -249,7 +240,7 @@ func TestDeriveFields(t *testing.T) {
 			CumulativeGasUsed: 10,
 			Logs:              []*Log{},
 			// derived fields:
-			TxHash:            txs[3].Hash(),
+			TxHash:            testTxs[3].Hash(),
 			GasUsed:           4,
 			EffectiveGasPrice: big.NewInt(1044),
 			BlockHash:         blockHash,
@@ -262,7 +253,7 @@ func TestDeriveFields(t *testing.T) {
 			CumulativeGasUsed: 15,
 			Logs:              []*Log{},
 			// derived fields:
-			TxHash:            txs[4].Hash(),
+			TxHash:            testTxs[4].Hash(),
 			GasUsed:           5,
 			EffectiveGasPrice: big.NewInt(1055),
 			BlockHash:         blockHash,
@@ -275,7 +266,7 @@ func TestDeriveFields(t *testing.T) {
 			CumulativeGasUsed: 21,
 			Logs:              []*Log{},
 			// derived fields:
-			TxHash:            txs[5].Hash(),
+			TxHash:            testTxs[5].Hash(),
 			GasUsed:           6,
 			EffectiveGasPrice: big.NewInt(1066),
 			BlockHash:         blockHash,
@@ -288,28 +279,41 @@ func TestDeriveFields(t *testing.T) {
 			CumulativeGasUsed: 28,
 			Logs:              []*Log{},
 			// derived fields:
-			TxHash:            txs[6].Hash(),
+			TxHash:            testTxs[6].Hash(),
 			GasUsed:           7,
 			EffectiveGasPrice: big.NewInt(1077),
 			BlockHash:         blockHash,
 			BlockNumber:       blockNumber,
 			TransactionIndex:  6,
 		},
 	}
+)
 
+func TestDecodeEmptyTypedReceipt(t *testing.T) {
+	input := []byte{0x80}
+	var r Receipt
+	err := rlp.DecodeBytes(input, &r)
+	if err != errShortTypedReceipt {
+		t.Fatal("wrong error:", err)
+	}
+}
+
+// Tests that receipt data can be correctly derived from the contextual infos
+func TestDeriveFields(t *testing.T) {
 	// Re-derive receipts.
 	basefee := big.NewInt(1000)
-	derivedReceipts := clearComputedFieldsOnReceipts(receipts)
-	err := Receipts(derivedReceipts).DeriveFields(params.TestChainConfig, blockHash, blockNumber.Uint64(), blockTime, basefee, txs)
+	derivedReceipts := clearComputedFieldsOnReceipts(testReceipts)
+	err := Receipts(derivedReceipts).DeriveFields(params.TestChainConfig, blockHash, blockNumber.Uint64(), blockTime, basefee, testTxs)
 	if err != nil {
 		t.Fatalf("DeriveFields(...) = %v, want <nil>", err)
 	}
 
 	// Check diff of receipts against derivedReceipts.
-	r1, err := json.MarshalIndent(receipts, "", "  ")
+	r1, err := json.MarshalIndent(testReceipts, "", "  ")
 	if err != nil {
 		t.Fatal("error marshaling input receipts:", err)
 	}
+
 	r2, err := json.MarshalIndent(derivedReceipts, "", "  ")
 	if err != nil {
 		t.Fatal("error marshaling derived receipts:", err)
@@ -320,6 +324,38 @@ func TestDeriveFields(t *testing.T) {
 	}
 }
 
+// Test that we can marshal/unmarshal receipts to/from json without errors.
+// This also confirms that our test receipts contain all the required fields.
+func TestReceiptJSON(t *testing.T) {
+	for i := range testReceipts {
+		b, err := testReceipts[i].MarshalJSON()
+		if err != nil {
+			t.Fatal("error marshaling receipt to json:", err)
+		}
+		r := Receipt{}
+		err = r.UnmarshalJSON(b)
+		if err != nil {
+			t.Fatal("error unmarshaling receipt from json:", err)
+		}
+	}
+}
+
+// Test we can still parse receipt without EffectiveGasPrice for backwards compatibility, even
+// though it is required per the spec.
+func TestEffectiveGasPriceNotRequired(t *testing.T) {
+	r := *testReceipts[0]
+	r.EffectiveGasPrice = nil
+	b, err := r.MarshalJSON()
+	if err != nil {
+		t.Fatal("error marshaling receipt to json:", err)
+	}
+	r2 := Receipt{}
+	err = r2.UnmarshalJSON(b)
+	if err != nil {
+		t.Fatal("error unmarshaling receipt from json:", err)
+	}
+}
+
 // TestTypedReceiptEncodingDecoding reproduces a flaw that existed in the receipt
 // rlp decoder, which failed due to a shadowing error.
 func TestTypedReceiptEncodingDecoding(t *testing.T) {