feat: upgrade to ethers v6, bump common-ts and use toolshed for contracts

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

package.json

@@ -23,20 +23,16 @@
     "lerna": "6.1.0"
   },
   "resolutions": {
-    "ethers": "5.7.0",
+    "ethers": "6.13.7",
     "sequelize": "6.33.0",
-    "@ethersproject/bignumber": "5.7.0",
-    "@ethersproject/providers": "5.7.0",
     "@urql/core": "3.1.0",
     "@urql/exchange-execute": "2.1.0",
     "punycode": "2.3.1",
     "uri-js": "4.2.2"
   },
   "overrides": {
-    "ethers": "5.7.0",
+    "ethers": "6.13.7",
     "sequelize": "6.33.0",
-    "@ethersproject/bignumber": "5.7.0",
-    "@ethersproject/providers": "5.7.0",
     "@urql/core": "3.1.0",
     "@urql/exchange-execute": "2.1.0",
     "graphql": "16.8.0"

packages/indexer-agent/jest.config.js

@@ -11,6 +11,7 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['/node_modules/', '/dist/', '.yalc'],
+  transformIgnorePatterns: ['!node_modules/'],
   globals: {
     __DATABASE__: {
       host:

packages/indexer-agent/package.json

@@ -29,13 +29,13 @@
     "graph-indexer-agent": "bin/graph-indexer-agent"
   },
   "dependencies": {
-    "@graphprotocol/common-ts": "2.0.11",
+    "@graphprotocol/common-ts": "3.0.1",
     "@graphprotocol/indexer-common": "^0.23.5",
     "@thi.ng/heaps": "^1.3.1",
     "axios": "0.26.1",
     "bs58": "5.0.0",
     "delay": "^5.0.0",
-    "ethers": "5.7.0",
+    "ethers": "6.13.7",
     "evt": "1.9.12",
     "global": "4.4.0",
     "graphql": "16.8.0",
@@ -80,10 +80,8 @@
     "typescript": "5.2.2"
   },
   "resolutions": {
-    "ethers": "5.7.0",
-    "sequelize": "6.33.0",
-    "@ethersproject/bignumber": "5.7.0",
-    "@ethersproject/providers": "5.7.0"
+    "ethers": "6.13.7",
+    "sequelize": "6.33.0"
   },
   "gitHead": "972ab96774007b2aee15b1da169d2ff4be9f9d27"
 }

packages/indexer-agent/src/__tests__/indexer.ts

@@ -21,7 +21,6 @@ import {
   MultiNetworks,
   loadTestYamlConfig,
 } from '@graphprotocol/indexer-common'
-import { BigNumber } from 'ethers'
 import { Sequelize } from 'sequelize'
 
 const TEST_DISPUTE_1: POIDisputeAttributes = {
@@ -69,7 +68,7 @@ const TEST_DISPUTE_2: POIDisputeAttributes = {
 
 const POI_DISPUTES_CONVERTERS_FROM_GRAPHQL: Record<
   keyof POIDisputeAttributes,
-  (x: never) => string | BigNumber | number | undefined
+  (x: never) => string | bigint | number | undefined
 > = {
   allocationID: x => x,
   subgraphDeploymentID: x => x,

packages/indexer-agent/src/agent.ts

@@ -47,7 +47,7 @@ import mapValues from 'lodash.mapvalues'
 import zip from 'lodash.zip'
 import { AgentConfigs, NetworkAndOperator } from './types'
 
-type ActionReconciliationContext = [AllocationDecision[], number, number]
+type ActionReconciliationContext = [AllocationDecision[], number, bigint]
 
 const deploymentInList = (
   list: SubgraphDeploymentID[],
@@ -270,15 +270,15 @@ export class Agent {
         },
       )
 
-    const maxAllocationEpochs: Eventual<NetworkMapped<number>> =
+    const maxAllocationEpochs: Eventual<NetworkMapped<bigint>> =
       sequentialTimerMap(
         { logger, milliseconds: requestIntervalLarge },
         () =>
           this.multiNetworks.map(({ network }) => {
             logger.trace('Fetching max allocation epochs', {
               protocolNetwork: network.specification.networkIdentifier,
             })
-            return network.contracts.staking.maxAllocationEpochs()
+            return network.contracts.LegacyStaking.maxAllocationEpochs()
           }),
         {
           onError: error =>
@@ -304,9 +304,9 @@ export class Agent {
               await network.networkMonitor.subgraphs(subgraphRuleIds)
             if (subgraphsMatchingRules.length >= 1) {
               const epochLength =
-                await network.contracts.epochManager.epochLength()
+                await network.contracts.EpochManager.epochLength()
               const blockPeriod = 15
-              const bufferPeriod = epochLength.toNumber() * blockPeriod * 100 // 100 epochs
+              const bufferPeriod = Number(epochLength) * blockPeriod * 100 // 100 epochs
               rules = convertSubgraphBasedRulesToDeploymentBased(
                 rules,
                 subgraphsMatchingRules,
@@ -486,7 +486,7 @@ export class Agent {
               const matchingTransfer = eligibleTransferDeployments.find(
                 deployment =>
                   deployment.ipfsHash == decision.deployment.ipfsHash &&
-                  deployment.startedTransferToL2At.toNumber() > oneWeekAgo,
+                  Number(deployment.startedTransferToL2At) > oneWeekAgo,
               )
               if (matchingTransfer) {
                 logger.debug('Found a matching subgraph transfer', {
@@ -682,7 +682,8 @@ export class Agent {
               currentEpochNumber: number,
             ) =>
               currentEpochNumber -
-              network.specification.indexerOptions.poiDisputableEpochs,
+              (network.specification.indexerOptions
+                .poiDisputableEpochs as number),
           )
 
           // Find disputable allocations
@@ -821,22 +822,22 @@ export class Agent {
             await network.networkProvider.getBlock(
               pool.previousEpochStartBlockHash!,
             )
-          pool.closedAtEpochStartBlockNumber = closedAtEpochStartBlock.number
+          pool.closedAtEpochStartBlockNumber = closedAtEpochStartBlock!.number
           pool.referencePOI = await this.graphNode.proofOfIndexing(
             pool.subgraphDeployment,
             {
-              number: closedAtEpochStartBlock.number,
-              hash: closedAtEpochStartBlock.hash,
+              number: closedAtEpochStartBlock!.number,
+              hash: closedAtEpochStartBlock!.hash!,
             },
             pool.allocationIndexer,
           )
-          pool.previousEpochStartBlockHash = previousEpochStartBlock.hash
-          pool.previousEpochStartBlockNumber = previousEpochStartBlock.number
+          pool.previousEpochStartBlockHash = previousEpochStartBlock!.hash!
+          pool.previousEpochStartBlockNumber = previousEpochStartBlock!.number
           pool.referencePreviousPOI = await this.graphNode.proofOfIndexing(
             pool.subgraphDeployment,
             {
-              number: previousEpochStartBlock.number,
-              hash: previousEpochStartBlock.hash,
+              number: previousEpochStartBlock!.number,
+              hash: previousEpochStartBlock!.hash!,
             },
             pool.allocationIndexer,
           )
@@ -1006,13 +1007,13 @@ export class Agent {
     activeAllocations: Allocation[],
     deploymentAllocationDecision: AllocationDecision,
     epoch: number,
-    maxAllocationEpochs: number,
+    maxAllocationEpochs: bigint,
     network: Network,
   ): Promise<Allocation[]> {
     const desiredAllocationLifetime = deploymentAllocationDecision.ruleMatch
       .rule?.allocationLifetime
       ? deploymentAllocationDecision.ruleMatch.rule.allocationLifetime
-      : Math.max(1, maxAllocationEpochs - 1)
+      : Math.max(1, Number(maxAllocationEpochs) - 1)
 
     // Identify expiring allocations
     let expiredAllocations = activeAllocations.filter(
@@ -1028,8 +1029,8 @@ export class Agent {
       async (allocation: Allocation) => {
         try {
           const onChainAllocation =
-            await network.contracts.staking.getAllocation(allocation.id)
-          return onChainAllocation.closedAtEpoch.eq('0')
+            await network.contracts.LegacyStaking.getAllocation(allocation.id)
+          return onChainAllocation.closedAtEpoch == 0n
         } catch (err) {
           this.logger.warn(
             `Failed to cross-check allocation state with contracts; assuming it needs to be closed`,
@@ -1050,7 +1051,7 @@ export class Agent {
     deploymentAllocationDecision: AllocationDecision,
     activeAllocations: Allocation[],
     epoch: number,
-    maxAllocationEpochs: number,
+    maxAllocationEpochs: bigint,
     network: Network,
     operator: Operator,
   ): Promise<void> {
@@ -1145,7 +1146,7 @@ export class Agent {
   async reconcileActions(
     networkDeploymentAllocationDecisions: NetworkMapped<AllocationDecision[]>,
     epoch: NetworkMapped<number>,
-    maxAllocationEpochs: NetworkMapped<number>,
+    maxAllocationEpochs: NetworkMapped<bigint>,
   ): Promise<void> {
     // --------------------------------------------------------------------------------
     // Filter out networks set to `manual` allocation management mode, and ensure the

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

@@ -31,7 +31,6 @@ import { createSyncingServer } from '../syncing-server'
 import { injectCommonStartupOptions } from './common-options'
 import pMap from 'p-map'
 import { NetworkSpecification } from '@graphprotocol/indexer-common/dist/network-specification'
-import { BigNumber } from 'ethers'
 import { displayZodParsingError } from '@graphprotocol/indexer-common'
 import { readFileSync } from 'fs'
 import { AgentConfigs } from '../types'
@@ -601,7 +600,7 @@ export async function run(
     defaults: {
       globalIndexingRule: {
         // TODO: Update this, there will be defaults per network
-        allocationAmount: BigNumber.from(100),
+        allocationAmount: BigInt(100),
         parallelAllocations: 1,
       },
     },

packages/indexer-agent/src/db/migrations/14-cost-models-history.ts

@@ -1,5 +1,5 @@
 import { Logger } from '@graphprotocol/common-ts'
-import { utils } from 'ethers'
+import { isHexString } from 'ethers'
 import { QueryInterface, DataTypes } from 'sequelize'
 
 interface MigrationContext {
@@ -45,7 +45,7 @@ export async function up({ context }: Context): Promise<void> {
               throw new Error('Deployment ID must be a string')
             }
             // "0x..." and "global" is ok
-            if (utils.isHexString(value, 32) || value === COST_MODEL_GLOBAL) {
+            if (isHexString(value, 32) || value === COST_MODEL_GLOBAL) {
               return
             }
 

packages/indexer-cli/jest.config.js

@@ -13,6 +13,7 @@ module.exports = {
   // The glob patterns Jest uses to detect test files
   testMatch: ['**/?(*.)+(spec|test).ts?(x)'],
   testPathIgnorePatterns: ['/node_modules/', '/dist/', '.yalc'],
+  transformIgnorePatterns: ['!node_modules/'],
   testTimeout: 60000,
   globals: {
     __DATABASE__: {

packages/indexer-cli/package.json

@@ -26,14 +26,14 @@
     "test:watch": "jest --watch --detectOpenHandles --verbose"
   },
   "dependencies": {
-    "@graphprotocol/common-ts": "2.0.11",
+    "@graphprotocol/common-ts": "3.0.1",
     "@graphprotocol/indexer-common": "^0.23.5",
     "@iarna/toml": "2.2.5",
     "@thi.ng/iterators": "5.1.74",
     "@urql/core": "3.1.0",
     "chalk": "4.1.2",
     "env-paths": "2.2.1",
-    "ethers": "5.7.0",
+    "ethers": "6.13.7",
     "gluegun": "4.7.0",
     "graphql-tag": "2.12.6",
     "isomorphic-fetch": "3.0.0",
@@ -53,7 +53,7 @@
     "typescript": "5.2.2"
   },
   "resolutions": {
-    "ethers": "5.7.0",
+    "ethers": "6.13.7",
     "sequelize": "6.33.0"
   },
   "gitHead": "972ab96774007b2aee15b1da169d2ff4be9f9d27"

packages/indexer-cli/src/actions.ts

@@ -14,7 +14,7 @@ import {
 } from '@graphprotocol/indexer-common'
 import { validatePOI, validateRequiredParams } from './command-helpers'
 import gql from 'graphql-tag'
-import { utils } from 'ethers'
+import { hexlify } from 'ethers'
 import { parseGRT } from '@graphprotocol/common-ts'
 
 export interface GenericActionInputParams {
@@ -51,7 +51,7 @@ export async function buildActionInput(
     case ActionType.UNALLOCATE: {
       let poi = actionParams.param2
       if (poi == '0' || poi == '0x0') {
-        poi = utils.hexlify(Array(32).fill(0))
+        poi = hexlify(new Uint8Array(32).fill(0))
       }
       return {
         deploymentID: actionParams.targetDeployment,
@@ -69,7 +69,7 @@ export async function buildActionInput(
     case ActionType.REALLOCATE: {
       let poi = actionParams.param3
       if (poi == '0' || poi == '0x0') {
-        poi = utils.hexlify(Array(32).fill(0))
+        poi = hexlify(new Uint8Array(32).fill(0))
       }
       return {
         deploymentID: actionParams.targetDeployment,