e2e: Rename 'funded key' to 'pre-funded key' for consistency (#2455)

Author: maru-ava

tests/e2e/c/dynamic_fees.go

@@ -42,7 +42,7 @@ var _ = e2e.DescribeCChain("[Dynamic Fees]", func() {
 		privateNetwork := e2e.Env.NewPrivateNetwork()
 
 		ginkgo.By("allocating a pre-funded key")
-		key := privateNetwork.GetConfig().FundedKeys[0]
+		key := privateNetwork.GetConfig().PreFundedKeys[0]
 		ethAddress := evm.GetEthAddress(key)
 
 		ginkgo.By("initializing a coreth client")

tests/e2e/c/interchain_workflow.go

@@ -37,7 +37,7 @@ var _ = e2e.DescribeCChain("[Interchain Workflow]", func() {
 		ethClient := e2e.NewEthClient(nodeURI)
 
 		ginkgo.By("allocating a pre-funded key to send from and a recipient key to deliver to")
-		senderKey := e2e.Env.AllocateFundedKey()
+		senderKey := e2e.Env.AllocatePreFundedKey()
 		senderEthAddress := evm.GetEthAddress(senderKey)
 		recipientKey, err := secp256k1.NewPrivateKey()
 		require.NoError(err)

tests/e2e/p/staking_rewards.go

@@ -87,7 +87,7 @@ var _ = ginkgo.Describe("[Staking Rewards]", func() {
 
 		ginkgo.By("creating keychain and P-Chain wallet")
 		keychain := secp256k1fx.NewKeychain(rewardKeys...)
-		fundedKey := e2e.Env.AllocateFundedKey()
+		fundedKey := e2e.Env.AllocatePreFundedKey()
 		keychain.Add(fundedKey)
 		nodeURI := e2e.Env.GetRandomNodeURI()
 		baseWallet := e2e.NewWallet(keychain, nodeURI)

tests/e2e/x/transfer/virtuous.go

@@ -69,7 +69,7 @@ var _ = e2e.DescribeXChainSerial("[Virtuous Transfer Tx AVAX]", func() {
 
 			// Ensure the same set of 10 keys is used for all tests
 			// by retrieving them outside of runFunc.
-			testKeys := e2e.Env.AllocateFundedKeys(10)
+			testKeys := e2e.Env.AllocatePreFundedKeys(10)
 
 			runFunc := func(round int) {
 				tests.Outf("{{green}}\n\n\n\n\n\n---\n[ROUND #%02d]:{{/}}\n", round)

tests/fixture/e2e/env.go

@@ -75,7 +75,7 @@ func NewTestEnvironment(flagVars *FlagVars) *TestEnvironment {
 	tests.Outf("{{green}}network URIs: {{/}} %+v\n", uris)
 
 	testDataServerURI, err := fixture.ServeTestData(fixture.TestData{
-		FundedKeys: network.FundedKeys,
+		PreFundedKeys: network.PreFundedKeys,
 	})
 	tests.Outf("{{green}}test data server URI: {{/}} %+v\n", testDataServerURI)
 	require.NoError(err)
@@ -104,21 +104,21 @@ func (te *TestEnvironment) GetNetwork() tmpnet.Network {
 }
 
 // Retrieve the specified number of funded keys allocated for the caller's exclusive use.
-func (te *TestEnvironment) AllocateFundedKeys(count int) []*secp256k1.PrivateKey {
-	keys, err := fixture.AllocateFundedKeys(te.TestDataServerURI, count)
+func (te *TestEnvironment) AllocatePreFundedKeys(count int) []*secp256k1.PrivateKey {
+	keys, err := fixture.AllocatePreFundedKeys(te.TestDataServerURI, count)
 	te.require.NoError(err)
-	tests.Outf("{{blue}} allocated funded key(s): %+v{{/}}\n", keys)
+	tests.Outf("{{blue}} allocated pre-funded key(s): %+v{{/}}\n", keys)
 	return keys
 }
 
 // Retrieve a funded key allocated for the caller's exclusive use.
-func (te *TestEnvironment) AllocateFundedKey() *secp256k1.PrivateKey {
-	return te.AllocateFundedKeys(1)[0]
+func (te *TestEnvironment) AllocatePreFundedKey() *secp256k1.PrivateKey {
+	return te.AllocatePreFundedKeys(1)[0]
 }
 
 // Create a new keychain with the specified number of test keys.
 func (te *TestEnvironment) NewKeychain(count int) *secp256k1fx.Keychain {
-	keys := te.AllocateFundedKeys(count)
+	keys := te.AllocatePreFundedKeys(count)
 	return secp256k1fx.NewKeychain(keys...)
 }
 

tests/fixture/e2e/helpers.go

@@ -235,7 +235,7 @@ func StartLocalNetwork(avalancheGoExecPath string, networkDir string) *local.Loc
 			},
 		},
 		tmpnet.DefaultNodeCount,
-		tmpnet.DefaultFundedKeyCount,
+		tmpnet.DefaultPreFundedKeyCount,
 	)
 	require.NoError(err)
 	ginkgo.DeferCleanup(func() {

tests/fixture/test_data_server.go

@@ -33,7 +33,7 @@ var (
 )
 
 type TestData struct {
-	FundedKeys []*secp256k1.PrivateKey
+	PreFundedKeys []*secp256k1.PrivateKey
 }
 
 // http server allocating resources to tests potentially executing in parallel
@@ -68,14 +68,14 @@ func (s *testDataServer) allocateKeys(w http.ResponseWriter, r *http.Request) {
 	defer s.lock.Unlock()
 
 	// Only fulfill requests for available keys
-	if keyCount > len(s.FundedKeys) {
+	if keyCount > len(s.PreFundedKeys) {
 		http.Error(w, requestedKeyCountExceedsAvailable, http.StatusInternalServerError)
 		return
 	}
 
 	// Allocate the requested number of keys
-	remainingKeys := len(s.FundedKeys) - keyCount
-	allocatedKeys := s.FundedKeys[remainingKeys:]
+	remainingKeys := len(s.PreFundedKeys) - keyCount
+	allocatedKeys := s.PreFundedKeys[remainingKeys:]
 
 	keysDoc := &keysDocument{
 		Keys: allocatedKeys,
@@ -88,7 +88,7 @@ func (s *testDataServer) allocateKeys(w http.ResponseWriter, r *http.Request) {
 
 	// Forget the allocated keys
 	utils.ZeroSlice(allocatedKeys)
-	s.FundedKeys = s.FundedKeys[:remainingKeys]
+	s.PreFundedKeys = s.PreFundedKeys[:remainingKeys]
 }
 
 // Serve test data via http to ensure allocation is synchronized even when
@@ -122,9 +122,9 @@ func ServeTestData(testData TestData) (string, error) {
 	return address, nil
 }
 
-// Retrieve the specified number of funded test keys from the provided URI. A given
+// Retrieve the specified number of pre-funded test keys from the provided URI. A given
 // key is allocated at most once during the life of the test data server.
-func AllocateFundedKeys(baseURI string, count int) ([]*secp256k1.PrivateKey, error) {
+func AllocatePreFundedKeys(baseURI string, count int) ([]*secp256k1.PrivateKey, error) {
 	if count <= 0 {
 		return nil, errInvalidKeyCount
 	}
@@ -144,13 +144,13 @@ func AllocateFundedKeys(baseURI string, count int) ([]*secp256k1.PrivateKey, err
 
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
-		return nil, fmt.Errorf("failed to request funded keys: %w", err)
+		return nil, fmt.Errorf("failed to request pre-funded keys: %w", err)
 	}
 	defer resp.Body.Close()
 
 	body, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read response for funded keys: %w", err)
+		return nil, fmt.Errorf("failed to read response for pre-funded keys: %w", err)
 	}
 	if resp.StatusCode != http.StatusOK {
 		if strings.TrimSpace(string(body)) == requestedKeyCountExceedsAvailable {
@@ -161,7 +161,7 @@ func AllocateFundedKeys(baseURI string, count int) ([]*secp256k1.PrivateKey, err
 
 	keysDoc := &keysDocument{}
 	if err := json.Unmarshal(body, keysDoc); err != nil {
-		return nil, fmt.Errorf("failed to unmarshal funded keys: %w", err)
+		return nil, fmt.Errorf("failed to unmarshal pre-funded keys: %w", err)
 	}
 	return keysDoc.Keys, nil
 }

tests/fixture/test_data_server_test.go

@@ -14,7 +14,7 @@ import (
 
 // Check that funded test keys can be served from an http server to
 // ensure at-most-once allocation when tests are executed in parallel.
-func TestAllocateFundedKeys(t *testing.T) {
+func TestAllocatePreFundedKeys(t *testing.T) {
 	require := require.New(t)
 
 	keys := make([]*secp256k1.PrivateKey, 5)
@@ -25,7 +25,7 @@ func TestAllocateFundedKeys(t *testing.T) {
 	}
 
 	uri, err := ServeTestData(TestData{
-		FundedKeys: keys,
+		PreFundedKeys: keys,
 	})
 	require.NoError(err)
 
@@ -63,7 +63,7 @@ func TestAllocateFundedKeys(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			keys, err := AllocateFundedKeys(uri, tc.count)
+			keys, err := AllocatePreFundedKeys(uri, tc.count)
 			require.ErrorIs(err, tc.expectedError)
 
 			addresses := make([]ids.ShortID, len(keys))

tests/fixture/tmpnet/cmd/main.go

@@ -46,10 +46,10 @@ func main() {
 	rootCmd.AddCommand(versionCmd)
 
 	var (
-		rootDir        string
-		execPath       string
-		nodeCount      uint8
-		fundedKeyCount uint8
+		rootDir           string
+		execPath          string
+		nodeCount         uint8
+		preFundedKeyCount uint8
 	)
 	startNetworkCmd := &cobra.Command{
 		Use:   "start-network",
@@ -68,7 +68,7 @@ func main() {
 			}
 			ctx, cancel := context.WithTimeout(context.Background(), local.DefaultNetworkStartTimeout)
 			defer cancel()
-			network, err := local.StartNetwork(ctx, os.Stdout, rootDir, network, int(nodeCount), int(fundedKeyCount))
+			network, err := local.StartNetwork(ctx, os.Stdout, rootDir, network, int(nodeCount), int(preFundedKeyCount))
 			if err != nil {
 				return err
 			}
@@ -95,7 +95,7 @@ func main() {
 	startNetworkCmd.PersistentFlags().StringVar(&rootDir, "root-dir", os.Getenv(local.RootDirEnvName), "The path to the root directory for local networks")
 	startNetworkCmd.PersistentFlags().StringVar(&execPath, "avalanchego-path", os.Getenv(local.AvalancheGoPathEnvName), "The path to an avalanchego binary")
 	startNetworkCmd.PersistentFlags().Uint8Var(&nodeCount, "node-count", tmpnet.DefaultNodeCount, "Number of nodes the network should initially consist of")
-	startNetworkCmd.PersistentFlags().Uint8Var(&fundedKeyCount, "funded-key-count", tmpnet.DefaultFundedKeyCount, "Number of funded keys the network should start with")
+	startNetworkCmd.PersistentFlags().Uint8Var(&preFundedKeyCount, "pre-funded-key-count", tmpnet.DefaultPreFundedKeyCount, "Number of pre-funded keys the network should start with")
 	rootCmd.AddCommand(startNetworkCmd)
 
 	var networkDir string

tests/fixture/tmpnet/config.go

@@ -33,21 +33,21 @@ import (
 )
 
 const (
-	DefaultNodeCount      = 2 // Minimum required to ensure connectivity-based health checks will pass
-	DefaultFundedKeyCount = 50
+	DefaultNodeCount         = 2 // Minimum required to ensure connectivity-based health checks will pass
+	DefaultPreFundedKeyCount = 50
 
 	DefaultGasLimit = uint64(100_000_000) // Gas limit is arbitrary
 
 	// Arbitrarily large amount of AVAX to fund keys on the X-Chain for testing
-	DefaultFundedKeyXChainAmount = 30 * units.MegaAvax
+	DefaultPreFundedKeyXChainAmount = 30 * units.MegaAvax
 
 	// A short min stake duration enables testing of staking logic.
 	DefaultMinStakeDuration = time.Second
 )
 
 var (
 	// Arbitrarily large amount of AVAX (10^12) to fund keys on the C-Chain for testing
-	DefaultFundedKeyCChainAmount = new(big.Int).Exp(big.NewInt(10), big.NewInt(30), nil)
+	DefaultPreFundedKeyCChainAmount = new(big.Int).Exp(big.NewInt(10), big.NewInt(30), nil)
 
 	errNoKeysForGenesis           = errors.New("failed to generate genesis: no keys to fund")
 	errInvalidNetworkIDForGenesis = errors.New("network ID can't be mainnet, testnet or local network ID")
@@ -121,10 +121,10 @@ func DefaultJSONMarshal(v interface{}) ([]byte, error) {
 // NetworkConfig defines configuration shared or
 // common to all nodes in a given network.
 type NetworkConfig struct {
-	Genesis      *genesis.UnparsedConfig
-	CChainConfig FlagsMap
-	DefaultFlags FlagsMap
-	FundedKeys   []*secp256k1.PrivateKey
+	Genesis       *genesis.UnparsedConfig
+	CChainConfig  FlagsMap
+	DefaultFlags  FlagsMap
+	PreFundedKeys []*secp256k1.PrivateKey
 }
 
 // Ensure genesis is generated if not already present.
@@ -133,17 +133,17 @@ func (c *NetworkConfig) EnsureGenesis(networkID uint32, initialStakers []genesis
 		return nil
 	}
 
-	if len(c.FundedKeys) == 0 {
+	if len(c.PreFundedKeys) == 0 {
 		return errNoKeysForGenesis
 	}
 
 	// Ensure pre-funded keys have arbitrary large balances on both chains to support testing
-	xChainBalances := make(XChainBalanceMap, len(c.FundedKeys))
-	cChainBalances := make(core.GenesisAlloc, len(c.FundedKeys))
-	for _, key := range c.FundedKeys {
-		xChainBalances[key.Address()] = DefaultFundedKeyXChainAmount
+	xChainBalances := make(XChainBalanceMap, len(c.PreFundedKeys))
+	cChainBalances := make(core.GenesisAlloc, len(c.PreFundedKeys))
+	for _, key := range c.PreFundedKeys {
+		xChainBalances[key.Address()] = DefaultPreFundedKeyXChainAmount
 		cChainBalances[evm.GetEthAddress(key)] = core.GenesisAccount{
-			Balance: DefaultFundedKeyCChainAmount,
+			Balance: DefaultPreFundedKeyCChainAmount,
 		}
 	}