Merge remote-tracking branch 'origin/main' into mpeter/poc-index-finalized-block-results

Author: m-Peter

.github/workflows/build.yml

@@ -1,10 +1,12 @@
 name: "Build & Push EVM Gateway Image to Public Repo"
 
 on:
-  push:
-    tags:
-      - '*'
   workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Git tag to build. Also used as the docker image tag.'
+        required: true
+        type: string
 
 env:
   DOCKER_IMAGE_URL: ${{ vars.REPO_DOCKER_IMAGE_URL }}
@@ -20,10 +22,7 @@ jobs:
         with:
           fetch-depth: 0
           fetch-tags: true
-
-      - name: Set Gateway Version
-        id: set_version
-        run: echo "GATEWAY_VERSION=$(git describe --tags --abbrev=0 2>/dev/null || echo 'unknown')" >> $GITHUB_OUTPUT
+          ref: ${{ inputs.tag }}
 
       - name: Google auth
         id: auth
@@ -41,5 +40,5 @@ jobs:
       - name: Docker Auth
         run: |-
           gcloud auth configure-docker ${{ vars.GAR_LOCATION }}-docker.pkg.dev
-          docker build --build-arg VERSION="${{ steps.set_version.outputs.GATEWAY_VERSION }}" --build-arg ARCH=amd64 -t ${{ env.DOCKER_IMAGE_URL }}:${{ steps.set_version.outputs.GATEWAY_VERSION }} --file Dockerfile .
-          docker push ${{ env.DOCKER_IMAGE_URL }}:${{ steps.set_version.outputs.GATEWAY_VERSION }}
+          docker build --build-arg VERSION="${{ inputs.tag }}" --build-arg ARCH=amd64 -t ${{ env.DOCKER_IMAGE_URL }}:${{ inputs.tag }} --file Dockerfile .
+          docker push ${{ env.DOCKER_IMAGE_URL }}:${{ inputs.tag }}

api/api.go

@@ -723,6 +723,11 @@ func (b *BlockChainAPI) EstimateGas(
 		return handleError[hexutil.Uint64](err, b.logger, b.collector)
 	}
 
