Support filtering by topics when fetching logs in rpc-eth-client (#441)

* Support filtering by topics when fetching logs * Include event signatures from all contracts in topics list * Refactor common code * Update package versions
cerc-io · Oct 26, 2023 · a8e59eb · a8e59eb
1 parent 43463af
commit a8e59eb
Show file tree

Hide file tree

Showing 21 changed files with 178 additions and 147 deletions.
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.66",
+  "version": "0.2.67",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

diff --git a/packages/cache/package.json b/packages/cache/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cache",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "Generic object cache",
   "main": "dist/index.js",
   "scripts": {

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cli",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "scripts": {
@@ -12,13 +12,13 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.1",
-    "@cerc-io/cache": "^0.2.66",
-    "@cerc-io/ipld-eth-client": "^0.2.66",
+    "@cerc-io/cache": "^0.2.67",
+    "@cerc-io/ipld-eth-client": "^0.2.67",
     "@cerc-io/libp2p": "^0.42.2-laconic-0.1.4",
     "@cerc-io/nitro-node": "^0.1.15",
-    "@cerc-io/peer": "^0.2.66",
-    "@cerc-io/rpc-eth-client": "^0.2.66",
-    "@cerc-io/util": "^0.2.66",
+    "@cerc-io/peer": "^0.2.67",
+    "@cerc-io/rpc-eth-client": "^0.2.67",
+    "@cerc-io/util": "^0.2.67",
     "@ethersproject/providers": "^5.4.4",
     "@graphql-tools/utils": "^9.1.1",
     "@ipld/dag-cbor": "^8.0.0",

diff --git a/packages/codegen/package.json b/packages/codegen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/codegen",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "Code generator",
   "private": true,
   "main": "index.js",
@@ -20,7 +20,7 @@
   },
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
-    "@cerc-io/util": "^0.2.66",
+    "@cerc-io/util": "^0.2.67",
     "@graphql-tools/load-files": "^6.5.2",
     "@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",
     "@solidity-parser/parser": "^0.13.2",

diff --git a/packages/codegen/src/templates/config-template.handlebars b/packages/codegen/src/templates/config-template.handlebars
@@ -23,8 +23,11 @@
   clearEntitiesCacheInterval = 1000
 
   {{/if}}
-  # Boolean to filter logs by contract.
-  filterLogs = false
+  # Boolean to filter logs by contracts.
+  filterLogsByAddresses = false
+
+  # Boolean to filter logs by topics.
+  filterLogsByTopics = false
 
   # Max block range for which to return events in eventsInRange GQL query.
   # Use -1 for skipping check on block range.

diff --git a/packages/codegen/src/templates/indexer-template.handlebars b/packages/codegen/src/templates/indexer-template.handlebars
@@ -96,6 +96,7 @@ export class Indexer implements IndexerInterface {
   _abiMap: Map<string, JsonFragment[]>;
   _storageLayoutMap: Map<string, StorageLayout>;
   _contractMap: Map<string, ethers.utils.Interface>;
+  _eventSignaturesMap: Map<string, string[]>;
 
   {{#if (subgraphPath)}}
   _entityTypesMap: Map<string, { [key: string]: string }>;
@@ -121,6 +122,9 @@ export class Indexer implements IndexerInterface {
     this._abiMap = new Map();
     this._storageLayoutMap = new Map();
     this._contractMap = new Map();
+    this._eventSignaturesMap = new Map();
+    let contractInterface: ethers.utils.Interface;
+    let eventSignatures: string[];
     {{#each contracts as | contract |}}
 
     const { abi: {{contract.contractName}}ABI{{#if contract.contractStorageLayout}}, storageLayout: {{contract.contractName}}StorageLayout{{/if}} } = {{contract.contractName}}Artifacts;
@@ -129,11 +133,19 @@ export class Indexer implements IndexerInterface {
 
     assert({{contract.contractName}}ABI);
     this._abiMap.set(KIND_{{capitalize contract.contractName}}, {{contract.contractName}}ABI);
+
+    contractInterface = new ethers.utils.Interface({{contract.contractName}}ABI);
+    this._contractMap.set(KIND_{{capitalize contract.contractName}}, contractInterface);
+
+    eventSignatures = Object.values(contractInterface.events).map(value => {
+      return contractInterface.getEventTopic(value);
+    });
+    this._eventSignaturesMap.set(KIND_{{capitalize contract.contractName}}, eventSignatures);
     {{#if contract.contractStorageLayout}}
+
     assert({{contract.contractName}}StorageLayout);
     this._storageLayoutMap.set(KIND_{{capitalize contract.contractName}}, {{contract.contractName}}StorageLayout);
     {{/if}}
-    this._contractMap.set(KIND_{{capitalize contract.contractName}}, new ethers.utils.Interface({{contract.contractName}}ABI));
     {{/each}}
     {{#if (subgraphPath)}}
 
@@ -642,7 +654,7 @@ export class Indexer implements IndexerInterface {
   }
 
   async fetchEventsAndSaveBlocks (blocks: DeepPartial<BlockProgress>[]): Promise<{ blockProgress: BlockProgress, events: DeepPartial<Event>[] }[]> {
-    return this._baseIndexer.fetchEventsAndSaveBlocks(blocks, this.parseEventNameAndArgs.bind(this));
+    return this._baseIndexer.fetchEventsAndSaveBlocks(blocks, this._eventSignaturesMap, this.parseEventNameAndArgs.bind(this));
   }
 
   async saveBlockAndFetchEvents (block: DeepPartial<BlockProgress>): Promise<[BlockProgress, DeepPartial<Event>[]]> {
@@ -762,7 +774,7 @@ export class Indexer implements IndexerInterface {
     assert(blockHash);
     assert(blockNumber);
 
-    const dbEvents = await this._baseIndexer.fetchEvents(blockHash, blockNumber, this.parseEventNameAndArgs.bind(this));
+    const dbEvents = await this._baseIndexer.fetchEvents(blockHash, blockNumber, this._eventSignaturesMap, this.parseEventNameAndArgs.bind(this));
 
     const dbTx = await this._db.createTransactionRunner();
     try {

diff --git a/packages/codegen/src/templates/package-template.handlebars b/packages/codegen/src/templates/package-template.handlebars
@@ -41,12 +41,12 @@
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
     "@apollo/client": "^3.3.19",
-    "@cerc-io/cli": "^0.2.65",
-    "@cerc-io/ipld-eth-client": "^0.2.65",
-    "@cerc-io/solidity-mapper": "^0.2.65",
-    "@cerc-io/util": "^0.2.65",
+    "@cerc-io/cli": "^0.2.67",
+    "@cerc-io/ipld-eth-client": "^0.2.67",
+    "@cerc-io/solidity-mapper": "^0.2.67",
+    "@cerc-io/util": "^0.2.67",
     {{#if (subgraphPath)}}
-    "@cerc-io/graph-node": "^0.2.65",
+    "@cerc-io/graph-node": "^0.2.67",
     {{/if}}
     "@ethersproject/providers": "^5.4.4",
     "apollo-type-bigint": "^0.1.3",

diff --git a/packages/graph-node/package.json b/packages/graph-node/package.json
@@ -1,10 +1,10 @@
 {
   "name": "@cerc-io/graph-node",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/solidity-mapper": "^0.2.66",
+    "@cerc-io/solidity-mapper": "^0.2.67",
     "@ethersproject/providers": "^5.4.4",
     "@graphprotocol/graph-ts": "^0.22.0",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
@@ -51,9 +51,9 @@
   "dependencies": {
     "@apollo/client": "^3.3.19",
     "@cerc-io/assemblyscript": "0.19.10-watcher-ts-0.1.2",
-    "@cerc-io/cache": "^0.2.66",
-    "@cerc-io/ipld-eth-client": "^0.2.66",
-    "@cerc-io/util": "^0.2.66",
+    "@cerc-io/cache": "^0.2.67",
+    "@cerc-io/ipld-eth-client": "^0.2.67",
+    "@cerc-io/util": "^0.2.67",
     "@types/json-diff": "^0.5.2",
     "@types/yargs": "^17.0.0",
     "bn.js": "^4.11.9",

diff --git a/packages/ipld-eth-client/package.json b/packages/ipld-eth-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/ipld-eth-client",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "IPLD ETH Client",
   "main": "dist/index.js",
   "scripts": {
@@ -20,8 +20,8 @@
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
     "@apollo/client": "^3.7.1",
-    "@cerc-io/cache": "^0.2.66",
-    "@cerc-io/util": "^0.2.66",
+    "@cerc-io/cache": "^0.2.67",
+    "@cerc-io/util": "^0.2.67",
     "cross-fetch": "^3.1.4",
     "debug": "^4.3.1",
     "ethers": "^5.4.4",

diff --git a/packages/ipld-eth-client/src/eth-client.ts b/packages/ipld-eth-client/src/eth-client.ts
@@ -133,6 +133,7 @@ export class EthClient implements EthClientInterface {
     };
   }
 
+  // TODO: Support filtering logs using topics
   async getLogs (vars: Vars): Promise<any> {
     console.time(`time:eth-client#getLogs-${JSON.stringify(vars)}`);
     const result = await this._getCachedOrFetch('getLogs', vars);

diff --git a/packages/peer/package.json b/packages/peer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/peer",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "libp2p module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",

diff --git a/packages/rpc-eth-client/package.json b/packages/rpc-eth-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/rpc-eth-client",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "RPC ETH Client",
   "main": "dist/index.js",
   "scripts": {
@@ -19,9 +19,9 @@
   },
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
-    "@cerc-io/cache": "^0.2.66",
-    "@cerc-io/ipld-eth-client": "^0.2.66",
-    "@cerc-io/util": "^0.2.66",
+    "@cerc-io/cache": "^0.2.67",
+    "@cerc-io/ipld-eth-client": "^0.2.67",
+    "@cerc-io/util": "^0.2.67",
     "chai": "^4.3.4",
     "ethers": "^5.4.4",
     "left-pad": "^1.3.0",

diff --git a/packages/rpc-eth-client/src/eth-client.ts b/packages/rpc-eth-client/src/eth-client.ts
@@ -21,6 +21,7 @@ interface Vars {
   contract?: string;
   slot?: string;
   addresses?: string[];
+  topics?: string[][];
   fromBlock?: number;
   toBlock?: number;
 }
@@ -235,12 +236,18 @@ export class EthClient implements EthClientInterface {
   async getLogs (vars: {
     blockHash: string,
     blockNumber: string,
-    addresses?: string[]
+    addresses?: string[],
+    topics?: string[][]
   }): Promise<any> {
     const blockNumber = Number(vars.blockNumber);
 
     console.time(`time:eth-client#getLogs-${JSON.stringify(vars)}`);
-    const result = await this._getLogs({ fromBlock: blockNumber, toBlock: blockNumber, addresses: vars.addresses });
+    const result = await this._getLogs({
+      fromBlock: blockNumber,
+      toBlock: blockNumber,
+      addresses: vars.addresses,
+      topics: vars.topics
+    });
     console.timeEnd(`time:eth-client#getLogs-${JSON.stringify(vars)}`);
 
     return result;
@@ -249,10 +256,16 @@ export class EthClient implements EthClientInterface {
   async getLogsForBlockRange (vars: {
     fromBlock?: number,
     toBlock?: number,
-    addresses?: string[]
+    addresses?: string[],
+    topics?: string[][]
   }): Promise<any> {
     console.time(`time:eth-client#getLogsForBlockRange-${JSON.stringify(vars)}`);
-    const result = await this._getLogs({ fromBlock: Number(vars.fromBlock), toBlock: Number(vars.toBlock), addresses: vars.addresses });
+    const result = await this._getLogs({
+      fromBlock: Number(vars.fromBlock),
+      toBlock: Number(vars.toBlock),
+      addresses: vars.addresses,
+      topics: vars.topics
+    });
     console.timeEnd(`time:eth-client#getLogsForBlockRange-${JSON.stringify(vars)}`);
 
     return result;
@@ -262,9 +275,10 @@ export class EthClient implements EthClientInterface {
   async _getLogs (vars: {
     fromBlock?: number,
     toBlock?: number,
-    addresses?: string[]
+    addresses?: string[],
+    topics?: string[][]
   }): Promise<any> {
-    const { fromBlock, toBlock, addresses = [] } = vars;
+    const { fromBlock, toBlock, addresses = [], topics } = vars;
 
     const result = await this._getCachedOrFetch(
       'getLogs',
@@ -273,7 +287,8 @@ export class EthClient implements EthClientInterface {
         const logsByAddressPromises = addresses?.map(address => this._provider.getLogs({
           fromBlock,
           toBlock,
-          address
+          address,
+          topics
         }));
         const logsByAddress = await Promise.all(logsByAddressPromises);
         let logs = logsByAddress.flat();
@@ -282,7 +297,8 @@ export class EthClient implements EthClientInterface {
         if (!addresses.length) {
           logs = await this._provider.getLogs({
             fromBlock,
-            toBlock
+            toBlock,
+            topics
           });
         }
 

diff --git a/packages/solidity-mapper/package.json b/packages/solidity-mapper/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/solidity-mapper",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {

diff --git a/packages/test/package.json b/packages/test/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/test",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "private": true,

diff --git a/packages/tracing-client/package.json b/packages/tracing-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/tracing-client",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "description": "ETH VM tracing client",
   "main": "dist/index.js",
   "scripts": {

diff --git a/packages/util/package.json b/packages/util/package.json
@@ -1,13 +1,13 @@
 {
   "name": "@cerc-io/util",
-  "version": "0.2.66",
+  "version": "0.2.67",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "dependencies": {
     "@apollo/utils.keyvaluecache": "^1.0.1",
     "@cerc-io/nitro-node": "^0.1.15",
-    "@cerc-io/peer": "^0.2.66",
-    "@cerc-io/solidity-mapper": "^0.2.66",
+    "@cerc-io/peer": "^0.2.67",
+    "@cerc-io/solidity-mapper": "^0.2.67",
     "@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
     "@ethersproject/properties": "^5.7.0",
     "@ethersproject/providers": "^5.4.4",
@@ -51,7 +51,7 @@
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "@cerc-io/cache": "^0.2.66",
+    "@cerc-io/cache": "^0.2.67",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@types/bunyan": "^1.8.8",
     "@types/express": "^4.17.14",