example_test.go

package seth_test

import (
	"context"
	"fmt"
	"math/big"
	"os"
	"strings"
	"testing"

	"github.com/stretchr/testify/require"

	"github.com/goplugin/plugin-testing-framework/seth"
	"github.com/goplugin/plugin-testing-framework/seth/test_utils"
	network_debug_contract "github.com/goplugin/seth/contracts/bind/debug"
)

func commonEnvVars(t *testing.T) {
	t.Setenv(seth.NETWORK_ENV_VAR, seth.GETH)
	t.Setenv(seth.ROOT_PRIVATE_KEY_ENV_VAR, "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80")
	t.Setenv(seth.CONFIG_FILE_ENV_VAR, "../seth.toml")
}

func deployDebugContracts(t *testing.T) *network_debug_contract.NetworkDebugContract {
	c, err := seth.NewClient()
	require.NoError(t, err, "failed to initialise seth")
	nonce := c.NonceManager.NextNonce(c.Addresses[0])
	require.NoError(t, err, "failed to initialise seth")
	subData, err := c.DeployContractFromContractStore(c.NewTXOpts(), "NetworkDebugSubContract.abi")
	require.NoError(t, err, "failed to deploy sub-debug contract")
	data, err := c.DeployContractFromContractStore(c.NewTXOpts(), "NetworkDebugContract.abi", subData.Address)
	require.NoError(t, err, "failed to deploy debug contract")
	contract, err := network_debug_contract.NewNetworkDebugContract(data.Address, c.Client)
	require.NoError(t, err, "failed to create debug contract instance")
	// these ^ are internal methods, so we need to update nonces manually
	err = c.NonceManager.UpdateNonces()
	require.NoError(t, err)
	nonce2 := c.NonceManager.NextNonce(c.Addresses[0])
	require.Equal(t, big.NewInt(0).Add(nonce, big.NewInt(2)).String(), nonce2.String(), "nonces should be updated after contract deployment")

	return contract
}

func setup(t *testing.T) *network_debug_contract.NetworkDebugContract {
	commonEnvVars(t)
	return deployDebugContracts(t)
}

func TestSmokeExampleWait(t *testing.T) {
	contract := setup(t)
	c, err := seth.NewClient()
	require.NoError(t, err)

	// receive decoded transaction or decoded err in case of revert
	dec, err := c.Decode(
		contract.Set(c.NewTXOpts(), big.NewInt(1)),
	)
	require.NoError(t, err)
	// original data
	_ = dec.Transaction
	_ = dec.Receipt
	// decoded data
	_ = dec.Input
	_ = dec.Output
	_ = dec.Events
	res, err := contract.Get(c.NewCallOpts())
	require.NoError(t, err)
	fmt.Printf("Result: %d", res.Int64())
}

func TestSmokeExampleMultiKey(t *testing.T) {
	// example of using client with multiple keys that are provided in the config
	// in this example we just generate and fund them inside NewClientWithAddresses() function
	// to simulate a case, when they were provided as part of the network config, instead of being
	// generated as ephemeral keys by Seth
	contract := setup(t)
	c := test_utils.NewClientWithAddresses(t, 10, big.NewInt(2))
	t.Cleanup(func() {
		err := seth.ReturnFunds(c, c.Addresses[0].Hex())
		require.NoError(t, err)
	})

	// you can use multiple keys to really execute transactions in parallel
	tx1, err1 := c.Decode(contract.Set(
		c.NewTXKeyOpts(1),
		big.NewInt(1),
	))
	require.NoError(t, err1)
	tx2, err2 := c.Decode(contract.Set(
		c.NewTXKeyOpts(2),
		big.NewInt(1),
	))
	require.NoError(t, err2)
	// original data
	_ = tx1.Transaction
	_ = tx1.Receipt
	// decoded data
	_ = tx1.Input
	_ = tx1.Output
	_ = tx1.Events
	// original data
	_ = tx2.Transaction
	_ = tx2.Receipt
	// decoded data
	_ = tx2.Input
	_ = tx2.Output
	_ = tx2.Events
	res, err := contract.Get(c.NewCallOpts())
	require.NoError(t, err)
	fmt.Printf("Result: %d", res.Int64())
}

