fix(cli): make POI parameters optional for action queue commands (#1194)

Signed-off-by: Tomás Migone <tomas@edgeandnode.com>
Co-authored-by: Tomás Migone <tomas@edgeandnode.com>

Author: rotarur

packages/indexer-cli/src/__tests__/actions.unit.test.ts

@@ -49,7 +49,7 @@ describe('buildActionInput', () => {
     expect(result.publicPOI).toBe(zeroPOI)
     expect(result.force).toBe(false)
     expect(result.allocationID).toBe('0xallocationId')
-    expect(result.poiBlockNumber).toBeUndefined()
+    expect(result.poiBlockNumber).toBe(0)
   })
 })
 

packages/indexer-cli/src/actions.ts

@@ -49,23 +49,31 @@ function normalizePOIParams(
     normalizedPoi = zeroPOI
   }
 
-  let normalizedPublicPoi = publicPOI
-  if (normalizedPublicPoi === '0' || normalizedPublicPoi === '0x0') {
+  // Normalize publicPOI: convert '0' or '0x0' to zeroPOI
+  let normalizedPublicPoi: string | undefined = publicPOI
+  if (publicPOI === '0' || publicPOI === '0x0') {
     normalizedPublicPoi = zeroPOI
   }
 
-  let poiBlockNumber: number | undefined = undefined
+  // Normalize blockNumber: parse to number if provided
+  let normalizedBlockNumber: number | undefined = undefined
   if (blockNumber !== undefined) {
-    poiBlockNumber = parseInt(blockNumber, 10)
-    if (isNaN(poiBlockNumber)) {
+    normalizedBlockNumber = parseInt(blockNumber, 10)
+    if (isNaN(normalizedBlockNumber)) {
       throw new Error(`Invalid block number: ${blockNumber}`)
     }
   }
 
+  // When POI is zero, default publicPOI and blockNumber to zero as well
+  if (normalizedPoi === zeroPOI) {
+    normalizedPublicPoi = normalizedPublicPoi ?? zeroPOI
+    normalizedBlockNumber = normalizedBlockNumber ?? 0
+  }
+
   return {
     poi: normalizedPoi,
     publicPOI: normalizedPublicPoi,
-    poiBlockNumber,
+    poiBlockNumber: normalizedBlockNumber,
   }
 }
 

packages/indexer-common/src/__tests__/actions.test.ts

@@ -139,8 +139,8 @@ describe('Action Validation', () => {
 
       expect(isValidActionInput(missingDeploymentID)).toBe(false)
 
-      // With POI provided, must also have publicPOI and poiBlockNumber
-      const withPoiButMissingPublicPOI = {
+      // With non-zero POI provided, publicPOI and poiBlockNumber are required
+      const withNonZeroPoiButMissingPublicPOI = {
         ...baseAction,
         type: ActionType.PRESENT_POI,
         deploymentID: 'Qmtest',
@@ -149,7 +149,19 @@ describe('Action Validation', () => {
         isLegacy: false,
       }
 
-      expect(isValidActionInput(withPoiButMissingPublicPOI)).toBe(false)
+      expect(isValidActionInput(withNonZeroPoiButMissingPublicPOI)).toBe(false)
+
+      // With zero POI, publicPOI and poiBlockNumber are optional
+      const withZeroPoi = {
+        ...baseAction,
+        type: ActionType.PRESENT_POI,
+        deploymentID: 'Qmtest',
+        allocationID: '0x1234567890123456789012345678901234567890',
+        poi: '0x' + '00'.repeat(32),
+        isLegacy: false,
+      }
+
+      expect(isValidActionInput(withZeroPoi)).toBe(true)
 
       // With all POI fields provided
       const withAllPoiFields = {

packages/indexer-common/src/actions.ts

@@ -57,6 +57,26 @@ export interface ActionInput {
   isLegacy: boolean
 }
 
+const ZERO_POI = '0x0000000000000000000000000000000000000000000000000000000000000000'
+
+// Validates POI-related fields for non-legacy actions.
+// When POI is zero, publicPOI and poiBlockNumber are optional.
+// When POI is non-zero, all three fields are required.
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const hasValidPOIParams = (variableToCheck: any): boolean => {
+  if (variableToCheck.isLegacy || variableToCheck.poi === undefined) {
+    return true
+  }
+  if (variableToCheck.poi === ZERO_POI) {
+    return 'poi' in variableToCheck
+  }
+  return (
+    'poi' in variableToCheck &&
+    'publicPOI' in variableToCheck &&
+    'poiBlockNumber' in variableToCheck
+  )
+}
+
 export const isValidActionInput = (
   /* eslint-disable @typescript-eslint/no-explicit-any */
   variableToCheck: any,
@@ -71,29 +91,16 @@ export const isValidActionInput = (
       break
     case ActionType.UNALLOCATE:
       hasActionParams =
-        'deploymentID' in variableToCheck && 'allocationID' in variableToCheck
-
-      if (!variableToCheck.isLegacy && variableToCheck.poi !== undefined) {
-        hasActionParams =
-          hasActionParams &&
-          'poi' in variableToCheck &&
-          'publicPOI' in variableToCheck &&
-          'poiBlockNumber' in variableToCheck
-      }
+        'deploymentID' in variableToCheck &&
+        'allocationID' in variableToCheck &&
+        hasValidPOIParams(variableToCheck)
       break
     case ActionType.REALLOCATE:
       hasActionParams =
         'deploymentID' in variableToCheck &&
         'allocationID' in variableToCheck &&
-        'amount' in variableToCheck
-
-      if (!variableToCheck.isLegacy && variableToCheck.poi !== undefined) {
-        hasActionParams =
-          hasActionParams &&
-          'poi' in variableToCheck &&
-          'publicPOI' in variableToCheck &&
-          'poiBlockNumber' in variableToCheck
-      }
+        'amount' in variableToCheck &&
+        hasValidPOIParams(variableToCheck)
       break
     case ActionType.RESIZE:
       hasActionParams =
@@ -103,15 +110,9 @@ export const isValidActionInput = (
       break
     case ActionType.PRESENT_POI:
       hasActionParams =
-        'deploymentID' in variableToCheck && 'allocationID' in variableToCheck
-
-      if (!variableToCheck.isLegacy && variableToCheck.poi !== undefined) {
-        hasActionParams =
-          hasActionParams &&
-          'poi' in variableToCheck &&
-          'publicPOI' in variableToCheck &&
-          'poiBlockNumber' in variableToCheck
-      }
+        'deploymentID' in variableToCheck &&
+        'allocationID' in variableToCheck &&
+        hasValidPOIParams(variableToCheck)
       break
   }
   return (