[WIP] Skip contract events if no match found in ABI (#503)

* Skip contract events if no match found in ABI

* Update package versions

lerna.json

@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.82",
+  "version": "0.2.83",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

packages/cache/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cache",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "description": "Generic object cache",
   "main": "dist/index.js",
   "scripts": {

packages/cli/package.json

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

packages/codegen/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/codegen",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "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.82",
+    "@cerc-io/util": "^0.2.83",
     "@graphql-tools/load-files": "^6.5.2",
     "@npmcli/package-json": "^5.0.0",
     "@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",

packages/codegen/src/templates/indexer-template.handlebars

@@ -512,20 +512,34 @@ export class Indexer implements IndexerInterface {
   }
 
   {{/if}}
-  parseEventNameAndArgs (kind: string, logObj: any): any {
+  parseEventNameAndArgs (kind: string, logObj: any): { eventParsed: boolean, eventDetails: any } {
     const { topics, data } = logObj;
 
     const contract = this._contractMap.get(kind);
     assert(contract);
 
-    const logDescription = contract.parseLog({ data, topics });
+    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: {} };
+      }
+
+      throw err;
+    }
 
     const { eventName, eventInfo, eventSignature } = this._baseIndexer.parseEvent(logDescription);
 
     return {
-      eventName,
+      eventParsed: true,
-      eventInfo,
+      eventDetails: {
-      eventSignature
+        eventName,
+        eventInfo,
+        eventSignature
+      }
     };
   }
 

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

packages/graph-node/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@cerc-io/graph-node",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/solidity-mapper": "^0.2.82",
+    "@cerc-io/solidity-mapper": "^0.2.83",
     "@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.82",
+    "@cerc-io/cache": "^0.2.83",
-    "@cerc-io/ipld-eth-client": "^0.2.82",
+    "@cerc-io/ipld-eth-client": "^0.2.83",
-    "@cerc-io/util": "^0.2.82",
+    "@cerc-io/util": "^0.2.83",
     "@types/json-diff": "^0.5.2",
     "@types/yargs": "^17.0.0",
     "bn.js": "^4.11.9",

packages/ipld-eth-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/ipld-eth-client",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "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.82",
+    "@cerc-io/cache": "^0.2.83",
-    "@cerc-io/util": "^0.2.82",
+    "@cerc-io/util": "^0.2.83",
     "cross-fetch": "^3.1.4",
     "debug": "^4.3.1",
     "ethers": "^5.4.4",

packages/peer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/peer",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "description": "libp2p module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",

packages/rpc-eth-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/rpc-eth-client",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "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.82",
+    "@cerc-io/cache": "^0.2.83",
-    "@cerc-io/ipld-eth-client": "^0.2.82",
+    "@cerc-io/ipld-eth-client": "^0.2.83",
-    "@cerc-io/util": "^0.2.82",
+    "@cerc-io/util": "^0.2.83",
     "chai": "^4.3.4",
     "ethers": "^5.4.4",
     "left-pad": "^1.3.0",

packages/solidity-mapper/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/solidity-mapper",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {

packages/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/test",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "private": true,

