Improve block overrides E2E tests with custom contract code

Author: m-Peter

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

@@ -7,7 +7,7 @@ let deployed = null
 let contractAddress = null
 
 before(async () => {
-    deployed = await helpers.deployContract('storage')
+    deployed = await helpers.deployContract('blockOverrides')
     contractAddress = deployed.receipt.contractAddress
 
     assert.equal(deployed.receipt.status, conf.successStatus)
@@ -20,14 +20,14 @@ it('should apply block overrides on eth_estimateGas', async () => {
     assert.equal(receipt.contractAddress, contractAddress)
 
     // Check the `block.number` value, without overrides
-    let blockNumberSelector = deployed.contract.methods.blockNumber().encodeABI()
+    let testFuncSelector = deployed.contract.methods.test().encodeABI()
     let txArgs = {
         from: conf.eoa.address,
         to: contractAddress,
-        gas: '0x75ab',
+        gas: '0x493E0',
         gasPrice: web3.utils.toHex(conf.minGasPrice),
         value: '0x0',
-        data: blockNumberSelector,
+        data: testFuncSelector,
     }
 
     let response = await helpers.callRPCMethod(
@@ -36,28 +36,25 @@ it('should apply block overrides on eth_estimateGas', async () => {
     )
     assert.equal(response.status, 200)
     assert.isDefined(response.body)
-    assert.equal(web3.utils.hexToNumber(response.body.result), 21651n)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
 
-    // Override the `block.number` value to `2`.
+    // Override the `block.number` value to `9090`.
     response = await helpers.callRPCMethod(
         'eth_estimateGas',
-        [txArgs, 'latest', null, { number: '0x2' }]
+        [txArgs, 'latest', null, { number: '0x2382' }]
     )
     assert.equal(response.status, 200)
     assert.isDefined(response.body)
-    assert.equal(web3.utils.hexToNumber(response.body.result), 21651n)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
 
     // Check the `block.timestamp` value, without overrides
-    let blockTimeSelector = deployed.contract.methods.blockTime().encodeABI()
-    txArgs.data = blockTimeSelector
-
     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), 21607n)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 21473n)
 
     // Override the `block.timestamp` value to `0x674DB1E1`.
     response = await helpers.callRPCMethod(
@@ -66,18 +63,16 @@ it('should apply block overrides on eth_estimateGas', async () => {
     )
     assert.equal(response.status, 200)
     assert.isDefined(response.body)
-    assert.equal(web3.utils.hexToNumber(response.body.result), 21607n)
+    assert.equal(web3.utils.hexToNumber(response.body.result), 273693n)
 
     // Check the `block.prevrandao` value, without overrides
-    let randomSelector = deployed.contract.methods.random().encodeABI()
-    txArgs.data = randomSelector
-
     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'
@@ -87,5 +82,23 @@ it('should apply block overrides on eth_estimateGas', async () => {
     )
     assert.equal(response.status, 200)
     assert.isDefined(response.body)
-    assert.equal(web3.utils.hexToNumber(response.body.result), 21584n)
+    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)
 })