fix: expose getScheduledRemovals on storageContext (#490)

Author: SgtPooki

packages/synapse-sdk/src/storage/context.ts

@@ -1149,6 +1149,25 @@ export class StorageContext {
     return pieces
   }
 
+  /**
+   * Get pieces scheduled for removal from this data set
+   * @returns Array of piece IDs scheduled for removal
+   */
+  async getScheduledRemovals(): Promise<number[]> {
+    if (this._dataSetId == null) {
+      return []
+    }
+
+    const pdpVerifierAddress = this._warmStorageService.getPDPVerifierAddress()
+    const pdpVerifier = new PDPVerifier(this._synapse.getProvider(), pdpVerifierAddress)
+
+    try {
+      return await pdpVerifier.getScheduledRemovals(this._dataSetId)
+    } catch (error) {
+      throw createError('StorageContext', 'getScheduledRemovals', 'Failed to get scheduled removals', error)
+    }
+  }
+
   /**
    * Get all active pieces for this data set as an async generator.
    * This provides lazy evaluation and better memory efficiency for large data sets.

packages/synapse-sdk/src/test/storage.test.ts

@@ -2010,6 +2010,46 @@ describe('StorageService', () => {
     })
   })
 
+  describe('getScheduledRemovals', () => {
+    it('should return scheduled removals for the data set', async () => {
+      server.use(
+        JSONRPC({
+          ...presets.basic,
+          pdpVerifier: {
+            ...presets.basic.pdpVerifier,
+            getScheduledRemovals: () => [[1n, 2n, 5n]],
+          },
+        })
+      )
+
+      const synapse = await Synapse.create({ signer })
+      const warmStorageService = await WarmStorageService.create(provider, ADDRESSES.calibration.warmStorage)
+      const context = await StorageContext.create(synapse, warmStorageService, {
+        dataSetId: 1,
+      })
+
+      const scheduledRemovals = await context.getScheduledRemovals()
+
+      assert.deepEqual(scheduledRemovals, [1, 2, 5])
+    })
+
+    it('should return an empty array when no data set is configured', async () => {
+      server.use(JSONRPC({ ...presets.basic }), PING())
+
+      const synapse = await Synapse.create({ signer })
+      const warmStorageService = await WarmStorageService.create(provider, ADDRESSES.calibration.warmStorage)
+      const context = await StorageContext.create(synapse, warmStorageService, {
+        dataSetId: 1,
+      })
+
+      ;(context as any)._dataSetId = undefined
+
+      const scheduledRemovals = await context.getScheduledRemovals()
+
+      assert.deepEqual(scheduledRemovals, [])
+    })
+  })
+
   describe('getPieces', () => {
     it('should get all active pieces with pagination', async () => {
       // Use actual valid PieceCIDs from test data