Support events handlers in multiple data sources for a contract addre…

…ss (#526) * Support processing events in multiple subgraph datasources for a single contract address * Fix parsing event topic in graph-node watcher * Update codegen templates * Fix dummy indexer method in graph-node test * Upgrade package versions to 0.2.102
cerc-io · Jun 26, 2024 · 2217cd3 · 2217cd3
1 parent b9a899a
commit 2217cd3
Show file tree

Hide file tree

Showing 22 changed files with 212 additions and 157 deletions.
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.101",
+  "version": "0.2.102",
   "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.101",
+  "version": "0.2.102",
   "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.101",
+  "version": "0.2.102",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "scripts": {
@@ -15,13 +15,13 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.1",
-    "@cerc-io/cache": "^0.2.101",
-    "@cerc-io/ipld-eth-client": "^0.2.101",
+    "@cerc-io/cache": "^0.2.102",
+    "@cerc-io/ipld-eth-client": "^0.2.102",
     "@cerc-io/libp2p": "^0.42.2-laconic-0.1.4",
     "@cerc-io/nitro-node": "^0.1.15",
-    "@cerc-io/peer": "^0.2.101",
-    "@cerc-io/rpc-eth-client": "^0.2.101",
-    "@cerc-io/util": "^0.2.101",
+    "@cerc-io/peer": "^0.2.102",
+    "@cerc-io/rpc-eth-client": "^0.2.102",
+    "@cerc-io/util": "^0.2.102",
     "@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.101",
+  "version": "0.2.102",
   "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.101",
+    "@cerc-io/util": "^0.2.102",
     "@graphql-tools/load-files": "^6.5.2",
     "@npmcli/package-json": "^5.0.0",
     "@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",

diff --git a/packages/codegen/src/data/entities/Contract.yaml b/packages/codegen/src/data/entities/Contract.yaml
@@ -2,6 +2,7 @@ className: Contract
 indexOn:
   - columns:
       - address
+      - kind
     unique: true
 columns:
   - name: id

diff --git a/packages/codegen/src/templates/indexer-template.handlebars b/packages/codegen/src/templates/indexer-template.handlebars
@@ -525,23 +525,27 @@ export class Indexer implements IndexerInterface {
   }
 
   {{/if}}
-  parseEventNameAndArgs (kind: string, logObj: any): { eventParsed: boolean, eventDetails: any } {
+  parseEventNameAndArgs (watchedContracts: Contract[], logObj: any): { eventParsed: boolean, eventDetails: any } {
     const { topics, data } = logObj;
-
-    const contract = this._contractMap.get(kind);
-    assert(contract);
-
-    let logDescription: ethers.utils.LogDescription;
-    try {
-      logDescription = contract.parseLog({ data, topics });
-    } catch (err) {
-      // Return if no matching event found
-      if ((err as Error).message.includes('no matching event')) {
-        log(`WARNING: Skipping event for contract ${kind} as no matching event found in the ABI`);
-        return { eventParsed: false, eventDetails: {} };
+    let logDescription: ethers.utils.LogDescription | undefined;
+
+    for (const watchedContract of watchedContracts) {
+      const contract = this._contractMap.get(watchedContract.kind);
+      assert(contract);
+
+      try {
+        logDescription = contract.parseLog({ data, topics });
+        break;
+      } catch (err) {
+        // Continue loop only if no matching event found
+        if (!((err as Error).message.includes('no matching event'))) {
+          throw err;
+        }
       }
+    }
 
-      throw err;
+    if (!logDescription) {
+      return { eventParsed: false, eventDetails: {} };
     }
 
     const { eventName, eventInfo, eventSignature } = this._baseIndexer.parseEvent(logDescription);
@@ -647,8 +651,8 @@ export class Indexer implements IndexerInterface {
     return this._baseIndexer.getEventsByFilter(blockHash, contract, name);
   }
 
-  isWatchedContract (address : string): Contract | undefined {
-    return this._baseIndexer.isWatchedContract(address);
+  isContractAddressWatched (address : string): Contract[] | undefined {
+    return this._baseIndexer.isContractAddressWatched(address);
   }
 
   getWatchedContracts (): Contract[] {

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.101",
-    "@cerc-io/ipld-eth-client": "^0.2.101",
-    "@cerc-io/solidity-mapper": "^0.2.101",
-    "@cerc-io/util": "^0.2.101",
+    "@cerc-io/cli": "^0.2.102",
+    "@cerc-io/ipld-eth-client": "^0.2.102",
+    "@cerc-io/solidity-mapper": "^0.2.102",
+    "@cerc-io/util": "^0.2.102",
     {{#if (subgraphPath)}}
-    "@cerc-io/graph-node": "^0.2.101",
+    "@cerc-io/graph-node": "^0.2.102",
     {{/if}}
     "@ethersproject/providers": "^5.4.4",
     "debug": "^4.3.1",

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.101",
+  "version": "0.2.102",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/solidity-mapper": "^0.2.101",
+    "@cerc-io/solidity-mapper": "^0.2.102",
     "@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.101",
-    "@cerc-io/ipld-eth-client": "^0.2.101",
-    "@cerc-io/util": "^0.2.101",
+    "@cerc-io/cache": "^0.2.102",
+    "@cerc-io/ipld-eth-client": "^0.2.102",
+    "@cerc-io/util": "^0.2.102",
     "@types/json-diff": "^0.5.2",
     "@types/yargs": "^17.0.0",
     "bn.js": "^4.11.9",

diff --git a/packages/graph-node/src/loader.ts b/packages/graph-node/src/loader.ts
@@ -50,6 +50,7 @@ export interface Context {
   rpcSupportsBlockHashParam: boolean;
   block?: Block;
   contractAddress?: string;
+  dataSourceName?: string;
 }
 
 const log = debug('vulcanize:graph-node');
@@ -719,13 +720,14 @@ export const instantiate = async (
       },
       'dataSource.context': async () => {
         assert(context.contractAddress);
-        const contract = indexer.isWatchedContract(context.contractAddress);
+        const watchedContracts = indexer.isContractAddressWatched(context.contractAddress);
+        const dataSourceContract = watchedContracts?.find(contract => contract.kind === context.dataSourceName);
 
-        if (!contract) {
+        if (!dataSourceContract) {
           return null;
         }
 
-        return database.toGraphContext(instanceExports, contract.context);
+        return database.toGraphContext(instanceExports, dataSourceContract.context);
       },
       'dataSource.network': async () => {
         assert(dataSource);

diff --git a/packages/graph-node/src/watcher.ts b/packages/graph-node/src/watcher.ts
@@ -169,15 +169,14 @@ export class GraphWatcher {
   async addContracts () {
     assert(this._indexer);
     assert(this._indexer.watchContract);
-    assert(this._indexer.isWatchedContract);
 
     // Watching the contract(s) if not watched already.
     for (const dataSource of this._dataSources) {
       const { source: { address, startBlock }, name } = dataSource;
 
       // Skip for templates as they are added dynamically.
       if (address) {
-        const watchedContract = await this._indexer.isWatchedContract(address);
+        const watchedContract = this._indexer.isContractAddressWatched(address);
 
         if (!watchedContract) {
           await this._indexer.watchContract(address, name, true, startBlock);
@@ -197,64 +196,79 @@ export class GraphWatcher {
     const blockData = this._context.block;
     assert(blockData);
 
-    assert(this._indexer && this._indexer.isWatchedContract);
-    const watchedContract = this._indexer.isWatchedContract(contract);
-    assert(watchedContract);
+    assert(this._indexer);
+    const watchedContracts = this._indexer.isContractAddressWatched(contract);
+    assert(watchedContracts);
 
-    // Get dataSource in subgraph yaml based on contract address.
-    const dataSource = this._dataSources.find(dataSource => dataSource.name === watchedContract.kind);
+    // Get dataSources in subgraph yaml based on contract kind (same as dataSource.name)
+    const dataSources = this._dataSources
+      .filter(dataSource => watchedContracts.some(contract => contract.kind === dataSource.name));
 
-    if (!dataSource) {
+    if (!dataSources.length) {
       log(`Subgraph doesn't have configuration for contract ${contract}`);
       return;
     }
 
-    this._context.contractAddress = contract;
+    for (const dataSource of dataSources) {
+      this._context.contractAddress = contract;
+      this._context.dataSourceName = dataSource.name;
 
-    const { instance, contractInterface } = this._dataSourceMap[watchedContract.kind];
-    assert(instance);
-    const { exports: instanceExports } = instance;
-
-    // Get event handler based on event topic (from event signature).
-    const eventTopic = contractInterface.getEventTopic(eventSignature);
-    const eventHandler = dataSource.mapping.eventHandlers.find((eventHandler: any) => {
-      // The event signature we get from logDescription is different than that given in the subgraph yaml file.
-      // For eg. event in subgraph.yaml: Stake(indexed address,uint256); from logDescription: Stake(address,uint256)
-      // ethers.js doesn't recognize the subgraph event signature with indexed keyword before param type.
-      // Match event topics from cleaned subgraph event signature (Stake(indexed address,uint256) -> Stake(address,uint256)).
-      const subgraphEventTopic = contractInterface.getEventTopic(eventHandler.event.replace(/indexed /g, ''));
-
-      return subgraphEventTopic === eventTopic;
-    });
+      const { instance, contractInterface } = this._dataSourceMap[dataSource.name];
+      assert(instance);
+      const { exports: instanceExports } = instance;
+      let eventTopic: string;
+
+      try {
+        eventTopic = contractInterface.getEventTopic(eventSignature);
+      } catch (err) {
+        // Continue loop only if no matching event found
+        if (!((err as Error).message.includes('no matching event'))) {
+          throw err;
+        }
 
-    if (!eventHandler) {
-      log(`No handler configured in subgraph for event ${eventSignature}`);
-      return;
-    }
+        continue;
+      }
 
-    const eventFragment = contractInterface.getEvent(eventSignature);
+      // Get event handler based on event topic (from event signature).
+      const eventHandler = dataSource.mapping.eventHandlers.find((eventHandler: any) => {
+        // The event signature we get from logDescription is different than that given in the subgraph yaml file.
+        // For eg. event in subgraph.yaml: Stake(indexed address,uint256); from logDescription: Stake(address,uint256)
+        // ethers.js doesn't recognize the subgraph event signature with indexed keyword before param type.
+        // Match event topics from cleaned subgraph event signature (Stake(indexed address,uint256) -> Stake(address,uint256)).
+        const subgraphEventTopic = contractInterface.getEventTopic(eventHandler.event.replace(/indexed /g, ''));
 
-    const tx = this._getTransactionData(txHash, extraData.ethFullTransactions);
+        return subgraphEventTopic === eventTopic;
+      });
 
-    const data = {
-      block: blockData,
-      inputs: eventFragment.inputs,
-      event,
-      tx,
-      eventIndex
-    };
+      if (!eventHandler) {
+        log(`No handler configured in subgraph for event ${eventSignature}`);
+        return;
+      }
 
-    // Create ethereum event to be passed to the wasm event handler.
-    console.time(`time:graph-watcher#handleEvent-createEvent-block-${block.number}-event-${eventSignature}`);
-    const ethereumEvent = await createEvent(instanceExports, contract, data);
-    console.timeEnd(`time:graph-watcher#handleEvent-createEvent-block-${block.number}-event-${eventSignature}`);
-    try {
-      console.time(`time:graph-watcher#handleEvent-exec-${dataSource.name}-event-handler-${eventSignature}`);
-      await this._handleMemoryError(instanceExports[eventHandler.handler](ethereumEvent), dataSource.name);
-      console.timeEnd(`time:graph-watcher#handleEvent-exec-${dataSource.name}-event-handler-${eventSignature}`);
-    } catch (error) {
-      this._clearCachedEntities();
-      throw error;
+      const eventFragment = contractInterface.getEvent(eventSignature);
+
+      const tx = this._getTransactionData(txHash, extraData.ethFullTransactions);
+
+      const data = {
+        block: blockData,
+        inputs: eventFragment.inputs,
+        event,
+        tx,
+        eventIndex
+      };
+
+      // Create ethereum event to be passed to the wasm event handler.
+      console.time(`time:graph-watcher#handleEvent-createEvent-block-${block.number}-event-${eventSignature}`);
+      const ethereumEvent = await createEvent(instanceExports, contract, data);
+      console.timeEnd(`time:graph-watcher#handleEvent-createEvent-block-${block.number}-event-${eventSignature}`);
+      try {
+        console.time(`time:graph-watcher#handleEvent-exec-${dataSource.name}-event-handler-${eventSignature}`);
+        await this._handleMemoryError(instanceExports[eventHandler.handler](ethereumEvent), dataSource.name);
+        console.timeEnd(`time:graph-watcher#handleEvent-exec-${dataSource.name}-event-handler-${eventSignature}`);
+      } catch (error) {
+        this._clearCachedEntities();
+        throw error;
+      }
     }
   }
 
@@ -311,6 +325,7 @@ export class GraphWatcher {
 
       for (const contractAddress of contractAddressList) {
         this._context.contractAddress = contractAddress;
+        this._context.dataSourceName = dataSource.name;
 
         // Call all the block handlers one after another for a contract.
         const blockHandlerPromises = dataSource.mapping.blockHandlers.map(async (blockHandler: any): Promise<void> => {

diff --git a/packages/graph-node/test/utils/indexer.ts b/packages/graph-node/test/utils/indexer.ts
@@ -248,7 +248,7 @@ export class Indexer implements IndexerInterface {
     return undefined;
   }
 
-  isWatchedContract (address : string): ContractInterface | undefined {
+  isContractAddressWatched (address : string): ContractInterface[] | undefined {
     return undefined;
   }
 

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.101",
+  "version": "0.2.102",
   "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.101",
-    "@cerc-io/util": "^0.2.101",
+    "@cerc-io/cache": "^0.2.102",
+    "@cerc-io/util": "^0.2.102",
     "cross-fetch": "^3.1.4",
     "debug": "^4.3.1",
     "ethers": "^5.4.4",

diff --git a/packages/peer/package.json b/packages/peer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/peer",
-  "version": "0.2.101",
+  "version": "0.2.102",
   "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.101",
+  "version": "0.2.102",
   "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.101",
-    "@cerc-io/ipld-eth-client": "^0.2.101",
-    "@cerc-io/util": "^0.2.101",
+    "@cerc-io/cache": "^0.2.102",
+    "@cerc-io/ipld-eth-client": "^0.2.102",
+    "@cerc-io/util": "^0.2.102",
     "chai": "^4.3.4",
     "ethers": "^5.4.4",
     "left-pad": "^1.3.0",