packages/tracing-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/tracing-client",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "description": "ETH VM tracing client",
   "main": "dist/index.js",
   "scripts": {

packages/util/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@cerc-io/util",
-  "version": "0.2.82",
+  "version": "0.2.83",
   "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.82",
+    "@cerc-io/peer": "^0.2.83",
-    "@cerc-io/solidity-mapper": "^0.2.82",
+    "@cerc-io/solidity-mapper": "^0.2.83",
     "@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
     "@ethersproject/properties": "^5.7.0",
     "@ethersproject/providers": "^5.4.4",
@@ -52,7 +52,7 @@
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "@cerc-io/cache": "^0.2.82",
+    "@cerc-io/cache": "^0.2.83",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@types/bunyan": "^1.8.8",
     "@types/express": "^4.17.14",

packages/util/src/common.ts

@@ -225,7 +225,7 @@ const _processEvents = async (
     console.time('time:common#processEvents-processing_events_batch');
 
     // Process events in loop
-    for (let event of events) {
+    for (const event of events) {
       // Skipping check for order of events processing since logIndex in FEVM is not index of log in block
       // Check was introduced to avoid reprocessing block events incase of restarts. But currently on restarts, unprocessed block is removed and reprocessed from first event log
       // if (event.index <= block.lastProcessedEventIndex) {
@@ -239,8 +239,11 @@ const _processEvents = async (
         // as a result of a previous event in the same block.
         if (event.eventName === UNKNOWN_EVENT_NAME) {
           // Parse the unknown event and save updated event to the db
-          event = _parseUnknownEvent(indexer, event, watchedContract.kind);
+          const { eventParsed, event: parsedEvent } = _parseUnknownEvent(indexer, event, watchedContract.kind);
-          updatedDbEvents.push(event);
+
+          if (eventParsed) {
+            updatedDbEvents.push(parsedEvent);
+          }
         }
 
         await indexer.processEvent(event, { ethFullBlock, ethFullTransactions });
@@ -339,7 +342,7 @@ const _processEventsInSubgraphOrder = async (
   }
 
   // Parse events of initially unwatched contracts
-  for (let event of unwatchedContractEvents) {
+  for (const event of unwatchedContractEvents) {
     const watchedContract = indexer.isWatchedContract(event.contract);
 
     if (watchedContract) {
@@ -347,8 +350,11 @@ const _processEventsInSubgraphOrder = async (
       // as a result of a previous event in the same block.
       if (event.eventName === UNKNOWN_EVENT_NAME) {
         // Parse the unknown event and save updated event to the db
-        event = _parseUnknownEvent(indexer, event, watchedContract.kind);
+        const { eventParsed, event: parsedEvent } = _parseUnknownEvent(indexer, event, watchedContract.kind);
-        updatedDbEvents.push(event);
+
+        if (eventParsed) {
+          updatedDbEvents.push(parsedEvent);
+        }
       }
     }
   }
@@ -381,11 +387,14 @@ const _getEventsBatch = async (indexer: IndexerInterface, blockHash: string, eve
   );
 };
 
-const _parseUnknownEvent = (indexer: IndexerInterface, event: EventInterface, contractKind: string): EventInterface => {
+const _parseUnknownEvent = (indexer: IndexerInterface, event: EventInterface, contractKind: string): { eventParsed: boolean, event: EventInterface } => {
   const logObj = JSONbigNative.parse(event.extraInfo);
 
   assert(indexer.parseEventNameAndArgs);
-  const { eventName, eventInfo, eventSignature } = indexer.parseEventNameAndArgs(contractKind, logObj);
+  const { eventParsed, eventDetails: { eventName, eventInfo, eventSignature } } = indexer.parseEventNameAndArgs(contractKind, logObj);
+  if (!eventParsed) {
+    return { eventParsed: false, event };
+  }
 
   event.eventName = eventName;
   event.eventInfo = JSONbigNative.stringify(eventInfo);
@@ -394,7 +403,7 @@ const _parseUnknownEvent = (indexer: IndexerInterface, event: EventInterface, co
     eventSignature
   });
 
-  return event;
+  return { eventParsed: true, event };
 };
 
 /**

packages/util/src/indexer.ts

@@ -383,7 +383,7 @@ export class Indexer {
     parseEventNameAndArgs: (
       kind: string,
       logObj: { topics: string[]; data: string }
-    ) => { eventName: string; eventInfo: {[key: string]: any}; eventSignature: string }
+    ) => { eventParsed: boolean, eventDetails: any }
   ): Promise<{
     blockProgress: BlockProgressInterface,
     events: DeepPartial<EventInterface>[],
@@ -490,7 +490,11 @@ export class Indexer {
   }
 
   // Fetch events (to be saved to db) for a particular block
-  async fetchEvents (blockHash: string, blockNumber: number, eventSignaturesMap: Map<string, string[]>, parseEventNameAndArgs: (kind: string, logObj: any) => any): Promise<{ events: DeepPartial<EventInterface>[], transactions: EthFullTransaction[]}> {
+  async fetchEvents (
+    blockHash: string, blockNumber: number,
+    eventSignaturesMap: Map<string, string[]>,
+    parseEventNameAndArgs: (kind: string, logObj: any) => { eventParsed: boolean, eventDetails: any }
+  ): Promise<{ events: DeepPartial<EventInterface>[], transactions: EthFullTransaction[]}> {
     const { addresses, topics } = this._createLogsFilters(eventSignaturesMap);
     const { logs, transactions } = await this._fetchLogsAndTransactions(blockHash, blockNumber, addresses, topics);
 
@@ -504,7 +508,12 @@ export class Indexer {
     return { events, transactions };
   }
 
-  async fetchEventsForContracts (blockHash: string, blockNumber: number, addresses: string[], eventSignaturesMap: Map<string, string[]>, parseEventNameAndArgs: (kind: string, logObj: any) => any): Promise<DeepPartial<EventInterface>[]> {
+  async fetchEventsForContracts (
+    blockHash: string, blockNumber: number,
+    addresses: string[],
+    eventSignaturesMap: Map<string, string[]>,
+    parseEventNameAndArgs: (kind: string, logObj: any) => { eventParsed: boolean, eventDetails: any }
+  ): Promise<DeepPartial<EventInterface>[]> {
     const { topics } = this._createLogsFilters(eventSignaturesMap);
     const { logs, transactions } = await this._fetchLogsAndTransactions(blockHash, blockNumber, addresses, topics);
 
@@ -546,7 +555,11 @@ export class Indexer {
   }
 
   // Create events to be saved to db for a block given blockHash, logs, transactions and a parser function
-  createDbEventsFromLogsAndTxs (blockHash: string, logs: any, transactions: any, parseEventNameAndArgs: (kind: string, logObj: any) => any): DeepPartial<EventInterface>[] {
+  createDbEventsFromLogsAndTxs (
+    blockHash: string,
+    logs: any, transactions: any,
+    parseEventNameAndArgs: (kind: string, logObj: any) => { eventParsed: boolean, eventDetails: any }
+  ): DeepPartial<EventInterface>[] {
     const transactionMap: {[key: string]: any} = transactions.reduce((acc: {[key: string]: any}, transaction: {[key: string]: any}) => {
       acc[transaction.txHash] = transaction;
       return acc;
@@ -595,7 +608,12 @@ export class Indexer {
         const watchedContract = this.isWatchedContract(contract);
 
         if (watchedContract) {
-          const eventDetails = parseEventNameAndArgs(watchedContract.kind, logObj);
+          const { eventParsed, eventDetails } = parseEventNameAndArgs(watchedContract.kind, logObj);
+          if (!eventParsed) {
+            // Skip unparsable events
+            continue;
+          }
+
           eventName = eventDetails.eventName;
           eventInfo = eventDetails.eventInfo;
           extraInfo.eventSignature = eventDetails.eventSignature;

packages/util/src/types.ts

@@ -200,7 +200,7 @@ export interface IndexerInterface {
   saveEventEntity (dbEvent: EventInterface): Promise<EventInterface>
   saveEvents (dbEvents: DeepPartial<EventInterface>[]): Promise<void>
   processEvent (event: EventInterface, extraData: ExtraEventData): Promise<void>
-  parseEventNameAndArgs?: (kind: string, logObj: any) => any
+  parseEventNameAndArgs?: (kind: string, logObj: any) => { eventParsed: boolean, eventDetails: any }
   isWatchedContract: (address: string) => ContractInterface | undefined;
   getWatchedContracts: () => ContractInterface[]
   getContractsByKind?: (kind: string) => ContractInterface[]