Horizon: allocation management (#1123)

Co-authored-by: Maikol <[email protected]>

Author: tmigone

packages/indexer-agent/src/agent.ts

@@ -38,6 +38,7 @@ import {
   DeploymentManagementMode,
   SubgraphStatus,
   sequentialTimerMap,
+  HorizonTransitionValue,
 } from '@graphprotocol/indexer-common'
 
 import PQueue from 'p-queue'
@@ -47,7 +48,11 @@ import mapValues from 'lodash.mapvalues'
 import zip from 'lodash.zip'
 import { AgentConfigs, NetworkAndOperator } from './types'
 
-type ActionReconciliationContext = [AllocationDecision[], number, bigint]
+type ActionReconciliationContext = [
+  AllocationDecision[],
+  number,
+  HorizonTransitionValue,
+]
 
 const deploymentInList = (
   list: SubgraphDeploymentID[],
@@ -271,21 +276,22 @@ export class Agent {
         },
       )
 
-    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.LegacyStaking.maxAllocationEpochs()
-          }),
-        {
-          onError: error =>
-            logger.warn(`Failed to fetch max allocation epochs`, { error }),
-        },
-      )
+    const maxAllocationDuration: Eventual<
+      NetworkMapped<HorizonTransitionValue>
+    > = sequentialTimerMap(
+      { logger, milliseconds: requestIntervalLarge },
+      () =>
+        this.multiNetworks.map(({ network }) => {
+          logger.trace('Fetching max allocation duration', {
+            protocolNetwork: network.specification.networkIdentifier,
+          })
+          return network.networkMonitor.maxAllocationDuration()
+        }),
+      {
+        onError: error =>
+          logger.warn(`Failed to fetch max allocation duration`, { error }),
+      },
+    )
 
     const indexingRules: Eventual<NetworkMapped<IndexingRuleAttributes[]>> =
       sequentialTimerMap(
@@ -653,7 +659,7 @@ export class Agent {
     join({
       ticker: timer(requestIntervalLarge),
       currentEpochNumber,
-      maxAllocationEpochs,
+      maxAllocationDuration,
       activeDeployments,
       targetDeployments,
       activeAllocations,
@@ -663,7 +669,7 @@ export class Agent {
     }).pipe(
       async ({
         currentEpochNumber,
-        maxAllocationEpochs,
+        maxAllocationDuration,
         activeDeployments,
         targetDeployments,
         activeAllocations,
@@ -746,7 +752,7 @@ export class Agent {
           await this.reconcileActions(
             networkDeploymentAllocationDecisions,
             currentEpochNumber,
-            maxAllocationEpochs,
+            maxAllocationDuration,
           )
         } catch (err) {
           logger.warn(`Exited early while reconciling actions`, {
@@ -1008,18 +1014,25 @@ export class Agent {
     activeAllocations: Allocation[],
     deploymentAllocationDecision: AllocationDecision,
     epoch: number,
-    maxAllocationEpochs: bigint,
+    maxAllocationDuration: HorizonTransitionValue,
     network: Network,
   ): Promise<Allocation[]> {
-    const desiredAllocationLifetime = deploymentAllocationDecision.ruleMatch
-      .rule?.allocationLifetime
-      ? deploymentAllocationDecision.ruleMatch.rule.allocationLifetime
-      : Math.max(1, Number(maxAllocationEpochs) - 1)
-
-    // Identify expiring allocations
     let expiredAllocations = activeAllocations.filter(
-      allocation =>
-        epoch >= allocation.createdAtEpoch + desiredAllocationLifetime,
+      async (allocation: Allocation) => {
+        let desiredAllocationLifetime: number = 0
+        if (allocation.isLegacy) {
+          desiredAllocationLifetime = deploymentAllocationDecision.ruleMatch
+            .rule?.allocationLifetime
+            ? deploymentAllocationDecision.ruleMatch.rule.allocationLifetime
+            : Math.max(1, maxAllocationDuration.legacy - 1)
+        } else {
+          desiredAllocationLifetime = deploymentAllocationDecision.ruleMatch
+            .rule?.allocationLifetime
+            ? deploymentAllocationDecision.ruleMatch.rule.allocationLifetime
+            : maxAllocationDuration.horizon
+        }
+        return 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
@@ -1029,9 +1042,17 @@ export class Agent {
       expiredAllocations,
       async (allocation: Allocation) => {
         try {
-          const onChainAllocation =
-            await network.contracts.LegacyStaking.getAllocation(allocation.id)
-          return onChainAllocation.closedAtEpoch == 0n
+          if (allocation.isLegacy) {
+            const onChainAllocation =
+              await network.contracts.LegacyStaking.getAllocation(allocation.id)
+            return onChainAllocation.closedAtEpoch == 0n
+          } else {
+            const onChainAllocation =
+              await network.contracts.SubgraphService.getAllocation(
+                allocation.id,
+              )
+            return onChainAllocation.closedAt == 0n
+          }
         } catch (err) {
           this.logger.warn(
             `Failed to cross-check allocation state with contracts; assuming it needs to be closed`,
@@ -1052,7 +1073,7 @@ export class Agent {
     deploymentAllocationDecision: AllocationDecision,
     activeAllocations: Allocation[],
     epoch: number,
-    maxAllocationEpochs: bigint,
+    maxAllocationDuration: HorizonTransitionValue,
     network: Network,
     operator: Operator,
   ): Promise<void> {
@@ -1128,7 +1149,7 @@ export class Agent {
               activeDeploymentAllocations,
               deploymentAllocationDecision,
               epoch,
-              maxAllocationEpochs,
+              maxAllocationDuration,
               network,
             )
             if (expiringAllocations.length > 0) {
@@ -1147,7 +1168,7 @@ export class Agent {
   async reconcileActions(
     networkDeploymentAllocationDecisions: NetworkMapped<AllocationDecision[]>,
     epoch: NetworkMapped<number>,
-    maxAllocationEpochs: NetworkMapped<bigint>,
+    maxAllocationDuration: NetworkMapped<HorizonTransitionValue>,
   ): Promise<void> {
     // --------------------------------------------------------------------------------
     // Filter out networks set to `manual` allocation management mode, and ensure the
@@ -1200,14 +1221,14 @@ export class Agent {
       this.multiNetworks.zip3(
         validatedAllocationDecisions,
         epoch,
-        maxAllocationEpochs,
+        maxAllocationDuration,
       ),
       async (
         { network, operator }: NetworkAndOperator,
         [
           allocationDecisions,
           epoch,
-          maxAllocationEpochs,
+          maxAllocationDuration,
         ]: ActionReconciliationContext,
       ) => {
         // Do nothing if there are already approved actions in the queue awaiting execution
@@ -1232,7 +1253,7 @@ export class Agent {
         this.logger.trace(`Reconcile allocation actions`, {
           protocolNetwork: network.specification.networkIdentifier,
           epoch,
-          maxAllocationEpochs,
+          maxAllocationDuration,
           targetDeployments: allocationDecisions
             .filter(decision => decision.toAllocate)
             .map(decision => decision.deployment.ipfsHash),
@@ -1248,7 +1269,7 @@ export class Agent {
             decision,
             activeAllocations,
             epoch,
-            maxAllocationEpochs,
+            maxAllocationDuration,
             network,
             operator,
           ),

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

@@ -100,7 +100,8 @@ export const start = {
         group: 'Ethereum',
       })
       .option('confirmation-blocks', {
-        description: 'The number of blocks to wait for a transaction to be confirmed',
+        description:
+          'The number of blocks to wait for a transaction to be confirmed',
         type: 'number',
         default: 3,
         group: 'Ethereum',

packages/indexer-cli/src/__tests__/references/indexer-help.stdout

@@ -10,6 +10,12 @@ Manage indexer configuration
   indexer rules delete               Remove one or many indexing rules                                
   indexer rules clear (reset)        Clear one or more indexing rules                                 
   indexer rules                      Configure indexing rules                                         
+  indexer provision thaw             Thaw stake from the indexer's provision                          
+  indexer provision remove           Remove thawed stake from the indexer's provision                 
+  indexer provision list-thaw        List thaw requests for the indexer's provision                   
+  indexer provision get              List indexer provision details                                   
+  indexer provision add              Add stake to the indexer's provision                             
+  indexer provision                  Manage indexer's provision                                       
   indexer disputes get               Cross-check POIs submitted in the network                        
   indexer disputes                   Configure allocation POI monitoring                              
   indexer cost set model             Update a cost model                                              

packages/indexer-cli/src/__tests__/references/indexer.stdout

@@ -10,6 +10,12 @@ Manage indexer configuration
   indexer rules delete               Remove one or many indexing rules                                
   indexer rules clear (reset)        Clear one or more indexing rules                                 
   indexer rules                      Configure indexing rules                                         
+  indexer provision thaw             Thaw stake from the indexer's provision                          
+  indexer provision remove           Remove thawed stake from the indexer's provision                 
+  indexer provision list-thaw        List thaw requests for the indexer's provision                   
+  indexer provision get              List indexer provision details                                   
+  indexer provision add              Add stake to the indexer's provision                             
+  indexer provision                  Manage indexer's provision                                       
   indexer disputes get               Cross-check POIs submitted in the network                        
   indexer disputes                   Configure allocation POI monitoring                              
   indexer cost set model             Update a cost model                                              

packages/indexer-cli/src/allocations.ts

@@ -29,6 +29,7 @@ export interface IndexerAllocation {
   queryFeesCollected: bigint
   status: string
   protocolNetwork: string
+  isLegacy: boolean
 }
 
 const ALLOCATION_CONVERTERS_FROM_GRAPHQL: Record<
@@ -53,6 +54,7 @@ const ALLOCATION_CONVERTERS_FROM_GRAPHQL: Record<
   queryFeesCollected: nullPassThrough((x: string) => BigInt(x)),
   status: x => x,
   protocolNetwork: x => x,
+  isLegacy: x => x,
 }
 
 const ALLOCATION_FORMATTERS: Record<
@@ -76,6 +78,7 @@ const ALLOCATION_FORMATTERS: Record<
   queryFeesCollected: x => commify(formatGRT(x)),
   status: x => x,
   protocolNetwork: resolveChainAlias,
+  isLegacy: x => (x ? 'Yes' : 'No'),
 }
 
 /**
@@ -218,6 +221,8 @@ export const closeAllocation = async (
   client: IndexerManagementClient,
   allocationID: string,
   poi: string | undefined,
+  blockNumber: number | undefined,
+  publicPOI: string | undefined,
   force: boolean,
   protocolNetwork: string,
 ): Promise<CloseAllocationResult> => {
@@ -227,26 +232,31 @@ export const closeAllocation = async (
         mutation closeAllocation(
           $allocation: String!
           $poi: String
+          $blockNumber: Int
+          $publicPOI: String
           $force: Boolean
           $protocolNetwork: String!
         ) {
           closeAllocation(
             allocation: $allocation
             poi: $poi
+            blockNumber: $blockNumber
+            publicPOI: $publicPOI
             force: $force
             protocolNetwork: $protocolNetwork
           ) {
             allocation
             allocatedTokens
             indexingRewards
-            receiptsWorthCollecting
             protocolNetwork
           }
         }
       `,
       {
         allocation: allocationID,
         poi,
+        blockNumber,
+        publicPOI,
         force,
         protocolNetwork,
       },
@@ -264,6 +274,8 @@ export const reallocateAllocation = async (
   client: IndexerManagementClient,
   allocationID: string,
   poi: string | undefined,
+  blockNumber: number | undefined,
+  publicPOI: string | undefined,
   amount: bigint,
   force: boolean,
   protocolNetwork: string,
@@ -274,20 +286,23 @@ export const reallocateAllocation = async (
         mutation reallocateAllocation(
           $allocation: String!
           $poi: String
+          $blockNumber: Int
+          $publicPOI: String
           $amount: String!
           $force: Boolean
           $protocolNetwork: String!
         ) {
           reallocateAllocation(
             allocation: $allocation
             poi: $poi
+            blockNumber: $blockNumber
+            publicPOI: $publicPOI
             amount: $amount
             force: $force
             protocolNetwork: $protocolNetwork
           ) {
             closedAllocation
             indexingRewardsCollected
-            receiptsWorthCollecting
             createdAllocation
             createdAllocationStake
             protocolNetwork
@@ -297,6 +312,8 @@ export const reallocateAllocation = async (
       {
         allocation: allocationID,
         poi,
+        blockNumber,
+        publicPOI,
         amount: amount.toString(),
         force,
         protocolNetwork,