X-chain - introducing fees calculators

node/node.go

@@ -75,6 +75,7 @@ import (
 	"github.com/ava-labs/avalanchego/version"
 	"github.com/ava-labs/avalanchego/vms"
 	"github.com/ava-labs/avalanchego/vms/avm"
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
 	"github.com/ava-labs/avalanchego/vms/platformvm"
 	"github.com/ava-labs/avalanchego/vms/platformvm/signer"
 	"github.com/ava-labs/avalanchego/vms/platformvm/upgrade"
@@ -1249,9 +1250,11 @@ func (n *Node) initVMs() error {
 		}),
 		n.VMManager.RegisterFactory(context.TODO(), constants.AVMID, &avm.Factory{
 			Config: avmconfig.Config{
-				TxFee:            n.Config.TxFee,
-				CreateAssetTxFee: n.Config.CreateAssetTxFee,
-				EUpgradeTime:     eUpgradeTime,
+				StaticConfig: fee.StaticConfig{
+					TxFee:            n.Config.TxFee,
+					CreateAssetTxFee: n.Config.CreateAssetTxFee,
+				},
+				EUpgradeTime: eUpgradeTime,
 			},
 		}),
 		n.VMManager.RegisterFactory(context.TODO(), constants.EVMID, &coreth.Factory{}),

vms/avm/block/builder/builder_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/ava-labs/avalanchego/utils/logging"
 	"github.com/ava-labs/avalanchego/utils/timer/mockable"
 	"github.com/ava-labs/avalanchego/vms/avm/block"
+	"github.com/ava-labs/avalanchego/vms/avm/config"
 	"github.com/ava-labs/avalanchego/vms/avm/fxs"
 	"github.com/ava-labs/avalanchego/vms/avm/metrics"
 	"github.com/ava-labs/avalanchego/vms/avm/state"
@@ -523,6 +524,9 @@ func TestBlockBuilderAddLocalTx(t *testing.T) {
 		Ctx: &snow.Context{
 			Log: logging.NoLog{},
 		},
+		Config: &config.Config{
+			EUpgradeTime: mockable.MaxTime,
+		},
 		Codec: parser.Codec(),
 	}
 

vms/avm/block/executor/block_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/ava-labs/avalanchego/vms/avm/state"
 	"github.com/ava-labs/avalanchego/vms/avm/txs"
 	"github.com/ava-labs/avalanchego/vms/avm/txs/executor"
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
 	"github.com/ava-labs/avalanchego/vms/avm/txs/mempool"
 )
 
@@ -939,9 +940,11 @@ func defaultTestBackend(bootstrapped bool, sharedMemory atomic.SharedMemory) *ex
 			Log:          logging.NoLog{},
 		},
 		Config: &config.Config{
-			EUpgradeTime:     mockable.MaxTime,
-			TxFee:            0,
-			CreateAssetTxFee: 0,
+			StaticConfig: fee.StaticConfig{
+				TxFee:            0,
+				CreateAssetTxFee: 0,
+			},
+			EUpgradeTime: mockable.MaxTime,
 		},
 	}
 }

vms/avm/config/config.go

@@ -3,15 +3,15 @@
 
 package config
 
