indexer-agent, indexer-cli, indexer-common: add allocation lifetimes

Author: chriswessels

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

@@ -105,6 +105,7 @@ let sequelize: Sequelize
 let models: IndexerManagementModels
 let wallet: Wallet
 let address: string
+let maxLifetime: number
 let contracts: NetworkContracts
 let logger: Logger
 let indexerManagementClient: IndexerManagementClient
@@ -120,6 +121,7 @@ const setup = async () => {
   sequelize = await connectDatabase(__DATABASE__)
   models = defineIndexerManagementModels(sequelize)
   address = '0x3C17A4c7cD8929B83e4705e04020fA2B1bca2E55'
+  maxLifetime = 1
   contracts = await connectContracts(wallet, 4)
   await sequelize.sync({ force: true })
 
@@ -162,6 +164,7 @@ const setup = async () => {
     ['test'],
     parseGRT('1000'),
     address,
+    maxLifetime,
   )
 }
 

packages/indexer-agent/src/agent.ts

@@ -202,7 +202,11 @@ class Agent {
     )
 
     const maxAllocationEpochs = timer(600_000).tryMap(
-      () => this.network.contracts.staking.maxAllocationEpochs(),
+      () =>
+        // can i pass these 2 numbers into rule creation?
+        this.indexer.maxLifetime
+          ? this.indexer.maxLifetime
+          : this.network.contracts.staking.maxAllocationEpochs(),
       {
         onError: err =>
           this.logger.warn(`Failed to fetch max allocation epochs`, { err }),
@@ -697,7 +701,6 @@ class Agent {
 
     this.logger.info(`Reconcile allocations`, {
       currentEpoch,
-      maxAllocationEpochs,
       allocationLifetime,
       targetAllocations: targetAllocations.map(
         deployment => deployment.display,
@@ -715,7 +718,7 @@ class Agent {
       ...activeAllocations.map(allocation => allocation.subgraphDeployment.id),
     ])
 
-    // Ensure the network subgraph is never allocated towards
+    // Ensure the network subgraph is never allocated towards unless explicitly allowed
     if (
       !this.allocateOnNetworkSubgraph &&
       this.networkSubgraph.deployment?.id.bytes32
@@ -757,7 +760,7 @@ class Agent {
 
           currentEpoch,
           currentEpochStartBlock,
-          maxAllocationEpochs,
+          allocationLifetime,
         )
       },
       { concurrency: 1 },
@@ -782,6 +785,9 @@ class Agent {
       ? BigNumber.from(rule.allocationAmount)
       : this.indexer.defaultAllocationAmount
     const desiredNumberOfAllocations = 1
+    const desiredAllocationLifetime = rule?.allocationLifetime
+      ? Math.max(1, rule.allocationLifetime)
+      : maxAllocationEpochs
     const activeAllocationAmount = activeAllocations.reduce(
       (sum, allocation) => sum.add(allocation.allocatedTokens),
       BigNumber.from('0'),
@@ -795,6 +801,7 @@ class Agent {
         `Reconcile deployment allocations for deployment '${deployment.ipfsHash}'`,
         {
           desiredAllocationAmount: formatGRT(desiredAllocationAmount),
+          desiredAllocationLifetime,
 
           totalActiveAllocationAmount: formatGRT(activeAllocationAmount),
 
@@ -881,11 +888,10 @@ class Agent {
       )
     }
 
-    const lifetime = Math.max(1, maxAllocationEpochs - 1)
-
     // For allocations that have expired, let's reallocate in one transaction (closeAndAllocate)
     let expiredAllocations = activeAllocations.filter(
-      allocation => epoch >= allocation.createdAtEpoch + lifetime,
+      allocation =>
+        epoch >= allocation.createdAtEpoch + desiredAllocationLifetime,
     )
     // The allocations come from the network subgraph; due to short indexing
     // latencies, this data may be slightly outdated. Cross-check with the

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

@@ -308,6 +308,12 @@ export default {
         default: false,
         group: 'Disputes',
       })
+      .option('max-lifetime', {
+        description:
+          'Maximum epoches agent keep each allocation open (default 28) ',
+        type: 'number',
+        coerce: arg => Math.max(arg, 1),
+      })
       .check(argv => {
         if (
           !argv['network-subgraph-endpoint'] &&
@@ -420,6 +426,12 @@ export default {
       )
     }
 
+    if (argv.maxLifetime < 7) {
+      logger.warn(
+        `Maximum lifetime for allocations is less than a week. This might be expensive to maintain`,
+      )
+    }
+
     process.on('unhandledRejection', err => {
       logger.warn(`Unhandled promise rejection`, {
         err: indexerError(IndexerErrorCode.IE035, err),
@@ -661,6 +673,7 @@ export default {
       argv.indexNodeIds,
       parseGRT(argv.defaultAllocationAmount),
       indexerAddress,
+      argv.maxLifetime,
     )
     const networkSubgraphDeployment = argv.networkSubgraphDeployment
       ? new SubgraphDeploymentID(argv.networkSubgraphDeployment)

packages/indexer-agent/src/db/migrations/06-indexing-rules-add-max-lifetime.ts

@@ -0,0 +1,61 @@
+import { Logger } from '@graphprotocol/common-ts'
+import { DataTypes, QueryInterface } from 'sequelize'
+
+interface MigrationContext {
+  queryInterface: QueryInterface
+  logger: Logger
+}
+
+interface Context {
+  context: MigrationContext
+}
+
+export async function up({ context }: Context): Promise<void> {
+  const { queryInterface, logger } = context
+
+  logger.debug(`Checking if indexing rules table exists`)
+  const tables = await queryInterface.showAllTables()
+  if (!tables.includes('IndexingRules')) {
+    logger.info(`Indexing rules table does not exist, migration not necessary`)
+    return
+  }
+
+  logger.debug(`Checking if 'IndexingRules' table needs to be migrated`)
+  const table = await queryInterface.describeTable('IndexingRules')
+  const allocationLifetime = table.allocationLifetime
+  if (allocationLifetime) {
+    logger.info(
+      `'allocationLifetime' columns already exist, migration not necessary`,
+    )
+    return
+  }
+
+  logger.info(`Add 'allocationLifetime' column to 'IndexingRules' table`)
+  await queryInterface.addColumn('IndexingRules', 'allocationLifetime', {
+    type: DataTypes.INTEGER,
+    allowNull: false,
+    defaultValue: 27,
+  })
+}
+
+export async function down({ context }: Context): Promise<void> {
+  const { queryInterface, logger } = context
+
+  return await queryInterface.sequelize.transaction({}, async transaction => {
+    const tables = await queryInterface.showAllTables()
+
+    if (tables.includes('IndexingRules')) {
+      logger.info(`Remove 'allocationLifetime' column`)
+      await context.queryInterface.removeColumn(
+        'IndexingRules',
+        'allocationLifetime',
+        { transaction },
+      )
+
+      logger.info(`Remove 'int_IndexingRules_allocationLifetime' custom type`)
+      await queryInterface.sequelize.query(
+        `delete  from pg_type where typname = 'int_IndexingRules_allocationLifetime'`,
+      )
+    }
+  })
+}

packages/indexer-agent/src/indexer.ts

@@ -62,6 +62,7 @@ export class Indexer {
   indexNodeIDs: string[]
   defaultAllocationAmount: BigNumber
   indexerAddress: string
+  maxLifetime: number | null | undefined
 
   constructor(
     logger: Logger,
@@ -71,11 +72,13 @@ export class Indexer {
     indexNodeIDs: string[],
     defaultAllocationAmount: BigNumber,
     indexerAddress: string,
+    maxLifetime: number | null | undefined,
   ) {
     this.indexerManagement = indexerManagement
     this.statusResolver = statusResolver
     this.logger = logger
     this.indexerAddress = indexerAddress
+    this.maxLifetime = maxLifetime
 
     if (adminEndpoint.startsWith('https')) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -219,6 +222,7 @@ export class Indexer {
                 identifier
                 identifierType
                 allocationAmount
+                allocationLifetime
                 parallelAllocations
                 maxAllocationPercentage
                 minSignal
@@ -292,6 +296,7 @@ export class Indexer {
                   identifier
                   identifierType
                   allocationAmount
+                  allocationLifetime
                   parallelAllocations
                   maxAllocationPercentage
                   minSignal

packages/indexer-cli/src/__tests__/indexer/rules.test.ts

@@ -267,7 +267,7 @@ describe('Indexer rules tests', () => {
         },
       )
       cliTest(
-        'Indexer rules set subgraph id - success - offchain',
+        'Indexer rules set subgraph options - success',
         [
           'indexer',
           'rules',
@@ -277,6 +277,8 @@ describe('Indexer rules tests', () => {
           '1000',
           'decisionBasis',
           'offchain',
+          'allocationLifetime',
+          '12',
         ],
         'references/indexer-rule-subgraph-offchain',
         {
@@ -296,16 +298,18 @@ describe('Indexer rules tests', () => {
         },
       )
       cliTest(
-        'Indexer rules set deployment id - success - offchain',
+        'Indexer rules set deployment lifetime - success',
         [
           'indexer',
           'rules',
           'set',
           'QmZfeJYR86UARzp9HiXbURWunYgC9ywvPvoePNbuaATrEK',
           'decisionBasis',
           'offchain',
+          'allocationLifetime',
+          '21',
         ],
-        'references/indexer-rule-deployment-offchain',
+        'references/indexer-rule-deployment-lifetime',
         {
           expectedExitCode: 0,
           cwd: baseDir,
@@ -384,6 +388,16 @@ describe('Indexer rules tests', () => {
           timeout: 10000,
         },
       )
+      cliTest(
+        'Indexer rules get subgraph - success - options',
+        ['indexer', 'rules', 'get', '0x0000000000000000000000000000000000000000-2'],
+        'references/indexer-rule-subgraph-options',
+        {
+          expectedExitCode: 0,
+          cwd: baseDir,
+          timeout: 10000,
+        },
+      )
       cliTest(
         'Indexer rules get global - success',
         ['indexer', 'rules', 'get', 'global'],

packages/indexer-cli/src/__tests__/references/indexer-rule-deployment-always.stdout

@@ -1,5 +1,5 @@
-┌────────────────────────────────────────────────┬────────────────┬──────────────────┬─────────────────────┬─────────────────────────┬───────────┬───────────┬──────────┬─────────────────────┬────────┬───────────────┐
-│ identifier                                     │ identifierType │ allocationAmount │ parallelAllocations │ maxAllocationPercentage │ minSignal │ maxSignal │ minStake │ minAverageQueryFees │ custom │ decisionBasis │
-├────────────────────────────────────────────────┼────────────────┼──────────────────┼─────────────────────┼─────────────────────────┼───────────┼───────────┼──────────┼─────────────────────┼────────┼───────────────┤
-│ QmZZtzZkfzCWMNrajxBf22q7BC9HzoT5iJUK3S8qA6zNZr │ deployment     │ null             │ null                │ null                    │ null      │ null      │ null     │ null                │ null   │ always        │
-└────────────────────────────────────────────────┴────────────────┴──────────────────┴─────────────────────┴─────────────────────────┴───────────┴───────────┴──────────┴─────────────────────┴────────┴───────────────┘
+┌────────────────────────────────────────────────┬────────────────┬──────────────────┬───────────────────────┬─────────────────────┬─────────────────────────┬───────────┬───────────┬──────────┬─────────────────────┬────────┬───────────────┐
+│ identifier                                     │ identifierType │ allocationAmount │ allocationLifetime    │ parallelAllocations │ maxAllocationPercentage │ minSignal │ maxSignal │ minStake │ minAverageQueryFees │ custom │ decisionBasis │
+├────────────────────────────────────────────────┼────────────────┼──────────────────┼───────────────────────┼─────────────────────┼─────────────────────────┼───────────┼───────────┼──────────┼─────────────────────┼────────┼───────────────┤
+│ QmZZtzZkfzCWMNrajxBf22q7BC9HzoT5iJUK3S8qA6zNZr │ deployment     │ null             │ null                  │ null                │ null                    │ null      │ null      │ null     │ null                │ null   │ always        │
+└────────────────────────────────────────────────┴────────────────┴──────────────────┴───────────────────────┴─────────────────────┴─────────────────────────┴───────────┴───────────┴──────────┴─────────────────────┴────────┴───────────────┘

packages/indexer-cli/src/__tests__/references/indexer-rule-deployment-lifetime.stdout

@@ -0,0 +1,5 @@
+┌────────────────────────────────────────────────┬────────────────┬──────────────────┬───────────────────────┬─────────────────────┬─────────────────────────┬───────────┬───────────┬──────────┬─────────────────────┬────────┬───────────────┐
+│ identifier                                     │ identifierType │ allocationAmount │ allocationLifetime    │ parallelAllocations │ maxAllocationPercentage │ minSignal │ maxSignal │ minStake │ minAverageQueryFees │ custom │ decisionBasis │
+├────────────────────────────────────────────────┼────────────────┼──────────────────┼───────────────────────┼─────────────────────┼─────────────────────────┼───────────┼───────────┼──────────┼─────────────────────┼────────┼───────────────┤
+│ QmZfeJYR86UARzp9HiXbURWunYgC9ywvPvoePNbuaATrEK │ deployment     │ null             │ 21                    │ null                │ null                    │ null      │ null      │ null     │ null                │ null   │ offchain      │
+└────────────────────────────────────────────────┴────────────────┴──────────────────┴───────────────────────┴─────────────────────┴─────────────────────────┴───────────┴───────────┴──────────┴─────────────────────┴────────┴───────────────┘