feat: add type to receipt and refactor reward calculation function

vechain · Feb 21, 2025 · 0189f12 · 0189f12
1 parent 1b887cd
commit 0189f12
Show file tree

Hide file tree

Showing 11 changed files with 386 additions and 103 deletions.
diff --git a/api/transactions/transactions_test.go b/api/transactions/transactions_test.go
@@ -127,12 +127,14 @@ func getTxReceipt(t *testing.T) {
 		t.Fatal(err)
 	}
 	assert.Equal(t, receipt.GasUsed, legacyTx.Gas(), "receipt gas used not equal to transaction gas")
+	assert.Equal(t, receipt.Type, legacyTx.Type())
 
 	r = httpGetAndCheckResponseStatus(t, "/transactions/"+dynFeeTx.ID().String()+"/receipt", 200)
 	if err := json.Unmarshal(r, &receipt); err != nil {
 		t.Fatal(err)
 	}
 	assert.Equal(t, receipt.GasUsed, legacyTx.Gas(), "receipt gas used not equal to transaction gas")
+	assert.Equal(t, receipt.Type, dynFeeTx.Type())
 }
 
 func sendLegacyTx(t *testing.T) {

diff --git a/api/transactions/types.go b/api/transactions/types.go
@@ -82,6 +82,7 @@ type ReceiptMeta struct {
 
 // Receipt for json marshal
 type Receipt struct {
+	Type     uint8                 `json:"type,omitempty"`
 	GasUsed  uint64                `json:"gasUsed"`
 	GasPayer thor.Address          `json:"gasPayer"`
 	Paid     *math.HexOrDecimal256 `json:"paid"`
@@ -121,6 +122,7 @@ func convertReceipt(txReceipt *tx.Receipt, header *block.Header, tx *tx.Transact
 		return nil, err
 	}
 	receipt := &Receipt{
+		Type:     txReceipt.Type,
 		GasUsed:  txReceipt.GasUsed,
 		GasPayer: txReceipt.GasPayer,
 		Paid:     &paid,

diff --git a/api/transactions/types_test.go b/api/transactions/types_test.go
@@ -27,8 +27,10 @@ func TestErrorWhileRetrievingTxOriginInConvertReceipt(t *testing.T) {
 		tr := tx.NewTxBuilder(txType).MustBuild()
 		header := &block.Header{}
 		receipt := &tx.Receipt{
-			Reward: big.NewInt(100),
-			Paid:   big.NewInt(10),
+			ReceiptBody: tx.ReceiptBody{
+				Reward: big.NewInt(100),
+				Paid:   big.NewInt(10),
+			},
 		}
 
 		convRec, err := convertReceipt(receipt, header, tr)
@@ -42,8 +44,8 @@ func TestErrorWhileRetrievingTxOriginInConvertReceipt(t *testing.T) {
 func TestConvertReceiptWhenTxHasNoClauseTo(t *testing.T) {
 	value := big.NewInt(100)
 	txs := []*tx.Transaction{
-		newLegacyTx(tx.NewClause(nil).WithValue(value)),
-		newDynFeeTx(tx.NewClause(nil).WithValue(value)),
+		newTx(tx.NewClause(nil).WithValue(value), tx.LegacyTxType),
+		newTx(tx.NewClause(nil).WithValue(value), tx.DynamicFeeTxType),
 	}
 	for _, tr := range txs {
 		b := new(block.Builder).Build()
@@ -64,8 +66,8 @@ func TestConvertReceipt(t *testing.T) {
 	addr := randAddress()
 
 	txs := []*tx.Transaction{
-		newLegacyTx(tx.NewClause(&addr).WithValue(value)),
-		newDynFeeTx(tx.NewClause(&addr).WithValue(value)),
+		newTx(tx.NewClause(&addr).WithValue(value), tx.LegacyTxType),
+		newTx(tx.NewClause(&addr).WithValue(value), tx.DynamicFeeTxType),
 	}
 	for _, tr := range txs {
 		b := new(block.Builder).Build()
@@ -75,6 +77,7 @@ func TestConvertReceipt(t *testing.T) {
 		convRec, err := convertReceipt(receipt, header, tr)
 
 		assert.NoError(t, err)
+		assert.Equal(t, receipt.Type, convRec.Type)
 		assert.Equal(t, 1, len(convRec.Outputs))
 		assert.Equal(t, 1, len(convRec.Outputs[0].Events))
 		assert.Equal(t, 1, len(convRec.Outputs[0].Transfers))
@@ -95,36 +98,29 @@ func randAddress() (addr thor.Address) {
 
 func newReceipt() *tx.Receipt {
 	return &tx.Receipt{
-		Outputs: []*tx.Output{
-			{
-				Events: tx.Events{{
-					Address: randAddress(),
-					Topics:  []thor.Bytes32{randomBytes32()},
-					Data:    randomBytes32().Bytes(),
-				}},
-				Transfers: tx.Transfers{{
-					Sender:    randAddress(),
-					Recipient: randAddress(),
-					Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
-				}},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{
+					Events: tx.Events{{
+						Address: randAddress(),
+						Topics:  []thor.Bytes32{randomBytes32()},
+						Data:    randomBytes32().Bytes(),
+					}},
+					Transfers: tx.Transfers{{
+						Sender:    randAddress(),
+						Recipient: randAddress(),
+						Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
+					}},
+				},
 			},
+			Reward: big.NewInt(100),
+			Paid:   big.NewInt(10),
 		},
-		Reward: big.NewInt(100),
-		Paid:   big.NewInt(10),
 	}
 }
 
-func newLegacyTx(clause *tx.Clause) *tx.Transaction {
-	tx := tx.NewTxBuilder(tx.LegacyTxType).
-		Clause(clause).
-		MustBuild()
-	pk, _ := crypto.GenerateKey()
-	sig, _ := crypto.Sign(tx.SigningHash().Bytes(), pk)
-	return tx.WithSignature(sig)
-}
-
-func newDynFeeTx(clause *tx.Clause) *tx.Transaction {
-	tx := tx.NewTxBuilder(tx.DynamicFeeTxType).
+func newTx(clause *tx.Clause, txType int) *tx.Transaction {
+	tx := tx.NewTxBuilder(txType).
 		Clause(clause).
 		MustBuild()
 	pk, _ := crypto.GenerateKey()

diff --git a/api/transfers/transfers_test.go b/api/transfers/transfers_test.go
@@ -242,13 +242,15 @@ func createDb(t *testing.T) *logdb.LogDB {
 // Utilities functions
 func newReceipt() *tx.Receipt {
 	return &tx.Receipt{
-		Outputs: []*tx.Output{
-			{
-				Transfers: tx.Transfers{{
-					Sender:    datagen.RandAddress(),
-					Recipient: datagen.RandAddress(),
-					Amount:    new(big.Int).SetBytes(datagen.RandAddress().Bytes()),
-				}},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{
+					Transfers: tx.Transfers{{
+						Sender:    datagen.RandAddress(),
+						Recipient: datagen.RandAddress(),
+						Amount:    new(big.Int).SetBytes(datagen.RandAddress().Bytes()),
+					}},
+				},
 			},
 		},
 	}

diff --git a/cmd/thor/utils.go b/cmd/thor/utils.go
@@ -425,8 +425,10 @@ func initChainRepository(gene *genesis.Genesis, mainDB *muxdb.MuxDB, logDB *logd
 	}
 	w := logDB.NewWriter()
 	if err := w.Write(genesisBlock, tx.Receipts{{
-		Outputs: []*tx.Output{
-			{Events: genesisEvents, Transfers: genesisTransfers},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{Events: genesisEvents, Transfers: genesisTransfers},
+			},
 		},
 	}}); err != nil {
 		return nil, errors.Wrap(err, "write genesis logs")

diff --git a/consensus/fork/galactica.go b/consensus/fork/galactica.go
@@ -124,7 +124,8 @@ func GalacticaGasPrice(tr *tx.Transaction, baseGasPrice *big.Int, galacticaItems
 
 	feeItems := GalacticaTxGasPriceAdapter(tr, gasPrice)
 	// This gasPrice is the same that will be used when refunding the user
-	// it takes into account the priority fee that will be paid to the validator
+	// it takes into account the priority fee that will be paid to the validator and the base fee that will be implicitly burned
+	// tracked by Energy.TotalAddSub
 	return math.BigMin(new(big.Int).Add(feeItems.MaxPriorityFee, galacticaItems.BaseFee), feeItems.MaxFee)
 }
 
@@ -144,3 +145,15 @@ func GalacticaPriorityPrice(tr *tx.Transaction, baseGasPrice, provedWork *big.In
 	 */
 	return math.BigMin(feeItems.MaxPriorityFee, new(big.Int).Sub(feeItems.MaxFee, galacticaItems.BaseFee))
 }
+
+func CalculateReward(gasUsed uint64, rewardGasPrice, rewardRatio *big.Int, isGalactica bool) *big.Int {
+	reward := new(big.Int).SetUint64(gasUsed)
+	reward.Mul(reward, rewardGasPrice)
+	if isGalactica {
+		return reward
+	}
+	// Returning the 30% of the reward
+	reward.Mul(reward, rewardRatio)
+	reward.Div(reward, big.NewInt(1e18))
+	return reward
+}
diff --git a/consensus/fork/galactica_test.go b/consensus/fork/galactica_test.go
@@ -377,3 +377,50 @@ func TestGalacticaPriorityPrice(t *testing.T) {
 		})
 	}
 }
+
+func TestCalculateReward(t *testing.T) {
+	rewardRatio := thor.InitialRewardRatio
+	tests := []struct {
+		name           string
+		gasUsed        uint64
+		rewardGasPrice *big.Int
+		isGalactica    bool
+		expectedReward *big.Int
+	}{
+		{
+			name:           "Galactica active, full reward",
+			gasUsed:        1000,
+			rewardGasPrice: big.NewInt(100),
+			isGalactica:    true,
+			expectedReward: big.NewInt(100000),
+		},
+		{
+			name:           "Galactica inactive, 30% reward",
+			gasUsed:        1000,
+			rewardGasPrice: big.NewInt(100),
+			isGalactica:    false,
+			expectedReward: big.NewInt(30000),
+		},
+		{
+			name:           "Galactica active, zero gas used",
+			gasUsed:        0,
+			rewardGasPrice: big.NewInt(100),
+			isGalactica:    true,
+			expectedReward: big.NewInt(0),
+		},
+		{
+			name:           "Galactica inactive, zero gas used",
+			gasUsed:        0,
+			rewardGasPrice: big.NewInt(100),
+			isGalactica:    false,
+			expectedReward: big.NewInt(0),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			reward := CalculateReward(tt.gasUsed, tt.rewardGasPrice, rewardRatio, tt.isGalactica)
+			assert.Equal(t, tt.expectedReward, reward)
+		})
+	}
+}
diff --git a/logdb/logdb_test.go b/logdb/logdb_test.go
@@ -40,46 +40,52 @@ func randBytes32() (b thor.Bytes32) {
 
 func newReceipt() *tx.Receipt {
 	return &tx.Receipt{
-		Outputs: []*tx.Output{
-			{
-				Events: tx.Events{{
-					Address: randAddress(),
-					Topics:  []thor.Bytes32{randBytes32()},
-					Data:    randBytes32().Bytes(),
-				}},
-				Transfers: tx.Transfers{{
-					Sender:    randAddress(),
-					Recipient: randAddress(),
-					Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
-				}},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{
+					Events: tx.Events{{
+						Address: randAddress(),
+						Topics:  []thor.Bytes32{randBytes32()},
+						Data:    randBytes32().Bytes(),
+					}},
+					Transfers: tx.Transfers{{
+						Sender:    randAddress(),
+						Recipient: randAddress(),
+						Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
+					}},
+				},
 			},
 		},
 	}
 }
 
 func newEventOnlyReceipt() *tx.Receipt {
 	return &tx.Receipt{
-		Outputs: []*tx.Output{
-			{
-				Events: tx.Events{{
-					Address: randAddress(),
-					Topics:  []thor.Bytes32{randBytes32()},
-					Data:    randBytes32().Bytes(),
-				}},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{
+					Events: tx.Events{{
+						Address: randAddress(),
+						Topics:  []thor.Bytes32{randBytes32()},
+						Data:    randBytes32().Bytes(),
+					}},
+				},
 			},
 		},
 	}
 }
 
 func newTransferOnlyReceipt() *tx.Receipt {
 	return &tx.Receipt{
-		Outputs: []*tx.Output{
-			{
-				Transfers: tx.Transfers{{
-					Sender:    randAddress(),
-					Recipient: randAddress(),
-					Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
-				}},
+		ReceiptBody: tx.ReceiptBody{
+			Outputs: []*tx.Output{
+				{
+					Transfers: tx.Transfers{{
+						Sender:    randAddress(),
+						Recipient: randAddress(),
+						Amount:    new(big.Int).SetBytes(randAddress().Bytes()),
+					}},
+				},
 			},
 		},
 	}

diff --git a/runtime/runtime.go b/runtime/runtime.go
@@ -501,10 +501,13 @@ func (rt *Runtime) PrepareTransaction(tx *tx.Transaction) (*TransactionExecutor,
 			finalized = true
 
 			receipt := &Tx.Receipt{
-				Reverted: reverted,
-				Outputs:  txOutputs,
-				GasUsed:  tx.Gas() - leftOverGas,
-				GasPayer: payer,
+				Type: tx.Type(),
+				ReceiptBody: Tx.ReceiptBody{
+					Reverted: reverted,
+					Outputs:  txOutputs,
+					GasUsed:  tx.Gas() - leftOverGas,
+					GasPayer: payer,
+				},
 			}
 
 			receipt.Paid = new(big.Int).Mul(new(big.Int).SetUint64(receipt.GasUsed), gasPrice)
@@ -523,11 +526,8 @@ func (rt *Runtime) PrepareTransaction(tx *tx.Transaction) (*TransactionExecutor,
 				return nil, err
 			}
 			rewardGasPrice := fork.GalacticaPriorityPrice(tx, baseGasPrice, provedWork, &fork.GalacticaItems{IsActive: galactica, BaseFee: rt.ctx.BaseFee})
+			reward := fork.CalculateReward(receipt.GasUsed, rewardGasPrice, rewardRatio, galactica)
 
-			reward := new(big.Int).SetUint64(receipt.GasUsed)
-			reward.Mul(reward, rewardGasPrice)
-			reward.Mul(reward, rewardRatio)
-			reward.Div(reward, big.NewInt(1e18))
 			if err := builtin.Energy.Native(rt.state, rt.ctx.Time).Add(rt.ctx.Beneficiary, reward); err != nil {
 				return nil, err
 			}