Use Multicall for SimpleStorageHandler (#72)

l2beat · Oct 20, 2023 · a25b194 · a25b194
1 parent 0f7094e
commit a25b194
Show file tree

Hide file tree

Showing 36 changed files with 815 additions and 104 deletions.
diff --git a/packages/discovery/CHANGELOG.md b/packages/discovery/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @l2beat/discovery
 
+## 0.18.0
+
+### Minor Changes
+
+- Add multicall support and use multicall for SimpleStorageHandler
+
 ## 0.17.2
 
 ### Patch Changes

diff --git a/packages/discovery/package.json b/packages/discovery/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@l2beat/discovery",
   "description": "L2Beat discovery - engine & tooling utilized for keeping an eye on L2s",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {

diff --git a/packages/discovery/src/cli.ts b/packages/discovery/src/cli.ts
@@ -61,6 +61,7 @@ async function discover(
     await dryRunDiscovery(
       provider,
       etherscanClient,
+      config.chain.multicall,
       configReader,
       discoverConfig,
     )
@@ -71,7 +72,13 @@ async function discover(
   logger.info('Starting discovery...\n')
   logger.info(`Project: ${discoverConfig.project}`)
   logger.info(`Chain: ${ChainId.getName(discoverConfig.chainId)}\n`)
-  await runDiscovery(provider, etherscanClient, configReader, discoverConfig)
+  await runDiscovery(
+    provider,
+    etherscanClient,
+    config.chain.multicall,
+    configReader,
+    discoverConfig,
+  )
 }
 
 async function invert(

diff --git a/packages/discovery/src/config/config.discovery.ts b/packages/discovery/src/config/config.discovery.ts
@@ -2,6 +2,8 @@ import { getEnv } from '@l2beat/backend-tools'
 import { config as dotenv } from 'dotenv'
 
 import { CliParameters } from '../cli/getCliParameters'
+import { multicallConfig } from '../discovery/provider/multicall/MulticallConfig'
+import { MulticallConfig } from '../discovery/provider/multicall/types'
 import { ChainId } from '../utils/ChainId'
 import { EthereumAddress } from '../utils/EthereumAddress'
 import { EtherscanUnsupportedMethods } from '../utils/EtherscanLikeClient'
@@ -57,6 +59,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_ETHEREUM_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.ethereum,
         etherscanApiKey: env.string('DISCOVERY_ETHEREUM_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.etherscan.io/api',
       }
@@ -67,6 +70,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_ARBITRUM_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.arbitrum,
         etherscanApiKey: env.string('DISCOVERY_ARBITRUM_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.arbiscan.io/api',
       }
@@ -77,6 +81,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_OPTIMISM_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.optimism,
         etherscanApiKey: env.string('DISCOVERY_OPTIMISM_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api-optimistic.etherscan.io/api',
       }
@@ -87,6 +92,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_POLYGON_POS_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.polygon_pos,
         etherscanApiKey: env.string('DISCOVERY_POLYGON_POS_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.polygonscan.com/api',
       }
@@ -97,6 +103,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_BSC_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.bsc,
         etherscanApiKey: env.string('DISCOVERY_BSC_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.bscscan.com/api',
       }
@@ -107,6 +114,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_AVALANCHE_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.avalanche,
         etherscanApiKey: env.string('DISCOVERY_AVALANCHE_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.snowtrace.io/api',
       }
@@ -117,6 +125,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_CELO_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.celo,
         etherscanApiKey: env.string('DISCOVERY_CELO_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.celoscan.io/api',
         etherscanUnsupported: {
@@ -130,6 +139,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_LINEA_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.linea,
         etherscanApiKey: env.string('DISCOVERY_LINEA_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.lineascan.build/api',
       }
@@ -140,6 +150,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_BASE_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.base,
         etherscanApiKey: env.string('DISCOVERY_BASE_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.basescan.org/api',
       }
@@ -150,6 +161,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_POLYGON_ZKEVM_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.polygon_zkevm,
         etherscanApiKey: env.string(
           'DISCOVERY_POLYGON_ZKEVM_ETHERSCAN_API_KEY',
         ),
@@ -162,6 +174,7 @@ function getChainConfig(chainId: ChainId): DiscoveryChainConfig {
         rpcGetLogsMaxRange: env.optionalInteger(
           'DISCOVERY_GNOSIS_RPC_GETLOGS_MAX_RANGE',
         ),
+        multicall: multicallConfig.gnosis,
         etherscanApiKey: env.string('DISCOVERY_GNOSIS_ETHERSCAN_API_KEY'),
         etherscanUrl: 'https://api.gnosisscan.io/api',
       }
@@ -199,6 +212,7 @@ export interface DiscoveryChainConfig {
   chainId: ChainId
   rpcUrl: string
   rpcGetLogsMaxRange?: number
+  multicall: MulticallConfig
   etherscanApiKey: string
   etherscanUrl: string
   etherscanUnsupported?: EtherscanUnsupportedMethods

diff --git a/packages/discovery/src/discovery/engine/discover.ts b/packages/discovery/src/discovery/engine/discover.ts
@@ -3,19 +3,23 @@ import { DiscoveryConfig } from '../config/DiscoveryConfig'
 import { DiscoveryLogger } from '../DiscoveryLogger'
 import { HandlerExecutor } from '../handlers/HandlerExecutor'
 import { DiscoveryProvider } from '../provider/DiscoveryProvider'
+import { MulticallClient } from '../provider/multicall/MulticallClient'
+import { MulticallConfig } from '../provider/multicall/types'
 import { ProxyDetector } from '../proxies/ProxyDetector'
 import { SourceCodeService } from '../source/SourceCodeService'
 import { DiscoveryEngine } from './DiscoveryEngine'
 
 export async function discover(
   provider: DiscoveryProvider,
   config: DiscoveryConfig,
+  multicallConfig: MulticallConfig,
   logger: DiscoveryLogger,
   blockNumber: number,
 ): Promise<Analysis[]> {
   const proxyDetector = new ProxyDetector(provider, logger)
   const sourceCodeService = new SourceCodeService(provider)
-  const handlerExecutor = new HandlerExecutor(provider, logger)
+  const multicallClient = new MulticallClient(provider, multicallConfig)
+  const handlerExecutor = new HandlerExecutor(provider, multicallClient, logger)
   const addressAnalyzer = new AddressAnalyzer(
     provider,
     proxyDetector,

diff --git a/packages/discovery/src/discovery/handlers/Handler.ts b/packages/discovery/src/discovery/handlers/Handler.ts
@@ -3,6 +3,10 @@ import { ContractValue } from '@l2beat/discovery-types'
 import { EthereumAddress } from '../../utils/EthereumAddress'
 import { DiscoveryLogger } from '../DiscoveryLogger'
 import { DiscoveryProvider } from '../provider/DiscoveryProvider'
+import {
+  MulticallRequest,
+  MulticallResponse,
+} from '../provider/multicall/types'
 
 export interface HandlerResult {
   field: string
@@ -11,7 +15,7 @@ export interface HandlerResult {
   ignoreRelative?: boolean
 }
 
-export interface Handler {
+interface BaseHandler {
   field: string
   dependencies: string[]
   logger?: DiscoveryLogger
@@ -22,3 +26,18 @@ export interface Handler {
     previousResults: Record<string, HandlerResult | undefined>,
   ): Promise<HandlerResult>
 }
+
+export interface ClassicHandler extends BaseHandler {
+  multicallable?: false
+}
+
+export interface MulticallableHandler extends BaseHandler {
+  multicallable: true
+  encode(
+    address: EthereumAddress,
+    previousResults: Record<string, HandlerResult | undefined>,
+  ): MulticallRequest[]
+  decode: (result: MulticallResponse[]) => HandlerResult
+}
+
+export type Handler = MulticallableHandler | ClassicHandler
diff --git a/packages/discovery/src/discovery/handlers/HandlerExecutor.ts b/packages/discovery/src/discovery/handlers/HandlerExecutor.ts
@@ -4,6 +4,7 @@ import { EthereumAddress } from '../../utils/EthereumAddress'
 import { ContractOverrides } from '../config/DiscoveryOverrides'
 import { DiscoveryLogger } from '../DiscoveryLogger'
 import { DiscoveryProvider } from '../provider/DiscoveryProvider'
+import { MulticallClient } from '../provider/multicall/MulticallClient'
 import { executeHandlers } from './executeHandlers'
 import { getHandlers } from './getHandlers'
 import { getValuesAndErrors } from './getValuesAndErrors'
@@ -12,6 +13,7 @@ import { HandlerResult } from './Handler'
 export class HandlerExecutor {
   constructor(
     private readonly provider: DiscoveryProvider,
+    private readonly multicallClient: MulticallClient,
     private readonly logger: DiscoveryLogger,
   ) {}
 
@@ -28,6 +30,7 @@ export class HandlerExecutor {
     const handlers = getHandlers(abi, overrides, this.logger)
     const results = await executeHandlers(
       this.provider,
+      this.multicallClient,
       handlers,
       address,
       blockNumber,