-import "time"
+import (
+	"time"
+
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
+)
 
 // Struct collecting all the foundational parameters of the AVM
 type Config struct {
-	// Fee that is burned by every non-asset creating transaction
-	TxFee uint64
-
-	// Fee that must be burned by every asset creating transaction
-	CreateAssetTxFee uint64
+	fee.StaticConfig
 
 	// Time of the E network upgrade
 	EUpgradeTime time.Time

vms/avm/environment_test.go

@@ -31,6 +31,7 @@ import (
 	"github.com/ava-labs/avalanchego/vms/avm/config"
 	"github.com/ava-labs/avalanchego/vms/avm/fxs"
 	"github.com/ava-labs/avalanchego/vms/avm/txs"
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
 	"github.com/ava-labs/avalanchego/vms/avm/txs/txstest"
 	"github.com/ava-labs/avalanchego/vms/components/avax"
 	"github.com/ava-labs/avalanchego/vms/nftfx"
@@ -230,9 +231,11 @@ func setup(tb testing.TB, c *envConfig) *environment {
 
 func staticConfig(tb testing.TB, f fork) config.Config {
 	c := config.Config{
-		TxFee:            testTxFee,
-		CreateAssetTxFee: testTxFee,
-		EUpgradeTime:     mockable.MaxTime,
+		StaticConfig: fee.StaticConfig{
+			TxFee:            testTxFee,
+			CreateAssetTxFee: testTxFee,
+		},
+		EUpgradeTime: mockable.MaxTime,
 	}
 
 	switch f {

vms/avm/txs/executor/syntactic_verifier.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ava-labs/avalanchego/utils"
 	"github.com/ava-labs/avalanchego/utils/set"
 	"github.com/ava-labs/avalanchego/vms/avm/txs"
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
 	"github.com/ava-labs/avalanchego/vms/components/avax"
 )
 
@@ -51,18 +52,7 @@ type SyntacticVerifier struct {
 }
 
 func (v *SyntacticVerifier) BaseTx(tx *txs.BaseTx) error {
-	if err := tx.BaseTx.Verify(v.Ctx); err != nil {
-		return err
-	}
-
-	err := avax.VerifyTx(
-		v.Config.TxFee,
-		v.FeeAssetID,
-		[][]*avax.TransferableInput{tx.Ins},
-		[][]*avax.TransferableOutput{tx.Outs},
-		v.Codec,
-	)
-	if err != nil {
+	if err := v.verifyBaseTx(tx, nil, nil); err != nil {
 		return err
 	}
 
@@ -114,18 +104,7 @@ func (v *SyntacticVerifier) CreateAssetTx(tx *txs.CreateAssetTx) error {
 		}
 	}
 
-	if err := tx.BaseTx.BaseTx.Verify(v.Ctx); err != nil {
-		return err
-	}
-
-	err := avax.VerifyTx(
-		v.Config.CreateAssetTxFee,
-		v.FeeAssetID,
-		[][]*avax.TransferableInput{tx.Ins},
-		[][]*avax.TransferableOutput{tx.Outs},
-		v.Codec,
-	)
-	if err != nil {
+	if err := v.verifyBaseTx(&tx.BaseTx, nil, nil); err != nil {
 		return err
 	}
 
@@ -162,18 +141,7 @@ func (v *SyntacticVerifier) OperationTx(tx *txs.OperationTx) error {
 		return errNoOperations
 	}
 
-	if err := tx.BaseTx.BaseTx.Verify(v.Ctx); err != nil {
-		return err
-	}
-
-	err := avax.VerifyTx(
-		v.Config.TxFee,
-		v.FeeAssetID,
-		[][]*avax.TransferableInput{tx.Ins},
-		[][]*avax.TransferableOutput{tx.Outs},
-		v.Codec,
-	)
-	if err != nil {
+	if err := v.verifyBaseTx(&tx.BaseTx, nil, nil); err != nil {
 		return err
 	}
 
@@ -222,21 +190,7 @@ func (v *SyntacticVerifier) ImportTx(tx *txs.ImportTx) error {
 		return errNoImportInputs
 	}
 
-	if err := tx.BaseTx.BaseTx.Verify(v.Ctx); err != nil {
-		return err
-	}
-
-	err := avax.VerifyTx(
-		v.Config.TxFee,
-		v.FeeAssetID,
-		[][]*avax.TransferableInput{
-			tx.Ins,
-			tx.ImportedIns,
-		},
-		[][]*avax.TransferableOutput{tx.Outs},
-		v.Codec,
-	)
-	if err != nil {
+	if err := v.verifyBaseTx(&tx.BaseTx, tx.ImportedIns, nil); err != nil {
 		return err
 	}
 
@@ -264,21 +218,7 @@ func (v *SyntacticVerifier) ExportTx(tx *txs.ExportTx) error {
 		return errNoExportOutputs
 	}
 
-	if err := tx.BaseTx.BaseTx.Verify(v.Ctx); err != nil {
-		return err
-	}
-
-	err := avax.VerifyTx(
-		v.Config.TxFee,
-		v.FeeAssetID,
-		[][]*avax.TransferableInput{tx.Ins},
-		[][]*avax.TransferableOutput{
-			tx.Outs,
-			tx.ExportedOuts,
-		},
-		v.Codec,
-	)
-	if err != nil {
+	if err := v.verifyBaseTx(&tx.BaseTx, nil, tx.ExportedOuts); err != nil {
 		return err
 	}
 
@@ -300,3 +240,27 @@ func (v *SyntacticVerifier) ExportTx(tx *txs.ExportTx) error {
 
 	return nil
 }
+
+func (v *SyntacticVerifier) verifyBaseTx(
+	bTx *txs.BaseTx,
+	importedIns []*avax.TransferableInput,
+	exportedOuts []*avax.TransferableOutput,
+) error {
+	if err := bTx.BaseTx.Verify(v.Ctx); err != nil {
+		return err
+	}
+
+	feeCalculator := fee.NewStaticCalculator(v.Backend.Config.StaticConfig)
+	fee, err := feeCalculator.CalculateFee(v.Tx)
+	if err != nil {
+		return err
+	}
+
+	return avax.VerifyTx(
+		fee,
+		v.FeeAssetID,
+		[][]*avax.TransferableInput{bTx.Ins, importedIns},
+		[][]*avax.TransferableOutput{bTx.Outs, exportedOuts},
+		v.Codec,
+	)
+}

vms/avm/txs/executor/syntactic_verifier_test.go

@@ -18,6 +18,7 @@ import (
 	"github.com/ava-labs/avalanchego/vms/avm/config"
 	"github.com/ava-labs/avalanchego/vms/avm/fxs"
 	"github.com/ava-labs/avalanchego/vms/avm/txs"
+	"github.com/ava-labs/avalanchego/vms/avm/txs/fee"
 	"github.com/ava-labs/avalanchego/vms/components/avax"
 	"github.com/ava-labs/avalanchego/vms/components/verify"
 	"github.com/ava-labs/avalanchego/vms/secp256k1fx"
@@ -28,9 +29,11 @@ import (
 var (
 	keys      = secp256k1.TestKeys()
 	feeConfig = config.Config{
-		TxFee:            2,
-		CreateAssetTxFee: 3,
-		EUpgradeTime:     mockable.MaxTime,
+		StaticConfig: fee.StaticConfig{
+			TxFee:            2,
+			CreateAssetTxFee: 3,
+		},
+		EUpgradeTime: mockable.MaxTime,
 	}
 )
 

vms/avm/txs/fee/calculator.go

@@ -0,0 +1,11 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package fee
+
+import "github.com/ava-labs/avalanchego/vms/avm/txs"
+
+// Calculator is the interfaces that any fee Calculator must implement
+type Calculator interface {
+	CalculateFee(tx *txs.Tx) (uint64, error)
+}

vms/avm/txs/fee/calculator_test.go

@@ -0,0 +1,93 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package fee
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/avalanchego/utils/units"
+	"github.com/ava-labs/avalanchego/vms/avm/txs"
+)
+
+func TestTxFees(t *testing.T) {
+	feeTestsDefaultCfg := StaticConfig{
+		TxFee:            1 * units.Avax,
+		CreateAssetTxFee: 2 * units.Avax,
+	}
+
+	// chain times needed to have specific upgrades active
+	eUpgradeTime := time.Unix(1713945427, 0)
+	preEUpgradeTime := eUpgradeTime.Add(-1 * time.Second)
+
+	tests := []struct {
+		name       string
+		chainTime  time.Time
+		unsignedTx func() txs.UnsignedTx
+		expected   uint64
+	}{
+		{
+			name:       "BaseTx pre EUpgrade",
+			chainTime:  preEUpgradeTime,
+			unsignedTx: baseTx,
+			expected:   feeTestsDefaultCfg.TxFee,
+		},
+		{
+			name:       "CreateAssetTx pre EUpgrade",
+			chainTime:  preEUpgradeTime,
+			unsignedTx: createAssetTx,
+			expected:   feeTestsDefaultCfg.CreateAssetTxFee,
+		},
+		{
+			name:       "OperationTx pre EUpgrade",
+			chainTime:  preEUpgradeTime,
+			unsignedTx: operationTx,
+			expected:   feeTestsDefaultCfg.TxFee,
+		},
+		{
+			name:       "ImportTx pre EUpgrade",
+			chainTime:  preEUpgradeTime,
+			unsignedTx: importTx,
+			expected:   feeTestsDefaultCfg.TxFee,
+		},
+		{
+			name:       "ExportTx pre EUpgrade",
+			chainTime:  preEUpgradeTime,
+			unsignedTx: exportTx,
+			expected:   feeTestsDefaultCfg.TxFee,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			uTx := tt.unsignedTx()
+			fc := NewStaticCalculator(feeTestsDefaultCfg)
+			haveFee, err := fc.CalculateFee(&txs.Tx{Unsigned: uTx})
+			require.NoError(t, err)
+			require.Equal(t, tt.expected, haveFee)
+		})
+	}
+}
+
+func baseTx() txs.UnsignedTx {
+	return &txs.BaseTx{}
+}
+
+func createAssetTx() txs.UnsignedTx {
+	return &txs.CreateAssetTx{}
+}
+
+func operationTx() txs.UnsignedTx {
+	return &txs.OperationTx{}
+}
+
+func importTx() txs.UnsignedTx {
+	return &txs.ImportTx{}
+}
+
+func exportTx() txs.UnsignedTx {
+	return &txs.ExportTx{}
+}