Removing cache for getBalance in dev mode and 'blockNumberOrTagOrHash' is explicit (#1924)

* Removing cache for dev mode if blockNumberOrTagOrHash is explicitly 'latest' or 'pending'
---------

Signed-off-by: Stefan Stefanov <[email protected]>

Author: stefan-stefanooov

packages/relay/package.json

@@ -24,7 +24,8 @@
     "compile": "tsc -b tsconfig.json",
     "lint": "npx eslint --ext .js,.ts .",
     "format": "npx prettier --ignore-path ../../.gitignore --write \"**/*.+(js|ts|json)\"",
-    "test": "nyc ts-mocha --recursive './tests/**/*.spec.ts' './tests/**/**/*.spec.ts' --exit"
+    "test": "nyc ts-mocha --recursive './tests/**/*.spec.ts' './tests/**/**/*.spec.ts' --exit",
+    "test:balance": "nyc ts-mocha --recursive './tests/**/*.spec.ts' './tests/**/**/*.spec.ts' -g '@balance' --exit"
   },
   "dependencies": {
     "@ethersproject/asm": "^5.7.0",

packages/relay/src/lib/eth.ts

@@ -260,6 +260,11 @@ export class EthImpl implements Eth {
     this.debugServiceImpl = new DebugService(mirrorNodeClient, logger, this.common);
   }
 
+  private shouldUseCacheForBalance(tag: string | null): boolean {
+    // should only cache balance when is Not latest or pending and is not in dev mode
+    return !CommonService.blockTagIsLatestOrPendingStrict(tag) && !CommonService.isDevMode;
+  }
+
   private initEthExecutionCounter(register: Registry) {
     const metricCounterName = 'rpc_relay_eth_executions';
     register.removeSingleMetric(metricCounterName);
@@ -842,6 +847,7 @@ export class EthImpl implements Eth {
     // this check is required, because some tools like Metamask pass for parameter latest block, with a number (ex 0x30ea)
     // tolerance is needed, because there is a small delay between requesting latest block from blockNumber and passing it here
     if (!this.common.blockTagIsLatestOrPending(blockNumberOrTagOrHash)) {
+      let blockHashNumber, isHash;
       const cacheKey = `${constants.CACHE_KEY.ETH_BLOCK_NUMBER}`;
       const blockNumberCached = this.cacheService.get(cacheKey, EthImpl.ethGetBalance, requestIdPrefix);
 
@@ -852,9 +858,6 @@ export class EthImpl implements Eth {
         latestBlock = await this.blockNumberTimestamp(EthImpl.ethGetBalance, requestIdPrefix);
       }
 
-      let blockHashNumber;
-      let isHash;
-
       if (blockNumberOrTagOrHash != null && blockNumberOrTagOrHash.length > 32) {
         isHash = true;
         blockHashNumber = await this.mirrorNodeClient.getBlock(blockNumberOrTagOrHash);
@@ -878,7 +881,7 @@ export class EthImpl implements Eth {
     // create a key for the cache
     const cacheKey = `${constants.CACHE_KEY.ETH_GET_BALANCE}-${account}-${blockNumberOrTagOrHash}`;
     let cachedBalance = this.cacheService.get(cacheKey, EthImpl.ethGetBalance, requestIdPrefix);
-    if (cachedBalance) {
+    if (cachedBalance && this.shouldUseCacheForBalance(blockNumberOrTagOrHash)) {
       this.logger.trace(`${requestIdPrefix} returning cached value ${cacheKey}:${JSON.stringify(cachedBalance)}`);
       return cachedBalance;
     }

packages/relay/src/lib/services/ethService/ethCommonService/index.ts

@@ -61,6 +61,7 @@ export class CommonService implements ICommonService {
   static blockLatest = 'latest';
   static blockEarliest = 'earliest';
   static blockPending = 'pending';
+  static isDevMode = process.env.DEV_MODE === 'true';
 
   // function callerNames
   static latestBlockNumber = 'getLatestBlockNumber';
@@ -77,6 +78,10 @@ export class CommonService implements ICommonService {
     this.cacheService = cacheService;
   }
 
+  public static blockTagIsLatestOrPendingStrict(tag: string | null): boolean {
+    return tag === CommonService.blockLatest || tag === CommonService.blockPending;
+  }
+
   public blockTagIsLatestOrPending = (tag) => {
     return tag == null || tag === CommonService.blockLatest || tag === CommonService.blockPending;
   };

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

@@ -1790,9 +1790,12 @@ describe('Eth calls using MirrorNode', async function () {
     });
   });
 
-  describe('eth_getBalance', async function () {
+  describe('@balance eth_getBalance', async function () {
     const defBalance = 99960581137;
+    const defBalanceSec = 99960581137 + 1;
     const defHexBalance = numberTo0x(BigInt(defBalance) * TINYBAR_TO_WEIBAR_COEF_BIGINT);
+    const defHexBalanceFunc = (defBalance) => numberTo0x(BigInt(defBalance) * TINYBAR_TO_WEIBAR_COEF_BIGINT);
+
     it('should return balance from mirror node', async () => {
       restMock.onGet(`blocks?limit=1&order=desc`).reply(200, {
         blocks: [
@@ -1852,6 +1855,37 @@ describe('Eth calls using MirrorNode', async function () {
       expect(newBalanceHex).to.equal(resBalanceNew);
     });
 
+    it('should not return balance for explicitly latest block from cache', async () => {
+      restMock.onGet(`blocks?limit=1&order=desc`).reply(200, {
+        blocks: [
+          {
+            number: 10000,
+          },
+        ],
+      });
+      restMock.onGet(`accounts/${contractAddress1}?limit=100`).reply(200, {
+        account: contractAddress1,
+        balance: {
+          balance: defBalance,
+        },
+      });
+
+      const resBalance = await ethImpl.getBalance(contractAddress1, 'latest', getRequestId());
+      expect(resBalance).to.equal(defHexBalance);
+      restMock.onGet(`accounts/${contractAddress1}?limit=100`).reply(200, {
+        account: contractAddress1,
+        balance: {
+          balance: defBalance + 1,
+        },
+      });
+
+      const resBalanceCached = await ethImpl.getBalance(contractAddress1, 'latest');
+      expect(
+        resBalanceCached,
+        `To equal the result from the request ${defHexBalanceFunc(defBalanceSec)} not from cache ${defHexBalance}`,
+      ).to.equal(defHexBalanceFunc(defBalanceSec));
+    });
+
     it('should return balance from mirror node with block number passed as param the same as latest', async () => {
       const blockNumber = '0x2710';
       restMock.onGet(`blocks?limit=1&order=desc`).reply(200, {