sync: coreth PR #1305: feat!: explicit libevm calls to Register{Extras,Hooks}() (#1773)

Author: ARR4N

.github/workflows/tests.yml

@@ -97,7 +97,7 @@ jobs:
       - name: Setup Contracts
         run: ./scripts/run_task.sh setup-contracts
       - name: Run Warp E2E Tests
-        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@36baa0509d61679085d35bffa590d63732b0a7bd
+        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@84e9aebcfbc04602865f4c0a3e8b46a27409a3f5
         with:
           run: ./scripts/run_task.sh test-e2e-warp-ci
           artifact_prefix: warp
@@ -122,7 +122,7 @@ jobs:
         with:
           go-version-file: "go.mod"
       - name: Run E2E Load Tests
-        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@36baa0509d61679085d35bffa590d63732b0a7bd
+        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@84e9aebcfbc04602865f4c0a3e8b46a27409a3f5
         with:
           run: ./scripts/run_task.sh test-e2e-load-ci
           artifact_prefix: load

accounts/abi/bind/bind_test.go

@@ -37,8 +37,16 @@ import (
 	"testing"
 
 	"github.com/ava-labs/libevm/common"
+	"github.com/ava-labs/subnet-evm/params"
+	"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
 )
 
+func TestMain(m *testing.M) {
+	customtypes.Register()
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 var bindTests = []struct {
 	name     string
 	contract string
@@ -2156,10 +2164,21 @@ func golangBindings(t *testing.T, overload bool) {
 
 			import (
 				"testing"
+
+				"github.com/ava-labs/subnet-evm/params"
+				"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
+				libevmparams "github.com/ava-labs/libevm/params"
+				libevmtypes "github.com/ava-labs/libevm/core/types"
+
 				%s
 			)
 
 			func Test%s(t *testing.T) {
+				customtypes.Register()
+				t.Cleanup(libevmtypes.TestOnlyClearRegisteredExtras)
+				params.RegisterExtras()
+				t.Cleanup(libevmparams.TestOnlyClearRegisteredExtras)
+
 				%s
 			}
 		`, tt.imports, tt.name, tt.tester)

core/evm.go

@@ -46,7 +46,14 @@ import (
 	"github.com/holiman/uint256"
 )
 
-func init() {
+// RegisterExtras registers hooks with libevm to achieve Avalanche behaviour of
+// the EVM. It MUST NOT be called more than once and therefore is only allowed
+// to be used in tests and `package main`, to avoid polluting other packages
+// that transitively depend on this one but don't need registration.
+func RegisterExtras() {
+	// Although the registration function refers to just Hooks (not Extras) this
+	// will be changed in the future to standardise across libevm, hence the
+	// name of the function we're in.
 	vm.RegisterHooks(hooks{})
 }
 

core/main_test.go

@@ -7,11 +7,19 @@ import (
 	"testing"
 
 	"go.uber.org/goleak"
+
+	"github.com/ava-labs/subnet-evm/params"
+	"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
 )
 
 // TestMain uses goleak to verify tests in this package do not leak unexpected
 // goroutines.
 func TestMain(m *testing.M) {
+	RegisterExtras()
+
+	customtypes.Register()
+	params.RegisterExtras()
+
 	opts := []goleak.Option{
 		// No good way to shut down these goroutines:
 		goleak.IgnoreTopFunction("github.com/ava-labs/subnet-evm/core/state/snapshot.(*diskLayer).generate"),

core/txpool/blobpool/blobpool_test.go

@@ -75,6 +75,8 @@ var (
 var testChainConfig *params.ChainConfig
 
 func init() {
+	params.RegisterExtras()
+
 	testChainConfig = new(params.ChainConfig)
 	*testChainConfig = params.Copy(params.TestChainConfig)
 	params.GetExtra(testChainConfig).FeeConfig.MinBaseFee = new(big.Int).SetUint64(1)

core/txpool/legacypool/legacypool_test.go

@@ -54,6 +54,11 @@ import (
 	"github.com/holiman/uint256"
 )
 
+func TestMain(m *testing.M) {
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 var (
 	// testTxPoolConfig is a transaction pool configuration without stateful disk
 	// sideeffects used during testing.

core/vm/runtime/runtime_test.go

@@ -52,6 +52,11 @@ import (
 	"github.com/holiman/uint256"
 )
 
+func TestMain(m *testing.M) {
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 func TestDefaults(t *testing.T) {
 	cfg := new(Config)
 	setDefaults(cfg)

eth/filters/filter_test.go

@@ -31,6 +31,7 @@ import (
 	"context"
 	"encoding/json"
 	"math/big"
+	"os"
 	"strings"
 	"testing"
 	"time"
@@ -46,10 +47,17 @@ import (
 	"github.com/ava-labs/subnet-evm/core"
 	"github.com/ava-labs/subnet-evm/params"
 	"github.com/ava-labs/subnet-evm/plugin/evm/customrawdb"
+	"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
 	"github.com/ava-labs/subnet-evm/rpc"
 	"github.com/stretchr/testify/require"
 )
 
+func TestMain(m *testing.M) {
+	customtypes.Register()
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 func makeReceipt(addr common.Address) *types.Receipt {
 	receipt := types.NewReceipt(nil, false, 0)
 	receipt.Logs = []*types.Log{

eth/gasprice/gasprice_test.go

@@ -30,6 +30,7 @@ package gasprice
 import (
 	"context"
 	"math/big"
+	"os"
 	"testing"
 	"time"
 
@@ -46,13 +47,21 @@ import (
 	"github.com/ava-labs/subnet-evm/params"
 	"github.com/ava-labs/subnet-evm/params/extras"
 	"github.com/ava-labs/subnet-evm/plugin/evm/customheader"
+	"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
 	"github.com/ava-labs/subnet-evm/plugin/evm/upgrade/legacy"
 	"github.com/ava-labs/subnet-evm/precompile/contracts/feemanager"
 	"github.com/ava-labs/subnet-evm/rpc"
 	"github.com/ava-labs/subnet-evm/utils"
 	"github.com/stretchr/testify/require"
 )
 
+func TestMain(m *testing.M) {
+	core.RegisterExtras()
+	customtypes.Register()
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 var (
 	key, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
 	addr   = crypto.PubkeyToAddress(key.PublicKey)

eth/tracers/api_extra_test.go

@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"math/big"
+	"os"
 	"reflect"
 	"sync/atomic"
 	"testing"
@@ -25,12 +26,19 @@ import (
 	"github.com/ava-labs/subnet-evm/params"
 	"github.com/ava-labs/subnet-evm/params/extras"
 	"github.com/ava-labs/subnet-evm/plugin/evm/customrawdb"
+	"github.com/ava-labs/subnet-evm/plugin/evm/customtypes"
 	"github.com/ava-labs/subnet-evm/precompile/contracts/txallowlist"
 	"github.com/ava-labs/subnet-evm/rpc"
 
 	ethparams "github.com/ava-labs/libevm/params"
 )
 
+func TestMain(m *testing.M) {
+	customtypes.Register()
+	params.RegisterExtras()
+	os.Exit(m.Run())
+}
+
 var schemes = []string{rawdb.HashScheme, customrawdb.FirewoodScheme}
 
 func TestTraceBlockPrecompileActivation(t *testing.T) {