fix: bug where finalized and safe tags are cached (#2927)

* Fixes bug where finalized and safe tags are cached

Signed-off-by: Konstantina Blazhukova <[email protected]>

* Adds acceptance test for blockByNumber endpoint

Signed-off-by: Konstantina Blazhukova <[email protected]>

* fix: reused Utils.wait()

Signed-off-by: Logan Nguyen <[email protected]>

---------

Signed-off-by: Konstantina Blazhukova <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Co-authored-by: Logan Nguyen <[email protected]>

Author: konstantinabl

packages/relay/src/lib/eth.ts

@@ -1230,7 +1230,7 @@ export class EthImpl implements Eth {
         );
       });
 
-      if (blockNumOrTag != EthImpl.blockLatest && blockNumOrTag != EthImpl.blockPending) {
+      if (!this.common.blockTagIsLatestOrPending(blockNumOrTag)) {
         await this.cacheService.set(cacheKey, block, EthImpl.ethGetBlockByNumber, undefined, requestIdPrefix);
       }
     }

packages/server/tests/acceptance/rpc_batch1.spec.ts

@@ -544,6 +544,70 @@ describe('@api-batch-1 RPC Server Acceptance Tests', function () {
         Assertions.block(blockResult, mirrorBlock, mirrorTransactions, expectedGasPrice, false);
       });
 
+      it('should not cache "latest" block in "eth_getBlockByNumber" ', async function () {
+        const blockResult = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['latest', false],
+          requestId,
+        );
+        await Utils.wait(1000);
+
+        const blockResult2 = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['latest', false],
+          requestId,
+        );
+        expect(blockResult).to.not.deep.equal(blockResult2);
+      });
+
+      it('should not cache "finalized" block in "eth_getBlockByNumber" ', async function () {
+        const blockResult = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['finalized', false],
+          requestId,
+        );
+        await Utils.wait(1000);
+
+        const blockResult2 = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['finalized', false],
+          requestId,
+        );
+        expect(blockResult).to.not.deep.equal(blockResult2);
+      });
+
+      it('should not cache "safe" block in "eth_getBlockByNumber" ', async function () {
+        const blockResult = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['safe', false],
+          requestId,
+        );
+        await Utils.wait(1000);
+
+        const blockResult2 = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['safe', false],
+          requestId,
+        );
+        expect(blockResult).to.not.deep.equal(blockResult2);
+      });
+
+      it('should not cache "pending" block in "eth_getBlockByNumber" ', async function () {
+        const blockResult = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['pending', false],
+          requestId,
+        );
+        await Utils.wait(1000);
+
+        const blockResult2 = await relay.call(
+          RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,
+          ['pending', false],
+          requestId,
+        );
+        expect(blockResult).to.not.deep.equal(blockResult2);
+      });
+
       it('@release should execute "eth_getBlockByNumber", hydrated transactions = true', async function () {
         const blockResult = await relay.call(
           RelayCalls.ETH_ENDPOINTS.ETH_GET_BLOCK_BY_NUMBER,