Cherry pick 0.18 commits since 0.18.0-alpha1 (#901)

Cherry pick PRs that went into main branch since cutting a 0.18.0-alpha1. PRs map to individual commits
- [PR 882 - eth_feeHistory invalid cached response](https://github.com/hashgraph/hedera-json-rpc-relay/pull/882)
- [PR 887 - Needed changes for metrics improvements](https://github.com/hashgraph/hedera-json-rpc-relay/pull/887)
- [PR 883 - Handle GRPC timeout error](https://github.com/hashgraph/hedera-json-rpc-relay/pull/883)
- PR 898 - update-logs-and-metrics Added the requestId to the server context](https://github.com/hashgraph/hedera-json-rpc-relay/pull/898)

---------

Signed-off-by: ebadiere <[email protected]>
Signed-off-by: Nana Essilfie-Conduah <[email protected]>

---------

Signed-off-by: nikolay <[email protected]>
Signed-off-by: Nana Essilfie-Conduah <[email protected]>
Signed-off-by: Alfredo Gutierrez <[email protected]>
Signed-off-by: Ivo Yankov <[email protected]>
Signed-off-by: ebadiere <[email protected]>
Co-authored-by: Nikolay Atanasow <[email protected]>
Co-authored-by: Alfredo Gutierrez <[email protected]>
Co-authored-by: Ivo Yankov <[email protected]>
Co-authored-by: Eric Badiere <[email protected]>

Author: 5 people

.env.example

@@ -25,4 +25,5 @@ MIRROR_NODE_LIMIT_PARAM =
 CLIENT_TRANSPORT_SECURITY=
 INPUT_SIZE_LIMIT=
 ETH_CALL_CONSENSUS=
+CONSENSUS_MAX_EXECUTION_TIME=
 ETH_CALL_CACHE_TTL=

README.md

@@ -81,10 +81,10 @@ MIRROR_NODE_URL=http://127.0.0.1:5551
 LOCAL_NODE=true
 SERVER_PORT=7546
 E2E_RELAY_HOST=http://127.0.0.1:7546
-DEFAULT_RATE_LIMIT = 200
-TIER_1_RATE_LIMIT = 100
-TIER_2_RATE_LIMIT = 200
-TIER_3_RATE_LIMIT = 400
+DEFAULT_RATE_LIMIT: 200
+TIER_1_RATE_LIMIT: 100
+TIER_2_RATE_LIMIT: 800
+TIER_3_RATE_LIMIT: 1600
 LIMIT_DURATION = 60000
 HBAR_RATE_LIMIT_TINYBAR = 6000000000
 HBAR_RATE_LIMIT_DURATION = 60000
@@ -96,6 +96,7 @@ MIRROR_NODE_RETRY_DELAY = 500
 MIRROR_NODE_LIMIT_PARAM = 100
 INPUT_SIZE_LIMIT = 1
 ETH_CALL_CACHE_TTL = 200
+CONSENSUS_MAX_EXECUTION_TIME = 10000
 ````
 
 Note: Read more about `DEV_MODE` [here](docs/dev-mode.md)

helm-chart/templates/configmap.yaml

@@ -32,3 +32,4 @@ data:
   MIRROR_NODE_LIMIT_PARAM: {{ .Values.config.MIRROR_NODE_LIMIT_PARAM | quote }}
   INPUT_SIZE_LIMIT: {{ .Values.config.INPUT_SIZE_LIMIT | quote }}
   ETH_CALL_CACHE_TTL: {{ .Values.config.ETH_CALL_CACHE_TTL | quote }}
+  CONSENSUS_MAX_EXECUTION_TIME: {{ .Values.config.CONSENSUS_MAX_EXECUTION_TIME | quote }}

helm-chart/value-test.yaml

@@ -121,6 +121,7 @@ config:
   MIRROR_NODE_LIMIT_PARAM: 100
   INPUT_SIZE_LIMIT: 1
   ETH_CALL_CACHE_TTL: 200
+  CONSENSUS_MAX_EXECUTION_TIME: 15000
 
 # 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

@@ -122,6 +122,7 @@ config:
   CLIENT_TRANSPORT_SECURITY: false
   INPUT_SIZE_LIMIT: 1
   ETH_CALL_CACHE_TTL: 200
+  CONSENSUS_MAX_EXECUTION_TIME: 15000
 
 # Enable rolling_restarts if SDK calls fail this is usually due to stale connections that get cycled on restart
 rolling_restart:

package-lock.json

@@ -167,7 +167,8 @@ export class MirrorNodeClient {
             name: metricHistogramName,
             help: 'Mirror node response method statusCode latency histogram',
             labelNames: ['method', 'statusCode'],
-            registers: [register]
+            registers: [register],
+            buckets: [5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000] // ms (milliseconds)
         });
 
         this.logger.info(`Mirror Node client successfully configured to REST url: ${this.restUrl} and Web3 url: ${this.web3Url} `);
@@ -331,6 +332,21 @@ export class MirrorNodeClient {
             requestId);
     }
 
+    /**
+     * In some very rare cases the /contracts/results api is called before all the data is saved in
+     * the mirror node DB and `transaction_index` is returned as `undefined`. A single re-fetch is sufficient to
+     * resolve this problem.
+     * @param transactionIdOrHash
+     * @param requestId
+     */
+    public async getContractResultWithRetry(transactionIdOrHash: string, requestId?: string) {
+        let contractResult = await this.getContractResult(transactionIdOrHash, requestId);
+        if (contractResult && typeof contractResult.transaction_index === 'undefined') {
+            return this.getContractResult(transactionIdOrHash, requestId);
+        }
+        return contractResult;
+    }
+
     public async getContractResults(contractResultsParams?: IContractResultsParams, limitOrderParams?: ILimitOrderParams, requestId?: string) {
         const queryParamObject = {};
         this.setContractResultsParams(queryParamObject, contractResultsParams);

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

@@ -62,6 +62,7 @@ const _ = require('lodash');
 export class SDKClient {
     static transactionMode = 'TRANSACTION';
     static queryMode = 'QUERY';
+    static recordMode = 'RECORD';
     /**
      * The client to use for connecting to the main consensus network. The account
      * associated with this client will pay for all operations on the main network.
@@ -95,6 +96,13 @@ export class SDKClient {
     // populate with consensusnode requests via SDK
     constructor(clientMain: Client, logger: Logger, register: Registry) {
         this.clientMain = clientMain;
+
+        if (process.env.CONSENSUS_MAX_EXECUTION_TIME) {
+            // sets the maximum time in ms for the SDK to wait when submitting
+            // a transaction/query before throwing a TIMEOUT error
+            this.clientMain = clientMain.setMaxExecutionTime(Number(process.env.CONSENSUS_MAX_EXECUTION_TIME));
+        }
+
         this.logger = logger;
         this.register = register;
         this.operatorAccountId = clientMain.operatorAccountId ? clientMain.operatorAccountId.toString() : 'UNKNOWN';
@@ -133,7 +141,7 @@ export class SDKClient {
 
         const duration = parseInt(process.env.HBAR_RATE_LIMIT_DURATION!);
         const total = parseInt(process.env.HBAR_RATE_LIMIT_TINYBAR!);
-        this.hbarLimiter = new HbarLimit(logger.child({ name: 'hbar-rate-limit' }), Date.now(), total, duration);
+        this.hbarLimiter = new HbarLimit(logger.child({ name: 'hbar-rate-limit' }), Date.now(), total, duration, register);
     }
 
     async getAccountBalance(account: string, callerName: string, requestId?: string): Promise<AccountBalance> {
@@ -300,7 +308,7 @@ export class SDKClient {
         const requestIdPrefix = formatRequestIdMessage(requestId);
         const currentDateNow = Date.now();
         try {
-            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow);
+            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow, SDKClient.queryMode, callerName);
             if (shouldLimit) {
                 throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
             }
@@ -348,6 +356,11 @@ export class SDKClient {
             if (e instanceof JsonRpcError){
                 throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
             }
+
+            if (sdkClientError.isGrpcTimeout()) {
+                throw predefined.REQUEST_TIMEOUT;
+            }
+
             throw sdkClientError;
         }
     };
@@ -357,7 +370,7 @@ export class SDKClient {
         const requestIdPrefix = formatRequestIdMessage(requestId);
         const currentDateNow = Date.now();
         try {
-            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow);
+            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow, SDKClient.transactionMode, callerName);
             if (shouldLimit) {
                 throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
             }
@@ -411,7 +424,7 @@ export class SDKClient {
             if (!resp.getRecord) {
                 throw new SDKClientError({}, `${requestIdPrefix} Invalid response format, expected record availability: ${JSON.stringify(resp)}`);
             }
-            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow);
+            const shouldLimit = this.hbarLimiter.shouldLimit(currentDateNow, SDKClient.recordMode, transactionName);
             if (shouldLimit) {
                 throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
             }
@@ -476,7 +489,6 @@ export class SDKClient {
             status,
             caller)
             .observe(resolvedCost);
-        this.operatorAccountGauge.labels(mode, type, this.operatorAccountId).dec(resolvedCost);
     };
 
     /**

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

@@ -162,11 +162,25 @@ export const predefined = {
     message: 'Value below 10_000_000_000 wei which is 1 tinybar'
   }),
   'INVALID_CONTRACT_ADDRESS':  (address) => {
-    const message = address && address.length ? ` Expected length of 42 chars but was ${address.length}.` : ''
+    let message = `Invalid Contract Address: ${address}.`;
+    if (address && address.length) {
+      message = `${message} Expected length of 42 chars but was ${address.length}.`;
+    }
+
     return new JsonRpcError({
       name: 'Invalid Contract Address',
       code: -32012,
-      message: `Invalid Contract Address: ${address}.${message}`
+      message: message
     })
-  }
+  },
+  'COULD_NOT_ESTIMATE_GAS_PRICE': new JsonRpcError({
+    name: 'Could not estimate gas price',
+    code: -32604,
+    message: 'Error encountered estimating the gas price'
+  }),
+  'COULD_NOT_RETRIEVE_LATEST_BLOCK': new JsonRpcError({
+    name: 'Could not retrieve latest block',
+    code: -32607,
+    message: 'Error encountered retrieving latest block'
+  })
 };

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

@@ -55,5 +55,10 @@ export class SDKClientError extends Error {
   public isInsufficientTxFee(): boolean {
     return this.statusCode === Status.InsufficientTxFee._code;
   }
+
+  public isGrpcTimeout(): boolean {
+    // The SDK uses the same code for Grpc Timeout as INVALID_TRANSACTION_ID
+    return this.statusCode === Status.InvalidTransactionId._code;
+  }
 }