+	blockOverridesArgs, err := json.Marshal(blockOverrides)
+	if err != nil {
+		return handleError[hexutil.Uint64](err, b.logger, b.collector)
+	}
+
 	txArgs, err := json.Marshal(args)
 	if err != nil {
 		return handleError[hexutil.Uint64](err, b.logger, b.collector)
@@ -733,6 +738,7 @@ func (b *BlockChainAPI) EstimateGas(
 		RawJSON("args", txArgs).
 		Str("blockTag", fmt.Sprintf("%v", blockNumberOrHash)).
 		RawJSON("stateOverrides", stateOverridesArgs).
+		RawJSON("blockOverrides", blockOverridesArgs).
 		Logger()
 
 	if err := b.rateLimiter.Apply(ctx, EthEstimateGas); err != nil {

api/debug.go

@@ -181,10 +181,10 @@ func (d *DebugAPI) TraceCall(
 
 	if config.BlockOverrides != nil {
 		blocksProvider = blocksProvider.WithBlockOverrides(&ethTypes.BlockOverrides{
-			Number:   config.BlockOverrides.Number,
-			Time:     config.BlockOverrides.Time,
-			Coinbase: config.BlockOverrides.FeeRecipient,
-			Random:   config.BlockOverrides.PrevRandao,
+			Number:       config.BlockOverrides.Number,
+			Time:         config.BlockOverrides.Time,
+			FeeRecipient: config.BlockOverrides.FeeRecipient,
+			PrevRandao:   config.BlockOverrides.PrevRandao,
 		})
 	}
 	viewProvider := query.NewViewProvider(

cmd/run/cmd.go

@@ -170,23 +170,18 @@ func parseConfigFromFlags() error {
 	case "flow-testnet":
 		cfg.FlowNetworkID = flowGo.Testnet
 		cfg.EVMNetworkID = types.FlowEVMTestNetChainID
-		cfg.InitCadenceHeight = config.LiveNetworkInitCadenceHeight
+		cfg.InitCadenceHeight = config.TestnetInitCadenceHeight
 	case "flow-mainnet":
 		cfg.FlowNetworkID = flowGo.Mainnet
 		cfg.EVMNetworkID = types.FlowEVMMainNetChainID
-		cfg.InitCadenceHeight = config.LiveNetworkInitCadenceHeight
+		cfg.InitCadenceHeight = config.MainnetInitCadenceHeight
 	default:
 		return fmt.Errorf(
 			"flow network ID: %s not supported, valid values are ('flow-emulator', 'flow-previewnet', 'flow-testnet', 'flow-mainnet')",
 			flowNetwork,
 		)
 	}
 
-	// if a specific value was provided use it
-	if initHeight != 0 {
-		cfg.InitCadenceHeight = initHeight
-	}
-
 	// configure logging
 	level, err := zerolog.ParseLevel(logLevel)
 	if err != nil {
@@ -304,4 +299,9 @@ func init() {
 	Cmd.Flags().BoolVar(&experimentalSoftFinalityEnabled, "experimental-soft-finality-enabled", false, "Sets whether the gateway should use the experimental soft finality feature. WARNING: This may result in incorrect results being returned in certain circumstances. Use only if you know what you are doing.")
 	Cmd.Flags().BoolVar(&experimentalSealingVerificationEnabled, "experimental-sealing-verification-enabled", true, "Sets whether the gateway should use the experimental soft finality sealing verification feature. WARNING: This may result in indexing halts if events do not match. Use only if you know what you are doing.")
 	Cmd.Flags().DurationVar(&cfg.EOAActivityCacheTTL, "eoa-activity-cache-ttl", time.Second*10, "Time interval used to track EOA activity. Tx send more frequently than this interval will be batched. Useful only when batch transaction submission is enabled.")
+
+	err := Cmd.Flags().MarkDeprecated("init-cadence-height", "This flag is no longer necessary and will be removed in future version. The initial Cadence height is known for testnet/mainnet and this was only required for fresh deployments of EVM Gateway. Once the DB has been initialized, the latest index Cadence height will be used upon start-up.")
+	if err != nil {
+		panic(err)
+	}
 }

config/config.go

@@ -14,14 +14,24 @@ import (
 	"github.com/rs/zerolog"
 )
 
-// Default InitCadenceHeight for initializing the database on a local emulator.
-// TODO: temporary fix until https://github.com/onflow/flow-go/issues/5481 is
-// fixed upstream and released.
-const EmulatorInitCadenceHeight = uint64(0)
+const (
+	// Default InitCadenceHeight for initializing the database on a local emulator.
+	// TODO: temporary fix until https://github.com/onflow/flow-go/issues/5481 is
+	// fixed upstream and released.
+	EmulatorInitCadenceHeight = uint64(0)
+
+	// Default InitCadenceHeight for initializing the database on a live network.
+	// We don't use 0 as it has a special meaning to represent latest block in the AN API context.
+	LiveNetworkInitCadenceHeight = uint64(1)
 
-// Default InitCadenceHeight for initializing the database on a live network.
-// We don't use 0 as it has a special meaning to represent latest block in the AN API context.
-const LiveNetworkInitCadenceHeight = uint64(1)
+	// Testnet height at which the `EVM` system contract was first deployed.
+	// This is the first height at which the EVM state starts.
+	TestnetInitCadenceHeight = uint64(211176670)
+
+	// Mainnet height at which the `EVM` system contract was first deployed.
+	// This is the first height at which the EVM state starts.
+	MainnetInitCadenceHeight = uint64(85981134)
+)
 
 type TxStateValidation string
 

eth/types/types.go

@@ -433,29 +433,32 @@ type SignTransactionResult struct {
 // of a message call.
 // Note, state and stateDiff can't be specified at the same time. If state is
 // set, message execution will only use the data in the given state. Otherwise
-// if statDiff is set, all diff will be applied first and then execute the call
+// if stateDiff is set, all diff will be applied first and then execute the call
 // message.
 type OverrideAccount struct {
-	Nonce     *hexutil.Uint64              `json:"nonce"`
-	Code      *hexutil.Bytes               `json:"code"`
-	Balance   **hexutil.Big                `json:"balance"`
-	State     *map[common.Hash]common.Hash `json:"state"`
-	StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
+	Nonce            *hexutil.Uint64             `json:"nonce"`
+	Code             *hexutil.Bytes              `json:"code"`
+	Balance          *hexutil.Big                `json:"balance"`
+	State            map[common.Hash]common.Hash `json:"state"`
+	StateDiff        map[common.Hash]common.Hash `json:"stateDiff"`
+	MovePrecompileTo *common.Address             `json:"movePrecompileToAddress"`
 }
 
 // StateOverride is the collection of overridden accounts.
 type StateOverride map[common.Address]OverrideAccount
 
 // BlockOverrides is a set of header fields to override.
 type BlockOverrides struct {
-	Number      *hexutil.Big
-	Difficulty  *hexutil.Big
-	Time        *hexutil.Uint64
-	GasLimit    *hexutil.Uint64
-	Coinbase    *common.Address
-	Random      *common.Hash
-	BaseFee     *hexutil.Big
-	BlobBaseFee *hexutil.Big
+	Number        *hexutil.Big
+	Difficulty    *hexutil.Big // No-op if we're simulating post-merge calls.
+	Time          *hexutil.Uint64
+	GasLimit      *hexutil.Uint64
+	FeeRecipient  *common.Address
+	PrevRandao    *common.Hash
+	BaseFeePerGas *hexutil.Big
+	BlobBaseFee   *hexutil.Big
+	BeaconRoot    *common.Hash
+	Withdrawals   *types.Withdrawals
 }
 
 type Block struct {

services/requester/overridable_blocks_provider.go

@@ -54,12 +54,12 @@ func (bs *blockSnapshot) BlockContext() (evmTypes.BlockContext, error) {
 		blockContext.BlockTimestamp = uint64(*bs.blockOverrides.Time)
 	}
 
-	if bs.blockOverrides.Random != nil {
-		blockContext.Random = *bs.blockOverrides.Random
+	if bs.blockOverrides.PrevRandao != nil {
+		blockContext.Random = *bs.blockOverrides.PrevRandao
 	}
 
-	if bs.blockOverrides.Coinbase != nil {
-		blockContext.GasFeeCollector = evmTypes.NewAddress(*bs.blockOverrides.Coinbase)
+	if bs.blockOverrides.FeeRecipient != nil {
+		blockContext.GasFeeCollector = evmTypes.NewAddress(*bs.blockOverrides.FeeRecipient)
 	}
 
 	return blockContext, nil

services/requester/requester.go

@@ -538,18 +538,18 @@ func (e *EVM) dryRunTx(
 			}
 			// Override account balance.
 			if account.Balance != nil {
-				opts = append(opts, query.WithStateOverrideBalance(addr, (*big.Int)(*account.Balance)))
+				opts = append(opts, query.WithStateOverrideBalance(addr, (*big.Int)(account.Balance)))
 			}
 			if account.State != nil && account.StateDiff != nil {
 				return nil, fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex())
 			}
 			// Replace entire state if caller requires.
 			if account.State != nil {
-				opts = append(opts, query.WithStateOverrideState(addr, *account.State))
+				opts = append(opts, query.WithStateOverrideState(addr, account.State))
 			}
 			// Apply state diff into specified accounts.
 			if account.StateDiff != nil {
-				opts = append(opts, query.WithStateOverrideStateDiff(addr, *account.StateDiff))
+				opts = append(opts, query.WithStateOverrideStateDiff(addr, account.StateDiff))
 			}
 		}
 	}

tests/e2e_web3js_test.go

@@ -78,6 +78,10 @@ func TestWeb3_E2E(t *testing.T) {
 		runWeb3Test(t, "eth_deploy_contract_and_interact_test")
 	})
 
+	t.Run("apply state overrides", func(t *testing.T) {
+		runWeb3Test(t, "eth_state_overrides_test")
+	})
+
 	t.Run("test retrieval of contract storage slots", func(t *testing.T) {
 		runWeb3Test(t, "eth_get_storage_at_test")
 	})