func TestSmokeExampleMultiKeyFromEnv(t *testing.T) {
	// example of creating client with multiple keys that are read from environment variable called `SETH_KEYS`
	// we assume here that you will be using `Geth` network
	contract := setup(t)
	cfg, err := seth.ReadConfig()
	require.NoError(t, err)

	_, pk1, err := seth.NewAddress()
	require.NoError(t, err, "failed to generate new address")

	_, pk2, err := seth.NewAddress()
	require.NoError(t, err, "failed to generate new address")

	err = os.Setenv("SETH_KEYS", pk1+","+pk2)
	require.NoError(t, err, "failed to set env var")

	keys := os.Getenv("SETH_KEYS")
	require.NotEmpty(t, keys, "SETH_KEYS env var is empty")
	var pks []string
	pks = append(pks, strings.Split(keys, ",")...)
	require.GreaterOrEqual(t, len(pks), 1, "SETH_KEYS env var should contain at least 1 key")

	updated := cfg.AppendPksToNetwork(pks, "Geth")
	require.True(t, updated, "network should have been updated")

	c, err := seth.NewClientWithConfig(cfg)
	require.NoError(t, err)

	// required as our keys have no funds
	err = c.TransferETHFromKey(context.Background(), 0, c.Addresses[1].Hex(), big.NewInt(10_000_000_000_000_000), big.NewInt(100_000_000))
	require.NoError(t, err, "failed to transfer funds to pk1")

	err = c.TransferETHFromKey(context.Background(), 0, c.Addresses[2].Hex(), big.NewInt(10_000_000_000_000_000), big.NewInt(100_000_000))
	require.NoError(t, err, "failed to transfer funds to pk2")

	t.Cleanup(func() {
		err = c.NonceManager.UpdateNonces()
		require.NoError(t, err)
		err = seth.ReturnFunds(c, c.Addresses[0].Hex())
		require.NoError(t, err)
	})

	// you can use multiple keys to really execute transactions in parallel
	tx1, err1 := c.Decode(contract.Set(
		c.NewTXKeyOpts(1),
		big.NewInt(1),
	))
	require.NoError(t, err1)
	tx2, err2 := c.Decode(contract.Set(
		c.NewTXKeyOpts(2),
		big.NewInt(1),
	))
	require.NoError(t, err2)
	// original data
	_ = tx1.Transaction
	_ = tx1.Receipt
	// decoded data
	_ = tx1.Input
	_ = tx1.Output
	_ = tx1.Events
	// original data
	_ = tx2.Transaction
	_ = tx2.Receipt
	// decoded data
	_ = tx2.Input
	_ = tx2.Output
	_ = tx2.Events
	res, err := contract.Get(c.NewCallOpts())
	require.NoError(t, err)
	fmt.Printf("Result: %d", res.Int64())
}

func TestSmokeExampleMultiKeyEphemeral(t *testing.T) {
	// example of using ephemeral keys
	// suitable for testing ephemeral networks where network is created every time
	contract := setup(t)
	c, err := seth.NewClient()
	require.NoError(t, err)

	// you can use multiple keys to really execute transactions in parallel
	tx1, err1 := c.Decode(contract.Set(
		c.NewTXKeyOpts(1),
		big.NewInt(1),
	))
	require.NoError(t, err1)
	tx2, err2 := c.Decode(contract.Set(
		c.NewTXKeyOpts(2),
		big.NewInt(1),
	))
	require.NoError(t, err2)
	// original data
	_ = tx1.Transaction
	_ = tx1.Receipt
	// decoded data
	_ = tx1.Input
	_ = tx1.Output
	_ = tx1.Events
	// original data
	_ = tx2.Transaction
	_ = tx2.Receipt
	// decoded data
	_ = tx2.Input
	_ = tx2.Output
	_ = tx2.Events
	res, err := contract.Get(c.NewCallOpts())
	require.NoError(t, err)
	fmt.Printf("Result: %d", res.Int64())
}