Rename configs: alternative

params/config.go

@@ -34,7 +34,7 @@ import (
 
 	"github.com/ava-labs/avalanchego/snow"
 	"github.com/ava-labs/subnet-evm/commontype"
-	"github.com/ava-labs/subnet-evm/precompile/config"
+	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ava-labs/subnet-evm/precompile/modules"
 	"github.com/ava-labs/subnet-evm/utils"
 	"github.com/ethereum/go-ethereum/common"
@@ -558,7 +558,7 @@ type Rules struct {
 	// for this rule set.
 	// Note: none of these addresses should conflict with the address space used by
 	// any existing precompiles.
-	ActivePrecompiles map[common.Address]config.Config
+	ActivePrecompiles map[common.Address]precompileConfig.Config
 }
 
 // IsPrecompileEnabled returns true if the precompile at [addr] is enabled for this rule set.
@@ -594,7 +594,7 @@ func (c *ChainConfig) AvalancheRules(blockNum, blockTimestamp *big.Int) Rules {
 	rules.IsSubnetEVM = c.IsSubnetEVM(blockTimestamp)
 
 	// Initialize the stateful precompiles that should be enabled at [blockTimestamp].
-	rules.ActivePrecompiles = make(map[common.Address]config.Config)
+	rules.ActivePrecompiles = make(map[common.Address]precompileConfig.Config)
 	for _, module := range modules.RegisteredModules() {
 		if config := c.GetActivePrecompileConfig(module.Address, blockTimestamp); config != nil && !config.IsDisabled() {
 			rules.ActivePrecompiles[module.Address] = config

params/precompile_upgrade.go

@@ -9,7 +9,6 @@ import (
 	"fmt"
 	"math/big"
 
-	"github.com/ava-labs/subnet-evm/precompile/config"
 	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ava-labs/subnet-evm/precompile/modules"
 	"github.com/ava-labs/subnet-evm/utils"
@@ -23,7 +22,7 @@ var errNoKey = errors.New("PrecompileUpgrade cannot be empty")
 // based on the key. Keys are defined in each precompile module, and registered in
 // precompile/registry/registry.go.
 type PrecompileUpgrade struct {
-	config.Config
+	precompileConfig.Config
 }
 
 // UnmarshalJSON unmarshals the json into the correct precompile config type
@@ -152,7 +151,7 @@ func (c *ChainConfig) verifyPrecompileUpgrades() error {
 
 // GetActivePrecompileConfig returns the most recent precompile config corresponding to [address].
 // If none have occurred, returns nil.
-func (c *ChainConfig) GetActivePrecompileConfig(address common.Address, blockTimestamp *big.Int) config.Config {
+func (c *ChainConfig) GetActivePrecompileConfig(address common.Address, blockTimestamp *big.Int) precompileConfig.Config {
 	configs := c.GetActivatingPrecompileConfigs(address, nil, blockTimestamp, c.PrecompileUpgrades)
 	if len(configs) == 0 {
 		return nil
@@ -162,13 +161,13 @@ func (c *ChainConfig) GetActivePrecompileConfig(address common.Address, blockTim
 
 // GetActivatingPrecompileConfigs returns all upgrades configured to activate during the state transition from a block with timestamp [from]
 // to a block with timestamp [to].
-func (c *ChainConfig) GetActivatingPrecompileConfigs(address common.Address, from *big.Int, to *big.Int, upgrades []PrecompileUpgrade) []config.Config {
+func (c *ChainConfig) GetActivatingPrecompileConfigs(address common.Address, from *big.Int, to *big.Int, upgrades []PrecompileUpgrade) []precompileConfig.Config {
 	// Get key from address.
 	module, ok := modules.GetPrecompileModuleByAddress(address)
 	if !ok {
 		return nil
 	}
-	configs := make([]config.Config, 0)
+	configs := make([]precompileConfig.Config, 0)
 	key := module.ConfigKey
 	// First check the embedded [upgrade] for precompiles configured
 	// in the genesis chain config.

params/precompiles.go

@@ -6,11 +6,11 @@ package params
 import (
 	"encoding/json"
 
-	"github.com/ava-labs/subnet-evm/precompile/config"
+	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ava-labs/subnet-evm/precompile/modules"
 )
 
-type Precompiles map[string]config.Config
+type Precompiles map[string]precompileConfig.Config
 
 // UnmarshalJSON parses the JSON-encoded data into the ChainConfigPrecompiles.
 // ChainConfigPrecompiles is a map of precompile module keys to their

precompile/allowlist/allow_list_test.go

@@ -25,7 +25,7 @@ func TestAllowListRun(t *testing.T) {
 		expectedRes []byte
 		expectedErr string
 
-		config *Config
+		config *AllowList
 
 		assertState func(t *testing.T, state *state.StateDB)
 	}
@@ -221,7 +221,7 @@ func TestAllowListRun(t *testing.T) {
 			expectedErr: vmerrs.ErrOutOfGas.Error(),
 		},
 		"initial config sets admins": {
-			config: &Config{
+			config: &AllowList{
 				AdminAddresses: []common.Address{noRoleAddr, enabledAddr},
 			},
 			suppliedGas: 0,
@@ -233,7 +233,7 @@ func TestAllowListRun(t *testing.T) {
 			},
 		},
 		"initial config sets enabled": {
-			config: &Config{
+			config: &AllowList{
 				EnabledAddresses: []common.Address{noRoleAddr, adminAddr},
 			},
 			suppliedGas: 0,

precompile/allowlist/config.go

@@ -10,15 +10,15 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 )
 
-// Config specifies the initial set of addresses with Admin or Enabled roles.
-type Config struct {
+// AllowList specifies the initial set of addresses with Admin or Enabled roles.
+type AllowList struct {
 	AdminAddresses   []common.Address `json:"adminAddresses,omitempty"`   // initial admin addresses
 	EnabledAddresses []common.Address `json:"enabledAddresses,omitempty"` // initial enabled addresses
 }
 
 // Configure initializes the address space of [precompileAddr] by initializing the role of each of
 // the addresses in [AllowListAdmins].
-func (c *Config) Configure(state contract.StateDB, precompileAddr common.Address) error {
+func (c *AllowList) Configure(state contract.StateDB, precompileAddr common.Address) error {
 	for _, enabledAddr := range c.EnabledAddresses {
 		SetAllowListRole(state, precompileAddr, enabledAddr, EnabledRole)
 	}
@@ -29,7 +29,7 @@ func (c *Config) Configure(state contract.StateDB, precompileAddr common.Address
 }
 
 // Equal returns true iff [other] has the same admins in the same order in its allow list.
-func (c *Config) Equal(other *Config) bool {
+func (c *AllowList) Equal(other *AllowList) bool {
 	if other == nil {
 		return false
 	}
@@ -52,7 +52,7 @@ func areEqualAddressLists(current []common.Address, other []common.Address) bool
 }
 
 // Verify returns an error if there is an overlapping address between admin and enabled roles
-func (c *Config) Verify() error {
+func (c *AllowList) Verify() error {
 	addressMap := make(map[common.Address]Role) // tracks which addresses we have seen and their role
 
 	// check for duplicates in enabled list

precompile/allowlist/config_test.go

@@ -10,32 +10,32 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestVerifyAllowlistConfig(t *testing.T) {
+func TestVerifyAllowlistAllowList(t *testing.T) {
 	admins := []common.Address{{1}}
 	enableds := []common.Address{{2}}
 	tests := []struct {
 		name          string
-		config        Config
+		config        AllowList
 		expectedError string
 	}{
 		{
 			name:          "invalid allow list config in allowlist",
-			config:        Config{admins, admins},
+			config:        AllowList{admins, admins},
 			expectedError: "cannot set address",
 		},
 		{
 			name:          "nil member allow list config in allowlist",
-			config:        Config{nil, nil},
+			config:        AllowList{nil, nil},
 			expectedError: "",
 		},
 		{
 			name:          "empty member allow list config in allowlist",
-			config:        Config{[]common.Address{}, []common.Address{}},
+			config:        AllowList{[]common.Address{}, []common.Address{}},
 			expectedError: "",
 		},
 		{
 			name:          "valid allow list config in allowlist",
-			config:        Config{admins, enableds},
+			config:        AllowList{admins, enableds},
 			expectedError: "",
 		},
 	}
@@ -53,37 +53,37 @@ func TestVerifyAllowlistConfig(t *testing.T) {
 	}
 }
 
-func TestEqualAllowListConfig(t *testing.T) {
+func TestEqualAllowListAllowList(t *testing.T) {
 	admins := []common.Address{{1}}
 	enableds := []common.Address{{2}}
 	tests := []struct {
 		name     string
-		config   *Config
-		other    *Config
+		config   *AllowList
+		other    *AllowList
 		expected bool
 	}{
 		{
 			name:     "non-nil config and nil other",
-			config:   &Config{admins, enableds},
+			config:   &AllowList{admins, enableds},
 			other:    nil,
 			expected: false,
 		},
 		{
 			name:     "different admin",
-			config:   &Config{admins, enableds},
-			other:    &Config{[]common.Address{{3}}, enableds},
+			config:   &AllowList{admins, enableds},
+			other:    &AllowList{[]common.Address{{3}}, enableds},
 			expected: false,
 		},
 		{
 			name:     "different enabled",
-			config:   &Config{admins, enableds},
-			other:    &Config{admins, []common.Address{{3}}},
+			config:   &AllowList{admins, enableds},
+			other:    &AllowList{admins, []common.Address{{3}}},
 			expected: false,
 		},
 		{
 			name:     "same config",
-			config:   &Config{admins, enableds},
-			other:    &Config{admins, enableds},
+			config:   &AllowList{admins, enableds},
+			other:    &AllowList{admins, enableds},
 			expected: true,
 		},
 	}

precompile/config/config.go

@@ -2,7 +2,7 @@
 // See the file LICENSE for licensing terms.
 
 // Defines the stateless interface for unmarshalling an arbitrary config of a precompile
-package config
+package precompileConfig
 
 import (
 	"math/big"

precompile/config/mock_config.go

@@ -2,8 +2,7 @@
 // See the file LICENSE for licensing terms.
 
 // TODO: replace with gomock
-
-package config
+package precompileConfig
 
 import (
 	"math/big"

precompile/config/upgradeable.go

@@ -1,7 +1,7 @@
 // (c) 2022 Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-package config
+package precompileConfig
 
 import (
 	"math/big"

precompile/contract/interfaces.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/ava-labs/avalanchego/snow"
 	"github.com/ava-labs/subnet-evm/commontype"
-	"github.com/ava-labs/subnet-evm/precompile/config"
+	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ethereum/go-ethereum/common"
 )
 
@@ -69,10 +69,10 @@ type BlockContext interface {
 }
 
 type Configurator interface {
-	NewConfig() config.Config
+	NewConfig() precompileConfig.Config
 	Configure(
 		chainConfig ChainConfig,
-		precompileConfig config.Config,
+		precompileConfig precompileConfig.Config,
 		state StateDB,
 		blockContext BlockContext,
 	) error

precompile/contract/utils.go

@@ -10,7 +10,7 @@ import (
 	"testing"
 
 	"github.com/ava-labs/subnet-evm/accounts/abi"
-	"github.com/ava-labs/subnet-evm/precompile/config"
+	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ava-labs/subnet-evm/vmerrs"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
@@ -39,7 +39,7 @@ type PrecompileTest struct {
 	// It should be the same precompile config that is used in the
 	// precompile's configurator.
 	// If nil, Configure on the Configurator will not be called.
-	Config config.Config
+	Config precompileConfig.Config
 	// BeforeHook is called before the precompile is called.
 	BeforeHook func(t *testing.T, state StateDB)
 	// AfterHook is called after the precompile is called.

precompile/contracts/deployerallowlist/config.go

@@ -7,36 +7,36 @@ import (
 	"math/big"
 
 	"github.com/ava-labs/subnet-evm/precompile/allowlist"
-	"github.com/ava-labs/subnet-evm/precompile/config"
+	precompileConfig "github.com/ava-labs/subnet-evm/precompile/config"
 	"github.com/ethereum/go-ethereum/common"
 )
 
-var _ config.Config = &Config{}
+var _ precompileConfig.Config = &Config{}
 
 // Config contains the configuration for the ContractDeployerAllowList precompile,
 // consisting of the initial allowlist and the timestamp for the network upgrade.
 type Config struct {
-	allowlist.Config
-	config.Upgrade
+	allowlist.AllowList
+	precompileConfig.Upgrade
 }
 
 // NewConfig returns a config for a network upgrade at [blockTimestamp] that enables
 // ContractDeployerAllowList with [admins] and [enableds] as members of the allowlist.
 func NewConfig(blockTimestamp *big.Int, admins []common.Address, enableds []common.Address) *Config {
 	return &Config{
-		Config: allowlist.Config{
+		AllowList: allowlist.AllowList{
 			AdminAddresses:   admins,
 			EnabledAddresses: enableds,
 		},
-		Upgrade: config.Upgrade{BlockTimestamp: blockTimestamp},
+		Upgrade: precompileConfig.Upgrade{BlockTimestamp: blockTimestamp},
 	}
 }
 
 // NewDisableConfig returns config for a network upgrade at [blockTimestamp]
 // that disables ContractDeployerAllowList.
 func NewDisableConfig(blockTimestamp *big.Int) *Config {
 	return &Config{
-		Upgrade: config.Upgrade{
+		Upgrade: precompileConfig.Upgrade{
 			BlockTimestamp: blockTimestamp,
 			Disable:        true,
 		},
@@ -46,13 +46,13 @@ func NewDisableConfig(blockTimestamp *big.Int) *Config {
 func (*Config) Key() string { return ConfigKey }
 
 // Equal returns true if [cfg] is a [*ContractDeployerAllowListConfig] and it has been configured identical to [c].
-func (c *Config) Equal(cfg config.Config) bool {
+func (c *Config) Equal(cfg precompileConfig.Config) bool {
 	// typecast before comparison
 	other, ok := (cfg).(*Config)
 	if !ok {
 		return false
 	}
-	return c.Upgrade.Equal(&other.Upgrade) && c.Config.Equal(&other.Config)
+	return c.Upgrade.Equal(&other.Upgrade) && c.AllowList.Equal(&other.AllowList)
 }
 
-func (c *Config) Verify() error { return c.Config.Verify() }
+func (c *Config) Verify() error { return c.AllowList.Verify() }