Add ETH RPC API to get logs (#536)

* Add eth_getLogs API handler * Transform events into logs * Update codegen templates * Allow GET requests * Increment package verisons * Remove unnecessary todo * Add limit on getLogs results size * Fix config template
cerc-io · Sep 16, 2024 · d413d72 · d413d72
1 parent b46d881
commit d413d72
Show file tree

Hide file tree

Showing 24 changed files with 207 additions and 42 deletions.
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "scripts": {
@@ -15,13 +15,13 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.1",
-    "@cerc-io/cache": "^0.2.106",
-    "@cerc-io/ipld-eth-client": "^0.2.106",
+    "@cerc-io/cache": "^0.2.107",
+    "@cerc-io/ipld-eth-client": "^0.2.107",
     "@cerc-io/libp2p": "^0.42.2-laconic-0.1.4",
     "@cerc-io/nitro-node": "^0.1.15",
-    "@cerc-io/peer": "^0.2.106",
-    "@cerc-io/rpc-eth-client": "^0.2.106",
-    "@cerc-io/util": "^0.2.106",
+    "@cerc-io/peer": "^0.2.107",
+    "@cerc-io/rpc-eth-client": "^0.2.107",
+    "@cerc-io/util": "^0.2.107",
     "@ethersproject/providers": "^5.4.4",
     "@graphql-tools/utils": "^9.1.1",
     "@ipld/dag-cbor": "^8.0.0",

diff --git a/packages/cli/src/server.ts b/packages/cli/src/server.ts
@@ -323,7 +323,14 @@ export class ServerCmd {
 
     // Create an Express app
     const app: Application = express();
-    const server = await createAndStartServer(app, typeDefs, resolvers, ethRPCHandlers, config.server, paymentsManager);
+    const server = await createAndStartServer(
+      app,
+      typeDefs,
+      resolvers,
+      ethRPCHandlers,
+      config.server,
+      paymentsManager
+    );
 
     await startGQLMetricsServer(config);
 

diff --git a/packages/codegen/package.json b/packages/codegen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/codegen",
-  "version": "0.2.106",
+  "version": "0.2.107",
   "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.106",
+    "@cerc-io/util": "^0.2.107",
     "@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/templates/config-template.handlebars b/packages/codegen/src/templates/config-template.handlebars
@@ -25,6 +25,12 @@
   # Flag to specify whether RPC endpoint supports block hash as block tag parameter
   rpcSupportsBlockHashParam = true
 
+  # Enable ETH JSON RPC server at /rpc
+  enableEthRPCServer = true
+
+  # Max number of logs that can be returned in a single getLogs request (default: 10000)
+  ethGetLogsResultLimit = 10000
+
   # Server GQL config
   [server.gql]
     path = "/graphql"

diff --git a/packages/codegen/src/templates/database-template.handlebars b/packages/codegen/src/templates/database-template.handlebars
@@ -199,6 +199,12 @@ export class Database implements DatabaseInterface {
     return this._baseDatabase.getEventsInRange(repo, fromBlockNumber, toBlockNumber);
   }
 
+  async getEvents (options: FindManyOptions<Event>): Promise<Array<Event>> {
+    const repo = this._conn.getRepository(Event);
+
+    return this._baseDatabase.getEvents(repo, options);
+  }
+
   async saveEventEntity (queryRunner: QueryRunner, entity: Event): Promise<Event> {
     const repo = queryRunner.manager.getRepository(Event);
     return this._baseDatabase.saveEventEntity(repo, entity);

diff --git a/packages/codegen/src/templates/indexer-template.handlebars b/packages/codegen/src/templates/indexer-template.handlebars
@@ -188,6 +188,10 @@ export class Indexer implements IndexerInterface {
     return this._storageLayoutMap;
   }
 
+  get contractMap (): Map<string, ethers.utils.Interface> {
+    return this._contractMap;
+  }
+
   {{#if (subgraphPath)}}
   get graphWatcher (): GraphWatcher {
     return this._graphWatcher;
@@ -671,6 +675,10 @@ export class Indexer implements IndexerInterface {
     return this._baseIndexer.getEventsInRange(fromBlockNumber, toBlockNumber, this._serverConfig.gql.maxEventsBlockRange);
   }
 
+  async getEvents (options: FindManyOptions<Event>): Promise<Array<Event>> {
+    return this._db.getEvents(options);
+  }
+
   async getSyncStatus (): Promise<SyncStatus | undefined> {
     return this._baseIndexer.getSyncStatus();
   }

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.106",
-    "@cerc-io/ipld-eth-client": "^0.2.106",
-    "@cerc-io/solidity-mapper": "^0.2.106",
-    "@cerc-io/util": "^0.2.106",
+    "@cerc-io/cli": "^0.2.107",
+    "@cerc-io/ipld-eth-client": "^0.2.107",
+    "@cerc-io/solidity-mapper": "^0.2.107",
+    "@cerc-io/util": "^0.2.107",
     {{#if (subgraphPath)}}
-    "@cerc-io/graph-node": "^0.2.106",
+    "@cerc-io/graph-node": "^0.2.107",
     {{/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.106",
+  "version": "0.2.107",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/solidity-mapper": "^0.2.106",
+    "@cerc-io/solidity-mapper": "^0.2.107",
     "@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.106",
-    "@cerc-io/ipld-eth-client": "^0.2.106",
-    "@cerc-io/util": "^0.2.106",
+    "@cerc-io/cache": "^0.2.107",
+    "@cerc-io/ipld-eth-client": "^0.2.107",
+    "@cerc-io/util": "^0.2.107",
     "@types/json-diff": "^0.5.2",
     "@types/yargs": "^17.0.0",
     "bn.js": "^4.11.9",

diff --git a/packages/graph-node/test/utils/indexer.ts b/packages/graph-node/test/utils/indexer.ts
@@ -91,6 +91,12 @@ export class Indexer implements IndexerInterface {
     return undefined;
   }
 
+  async getEvents (options: FindManyOptions<EventInterface>): Promise<Array<EventInterface>> {
+    assert(options);
+
+    return [];
+  }
+
   async getSyncStatus (): Promise<SyncStatusInterface | 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.106",
+  "version": "0.2.107",
   "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.106",
-    "@cerc-io/util": "^0.2.106",
+    "@cerc-io/cache": "^0.2.107",
+    "@cerc-io/util": "^0.2.107",
     "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.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "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.106",
-    "@cerc-io/ipld-eth-client": "^0.2.106",
-    "@cerc-io/util": "^0.2.106",
+    "@cerc-io/cache": "^0.2.107",
+    "@cerc-io/ipld-eth-client": "^0.2.107",
+    "@cerc-io/util": "^0.2.107",
     "chai": "^4.3.4",
     "ethers": "^5.4.4",
     "left-pad": "^1.3.0",

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.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "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.106",
+  "version": "0.2.107",
   "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.106",
-    "@cerc-io/solidity-mapper": "^0.2.106",
+    "@cerc-io/peer": "^0.2.107",
+    "@cerc-io/solidity-mapper": "^0.2.107",
     "@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
     "@ethersproject/properties": "^5.7.0",
     "@ethersproject/providers": "^5.4.4",
@@ -55,7 +55,7 @@
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "@cerc-io/cache": "^0.2.106",
+    "@cerc-io/cache": "^0.2.107",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@types/bunyan": "^1.8.8",
     "@types/express": "^4.17.14",

diff --git a/packages/util/src/config.ts b/packages/util/src/config.ts
@@ -255,6 +255,9 @@ export interface ServerConfig {
 
   // Enable ETH JSON RPC server at /rpc
   enableEthRPCServer: boolean;
+
+  // Max number of logs that can be returned in a single getLogs request
+  ethGetLogsResultLimit?: number;
 }
 
 export interface FundingAmountsConfig {

diff --git a/packages/util/src/constants.ts b/packages/util/src/constants.ts
@@ -30,3 +30,5 @@ export const DEFAULT_PREFETCH_BATCH_SIZE = 10;
 export const DEFAULT_MAX_GQL_CACHE_SIZE = Math.pow(2, 20) * 8; // 8 MB
 
 export const SUPPORTED_PAID_RPC_METHODS = ['eth_getBlockByHash', 'eth_getStorageAt', 'eth_getBlockByNumber'];
+
+export const DEFAULT_ETH_GET_LOGS_RESULT_LIMIT = 10000;
diff --git a/packages/util/src/database.ts b/packages/util/src/database.ts
@@ -523,6 +523,12 @@ export class Database {
     return events;
   }
 
+  async getEvents (repo: Repository<EventInterface>, options: FindManyOptions<EventInterface>): Promise<Array<EventInterface>> {
+    const events = repo.find(options);
+
+    return events;
+  }
+
   async saveEventEntity (repo: Repository<EventInterface>, entity: EventInterface): Promise<EventInterface> {
     const event = await repo.save(entity);
     eventCount.inc(1);