Update eth_getLogs to utilize index across block transactions (0.3) (#325)

Nana-EC · web-flow · commit f67c2cfba044 · 2022-07-11T14:27:28.000-05:00
Update eth_getLogs to utilize index across block transactions (#314) * Update eth_getLogs to utilize index across block transactions Signed-off-by: Nana-EC <nana@swirldslabs.com>
diff --git a/packages/relay/src/lib/eth.ts b/packages/relay/src/lib/eth.ts
@@ -1134,7 +1134,7 @@ export class EthImpl implements Eth {
             blockHash: EthImpl.toHash32(detail.block_hash),
             blockNumber: detail.block_number,
             data: log.data,
-            logIndex: log.index,
+            logIndex: logIndex,
             removed: false,
             topics: log.topics,
             transactionHash: EthImpl.toHash32(detail.hash),
diff --git a/packages/relay/tests/lib/eth.spec.ts b/packages/relay/tests/lib/eth.spec.ts
@@ -204,6 +204,73 @@ describe('Eth calls using MirrorNode', async function () {
     }
   };
 
+  const defaultLogTopics = [
+    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+    "0x0000000000000000000000000000000000000000000000000000000000000000",
+    "0x000000000000000000000000000000000000000000000000000000000208fa13",
+    "0x0000000000000000000000000000000000000000000000000000000000000005"
+  ];
+
+
+  const logBloom1 = '0x1111';
+  const logBloom2 = '0x2222';
+  const logBloom3 = '0x3333';
+  const logBloom4 = '0x4444';
+
+  const defaultLogs1 = [
+    {
+      "address": "0x0000000000000000000000000000000002131951",
+      "bloom": logBloom1,
+      "contract_id": contractId1,
+      "data": "0x",
+      "index": 0,
+      "topics": defaultLogTopics,
+      "root_contract_id": "0.0.34806097",
+      "timestamp": contractTimestamp1
+    },
+    {
+      "address": "0x0000000000000000000000000000000002131951",
+      "bloom": logBloom2,
+      "contract_id": contractId1,
+      "data": "0x",
+      "index": 1,
+      "topics": defaultLogTopics,
+      "root_contract_id": "0.0.34806097",
+      "timestamp": contractTimestamp1
+    }
+  ];
+
+  const defaultLogs2 = [
+    {
+      "address": "0x0000000000000000000000000000000002131951",
+      "bloom": logBloom3,
+      "contract_id": contractId1,
+      "data": "0x",
+      "index": 0,
+      "topics": [],
+      "root_contract_id": "0.0.34806097",
+      "timestamp": contractTimestamp2
+    }
+  ];
+
+  const defaultLogs3 = [
+    {
+      "address": "0x0000000000000000000000000000000002131951",
+      "bloom": logBloom4,
+      "contract_id": contractId2,
+      "data": "0x",
+      "index": 0,
+      "topics": [],
+      "root_contract_id": "0.0.34806097",
+      "timestamp": contractTimestamp3
+    }
+  ];
+
+  const defaultLogsList = defaultLogs1.concat(defaultLogs2).concat(defaultLogs3);
+  const defaultLogs = {
+    "logs": defaultLogsList
+  };
+
   const defaultDetailedContractResults = {
     'access_list': '0x',
     'amount': 2000000000,
@@ -222,21 +289,7 @@ describe('Eth calls using MirrorNode', async function () {
     'gas_price': '0x4a817c80',
     'gas_used': 123,
     'hash': contractHash1,
-    'logs': [
-      {
-        'address': contractAddress1,
-        'bloom': '0x0123',
-        'contract_id': contractId1,
-        'data': '0x0123',
-        'index': 0,
-        'topics': [
-          '0x97c1fc0a6ed5551bc831571325e9bdb365d06803100dc20648640ba24ce69750',
-          '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
-          '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-          '0xe8d47b56e8cdfa95f871b19d4f50a857217c44a95502b0811a350fec1500dd67'
-        ]
-      },
-    ],
+    'logs': defaultLogs1,
     'max_fee_per_gas': '0x',
     'max_priority_fee_per_gas': '0x',
     'nonce': 1,
@@ -265,7 +318,8 @@ describe('Eth calls using MirrorNode', async function () {
       'timestamp': contractTimestamp2,
       'block_hash': blockHash2,
       'block_number': blockNumber2,
-      'hash': contractHash2
+      'hash': contractHash2,
+      'logs': defaultLogs2
     }
   };
 
@@ -276,6 +330,7 @@ describe('Eth calls using MirrorNode', async function () {
       'block_number': blockNumber3,
       'hash': contractHash3,
       'contract_id': contractId2,
+      'logs': defaultLogs3
     }
   };
 
@@ -290,63 +345,6 @@ describe('Eth calls using MirrorNode', async function () {
   const results = defaultContractResults.results;
   const totalGasUsed = EthImpl.numberTo0x(results[0].gas_used + results[1].gas_used);
 
-  const logBloom1 = '0x1111';
-  const logBloom2 = '0x2222';
-  const logBloom3 = '0x3333';
-  const logBloom4 = '0x4444';
-
-  const defaultLogTopics = [
-    "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
-    "0x0000000000000000000000000000000000000000000000000000000000000000",
-    "0x000000000000000000000000000000000000000000000000000000000208fa13",
-    "0x0000000000000000000000000000000000000000000000000000000000000005"
-  ];
-
-  const defaultLogs = {
-    "logs": [
-      {
-        "address": "0x0000000000000000000000000000000002131951",
-        "bloom": logBloom1,
-        "contract_id": contractId1,
-        "data": "0x",
-        "index": 0,
-        "topics": defaultLogTopics,
-        "root_contract_id": "0.0.34806097",
-        "timestamp": contractTimestamp1
-      },
-      {
-        "address": "0x0000000000000000000000000000000002131951",
-        "bloom": logBloom2,
-        "contract_id": contractId1,
-        "data": "0x",
-        "index": 1,
-        "topics": defaultLogTopics,
-        "root_contract_id": "0.0.34806097",
-        "timestamp": contractTimestamp1
-      },
-      {
-        "address": "0x0000000000000000000000000000000002131951",
-        "bloom": logBloom3,
-        "contract_id": contractId1,
-        "data": "0x",
-        "index": 0,
-        "topics": [],
-        "root_contract_id": "0.0.34806097",
-        "timestamp": contractTimestamp2
-      },
-      {
-        "address": "0x0000000000000000000000000000000002131951",
-        "bloom": logBloom4,
-        "contract_id": contractId2,
-        "data": "0x",
-        "index": 0,
-        "topics": [],
-        "root_contract_id": "0.0.34806097",
-        "timestamp": contractTimestamp3
-      }
-    ]
-  };
-
   const defaultNetworkFees = {
     'fees': [
       {
@@ -895,13 +893,13 @@ describe('Eth calls using MirrorNode', async function () {
 
   describe('eth_getLogs', async function () {
 
-    const expectLogData = (res, log, tx) => {
+    const expectLogData = (res, log, tx, blockLogIndexOffset) => {
       expect(res.address).to.eq(log.address);
       expect(res.blockHash).to.eq(EthImpl.toHash32(tx.block_hash));
       expect(res.blockHash.length).to.eq(66);
       expect(res.blockNumber).to.eq(tx.block_number);
       expect(res.data).to.eq(log.data);
-      expect(res.logIndex).to.eq(log.index);
+      expect(res.logIndex).to.eq(blockLogIndexOffset + log.index);
       expect(res.removed).to.eq(false);
       expect(res.topics).to.exist;
       expect(res.topics).to.deep.eq(log.topics);
@@ -911,19 +909,20 @@ describe('Eth calls using MirrorNode', async function () {
     };
 
     const expectLogData1 = (res) => {
-      expectLogData(res, defaultLogs.logs[0], defaultDetailedContractResults);
+      expectLogData(res, defaultLogs.logs[0], defaultDetailedContractResults, 0);
     };
 
     const expectLogData2 = (res) => {
-      expectLogData(res, defaultLogs.logs[1], defaultDetailedContractResults);
+      expectLogData(res, defaultLogs.logs[1], defaultDetailedContractResults, 0);
     };
 
     const expectLogData3 = (res) => {
-      expectLogData(res, defaultLogs.logs[2], defaultDetailedContractResults2);
+      expectLogData(res, defaultLogs.logs[2], defaultDetailedContractResults2, defaultDetailedContractResults.logs.length);
     };
 
+    const transaction3LogOffset = defaultDetailedContractResults.logs.length + defaultDetailedContractResults2.logs.length;
     const expectLogData4 = (res) => {
-      expectLogData(res, defaultLogs.logs[3], defaultDetailedContractResults3);
+      expectLogData(res, defaultLogs.logs[3], defaultDetailedContractResults3, transaction3LogOffset);
     };
 
     it('contract results details not found', async function () {
diff --git a/packages/server/tests/acceptance/rpc.spec.ts b/packages/server/tests/acceptance/rpc.spec.ts
@@ -19,12 +19,12 @@
  */
 
 // external resources
-import {expect} from 'chai';
-import {BigNumber, ethers} from 'ethers';
-import {AliasAccount} from '../clients/servicesClient';
+import { expect } from 'chai';
+import { BigNumber, ethers } from 'ethers';
+import { AliasAccount } from '../clients/servicesClient';
 import Assertions from '../helpers/assertions';
-import {Utils} from '../helpers/utils';
-import {AccountBalanceQuery, ContractFunctionParameters} from '@hashgraph/sdk';
+import { Utils } from '../helpers/utils';
+import { AccountBalanceQuery, ContractFunctionParameters } from '@hashgraph/sdk';
 
 // local resources
 import parentContractJson from '../contracts/Parent.json';
@@ -38,7 +38,7 @@ describe('RPC Server Acceptance Tests', function () {
     const accounts: AliasAccount[] = [];
 
     // @ts-ignore
-    const {servicesNode, mirrorNode, relay, logger} = global;
+    const { servicesNode, mirrorNode, relay, logger } = global;
 
     // cached entities
     let tokenId;
@@ -126,10 +126,13 @@ describe('RPC Server Acceptance Tests', function () {
                 const logs = await relay.call('eth_getLogs', [{}]);
                 expect(logs.length).to.be.greaterThan(0);
                 const txIndexLogIndexMapping: any[] = [];
-                for(let i in logs) {
+                for (const i in logs) {
                     expect(logs[i]).to.have.property('address');
                     expect(logs[i]).to.have.property('logIndex');
 
+                    // verify logIndex represents index in block across transactions
+                    expect(logs[i].logIndex).to.equal(Number(i));
+
                     const key = `${logs[i].transactionHash}---${logs[i].logIndex}`;
                     txIndexLogIndexMapping.push(key);
                 }
@@ -152,7 +155,7 @@ describe('RPC Server Acceptance Tests', function () {
                 expect(logs.length).to.be.greaterThan(0);
 
                 const log4BlockInt = parseInt(log4Block.blockNumber);
-                for(let i in logs) {
+                for (let i in logs) {
                     expect(logs[i].blockNumber).to.be.greaterThanOrEqual(log4BlockInt);
                 }
             });
@@ -164,7 +167,7 @@ describe('RPC Server Acceptance Tests', function () {
                 expect(logs.length).to.be.greaterThan(0);
 
                 const log0BlockInt = parseInt(log0Block.blockNumber);
-                for(let i in logs) {
+                for (let i in logs) {
                     expect(logs[i].blockNumber).to.be.lessThanOrEqual(log0BlockInt);
                 }
             });
@@ -184,29 +187,29 @@ describe('RPC Server Acceptance Tests', function () {
                 }
             });
 
-            it('should be able to use `address` param', async() => {
+            it('should be able to use `address` param', async () => {
                 const logs = await relay.call('eth_getLogs', [{
                     'address': contractAddress
                 }]);
                 expect(logs.length).to.be.greaterThan(0);
 
-                for(let i in logs) {
+                for (let i in logs) {
                     expect(logs[i].address).to.equal(contractAddress);
                 }
             });
 
-            it('should be able to use `blockHash` param', async() => {
+            it('should be able to use `blockHash` param', async () => {
                 const logs = await relay.call('eth_getLogs', [{
                     'blockHash': log0Block.blockHash
                 }]);
                 expect(logs.length).to.be.greaterThan(0);
 
-                for(let i in logs) {
+                for (let i in logs) {
                     expect(logs[i].blockHash).to.equal(log0Block.blockHash);
                 }
             });
 
-            it('should be able to use `topics` param', async() => {
+            it('should be able to use `topics` param', async () => {
                 const logs = await relay.call('eth_getLogs', [{
                     'fromBlock': log0Block.blockNumber,
                     'toBlock': log4Block.blockNumber,
@@ -221,7 +224,7 @@ describe('RPC Server Acceptance Tests', function () {
                 }]);
                 expect(logsWithTopic.length).to.be.greaterThan(0);
 
-                for(let i in logsWithTopic) {
+                for (let i in logsWithTopic) {
                     expect(logsWithTopic[i].topics.length).to.be.greaterThan(0);
                     expect(logsWithTopic[i].topics[0]).to.be.equal(topic);
                 }
@@ -450,7 +453,7 @@ describe('RPC Server Acceptance Tests', function () {
                         await relay.sendRawTransaction(signedTx);
                         Assertions.expectedError();
                     }
-                    catch(e) {
+                    catch (e) {
                         Assertions.jsonRpcError(e, predefined.UNSUPPORTED_CHAIN_ID(ethers.utils.hexValue(INCORRECT_CHAIN_ID), CHAIN_ID));
                     }
                 });
@@ -963,7 +966,7 @@ describe('RPC Server Acceptance Tests', function () {
                 lastBlockAfterUpdate = (await mirrorNode.get(`/blocks?limit=1&order=desc`)).blocks[0];
             });
 
-            it('should call eth_feeHistory with updated fees', async function() {
+            it('should call eth_feeHistory with updated fees', async function () {
                 const blockCountNumber = lastBlockAfterUpdate.number - lastBlockBeforeUpdate.number;
                 const blockCountHex = ethers.utils.hexValue(blockCountNumber);
                 const datedGasPriceHex = ethers.utils.hexValue(Assertions.datedGasPrice);
@@ -973,14 +976,14 @@ describe('RPC Server Acceptance Tests', function () {
 
                 const res = await relay.call('eth_feeHistory', [blockCountHex, newestBlockNumberHex, [0]]);
 
-                Assertions.feeHistory(res, {resultCount: blockCountNumber, oldestBlock: oldestBlockNumberHex, chechReward: true});
+                Assertions.feeHistory(res, { resultCount: blockCountNumber, oldestBlock: oldestBlockNumberHex, chechReward: true });
 
                 expect(res.baseFeePerGas[0]).to.equal(datedGasPriceHex);
                 expect(res.baseFeePerGas[res.baseFeePerGas.length - 2]).to.equal(updatedGasPriceHex);
                 expect(res.baseFeePerGas[res.baseFeePerGas.length - 1]).to.equal(updatedGasPriceHex);
             });
 
-            it('should call eth_feeHistory with newest block > latest', async function() {
+            it('should call eth_feeHistory with newest block > latest', async function () {
                 let latestBlock;
                 const newestBlockNumber = lastBlockAfterUpdate.number + 10;
                 const newestBlockNumberHex = ethers.utils.hexValue(newestBlockNumber);
@@ -992,7 +995,7 @@ describe('RPC Server Acceptance Tests', function () {
                 }
             });
 
-            it('should call eth_feeHistory with zero block count', async function() {
+            it('should call eth_feeHistory with zero block count', async function () {
                 const res = await relay.call('eth_feeHistory', ['0x0', 'latest', null]);
 
                 expect(res.reward).to.not.exist;
