Cherrypick PR-1105 into 0.21 release (#1111)

Add Contract Call Query Retry Logic (#1105)

* add contract call query retry logic



* fix tests



* remove unused



---------

Signed-off-by: georgi-l95 <[email protected]>
Signed-off-by: Alfredo Gutierrez <[email protected]>
Co-authored-by: Georgi Lazarov <[email protected]>

Author: AlfredoG87

docs/configuration.md

@@ -36,3 +36,4 @@ data:
   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 }}
+  CONTRACT_QUERY_TIMEOUT_RETRIES: {{ .Values.config.CONTRACT_QUERY_TIMEOUT_RETRIES | quote }}

helm-chart/templates/configmap.yaml

@@ -123,6 +123,7 @@ config:
   ETH_CALL_CACHE_TTL: 200
   CONSENSUS_MAX_EXECUTION_TIME: 15000
   SDK_REQUEST_TIMEOUT: 10000
+  CONTRACT_QUERY_TIMEOUT_RETRIES: 3
   SUBSCRIPTIONS_ENABLED: false
   ETH_CALL_DEFAULT_TO_CONSENSUS_NODE: false
 

helm-chart/value-test.yaml

@@ -124,6 +124,7 @@ config:
   ETH_CALL_CACHE_TTL: 200
   CONSENSUS_MAX_EXECUTION_TIME: 15000
   SDK_REQUEST_TIMEOUT: 10000
+  CONTRACT_QUERY_TIMEOUT_RETRIES: 3
   SUBSCRIPTIONS_ENABLED: false
   ETH_CALL_DEFAULT_TO_CONSENSUS_NODE: true
 

helm-chart/values.yaml

@@ -277,6 +277,30 @@ export class SDKClient {
         return this.executeQuery(contractCallQuery, this.clientMain, callerName, to, requestId);
     }
 
