Add prestateTracer system_tests

system_tests/debugapi_test.go

@@ -3,16 +3,24 @@ package arbtest
 import (
 	"context"
 	"encoding/json"
+	"fmt"
+	"math/big"
 	"testing"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/core/state"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/eth"
+	"github.com/ethereum/go-ethereum/eth/gasestimator"
 	"github.com/ethereum/go-ethereum/eth/tracers"
+	"github.com/ethereum/go-ethereum/params"
 	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/offchainlabs/nitro/arbos/l2pricing"
+	"github.com/offchainlabs/nitro/arbos/retryables"
+	"github.com/offchainlabs/nitro/solgen/go/node_interfacegen"
 	"github.com/offchainlabs/nitro/solgen/go/precompilesgen"
+	"github.com/offchainlabs/nitro/util/arbmath"
 )
 
 func TestDebugAPI(t *testing.T) {
@@ -56,3 +64,230 @@ func TestDebugAPI(t *testing.T) {
 	err = l2rpc.CallContext(ctx, &result, "debug_traceTransaction", tx.Hash(), &tracers.TraceConfig{Tracer: &flatCallTracer})
 	Require(t, err)
 }
+
+type account struct {
+	Balance *hexutil.Big                `json:"balance,omitempty"`
+	Code    []byte                      `json:"code,omitempty"`
+	Nonce   uint64                      `json:"nonce,omitempty"`
+	Storage map[common.Hash]common.Hash `json:"storage,omitempty"`
+}
+type prestateTrace struct {
+	Post map[common.Address]*account `json:"post"`
+	Pre  map[common.Address]*account `json:"pre"`
+}
+
+func TestPrestateTracingSimple(t *testing.T) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+	builder := NewNodeBuilder(ctx).DefaultConfig(t, true)
+	cleanup := builder.Build(t)
+	defer cleanup()
+
+	builder.L2Info.GenerateAccount("User2")
+	sender := builder.L2Info.GetAddress("Owner")
+	receiver := builder.L2Info.GetAddress("User2")
+	ownerOldBalance, err := builder.L2.Client.BalanceAt(ctx, sender, nil)
+	Require(t, err)
+	user2OldBalance, err := builder.L2.Client.BalanceAt(ctx, receiver, nil)
+	Require(t, err)
+
+	value := big.NewInt(1e6)
+	tx := builder.L2Info.PrepareTx("Owner", "User2", builder.L2Info.TransferGas, value, nil)
+	Require(t, builder.L2.Client.SendTransaction(ctx, tx))
+	_, err = builder.L2.EnsureTxSucceeded(tx)
+	Require(t, err)
+
+	l2rpc := builder.L2.Stack.Attach()
+
+	var result prestateTrace
+	traceConfig := map[string]interface{}{
+		"tracer": "prestateTracer",
+		"tracerConfig": map[string]interface{}{
+			"diffMode": true,
+		},
+	}
+	err = l2rpc.CallContext(ctx, &result, "debug_traceTransaction", tx.Hash(), traceConfig)
+	Require(t, err)
+
+	if !arbmath.BigEquals(result.Pre[sender].Balance.ToInt(), ownerOldBalance) {
+		Fatal(t, "Unexpected initial balance of sender")
+	}
+	if !arbmath.BigEquals(result.Pre[receiver].Balance.ToInt(), user2OldBalance) {
+		Fatal(t, "Unexpected initial balance of receiver")
+	}
+	if !arbmath.BigEquals(result.Post[sender].Balance.ToInt(), arbmath.BigSub(ownerOldBalance, value)) {
+		Fatal(t, "Unexpected final balance of sender")
+	}
+	if !arbmath.BigEquals(result.Post[receiver].Balance.ToInt(), value) {
+		Fatal(t, "Unexpected final balance of receiver")
+	}
+	if result.Post[sender].Nonce != result.Pre[sender].Nonce+1 {
+		Fatal(t, "sender nonce increment wasn't registered")
+	}
+	if result.Post[receiver].Nonce != result.Pre[receiver].Nonce {
+		Fatal(t, "receiver nonce shouldn't change")
+	}
+}
+
+func TestPrestateTracingComplex(t *testing.T) {
+	builder, delayedInbox, lookupL2Tx, ctx, teardown := retryableSetup(t)
+	defer teardown()
+
+	// Test prestate tracing of a ArbitrumDepositTx type tx
+	faucetAddr := builder.L1Info.GetAddress("Faucet")
+	oldBalance, err := builder.L2.Client.BalanceAt(ctx, faucetAddr, nil)
+	Require(t, err)
+
+	txOpts := builder.L1Info.GetDefaultTransactOpts("Faucet", ctx)
+	txOpts.Value = big.NewInt(13)
+
+	l1tx, err := delayedInbox.DepositEth439370b1(&txOpts)
+	Require(t, err)
+
+	l1Receipt, err := builder.L1.EnsureTxSucceeded(l1tx)
+	Require(t, err)
+	if l1Receipt.Status != types.ReceiptStatusSuccessful {
+		t.Errorf("Got transaction status: %v, want: %v", l1Receipt.Status, types.ReceiptStatusSuccessful)
+	}
+	waitForL1DelayBlocks(t, builder)
+
+	l2Tx := lookupL2Tx(l1Receipt)
+	l2Receipt, err := builder.L2.EnsureTxSucceeded(l2Tx)
+	Require(t, err)
+	newBalance, err := builder.L2.Client.BalanceAt(ctx, faucetAddr, l2Receipt.BlockNumber)
+	Require(t, err)
+	if got := new(big.Int); got.Sub(newBalance, oldBalance).Cmp(txOpts.Value) != 0 {
+		t.Errorf("Got transferred: %v, want: %v", got, txOpts.Value)
+	}
+
+	l2rpc := builder.L2.Stack.Attach()
+	var result prestateTrace
+	traceConfig := map[string]interface{}{
+		"tracer": "prestateTracer",
+		"tracerConfig": map[string]interface{}{
+			"diffMode": true,
+		},
+	}
+	err = l2rpc.CallContext(ctx, &result, "debug_traceTransaction", l2Tx.Hash(), traceConfig)
+	Require(t, err)
+
+	if _, ok := result.Pre[faucetAddr]; !ok {
+		Fatal(t, "Faucet account not found in the result of prestate tracer")
+	}
+	// Nonce shouldn't exist (in this case defaults to 0) in the Post map of the trace in DiffMode
+	if l2Tx.SkipAccountChecks() && result.Post[faucetAddr].Nonce != 0 {
+		Fatal(t, "Faucet account's nonce should remain unchanged ")
+	}
+	if !arbmath.BigEquals(result.Pre[faucetAddr].Balance.ToInt(), oldBalance) {
+		Fatal(t, "Unexpected initial balance of Faucet")
+	}
+	if !arbmath.BigEquals(result.Post[faucetAddr].Balance.ToInt(), arbmath.BigAdd(oldBalance, txOpts.Value)) {
+		Fatal(t, "Unexpected final balance of Faucet")
+	}
+
+	// Test prestate tracing of a ArbitrumSubmitRetryableTx type tx
+	user2Address := builder.L2Info.GetAddress("User2")
+	beneficiaryAddress := builder.L2Info.GetAddress("Beneficiary")
+
+	deposit := arbmath.BigMul(big.NewInt(1e12), big.NewInt(1e12))
+	callValue := big.NewInt(1e6)
+
+	nodeInterface, err := node_interfacegen.NewNodeInterface(types.NodeInterfaceAddress, builder.L2.Client)
+	Require(t, err, "failed to deploy NodeInterface")
+
+	// estimate the gas needed to auto redeem the retryable
+	usertxoptsL2 := builder.L2Info.GetDefaultTransactOpts("Faucet", ctx)
+	usertxoptsL2.NoSend = true
+	usertxoptsL2.GasMargin = 0
+	tx, err := nodeInterface.EstimateRetryableTicket(
+		&usertxoptsL2,
+		usertxoptsL2.From,
+		deposit,
+		user2Address,
+		callValue,
+		beneficiaryAddress,
+		beneficiaryAddress,
+		[]byte{0x32, 0x42, 0x32, 0x88}, // increase the cost to beyond that of params.TxGas
+	)
+	Require(t, err, "failed to estimate retryable submission")
+	estimate := tx.Gas()
+	expectedEstimate := params.TxGas + params.TxDataNonZeroGasEIP2028*4
+	if float64(estimate) > float64(expectedEstimate)*(1+gasestimator.EstimateGasErrorRatio) {
+		t.Errorf("estimated retryable ticket at %v gas but expected %v, with error margin of %v",
+			estimate,
+			expectedEstimate,
+			gasestimator.EstimateGasErrorRatio,
+		)
+	}
+
+	// submit & auto redeem the retryable using the gas estimate
+	usertxoptsL1 := builder.L1Info.GetDefaultTransactOpts("Faucet", ctx)
+	usertxoptsL1.Value = deposit
+	l1tx, err = delayedInbox.CreateRetryableTicket(
+		&usertxoptsL1,
+		user2Address,
+		callValue,
+		big.NewInt(1e16),
+		beneficiaryAddress,
+		beneficiaryAddress,
+		arbmath.UintToBig(estimate),
+		big.NewInt(l2pricing.InitialBaseFeeWei*2),
+		[]byte{0x32, 0x42, 0x32, 0x88},
+	)
+	Require(t, err)
+
+	l1Receipt, err = builder.L1.EnsureTxSucceeded(l1tx)
+	Require(t, err)
+	if l1Receipt.Status != types.ReceiptStatusSuccessful {
+		Fatal(t, "l1Receipt indicated failure")
+	}
+
+	waitForL1DelayBlocks(t, builder)
+
+	l2Tx = lookupL2Tx(l1Receipt)
+	receipt, err := builder.L2.EnsureTxSucceeded(l2Tx)
+	Require(t, err)
+	if receipt.Status != types.ReceiptStatusSuccessful {
+		Fatal(t)
+	}
+
+	l2balance, err := builder.L2.Client.BalanceAt(ctx, builder.L2Info.GetAddress("User2"), nil)
+	Require(t, err)
+	if !arbmath.BigEquals(l2balance, callValue) {
+		Fatal(t, "Unexpected balance:", l2balance)
+	}
+
+	ticketId := receipt.Logs[0].Topics[1]
+	firstRetryTxId := receipt.Logs[1].Topics[2]
+	fmt.Println("submitretryable txid ", ticketId)
+	fmt.Println("auto redeem txid ", firstRetryTxId)
+
+	// Trace ArbitrumSubmitRetryableTx
+	result = prestateTrace{}
+	err = l2rpc.CallContext(ctx, &result, "debug_traceTransaction", l2Tx.Hash(), traceConfig)
+	Require(t, err)
+
+	escrowAddr := retryables.RetryableEscrowAddress(ticketId)
+	if _, ok := result.Pre[escrowAddr]; !ok {
+		Fatal(t, "Escrow account not found in the result of prestate tracer for a ArbitrumSubmitRetryableTx transaction")
+	}
+
+	if !arbmath.BigEquals(result.Pre[escrowAddr].Balance.ToInt(), common.Big0) {
+		Fatal(t, "Unexpected initial balance of Escrow")
+	}
+	if !arbmath.BigEquals(result.Post[escrowAddr].Balance.ToInt(), callValue) {
+		Fatal(t, "Unexpected final balance of Escrow")
+	}
+
+	// Trace ArbitrumRetryTx
+	result = prestateTrace{}
+	err = l2rpc.CallContext(ctx, &result, "debug_traceTransaction", firstRetryTxId, traceConfig)
+	Require(t, err)
+
+	if !arbmath.BigEquals(result.Pre[user2Address].Balance.ToInt(), common.Big0) {
+		Fatal(t, "Unexpected initial balance of User2")
+	}
+	if !arbmath.BigEquals(result.Post[user2Address].Balance.ToInt(), callValue) {
+		Fatal(t, "Unexpected final balance of User2")
+	}
+}