Cherry Pick Switch eth_call to Mirror-node (#1019)

Switch eth_call to Mirror Node (#1005)

- Refactor of eth_call with added condition for using only consensus node for calls or mirror node and fallback to consensus node.
- Helm charts set for different env.
- Fixes erc20 tests as some of the tests actions need more time propagated to the mirror node.

---------

Signed-off-by: Ivo Yankov <[email protected]>
Signed-off-by: georgi-l95 <[email protected]>
Co-authored-by: Ivo Yankov <[email protected]>

Author: georgi-l95

.env.example

@@ -24,7 +24,7 @@ GAS_PRICE_TINY_BAR_BUFFER =
 MIRROR_NODE_LIMIT_PARAM =
 CLIENT_TRANSPORT_SECURITY=
 INPUT_SIZE_LIMIT=
-ETH_CALL_CONSENSUS=
+ETH_CALL_DEFAULT_TO_CONSENSUS_NODE=
 CONSENSUS_MAX_EXECUTION_TIME=
 ETH_CALL_CACHE_TTL=
 SDK_REQUEST_TIMEOUT=

docs/configuration.md

@@ -48,7 +48,7 @@ Unless you need to set a non-default value, it is recommended to only populate o
 | `CONSENSUS_MAX_EXECUTION_TIME`    | "15000"       | Maximum time in ms the SDK will wait when submitting a transaction/query before throwing a TIMEOUT error.   |
 | `DEFAULT_RATE_LIMIT`              | "200"         | default fallback rate limit, if no other is configured.   |
 | `ETH_CALL_CACHE_TTL`              | "200"         | Maximum time in ms to cache an eth_call response.   |
-| `ETH_CALL_CONSENSUS`              | "false"       | Flag to set if eth_call logic should first query the mirror node.   |
+| `ETH_CALL_DEFAULT_TO_CONSENSUS_NODE `              | "false"       | Flag to set if eth_call logic should first query the mirror node.   |
 | `ETH_GET_LOGS_BLOCK_RANGE_LIMIT`  | "1000"        | The maximum block number range to consider during an eth_getLogs call.   |
 | `FEE_HISTORY_MAX_RESULTS`         | "10"          | The maximum number of results to returns as part of `eth_feeHistory`.   |
 | `GAS_PRICE_TINY_BAR_BUFFER`       | "10000000000" | The additional buffer range to allow during a relay precheck of gas price. This supports slight fluctuations in network gasprice calculations.   |

helm-chart/templates/configmap.yaml

@@ -35,3 +35,4 @@ data:
   ETH_CALL_CACHE_TTL: {{ .Values.config.ETH_CALL_CACHE_TTL | quote }}
   CONSENSUS_MAX_EXECUTION_TIME: {{ .Values.config.CONSENSUS_MAX_EXECUTION_TIME | quote }}
   SUBSCRIPTIONS_ENABLED: {{ .Values.config.SUBSCRIPTIONS_ENABLED | quote }}
+  ETH_CALL_DEFAULT_TO_CONSENSUS_NODE: {{ .Values.config.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE | quote }}

helm-chart/value-test.yaml

@@ -124,6 +124,7 @@ config:
   CONSENSUS_MAX_EXECUTION_TIME: 15000
   SDK_REQUEST_TIMEOUT: 10000
   SUBSCRIPTIONS_ENABLED: false
+  ETH_CALL_DEFAULT_TO_CONSENSUS_NODE: false
 
 # Enable rolling_restarts if SDK calls fail this is usually due to stale connections that get cycled on restart
 rolling_restart:

helm-chart/values.yaml

@@ -125,6 +125,7 @@ config:
   CONSENSUS_MAX_EXECUTION_TIME: 15000
   SDK_REQUEST_TIMEOUT: 10000
   SUBSCRIPTIONS_ENABLED: false
+  ETH_CALL_DEFAULT_TO_CONSENSUS_NODE: true
 
 # Enable rolling_restarts if SDK calls fail this is usually due to stale connections that get cycled on restart
 rolling_restart:

packages/relay/src/lib/clients/mirrorNodeClient.ts

@@ -25,6 +25,7 @@ import constants from './../constants';
 import { Histogram, Registry } from 'prom-client';
 import { formatRequestIdMessage } from '../../formatters';
 import axiosRetry from 'axios-retry';
+import { predefined } from "../errors/JsonRpcError";
 const LRU = require('lru-cache');
 
 type REQUEST_METHODS = 'GET' | 'POST';
@@ -148,7 +149,7 @@ export class MirrorNodeClient {
             this.web3Url = '';
 
             this.restClient = restClient;
-            this.web3Client = !!web3Client ? web3Client : restClient;
+            this.web3Client = web3Client ? web3Client : restClient;
         } else {
             this.restUrl = this.buildUrl(restUrl);
             this.web3Url = this.buildUrl(web3Url);
@@ -238,7 +239,15 @@ export class MirrorNodeClient {
         }
 
         this.logger.error(new Error(error.message), `${requestIdPrefix} [${method}] ${path} ${effectiveStatusCode} status`);
-        throw new MirrorNodeClientError(error.message, effectiveStatusCode);
+
+        const mirrorError = new MirrorNodeClientError(error, effectiveStatusCode);
+
+        // we only need contract revert errors here as it's not the same as not supported
+        if (mirrorError.isContractReverted() && !mirrorError.isNotSupported() && !mirrorError.isNotSupportedSystemContractOperaton()) {
+            throw predefined.CONTRACT_REVERT(mirrorError.errorMessage);
+        }
+
+        throw mirrorError;
     }
 
     async getPaginatedResults(url: string, pathLabel: string, resultProperty: string, allowedErrorStatuses?: number[], requestId?: string, results = [], page = 1) {
@@ -528,7 +537,7 @@ export class MirrorNodeClient {
     }
 
     public async postContractCall(callData: string, requestId?: string) {
-        return this.post(MirrorNodeClient.CONTRACT_CALL_ENDPOINT, callData, MirrorNodeClient.CONTRACT_CALL_ENDPOINT, [400], requestId);
+        return this.post(MirrorNodeClient.CONTRACT_CALL_ENDPOINT, callData, MirrorNodeClient.CONTRACT_CALL_ENDPOINT, [], requestId);
     }
 
     getQueryParams(params: object) {

packages/relay/src/lib/errors/MirrorNodeClientError.ts

@@ -21,30 +21,54 @@
 
 export class MirrorNodeClientError extends Error {
     public statusCode: number;
+    public errorMessage?: string;
 
     static retryErrorCodes: Array<number> = [400, 404, 408, 425, 500]
 
     static ErrorCodes = {
       ECONNABORTED: 504,
-      CONTRACT_REVERT_EXECUTED : 400
+      CONTRACT_REVERT_EXECUTED : 400,
+      NOT_SUPPORTED: 501
     };
 
     static statusCodes = {
       NOT_FOUND: 404
     };
 
-    constructor(message: string, statusCode: number) {
-      super(message);
-      this.statusCode = statusCode;
+    constructor(error: any, statusCode: number) {
+        // web3 module sends errors in this format, this is why we need a check to distinguish
+        if (error.response?.data?._status?.messages?.length) {
+            const msg = error.response.data._status.messages[0];
+            const {message, data} = msg;
+            super(message);
 
-      Object.setPrototypeOf(this, MirrorNodeClientError.prototype);
+            this.errorMessage = data;
+        }
+        else {
+            super(error.message);
+        }
+
+        this.statusCode = statusCode;
+        Object.setPrototypeOf(this, MirrorNodeClientError.prototype);
     }
 
     public isTimeout(): boolean {
       return this.statusCode === MirrorNodeClientError.ErrorCodes.ECONNABORTED;
     }
 
+    public isContractReverted(): boolean {
+        return this.statusCode === MirrorNodeClientError.ErrorCodes.CONTRACT_REVERT_EXECUTED;
+    }
+
     public isNotFound(): boolean {
       return this.statusCode === MirrorNodeClientError.statusCodes.NOT_FOUND;
     }
+
+    public isNotSupported(): boolean {
+        return this.statusCode === MirrorNodeClientError.ErrorCodes.NOT_SUPPORTED;
+    }
+
+    public isNotSupportedSystemContractOperaton(): boolean {
+      return this.message === 'Precompile not supported';
+    }
   }

packages/relay/src/lib/eth.ts

@@ -974,48 +974,31 @@ export class EthImpl implements Eth {
     const requestIdPrefix = formatRequestIdMessage(requestId);
     this.logger.trace(`${requestIdPrefix} call(hash=${JSON.stringify(call)}, blockParam=${blockParam})`, call, blockParam);
 
-    // The "to" address must always be 42 chars.
-    if (!call.to || call.to.length != 42) {
-      throw predefined.INVALID_CONTRACT_ADDRESS(call.to);
-    }
+    await this.performCallChecks(call, requestId);
 
-    // If "From" is distinct from blank, we check is a valid account
-    if(call.from) {
-      const fromEntityType = await this.mirrorNodeClient.resolveEntityType(call.from, requestId, [constants.TYPE_ACCOUNT]);
-      if (fromEntityType?.type !== constants.TYPE_ACCOUNT) {
-        throw predefined.NON_EXISTING_ACCOUNT(call.from);
-      }
-    }
-    // Check "To" is a valid Contract or HTS Address
-    const toEntityType = await this.mirrorNodeClient.resolveEntityType(call.to, requestId, [constants.TYPE_TOKEN, constants.TYPE_CONTRACT]);
-    if(!(toEntityType?.type === constants.TYPE_CONTRACT || toEntityType?.type === constants.TYPE_TOKEN)) {
-      throw predefined.NON_EXISTING_CONTRACT(call.to);
+    // Get a reasonable value for "gas" if it is not specified.
+    let gas = Number(call.gas) || 400_000;
+
+    let value: string | null = null;
+    if (typeof call.value === 'string') {
+      value = (new BN(call.value)).toString();
     }
 
+    // Gas limit for `eth_call` is 50_000_000, but the current Hedera network limit is 15_000_000
+    // With values over the gas limit, the call will fail with BUSY error so we cap it at 15_000_000
+    if (gas > constants.BLOCK_GAS_LIMIT) {
+      this.logger.trace(`${requestIdPrefix} eth_call gas amount (${gas}) exceeds network limit, capping gas to ${constants.BLOCK_GAS_LIMIT}`);
+      gas = constants.BLOCK_GAS_LIMIT;
+    }
+    
     try {
-      // Get a reasonable value for "gas" if it is not specified.
-      let gas = Number(call.gas) || 400_000;
-
-      let value: string | null = null;
-      if (typeof call.value === 'string') {
-        value = (new BN(call.value)).toString();
-      }
-
-      // Gas limit for `eth_call` is 50_000_000, but the current Hedera network limit is 15_000_000
-      // With values over the gas limit, the call will fail with BUSY error so we cap it at 15_000_000
-      if (gas > constants.BLOCK_GAS_LIMIT) {
-        this.logger.trace(`${requestIdPrefix} eth_call gas amount (${gas}) exceeds network limit, capping gas to ${constants.BLOCK_GAS_LIMIT}`);
-        gas = constants.BLOCK_GAS_LIMIT;
-      }
-
-      // Execute the call and get the response
-      this.logger.debug(`${requestIdPrefix} Making eth_call on contract ${call.to} with gas ${gas} and call data "${call.data}" from "${call.from}"`, call.to, gas, call.data, call.from);
-
-      // ETH_CALL_CONSENSUS = false enables the use of Mirror node
-      if (process.env.ETH_CALL_CONSENSUS == 'false') {
+      // ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = false enables the use of Mirror node
+      if (process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE == 'false') {
         //temporary workaround until precompiles are implemented in Mirror node evm module
         const isHts = await this.mirrorNodeClient.resolveEntityType(call.to, requestId, [constants.TYPE_TOKEN]);
         if (!(isHts?.type === constants.TYPE_TOKEN)) {
+          // Execute the call and get the response
+          this.logger.debug(`${requestIdPrefix} Making eth_call on contract ${call.to} with gas ${gas} and call data "${call.data}" from "${call.from}" using mirror-node.`, call.to, gas, call.data, call.from);
           const callData = {
             ...call,
             gas,
@@ -1029,7 +1012,36 @@ export class EthImpl implements Eth {
           return EthImpl.emptyHex;
         }
       }
+      
+      return await this.callConsensusNode(call, gas, requestId);
+    } catch (e: any) {
+      // Temporary workaround until mirror node web3 module implements the support of precompiles
+      // If mirror node throws NOT_SUPPORTED or precompile is not supported, rerun eth_call and force it to go through the Consensus network
+      if (e instanceof MirrorNodeClientError && (e.isNotSupported() || e.isNotSupportedSystemContractOperaton())) {
+        return await this.callConsensusNode(call, gas, requestId);
+      }
+
+      this.logger.error(e, `${requestIdPrefix} Failed to successfully submit contractCallQuery`);
+      if (e instanceof JsonRpcError) {
+        return e;
+      }
+      return predefined.INTERNAL_ERROR();
+    }
+  }
 
+  /**
+   * Execute a contract call query to the consensus node
+   *
+   * @param call
+   * @param gas
+   * @param requestId
+   */
+  async callConsensusNode(call: any, gas: number, requestId?: string): Promise<string | JsonRpcError> {
+    const requestIdPrefix = formatRequestIdMessage(requestId);
+    // Execute the call and get the response
+    this.logger.debug(`${requestIdPrefix} Making eth_call on contract ${call.to} with gas ${gas} and call data "${call.data}" from "${call.from}" using consensus-node.`, call.to, gas, call.data, call.from);
+    
+    try {
       let data = call.data;
       if (data) {
         data = crypto.createHash('sha1').update(call.data).digest('hex'); // NOSONAR
@@ -1048,7 +1060,6 @@ export class EthImpl implements Eth {
 
       this.cache.set(cacheKey, formattedCallReponse, { ttl: EthImpl.ethCallCacheTtl });
       return formattedCallReponse;
-
     } catch (e: any) {
       this.logger.error(e, `${requestIdPrefix} Failed to successfully submit contractCallQuery`);
       if (e instanceof JsonRpcError) {
@@ -1058,6 +1069,32 @@ export class EthImpl implements Eth {
     }
   }
 
+  /**
+   * Perform neccecery checks for the passed call object
+   *
+   * @param call
+   * @param requestId
+   */
+  async performCallChecks(call: any, requestId?: string) {
+    // The "to" address must always be 42 chars.
+    if (!call.to || call.to.length != 42) {
+      throw predefined.INVALID_CONTRACT_ADDRESS(call.to);
+    }
+
+    // If "From" is distinct from blank, we check is a valid account
+    if(call.from) {
+      const fromEntityType = await this.mirrorNodeClient.resolveEntityType(call.from, requestId, [constants.TYPE_ACCOUNT]);
+      if (fromEntityType?.type !== constants.TYPE_ACCOUNT) {
+        throw predefined.NON_EXISTING_ACCOUNT(call.from);
+      }
+    }
+    // Check "To" is a valid Contract or HTS Address
+    const toEntityType = await this.mirrorNodeClient.resolveEntityType(call.to, requestId, [constants.TYPE_TOKEN, constants.TYPE_CONTRACT]);
+    if(!(toEntityType?.type === constants.TYPE_CONTRACT || toEntityType?.type === constants.TYPE_TOKEN)) {
+      throw predefined.NON_EXISTING_CONTRACT(call.to);
+    }
+  }
+
   /**
    * Gets a transaction by the provided hash
    *

packages/relay/tests/lib/eth.spec.ts

@@ -2371,12 +2371,12 @@ describe('Eth calls using MirrorNode', async function () {
     let initialEthCallConesneusFF;
 
     before(() => {
-      initialEthCallConesneusFF = process.env.ETH_CALL_CONSENSUS;
-      process.env.ETH_CALL_CONSENSUS = 'true';
+      initialEthCallConesneusFF = process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE;
+      process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = 'true';
     });
 
     after(() => {
-      process.env.ETH_CALL_CONSENSUS = initialEthCallConesneusFF;
+      process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = initialEthCallConesneusFF;
     });
 
     it('eth_call with no gas', async function () {
@@ -2567,12 +2567,12 @@ describe('Eth calls using MirrorNode', async function () {
     let initialEthCallConesneusFF;
 
     before(() => {
-      initialEthCallConesneusFF = process.env.ETH_CALL_CONSENSUS;
-      process.env.ETH_CALL_CONSENSUS = 'false';
+      initialEthCallConesneusFF = process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE;
+      process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = 'false';
     });
 
     after(() => {
-      process.env.ETH_CALL_CONSENSUS = initialEthCallConesneusFF;
+      process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = initialEthCallConesneusFF;
     });
 
     //temporary workaround until precompiles are implemented in Mirror node evm module
@@ -2631,6 +2631,38 @@ describe('Eth calls using MirrorNode', async function () {
       expect(result).to.equal("0x00");
     });
 
+    it('eth_call with all fields, but mirror node throws NOT_SUPPORTED', async function () {
+      const callData = {
+        ...defaultCallData,
+        "from": accountAddress1,
+        "to": contractAddress2,
+        "data": contractCallData,
+        "gas": maxGasLimit
+      };
+
+      web3Mock.onPost('contracts/call', {...callData, estimate: false}).reply(501, {
+        '_status': {
+          'messages': [
+            {
+              'message': 'Precompile not supported'
+            }
+          ]
+        }
+      });
+
+      sdkClientStub.submitContractCallQuery.returns({
+            asBytes: function () {
+              return Uint8Array.of(0);
+            }
+          }
+      );
+
+      const result = await ethImpl.call(callData, 'latest');
+
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, maxGasLimit, accountAddress1, 'eth_call');
+      expect(result).to.equal("0x00");
+    });
+
     it('caps gas at 15_000_000', async function () {
       const callData = {
         ...defaultCallData,

packages/relay/tests/lib/openrpc.spec.ts

@@ -179,8 +179,8 @@ describe("Open RPC Specification", function () {
     });
 
     it('should execute "eth_call" against mirror node', async function () {
-        let initialEthCallConesneusFF = process.env.ETH_CALL_CONSENSUS;
-        process.env.ETH_CALL_CONSENSUS = 'false';
+        let initialEthCallConesneusFF = process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE;
+        process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = 'false';
         mock.onGet(`contracts/${defaultCallData.from}`).reply(404);
         mock.onGet(`accounts/${defaultCallData.from}`).reply(200, {
             account: "0.0.1723",
@@ -190,12 +190,12 @@ describe("Open RPC Specification", function () {
 
         const response = await ethImpl.call({...defaultCallData, gas: `0x${defaultCallData.gas.toString(16)}`}, 'latest');
         validateResponseSchema(methodsResponseSchema.eth_call, response);
-        process.env.ETH_CALL_CONSENSUS = initialEthCallConesneusFF;
+        process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = initialEthCallConesneusFF;
     });
 
     it('should execute "eth_call" against consensus node', async function () {
-        let initialEthCallConesneusFF = process.env.ETH_CALL_CONSENSUS;
-        process.env.ETH_CALL_CONSENSUS = 'true';
+        let initialEthCallConesneusFF = process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE;
+        process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = 'true';
         mock.onGet(`contracts/${defaultCallData.from}`).reply(404);
         mock.onGet(`accounts/${defaultCallData.from}`).reply(200, {
             account: "0.0.1723",
@@ -205,7 +205,7 @@ describe("Open RPC Specification", function () {
 
         sdkClientStub.submitContractCallQuery.returns({ asBytes: () => Buffer.from('12') });
         const response = await ethImpl.call(defaultTransaction, 'latest');
-        process.env.ETH_CALL_CONSENSUS = initialEthCallConesneusFF;
+        process.env.ETH_CALL_DEFAULT_TO_CONSENSUS_NODE = initialEthCallConesneusFF;
     });
 
     it('should execute "eth_chainId"', function () {