feat: optionally override address book

Author: Theodus

packages/indexer-agent/src/commands/start.ts

@@ -233,6 +233,11 @@ export const start = {
         default: true,
         group: 'Cost Models',
       })
+      .option('address-book', {
+        description: 'Graph contracts address book file path',
+        type: 'string',
+        required: false,
+      })
       .option('dai-contract', {
         description:
           'Address of the DAI or USDC contract to use for the --inject-dai conversion rate',
@@ -421,6 +426,7 @@ export async function createNetworkSpecification(
       transactionMonitoring,
       subgraphs,
       networkProvider,
+      addressBook: argv.addressBook,
       dai,
     })
   } catch (parsingError) {

packages/indexer-common/src/network-specification.ts

@@ -143,6 +143,7 @@ export const NetworkSpecification = z
     transactionMonitoring: TransactionMonitoring,
     subgraphs: ProtocolSubgraphs,
     networkProvider: NetworkProvider,
+    addressBook: z.string().optional(),
     dai: Dai,
   })
   .strict()

packages/indexer-common/src/network.ts

@@ -5,6 +5,7 @@ import {
   SubgraphDeploymentID,
   connectContracts,
   Eventual,
+  AddressBook,
 } from '@graphprotocol/common-ts'
 import {
   INDEXER_ERROR_MESSAGES,
@@ -27,6 +28,7 @@ import pRetry from 'p-retry'
 import { resolveChainId } from './indexer-management'
 import { monitorEthBalance } from './utils'
 import { QueryFeeModels } from './query-fees'
+import { readFileSync } from 'fs'
 
 export class Network {
   logger: Logger
@@ -143,6 +145,7 @@ export class Network {
       wallet,
       specification.networkIdentifier,
       logger,
+      specification.addressBook,
     )
 
     // * -----------------------------------------------------------------------
@@ -436,6 +439,7 @@ async function connectToProtocolContracts(
   wallet: Wallet,
   networkIdentifier: string,
   logger: Logger,
+  addressBook?: string,
 ): Promise<NetworkContracts> {
   const numericNetworkId = parseInt(networkIdentifier.split(':')[1])
 
@@ -450,7 +454,10 @@ async function connectToProtocolContracts(
 
   let contracts
   try {
-    contracts = await connectContracts(wallet, numericNetworkId, undefined)
+    const contractAddresses = addressBook
+      ? (JSON.parse(readFileSync(addressBook).toString()) as AddressBook)
+      : undefined
+    contracts = await connectContracts(wallet, numericNetworkId, contractAddresses)
   } catch (error) {
     const errorMessage =
       'Failed to connect to contracts, please ensure you are using the intended protocol network.'

packages/indexer-service/src/commands/start.ts

@@ -11,6 +11,7 @@ const SUGGESTED_SUBGRAPH_MAX_BLOCK_DISTANCE_ON_L2 =
 const DEFAULT_SUBGRAPH_FRESHNESS_SLEEP_MILLISECONDS = 5_000
 
 import {
+  AddressBook,
   connectContracts,
   connectDatabase,
   createLogger,
@@ -194,6 +195,11 @@ export default {
         default: DEFAULT_SUBGRAPH_FRESHNESS_SLEEP_MILLISECONDS,
         group: 'Protocol',
       })
+      .option('address-book', {
+        description: 'Graph contracts address book file path',
+        type: 'string',
+        required: false,
+      })
 
       .check(argv => {
         if (!argv['network-subgraph-endpoint'] && !argv['network-subgraph-deployment']) {
@@ -393,10 +399,13 @@ export default {
 
     let contracts = undefined
     try {
+      const addressBook = argv.addressBook
+        ? (JSON.parse(fs.readFileSync(argv.addressBook).toString()) as AddressBook)
+        : undefined
       contracts = await connectContracts(
         networkProvider,
         networkIdentifier.chainId,
-        undefined,
+        addressBook,
       )
     } catch (error) {
       logger.error(