feat: add WarmStorageService#topUpCDNPaymentRails (#332)

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

Author: 2 people

docs/src/content/docs/intro/components.mdx

@@ -139,6 +139,9 @@ if (verification.dataSetLive) {
 // Service provider operations
 const isApproved = await warmStorageService.isProviderApproved(providerAddress)
 const providers = await warmStorageService.getAllApprovedProviders()
+
+// Top up CDN payment rails
+await wamStorageService.topUpCDNPaymentRails(signer, dataSetId, cdnAmountToAdd, cacheMissAmountToAdd)
 ```
 
 ### Subgraph Service

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

@@ -2035,4 +2035,30 @@ describe('WarmStorageService', () => {
       mockProvider.call = originalCall
     })
   })
+
+  describe('CDN Operations', () => {
+    it('should top up CDN payment rails (mock transaction)', async () => {
+      const dataSetId = 49
+      const warmStorageService = await createWarmStorageService()
+      const mockSigner = {
+        getAddress: async () => '0x1234567890123456789012345678901234567890',
+      } as any
+
+      // Mock the contract connection
+      const originalGetWarmStorageContract = (warmStorageService as any)._getWarmStorageContract
+      ;(warmStorageService as any)._getWarmStorageContract = () => ({
+        connect: () => ({
+          topUpCDNPaymentRails: async () => ({
+            hash: '0xmocktxhash',
+            wait: async () => ({ status: 1 }),
+          }),
+        }),
+      })
+
+      const tx = await warmStorageService.topUpCDNPaymentRails(mockSigner, dataSetId, 1n, 1n)
+      assert.equal(tx.hash, '0xmocktxhash')
+
+      ;(warmStorageService as any)._getWarmStorageContract = originalGetWarmStorageContract
+    })
+  })
 })

packages/synapse-sdk/src/warm-storage/service.ts

@@ -6,6 +6,7 @@
  * - Service provider registration and management
  * - Client dataset ID tracking
  * - Data set creation verification
+ * - CDN service management
  *
  * @example
  * ```typescript
@@ -1081,4 +1082,32 @@ export class WarmStorageService {
     const window = await viewContract.challengeWindow()
     return Number(window)
   }
+  /**
+   * Increments the fixed locked-up amounts for CDN payment rails.
+   *
+   * This method tops up the prepaid balance for CDN services by adding to the existing
+   * lockup amounts. Both CDN and cache miss rails can be incremented independently.
+   *
+   * @param dataSetId - The ID of the data set
+   * @param cdnAmountToAdd - Amount to add to the CDN rail lockup
+   * @param cacheMissAmountToAdd - Amount to add to the cache miss rail lockup
+   * @returns Transaction response
+   */
+  async topUpCDNPaymentRails(
+    signer: ethers.Signer,
+    dataSetId: number,
+    cdnAmountToAdd: bigint,
+    cacheMissAmountToAdd: bigint
+  ): Promise<ethers.TransactionResponse> {
+    if (cdnAmountToAdd < 0n || cacheMissAmountToAdd < 0n) {
+      throw new Error('Top up amounts must be positive')
+    }
+    if (cdnAmountToAdd === 0n && cacheMissAmountToAdd === 0n) {
+      throw new Error('At least one top up amount must be >0')
+    }
+
+    const contract = this._getWarmStorageContract()
+    const contractWithSigner = contract.connect(signer) as ethers.Contract
+    return await contractWithSigner.topUpCDNPaymentRails(dataSetId, cdnAmountToAdd, cacheMissAmountToAdd)
+  }
 }