config_test.go

package seth_test

import (
	"crypto/ecdsa"
	"math/big"
	"os"
	"testing"
	"time"

	"github.com/ethereum/go-ethereum/accounts/abi/bind"
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/ethclient"

	"github.com/pelletier/go-toml/v2"

	"github.com/ethereum/go-ethereum/common"
	"github.com/stretchr/testify/require"

	"github.com/smartcontractkit/chainlink-testing-framework/seth"
	link_token "github.com/smartcontractkit/chainlink-testing-framework/seth/contracts/bind/link"
)

func TestConfig_DefaultClient(t *testing.T) {
	client, err := seth.DefaultClient("ws://localhost:8546", []string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"})
	require.NoError(t, err, "failed to create client with default config")
	require.Equal(t, 1, len(client.PrivateKeys), "expected 1 private key")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_Default_TwoPks(t *testing.T) {
	client, err := seth.DefaultClient("ws://localhost:8546", []string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80", "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"})
	require.NoError(t, err, "failed to create client with default config")
	require.Equal(t, 2, len(client.PrivateKeys), "expected 2 private keys")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_MinimalBuilder(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.WithRpcUrl("ws://localhost:8546").
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		Build()
	require.NoError(t, err, "failed to build client")

	require.Equal(t, 1, len(client.PrivateKeys), "expected 1 private key")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_MaximalBuilder(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		WithRpcDialTimeout(10*time.Second).
		WithTransactionTimeout(1*time.Minute).
		// addresses
		WithEphemeralAddresses(10, 10).
		// tracing
		WithTracing(seth.TracingLevel_All, []string{seth.TraceOutput_Console}).
		// protections
		WithProtections(true, true, seth.MustMakeDuration(2*time.Minute)).
		// artifacts folder
		WithArtifactsFolder("some_folder").
		// geth wrappers folders
		WithGethWrappersFolders([]string{"./contracts/bind"}).
		// nonce manager
		WithNonceManager(10, 3, 60, 5).
		Build()

	require.NoError(t, err, "failed to create client")
	require.Equal(t, 11, len(client.PrivateKeys), "expected 11 private keys")

	t.Cleanup(func() {
		err = seth.ReturnFunds(client, client.Addresses[0].Hex())
		require.NoError(t, err, "failed to return funds")
	})

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_ModifyExistingConfigWithBuilder(t *testing.T) {
	configPath := os.Getenv(seth.CONFIG_FILE_ENV_VAR)
	require.NotEmpty(t, configPath, "expected config file path to be set")

	d, err := os.ReadFile(configPath)
	require.NoError(t, err, "failed to read config file")

	var sethConfig seth.Config
	err = toml.Unmarshal(d, &sethConfig)
	require.NoError(t, err, "failed to unmarshal config file")

	client, err := seth.NewClientBuilderWithConfig(&sethConfig).
		UseNetworkWithName(seth.GETH).
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80", "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		Build()

	require.NoError(t, err, "failed to create client")
	require.Equal(t, 2, len(client.PrivateKeys), "expected 11 private keys")
	require.NotNil(t, client.Cfg.Network, "expected network to be set")
	require.Equal(t, uint64(1337), client.Cfg.Network.ChainID, "expected chain ID to be set")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_ModifyExistingConfigWithBuilder_UnknownChainId(t *testing.T) {
	configPath := os.Getenv(seth.CONFIG_FILE_ENV_VAR)
	require.NotEmpty(t, configPath, "expected config file path to be set")

	d, err := os.ReadFile(configPath)
	require.NoError(t, err, "failed to read config file")

	var sethConfig seth.Config
	err = toml.Unmarshal(d, &sethConfig)
	require.NoError(t, err, "failed to unmarshal config file")

	// remove default network
	networks := []*seth.Network{}
	for _, network := range sethConfig.Networks {
		if network.Name != seth.DefaultNetworkName {
			networks = append(networks, network)
		}
	}

	sethConfig.Networks = networks

	_, err = seth.NewClientBuilderWithConfig(&sethConfig).
		UseNetworkWithChainId(225).
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		Build()

	expectedError := `errors occurred during building the config:
network with chainId '225' not found
at least one method that required network to be set was called, but network is nil`

	require.Error(t, err, "succeeded to create client")
	require.Equal(t, expectedError, err.Error(), "expected error message")
}

func TestConfig_ModifyExistingConfigWithBuilder_UnknownChainId_UseDefault(t *testing.T) {
	configPath := os.Getenv(seth.CONFIG_FILE_ENV_VAR)
	require.NotEmpty(t, configPath, "expected config file path to be set")

	d, err := os.ReadFile(configPath)
	require.NoError(t, err, "failed to read config file")

	var sethConfig seth.Config
	err = toml.Unmarshal(d, &sethConfig)
	require.NoError(t, err, "failed to unmarshal config file")

	_, err = seth.NewClientBuilderWithConfig(&sethConfig).
		UseNetworkWithChainId(225).
		WithRpcUrl("ws://localhost:8546").
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		Build()

	require.NoError(t, err, "failed to create client")
}

func TestConfig_LegacyGas_No_Estimations(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		// Gas price and estimations
		WithLegacyGasPrice(710_000_000).
		WithGasPriceEstimations(false, 0, "").
		Build()
	require.NoError(t, err, "failed to build client")
	require.Equal(t, 1, len(client.PrivateKeys), "expected 1 private key")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_Eip1559Gas_With_Estimations(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		// Gas price and estimations
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(true, 10, seth.Priority_Fast).
		Build()

	require.NoError(t, err, "failed to build client")
	require.Equal(t, 1, len(client.PrivateKeys), "expected 1 private key")

	linkAbi, err := link_token.LinkTokenMetaData.GetAbi()
	require.NoError(t, err, "failed to get LINK ABI")

	_, err = client.DeployContract(client.NewTXOpts(), "LinkToken", *linkAbi, common.FromHex(link_token.LinkTokenMetaData.Bin))
	require.NoError(t, err, "failed to deploy LINK contract")
}

func TestConfig_NoPrivateKeys_RpcHealthEnabled(t *testing.T) {
	builder := seth.NewClientBuilder()

	_, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		// Gas price and estimations
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(false, 10, seth.Priority_Fast).
		Build()

	require.Error(t, err, "succeeded in building the client")
	require.Contains(t, err.Error(), seth.NoPkForRpcHealthCheckErr, "expected error message")
}

func TestConfig_NoPrivateKeys_PendingNonce(t *testing.T) {
	builder := seth.NewClientBuilder()

	_, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		// Gas price and estimations
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(false, 10, seth.Priority_Fast).
		WithProtections(true, false, seth.MustMakeDuration(1*time.Minute)).
		Build()

	require.Error(t, err, "succeeded in building the client")
	require.Contains(t, err.Error(), seth.NoPkForNonceProtection, "expected error message")
}

func TestConfig_NoPrivateKeys_EphemeralKeys(t *testing.T) {
	builder := seth.NewClientBuilder()

	_, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithEphemeralAddresses(10, 1000).
		// Gas price and estimations
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(false, 10, seth.Priority_Fast).
		WithProtections(false, false, seth.MustMakeDuration(1*time.Minute)).
		Build()

	require.Error(t, err, "succeeded in building the client")
	require.Contains(t, err.Error(), seth.NoPkForEphemeralKeys, "expected error message")
}

func TestConfig_NoPrivateKeys_GasEstimations(t *testing.T) {
	builder := seth.NewClientBuilder()

	_, err := builder.
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithGasPriceEstimations(true, 10, seth.Priority_Fast).
		WithProtections(false, false, seth.MustMakeDuration(1*time.Minute)).
		Build()

	require.Error(t, err, "succeeded in building the client")
	require.Contains(t, err.Error(), seth.NoPkForGasPriceEstimation, "expected error message")
}

func TestConfig_NoPrivateKeys_TxOpts(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		// network
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		// Gas price and estimations
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(false, 10, seth.Priority_Fast).
		WithProtections(false, false, seth.MustMakeDuration(1*time.Minute)).
		Build()

	require.NoError(t, err, "failed to the client")
	require.Equal(t, 0, len(client.PrivateKeys), "expected 0 private keys")

	_ = client.NewTXOpts()
	require.Equal(t, 1, len(client.Errors), "expected 1 error")
	require.Equal(t, "no private keys were loaded, but keyNum 0 was requested", client.Errors[0].Error(), "expected error message")
}

func TestConfig_NoPrivateKeys_Tracing(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithEIP1559DynamicFees(true).
		WithDynamicGasPrices(120_000_000_000, 44_000_000_000).
		WithGasPriceEstimations(false, 10, seth.Priority_Fast).
		WithProtections(false, false, seth.MustMakeDuration(1*time.Minute)).
		WithGethWrappersFolders([]string{"./contracts/bind"}).
		Build()

	require.NoError(t, err, "failed to the client")
	require.Equal(t, 0, len(client.PrivateKeys), "expected 0 private keys")

	ethClient, err := ethclient.Dial("ws://localhost:8546")
	require.NoError(t, err, "failed to dial eth client")

	pk, err := crypto.HexToECDSA("ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80")
	require.NoError(t, err, "failed to parse private key")

	opts, err := bind.NewKeyedTransactorWithChainID(pk, big.NewInt(1337))
	require.NoError(t, err, "failed to create transactor")

	addr, tx, instance, err := link_token.DeployLinkToken(opts, ethClient)
	require.NoError(t, err, "failed to deploy LINK contract")

	// it's a deployment transaction, we don't know yet how to decode it
	_, decodeErr := client.DecodeTx(tx)
	require.NoError(t, decodeErr, "failed to decode transaction")

	publicKeyECDSA, ok := pk.Public().(*ecdsa.PublicKey)
	require.True(t, ok, "failed to cast public key to ECDSA")
	pubKeyAddress := crypto.PubkeyToAddress(*publicKeyECDSA)

	tx, err = instance.GrantMintRole(opts, pubKeyAddress)
	decoded, decodeErr := client.Decode(tx, err)
	require.NoError(t, decodeErr, "failed to decode transaction")
	require.NotNil(t, decoded, "expected decoded call")
	require.Equal(t, "c2e3273d", decoded.Signature, "signature mismatch")
	require.Equal(t, "grantMintRole(address)", decoded.Method, "method mismatch")
	require.Equal(t, common.HexToAddress("0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"), decoded.Input["minter"], "minter mismatch")
	require.Equal(t, 1, len(decoded.Events), "expected 1 event")
	require.Equal(t, "MintAccessGranted(address)", decoded.Events[0].Signature, "event signature mismatch")
	require.Equal(t, addr, decoded.Events[0].Address, "event address mismatch")
	require.Equal(t, common.HexToAddress("0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"), decoded.Events[0].EventData["minter"], "event minter mismatch")
}

func TestConfig_ReadOnlyMode(t *testing.T) {
	builder := seth.NewClientBuilder()

	client, err := builder.
		WithNetworkName("my network").
		WithRpcUrl("ws://localhost:8546").
		WithEphemeralAddresses(10, 1000).
		WithPrivateKeys([]string{"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"}).
		WithGasPriceEstimations(true, 10, seth.Priority_Fast).
		WithReadOnlyMode().
		Build()

	require.NoError(t, err, "failed to build client")
	require.Equal(t, 0, len(client.PrivateKeys), "expected 0 private keys")
	require.Equal(t, 0, len(client.Addresses), "expected 0 addresses")
	require.False(t, client.Cfg.CheckRpcHealthOnStart, "expected rpc health check to be disabled")
	require.False(t, client.Cfg.PendingNonceProtectionEnabled, "expected pending nonce protection to be disabled")
	require.False(t, client.Cfg.Network.GasPriceEstimationEnabled, "expected gas price estimations to be disabled")
}

func TestConfigAppendPkToEmptyNetwork(t *testing.T) {
	networkName := "network"
	cfg := &seth.Config{
		Network: &seth.Network{
			Name: networkName,
		},
	}

	added := cfg.AppendPksToNetwork([]string{"pk"}, networkName)
	require.True(t, added, "should have added pk to network")
	require.Equal(t, []string{"pk"}, cfg.Network.PrivateKeys, "network should have 1 pk")
}

func TestConfigAppendPkToEmptySharedNetwork(t *testing.T) {
	networkName := "network"
	network := &seth.Network{
		Name: networkName,
	}
	cfg := &seth.Config{
		Network:  network,
		Networks: []*seth.Network{network},
	}

	added := cfg.AppendPksToNetwork([]string{"pk"}, networkName)
	require.True(t, added, "should have added pk to network")
	require.Equal(t, []string{"pk"}, cfg.Network.PrivateKeys, "network should have 1 pk")
	require.Equal(t, []string{"pk"}, cfg.Networks[0].PrivateKeys, "network should have 1 pk")
}

func TestConfigAppendPkToNetworkWithPk(t *testing.T) {
	networkName := "network"
	cfg := &seth.Config{
		Network: &seth.Network{
			Name:        networkName,
			PrivateKeys: []string{"pk1"},
		},
	}

	added := cfg.AppendPksToNetwork([]string{"pk2"}, networkName)
	require.True(t, added, "should have added pk to network")
	require.Equal(t, []string{"pk1", "pk2"}, cfg.Network.PrivateKeys, "network should have 2 pks")
}

func TestConfigAppendPkToMissingNetwork(t *testing.T) {
	networkName := "network"
	cfg := &seth.Config{
		Network: &seth.Network{
			Name: "some_other",
		},
	}

	added := cfg.AppendPksToNetwork([]string{"pk"}, networkName)
	require.False(t, added, "should have not added pk to network")
	require.Equal(t, 0, len(cfg.Network.PrivateKeys), "network should have 0 pks")
}

func TestConfigAppendPkToInactiveNetwork(t *testing.T) {
	networkName := "network"
	cfg := &seth.Config{
		Network: &seth.Network{
			Name: "some_other",
		},
		Networks: []*seth.Network{
			{
				Name: "some_other",
			},
			{
				Name: networkName,
			},
		},
	}

	added := cfg.AppendPksToNetwork([]string{"pk"}, networkName)
	require.True(t, added, "should have added pk to network")
	require.Equal(t, 0, len(cfg.Network.PrivateKeys), "network should have 0 pks")
	require.Equal(t, 0, len(cfg.Networks[0].PrivateKeys), "network should have 0 pks")
	require.Equal(t, []string{"pk"}, cfg.Networks[1].PrivateKeys, "network should have 1 pk")
}

func TestConfig_ReadOnly_WithPk(t *testing.T) {
	cfg := seth.Config{
		ReadOnly: true,
		Network: &seth.Network{
			Name: "some_other",
			URLs: []string{"ws://localhost:8546"},
		},
	}

	addrs := []common.Address{common.HexToAddress("0xb794f5ea0ba39494ce839613fffba74279579268")}

	_, err := seth.NewClientRaw(&cfg, addrs, nil)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyWithPrivateKeys, err.Error(), "expected different error message")

	privateKey, err := crypto.HexToECDSA("ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80")
	require.NoError(t, err, "failed to parse private key")

	pks := []*ecdsa.PrivateKey{privateKey}
	_, err = seth.NewClientRaw(&cfg, nil, pks)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyWithPrivateKeys, err.Error(), "expected different error message")

	_, err = seth.NewClientRaw(&cfg, addrs, pks)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyWithPrivateKeys, err.Error(), "expected different error message")
}

func TestConfig_ReadOnly_GasBumping(t *testing.T) {
	cfg := seth.Config{
		ReadOnly: true,
		Network: &seth.Network{
			Name:        "some_other",
			URLs:        []string{"ws://localhost:8546"},
			DialTimeout: &seth.Duration{D: 10 * time.Second},
		},
		GasBump: &seth.GasBumpConfig{
			Retries: uint(1),
		},
	}

	_, err := seth.NewClientRaw(&cfg, nil, nil)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyGasBumping, err.Error(), "expected different error message")
}

func TestConfig_ReadOnly_RpcHealth(t *testing.T) {
	cfg := seth.Config{
		ReadOnly:              true,
		CheckRpcHealthOnStart: true,
		Network: &seth.Network{
			Name:        "some_other",
			URLs:        []string{"ws://localhost:8546"},
			DialTimeout: &seth.Duration{D: 10 * time.Second},
		},
	}

	_, err := seth.NewClientRaw(&cfg, nil, nil)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyRpcHealth, err.Error(), "expected different error message")
}

func TestConfig_ReadOnly_PendingNonce(t *testing.T) {
	cfg := seth.Config{
		ReadOnly:                      true,
		PendingNonceProtectionEnabled: true,
		Network: &seth.Network{
			Name:        "some_other",
			URLs:        []string{"ws://localhost:8546"},
			DialTimeout: &seth.Duration{D: 10 * time.Second},
		},
	}

	_, err := seth.NewClientRaw(&cfg, nil, nil)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrReadOnlyPendingNonce, err.Error(), "expected different error message")
}

func TestConfig_ReadOnly_EphemeralKeys(t *testing.T) {
	ten := int64(10)
	cfg := seth.Config{
		ReadOnly:       true,
		EphemeralAddrs: &ten,
		Network: &seth.Network{
			Name:        "some_other",
			URLs:        []string{"ws://localhost:8546"},
			DialTimeout: &seth.Duration{D: 10 * time.Second},
		},
	}

	_, err := seth.NewClientRaw(&cfg, nil, nil)
	require.Error(t, err, "succeeded in creating client")
	require.Equal(t, seth.ErrNoPksEphemeralMode, err.Error(), "expected different error message")
}