+    async submitContractCallQueryWithRetry(to: string, data: string, gas: number, from: string, callerName: string, requestId?: string): Promise<ContractFunctionResult> {
+        const requestIdPrefix = formatRequestIdMessage(requestId);
+        let retries = 0;
+        let resp;
+        while (parseInt(process.env.CONTRACT_QUERY_TIMEOUT_RETRIES || '1') > retries) {
+            console.log(retries)
+            try {
+                resp = await this.submitContractCallQuery(to, data, gas, from, callerName, requestId);
+                return resp;
+            } catch (e: any) {
+                const sdkClientError = new SDKClientError(e, e.message);
+                if (sdkClientError.isTimeoutExceeded()) {
+                    const delay = retries * 1000;
+                    this.logger.trace(`${requestIdPrefix} Contract call query failed with status ${sdkClientError.message}. Retrying again after ${delay}ms ...`);
+                    retries++;
+                    await new Promise(r => setTimeout(r, delay));
+                    continue;
+                }
+                throw sdkClientError;
+            }
+        }
+        return resp;
+    }
+
     async increaseCostAndRetryExecution(query: Query<any>, baseCost: Hbar, client: Client, maxRetries: number, currentRetry: number, requestId?: string) {
         const baseMultiplier = constants.QUERY_COST_INCREMENTATION_STEP;
         const multiplier = Math.pow(baseMultiplier, currentRetry);

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

@@ -60,6 +60,10 @@ export class SDKClientError extends Error {
     return this.statusCode == Status.ContractRevertExecuted._code;
   }
 
+  public isTimeoutExceeded(): boolean {
+    return this.statusCode === Status.Unknown._code && this.message?.includes("timeout exceeded");
+  }
+
   public isGrpcTimeout(): boolean {
     // The SDK uses the same code for Grpc Timeout as INVALID_TRANSACTION_ID
     return this.statusCode === Status.InvalidTransactionId._code;

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

@@ -1052,7 +1052,7 @@ export class EthImpl implements Eth {
         return cachedResponse;
       }
 
-      const contractCallResponse = await this.sdkClient.submitContractCallQuery(call.to, call.data, gas, call.from, EthImpl.ethCall, requestId);
+      const contractCallResponse = await this.sdkClient.submitContractCallQueryWithRetry(call.to, call.data, gas, call.from, EthImpl.ethCall, requestId);
       const formattedCallReponse = EthImpl.prepend0x(Buffer.from(contractCallResponse.asBytes()).toString('hex'));
 
       this.cache.set(cacheKey, formattedCallReponse, { ttl: EthImpl.ethCallCacheTtl });

packages/relay/src/lib/eth.ts

@@ -2491,7 +2491,7 @@ describe('Eth calls using MirrorNode', async function () {
       });
       restMock.onGet(`contracts/${contractAddress2}`).reply(200, defaultContract2);
 
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
             asBytes: function () {
               return Uint8Array.of(0);
             }
@@ -2504,12 +2504,12 @@ describe('Eth calls using MirrorNode', async function () {
         "data": contractCallData,
       }, 'latest');
 
-      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, 400_000, accountAddress1, 'eth_call');
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, contractCallData, 400_000, accountAddress1, 'eth_call');
       expect(result).to.equal("0x00");
     });
 
     it('eth_call with no data', async function () {
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
             asBytes: function () {
               return Uint8Array.of(0);
             }
@@ -2522,12 +2522,12 @@ describe('Eth calls using MirrorNode', async function () {
         "gas": maxGasLimitHex
       }, 'latest');
 
-      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, undefined, maxGasLimit, accountAddress1, 'eth_call');
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, undefined, maxGasLimit, accountAddress1, 'eth_call');
       expect(result).to.equal("0x00");
     });
 
     it('eth_call with no from address', async function () {
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
             asBytes: function () {
               return Uint8Array.of(0);
             }
@@ -2540,12 +2540,12 @@ describe('Eth calls using MirrorNode', async function () {
         "gas": maxGasLimitHex
       }, 'latest');
 
-      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, maxGasLimit, undefined, 'eth_call');
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, contractCallData, maxGasLimit, undefined, 'eth_call');
       expect(result).to.equal("0x00");
     });
 
     it('eth_call with all fields', async function () {
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
             asBytes: function () {
               return Uint8Array.of(0);
             }
@@ -2559,13 +2559,13 @@ describe('Eth calls using MirrorNode', async function () {
         "gas": maxGasLimitHex
       }, 'latest');
 
-      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, maxGasLimit, accountAddress1, 'eth_call');
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, contractCallData, maxGasLimit, accountAddress1, 'eth_call');
       expect(result).to.equal("0x00");
     });
 
     //Return once the value, then it's being fetched from cache. After the loop we reset the sdkClientStub, so that it returns nothing, if we get an error in the next request that means that the cache was cleared.
     it('eth_call should cache the response for 200ms', async function () {
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
         asBytes: function () {
           return Uint8Array.of(0);
             }
@@ -2601,7 +2601,7 @@ describe('Eth calls using MirrorNode', async function () {
 
     describe('with gas > 15_000_000', async function() {
       it('caps gas at 15_000_000', async function () {
-        sdkClientStub.submitContractCallQuery.returns({
+        sdkClientStub.submitContractCallQueryWithRetry.returns({
               asBytes: function () {
                 return Uint8Array.of(0);
               }
@@ -2615,13 +2615,13 @@ describe('Eth calls using MirrorNode', async function () {
           "gas": 50_000_000
         }, 'latest');
 
-        sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, 15_000_000, accountAddress1, 'eth_call');
+        sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, contractCallData, 15_000_000, accountAddress1, 'eth_call');
         expect(result).to.equal("0x00");
       });
     });
 
     it('SDK returns a precheck error', async function () {
-      sdkClientStub.submitContractCallQuery.throws(predefined.CONTRACT_REVERT(defaultErrorMessage));
+      sdkClientStub.submitContractCallQueryWithRetry.throws(predefined.CONTRACT_REVERT(defaultErrorMessage));
 
       const result = await ethImpl.call({
         "from": accountAddress1,
@@ -2754,7 +2754,7 @@ describe('Eth calls using MirrorNode', async function () {
         }
       });
 
-      sdkClientStub.submitContractCallQuery.returns({
+      sdkClientStub.submitContractCallQueryWithRetry.returns({
             asBytes: function () {
               return Uint8Array.of(0);
             }
@@ -2763,7 +2763,7 @@ describe('Eth calls using MirrorNode', async function () {
 
       const result = await ethImpl.call(callData, 'latest');
 
-      sinon.assert.calledWith(sdkClientStub.submitContractCallQuery, contractAddress2, contractCallData, maxGasLimit, accountAddress1, 'eth_call');
+      sinon.assert.calledWith(sdkClientStub.submitContractCallQueryWithRetry, contractAddress2, contractCallData, maxGasLimit, accountAddress1, 'eth_call');
       expect(result).to.equal("0x00");
     });