Merge pull request #876 from onflow/mpeter/estimate-gas-with-block-overrides

Apply block overrides in `eth_estimateGas` JSON-RPC endpoint

Author: m-Peter

api/api.go

@@ -693,6 +693,7 @@ func (b *BlockChainAPI) EstimateGas(
 	args ethTypes.TransactionArgs,
 	blockNumberOrHash *rpc.BlockNumberOrHash,
 	stateOverrides *ethTypes.StateOverride,
+	blockOverrides *ethTypes.BlockOverrides,
 ) (hexutil.Uint64, error) {
 	l := b.logger.With().
 		Str("endpoint", EthEstimateGas).
@@ -723,7 +724,13 @@ func (b *BlockChainAPI) EstimateGas(
 		return handleError[hexutil.Uint64](err, l, b.collector)
 	}
 
-	estimatedGas, err := b.evm.EstimateGas(args, from, height, stateOverrides)
+	estimatedGas, err := b.evm.EstimateGas(
+		args,
+		from,
+		height,
+		stateOverrides,
+		blockOverrides,
+	)
 	if err != nil {
 		return handleError[hexutil.Uint64](err, l, b.collector)
 	}

services/requester/requester.go

@@ -78,6 +78,7 @@ type Requester interface {
 		from common.Address,
 		height uint64,
 		stateOverrides *ethTypes.StateOverride,
+		blockOverrides *ethTypes.BlockOverrides,
 	) (uint64, error)
 
 	// GetNonce gets nonce from the network at the given EVM block height.
@@ -320,14 +321,15 @@ func (e *EVM) EstimateGas(
 	from common.Address,
 	height uint64,
 	stateOverrides *ethTypes.StateOverride,
+	blockOverrides *ethTypes.BlockOverrides,
 ) (uint64, error) {
 	iterations := 0
 
 	dryRun := func(gasLimit uint64) (*evmTypes.Result, error) {
 		gas := hexutil.Uint64(gasLimit)
 		txArgs.Gas = &gas
 		tx := txArgs.ToTransaction(types.LegacyTxType, blockGasLimit)
-		result, err := e.dryRunTx(tx, from, height, stateOverrides, nil)
+		result, err := e.dryRunTx(tx, from, height, stateOverrides, blockOverrides)
 		iterations += 1
 		return result, err
 	}

tests/e2e_web3js_test.go

@@ -46,6 +46,10 @@ func TestWeb3_E2E(t *testing.T) {
 		runWeb3Test(t, "contract_call_overrides_test")
 	})
 
+	t.Run("test gas estimation block overrides", func(t *testing.T) {
+		runWeb3Test(t, "estimate_gas_overrides_test")
+	})
+
 	t.Run("test setup sanity check", func(t *testing.T) {
 		runWeb3Test(t, "setup_test")
 	})

tests/fixtures/blockOverrides.byte

@@ -0,0 +1 @@
+6080604052348015600e575f5ffd5b506101c58061001c5f395ff3fe608060405234801561000f575f5ffd5b5060043610610034575f3560e01c80637b16441c14610038578063f8a8fd6d14610042575b5f5ffd5b61004061004c565b005b61004a61007e565b005b5f5f90505f5f90505b6103e881101561007a57808261006b919061015c565b91508080600101915050610055565b5050565b61238243036100905761008f61004c565b5b63674db1e142036100a4576100a361004c565b5b7f7914bb5b13bac6f621bc37bbf6e406fbf4472aaaaf17ec2f309a92aca4e27fc044036100d4576100d361004c565b5b73658bdf435d810c91414ec09147daa6db6240637973ffffffffffffffffffffffffffffffffffffffff164173ffffffffffffffffffffffffffffffffffffffff16036101245761012361004c565b5b565b5f819050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f61016682610126565b915061017183610126565b92508282019050808211156101895761018861012f565b5b9291505056fea26469706673582212206f7542706dc282fc8d2da0c0cc27398671a845e2c6ae871e23591b016bf3969464736f6c634300081e0033

tests/fixtures/blockOverrides.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity >=0.8.2 <0.9.0;
+
+contract BlockOverrides {
+
+    function test() public view {
+        // Add some hard-coded if conditions, to simulate overriding
+        // certain block header fields. The condition body is a simple
+        // way to check that the block header fields were indeed
+        // overrided, resulting in higher gas usage.
+        if (block.number == 9090) {
+            sumValues();
+        }
+
+        if (block.timestamp == 1733145057) {
+            sumValues();
+        }
+
+        if (block.prevrandao == 0x7914bb5b13bac6f621bc37bbf6e406fbf4472aaaaf17ec2f309a92aca4e27fc0) {
+            sumValues();
+        }
+
+        if (block.coinbase == 0x658Bdf435d810C91414eC09147DAA6DB62406379) {
+            sumValues();
+        }
+    }
+
+    function sumValues() public pure {
+        uint sum = 0;
+        for (uint i = 0; i < 1000; i++) {
+            sum += i;
+        }
+    }
+
+}

tests/fixtures/blockOverridesABI.json

@@ -0,0 +1,16 @@
+[
+    {
+        "inputs": [],
+        "name": "sumValues",
+        "outputs": [],
+        "stateMutability": "pure",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "test",
+        "outputs": [],
+        "stateMutability": "view",
+        "type": "function"
+    }
+]

tests/web3js/estimate_gas_overrides_test.js

@@ -0,0 +1,104 @@
+const { assert } = require('chai')
+const conf = require('./config')
+const helpers = require('./helpers')
+const web3 = conf.web3
+
+let deployed = null
+let contractAddress = null
+
+before(async () => {
+    deployed = await helpers.deployContract('blockOverrides')
+    contractAddress = deployed.receipt.contractAddress
+
+    assert.equal(deployed.receipt.status, conf.successStatus)
+})
+
+it('should apply block overrides on eth_estimateGas', async () => {
+    assert.equal(deployed.receipt.status, conf.successStatus)
+
+    let receipt = await web3.eth.getTransactionReceipt(deployed.receipt.transactionHash)
+    assert.equal(receipt.contractAddress, contractAddress)
+
+    // Check the `block.number` value, without overrides
+    let testFuncSelector = deployed.contract.methods.test().encodeABI()
+    let txArgs = {
+        from: conf.eoa.address,
+        to: contractAddress,
+        gas: '0x493E0',
+        gasPrice: web3.utils.toHex(conf.minGasPrice),
+        value: '0x0',
+        data: testFuncSelector,
+    }
+
+    let response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, null]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
+
+    // Override the `block.number` value to `9090`.
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, { number: '0x2382' }]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
+
+    // Check the `block.timestamp` value, without overrides
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, null]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
+
+    // Override the `block.timestamp` value to `0x674DB1E1`.
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, { time: '0x674DB1E1' }]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
+
+    // Check the `block.prevrandao` value, without overrides
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, null]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
+
+    // Override the `block.prevrandao` value to `0x7914bb5b13bac6f621bc37bbf6e406fbf4472aaaaf17ec2f309a92aca4e27fc0`.
+    let random = '0x7914bb5b13bac6f621bc37bbf6e406fbf4472aaaaf17ec2f309a92aca4e27fc0'
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, { random: random }]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
+
+    // Check the `block.coinbase` value, without overrides
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, null]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
+
+    // Override the `block.coinbase` value to `0x658Bdf435d810C91414eC09147DAA6DB62406379`.
+    response = await helpers.callRPCMethod(
+        'eth_estimateGas',
+        [txArgs, 'latest', null, { coinbase: '0x658Bdf435d810C91414eC09147DAA6DB62406379' }]
+    )
+    assert.equal(response.status, 200)
+    assert.isDefined(response.body)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
+})