refactor(sdk): rename StorageInfo → ServiceInfo, restructure pricing

- Rename getStorageInfo() → getServiceInfo()
- Restructure pricing fields for clarity
- Simplify allowance checks

Fixes: #360

Author: rvagg

docs/src/content/docs/guides/storage.mdx

@@ -286,9 +286,11 @@ Deletion of individual pieces is not supported at this time but is on the roadma
 Get comprehensive information about the storage service:
 
 ```typescript
-// Get storage service info including pricing and providers
-const info = await synapse.getStorageInfo()
-console.log('Price per TiB/month:', info.pricing.noCDN.perTiBPerMonth)
+// Get service information including pricing and providers
+const info = await synapse.storage.getServiceInfo()
+console.log('Storage price per TiB/month:', info.pricing.storagePricePerTiBPerMonth)
+console.log('CDN egress price per TiB:', info.pricing.cdnEgressPricePerTiB)
+console.log('Minimum price per month:', info.pricing.minimumPricePerMonth)
 console.log('Available providers:', info.providers.length)
 console.log('Network:', info.serviceParameters.network)
 

docs/src/content/docs/intro/getting-started.mdx

@@ -651,9 +651,11 @@ The SDK batches up to 32 uploads by default (configurable via `uploadBatchSize`)
 Get comprehensive information about the storage service:
 
 ```typescript
-// Get storage service info including pricing and providers
-const info = await synapse.getStorageInfo()
-console.log('Price per TiB/month:', info.pricing.noCDN.perTiBPerMonth)
+// Get service information including pricing and providers
+const info = await synapse.storage.getServiceInfo()
+console.log('Storage price per TiB/month:', info.pricing.storagePricePerTiBPerMonth)
+console.log('CDN egress price per TiB:', info.pricing.cdnEgressPricePerTiB)
+console.log('Minimum price per month:', info.pricing.minimumPricePerMonth)
 console.log('Available providers:', info.providers.length)
 console.log('Network:', info.serviceParameters.network)
 

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

@@ -32,8 +32,8 @@ import type {
   PieceRetriever,
   PreflightInfo,
   ProviderInfo,
+  ServiceInfo,
   StorageContextCallbacks,
-  StorageInfo,
   StorageServiceOptions,
   UploadCallbacks,
   UploadResult,
@@ -367,14 +367,12 @@ export class StorageManager {
   }
 
   /**
-   * Get comprehensive information about the storage service including
-   * approved providers, pricing, contract addresses, and current allowances
-   * @returns Complete storage service information
+   * Get service information including pricing, providers, and configuration
+   * @returns Service information with pricing, approved providers, and contract addresses
    */
-  async getStorageInfo(): Promise<StorageInfo> {
+  async getServiceInfo(): Promise<ServiceInfo> {
     try {
-      // Helper function to get allowances with error handling
-      const getOptionalAllowances = async (): Promise<StorageInfo['allowances']> => {
+      const getOptionalAllowances = async (): Promise<ServiceInfo['allowances']> => {
         try {
           const warmStorageAddress = this._synapse.getWarmStorageAddress()
           const approval = await this._synapse.payments.serviceApproval(warmStorageAddress, TOKENS.USDFC)
@@ -388,79 +386,58 @@ export class StorageManager {
             lockupUsed: approval.lockupUsed,
           }
         } catch {
-          // Return null if wallet not connected or any error occurs
           return null
         }
       }
 
-      // Create SPRegistryService to get providers
       const registryAddress = this._warmStorageService.getServiceProviderRegistryAddress()
       const spRegistry = new SPRegistryService(this._synapse.getProvider(), registryAddress)
 
-      // Fetch all data in parallel for performance
       const [pricingData, approvedIds, allowances] = await Promise.all([
         this._warmStorageService.getServicePrice(),
         this._warmStorageService.getApprovedProviderIds(),
         getOptionalAllowances(),
       ])
 
-      // Get provider details for approved IDs
       const providers = await spRegistry.getProviders(approvedIds)
-
-      // Calculate pricing per different time units
-      const epochsPerMonth = BigInt(pricingData.epochsPerMonth)
-
-      // TODO: StorageInfo needs updating to reflect that CDN costs are usage-based
-
-      // Calculate per-epoch pricing (base storage cost)
-      const noCDNPerEpoch = BigInt(pricingData.pricePerTiBPerMonthNoCDN) / epochsPerMonth
-      // CDN costs are usage-based (egress charges), so base storage cost is the same
-      const withCDNPerEpoch = BigInt(pricingData.pricePerTiBPerMonthNoCDN) / epochsPerMonth
-
-      // Calculate per-day pricing (base storage cost)
-      const noCDNPerDay = BigInt(pricingData.pricePerTiBPerMonthNoCDN) / TIME_CONSTANTS.DAYS_PER_MONTH
-      // CDN costs are usage-based (egress charges), so base storage cost is the same
-      const withCDNPerDay = BigInt(pricingData.pricePerTiBPerMonthNoCDN) / TIME_CONSTANTS.DAYS_PER_MONTH
-
-      // Filter out providers with zero addresses
       const validProviders = providers.filter((p: ProviderInfo) => p.serviceProvider !== ethers.ZeroAddress)
 
-      const network = this._synapse.getNetwork()
-
       return {
         pricing: {
-          noCDN: {
-            perTiBPerMonth: BigInt(pricingData.pricePerTiBPerMonthNoCDN),
-            perTiBPerDay: noCDNPerDay,
-            perTiBPerEpoch: noCDNPerEpoch,
-          },
-          // CDN costs are usage-based (egress charges), base storage cost is the same
-          withCDN: {
-            perTiBPerMonth: BigInt(pricingData.pricePerTiBPerMonthNoCDN),
-            perTiBPerDay: withCDNPerDay,
-            perTiBPerEpoch: withCDNPerEpoch,
-          },
+          storagePricePerTiBPerMonth: pricingData.pricePerTiBPerMonthNoCDN,
+          minimumPricePerMonth: pricingData.minimumPricePerMonth,
+          cdnEgressPricePerTiB: pricingData.pricePerTiBCdnEgress,
+          cacheMissEgressPricePerTiB: pricingData.pricePerTiBCacheMissEgress,
           tokenAddress: pricingData.tokenAddress,
-          tokenSymbol: 'USDFC', // Hardcoded as we know it's always USDFC
+          tokenSymbol: 'USDFC',
         },
         providers: validProviders,
         serviceParameters: {
-          network,
-          epochsPerMonth,
+          network: this._synapse.getNetwork(),
+          epochsPerMonth: pricingData.epochsPerMonth,
           epochsPerDay: TIME_CONSTANTS.EPOCHS_PER_DAY,
           epochDuration: TIME_CONSTANTS.EPOCH_DURATION,
           minUploadSize: SIZE_CONSTANTS.MIN_UPLOAD_SIZE,
           maxUploadSize: SIZE_CONSTANTS.MAX_UPLOAD_SIZE,
           warmStorageAddress: this._synapse.getWarmStorageAddress(),
           paymentsAddress: this._warmStorageService.getPaymentsAddress(),
           pdpVerifierAddress: this._warmStorageService.getPDPVerifierAddress(),
+          serviceProviderRegistryAddress: this._warmStorageService.getServiceProviderRegistryAddress(),
+          sessionKeyRegistryAddress: this._warmStorageService.getSessionKeyRegistryAddress(),
         },
         allowances,
       }
     } catch (error) {
-      throw new Error(
-        `Failed to get storage service information: ${error instanceof Error ? error.message : String(error)}`
-      )
+      throw new Error(`Failed to get service information: ${error instanceof Error ? error.message : String(error)}`)
     }
   }
+
+  /**
+   * Get service information including pricing, providers, and configuration
+   * @deprecated Use getServiceInfo() instead
+   * @returns Service information with pricing, approved providers, and contract addresses
+   */
+  async getStorageInfo(): Promise<ServiceInfo> {
+    return await this.getServiceInfo()
+  }
 }

packages/synapse-sdk/src/synapse.ts

@@ -17,7 +17,6 @@ import type {
   PieceCID,
   PieceRetriever,
   ProviderInfo,
-  StorageInfo,
   StorageServiceOptions,
   SubgraphConfig,
   SynapseOptions,
@@ -461,15 +460,4 @@ export class Synapse {
       throw new Error(`Failed to get provider info: ${error instanceof Error ? error.message : String(error)}`)
     }
   }
-
-  /**
-   * Get comprehensive information about the storage service including
-   * approved providers, pricing, contract addresses, and current allowances
-   * @deprecated Use synapse.storage.getStorageInfo() instead. This method will be removed in a future version.
-   * @returns Complete storage service information
-   */
-  async getStorageInfo(): Promise<StorageInfo> {
-    console.warn('synapse.getStorageInfo() is deprecated. Use synapse.storage.getStorageInfo() instead.')
-    return await this._storageManager.getStorageInfo()
-  }
 }

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

@@ -584,41 +584,43 @@ describe('Synapse', () => {
     })
   })
 
-  describe('getStorageInfo', () => {
-    it('should return comprehensive storage information', async () => {
+  describe('getServiceInfo', () => {
+    it('should return comprehensive service information', async () => {
       server.use(JSONRPC({ ...presets.basic }))
 
       const synapse = await Synapse.create({ signer })
-      const storageInfo = await synapse.getStorageInfo()
+      const serviceInfo = await synapse.storage.getServiceInfo()
 
       // Check pricing
-      assert.exists(storageInfo.pricing)
-      assert.exists(storageInfo.pricing.noCDN)
-      assert.exists(storageInfo.pricing.withCDN)
+      assert.exists(serviceInfo.pricing)
+      assert.exists(serviceInfo.pricing.storagePricePerTiBPerMonth)
+      assert.exists(serviceInfo.pricing.minimumPricePerMonth)
+      assert.exists(serviceInfo.pricing.cdnEgressPricePerTiB)
+      assert.exists(serviceInfo.pricing.cacheMissEgressPricePerTiB)
 
-      // Verify pricing calculations (2 USDFC per TiB per month)
-      const expectedNoCDNMonthly = parseUnits('2', 18) // 2 USDFC
-      assert.equal(storageInfo.pricing.noCDN.perTiBPerMonth, expectedNoCDNMonthly)
+      // Verify pricing (2 USDFC per TiB per month)
+      const expectedStorageMonthly = parseUnits('2', 18) // 2 USDFC
+      assert.equal(serviceInfo.pricing.storagePricePerTiBPerMonth, expectedStorageMonthly)
 
       // Check providers
-      assert.equal(storageInfo.providers.length, 2)
-      assert.equal(storageInfo.providers[0].serviceProvider, ADDRESSES.serviceProvider1)
-      assert.equal(storageInfo.providers[1].serviceProvider, ADDRESSES.serviceProvider2)
+      assert.equal(serviceInfo.providers.length, 2)
+      assert.equal(serviceInfo.providers[0].serviceProvider, ADDRESSES.serviceProvider1)
+      assert.equal(serviceInfo.providers[1].serviceProvider, ADDRESSES.serviceProvider2)
 
       // Check service parameters
-      assert.equal(storageInfo.serviceParameters.network, 'calibration')
-      assert.equal(storageInfo.serviceParameters.epochsPerMonth, 86400n)
-      assert.equal(storageInfo.serviceParameters.epochsPerDay, 2880n)
-      assert.equal(storageInfo.serviceParameters.epochDuration, 30)
-      assert.equal(storageInfo.serviceParameters.minUploadSize, 127)
-      assert.equal(storageInfo.serviceParameters.maxUploadSize, 200 * 1024 * 1024)
+      assert.equal(serviceInfo.serviceParameters.network, 'calibration')
+      assert.equal(serviceInfo.serviceParameters.epochsPerMonth, 86400n)
+      assert.equal(serviceInfo.serviceParameters.epochsPerDay, 2880n)
+      assert.equal(serviceInfo.serviceParameters.epochDuration, 30)
+      assert.equal(serviceInfo.serviceParameters.minUploadSize, 127)
+      assert.equal(serviceInfo.serviceParameters.maxUploadSize, 200 * 1024 * 1024)
 
-      // Check allowances (including operator approval flag)
-      assert.exists(storageInfo.allowances)
-      assert.equal(storageInfo.allowances?.isApproved, true)
-      assert.equal(storageInfo.allowances?.service, ADDRESSES.calibration.warmStorage)
-      assert.equal(storageInfo.allowances?.rateAllowance, 1000000n)
-      assert.equal(storageInfo.allowances?.lockupAllowance, 10000000n)
+      // Check allowances
+      assert.exists(serviceInfo.allowances)
+      assert.equal(serviceInfo.allowances?.isApproved, true)
+      assert.equal(serviceInfo.allowances?.service, ADDRESSES.calibration.warmStorage)
+      assert.equal(serviceInfo.allowances?.rateAllowance, 1000000n)
+      assert.equal(serviceInfo.allowances?.lockupAllowance, 10000000n)
     })
 
     it('should handle missing allowances gracefully', async () => {
@@ -632,13 +634,13 @@ describe('Synapse', () => {
       )
 
       const synapse = await Synapse.create({ signer })
-      const storageInfo = await synapse.getStorageInfo()
+      const serviceInfo = await synapse.storage.getServiceInfo()
 
       // Should still return data with null allowances
-      assert.exists(storageInfo.pricing)
-      assert.exists(storageInfo.providers)
-      assert.exists(storageInfo.serviceParameters)
-      assert.deepEqual(storageInfo.allowances, {
+      assert.exists(serviceInfo.pricing)
+      assert.exists(serviceInfo.providers)
+      assert.exists(serviceInfo.serviceParameters)
+      assert.deepEqual(serviceInfo.allowances, {
         isApproved: false,
         service: ADDRESSES.calibration.warmStorage,
         rateAllowance: 0n,
@@ -717,11 +719,11 @@ describe('Synapse', () => {
       )
 
       const synapse = await Synapse.create({ signer })
-      const storageInfo = await synapse.getStorageInfo()
+      const serviceInfo = await synapse.storage.getServiceInfo()
 
       // Should filter out zero address provider
-      assert.equal(storageInfo.providers.length, 1)
-      assert.equal(storageInfo.providers[0].serviceProvider, ADDRESSES.serviceProvider1)
+      assert.equal(serviceInfo.providers.length, 1)
+      assert.equal(serviceInfo.providers[0].serviceProvider, ADDRESSES.serviceProvider1)
     })
 
     it('should handle contract call failures', async () => {
@@ -738,7 +740,7 @@ describe('Synapse', () => {
       )
       try {
         const synapse = await Synapse.create({ signer })
-        await synapse.getStorageInfo()
+        await synapse.storage.getServiceInfo()
         assert.fail('Should have thrown')
       } catch (error: any) {
         // The error should bubble up from the contract call

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

@@ -673,22 +673,11 @@ describe('WarmStorageService', () => {
         const costs = await warmStorageService.calculateStorageCost(sizeInBytes)
 
         assert.exists(costs.perEpoch)
-        assert.exists(costs.perDay)
         assert.exists(costs.perMonth)
-        assert.exists(costs.withCDN)
-        assert.exists(costs.withCDN.perEpoch)
-        assert.exists(costs.withCDN.perDay)
-        assert.exists(costs.withCDN.perMonth)
 
         // Verify costs are reasonable
         assert.isTrue(costs.perEpoch > 0n)
-        assert.isTrue(costs.perDay > costs.perEpoch)
-        assert.isTrue(costs.perMonth > costs.perDay)
-
-        // CDN costs are usage-based (egress pricing), so withCDN equals base storage cost
-        assert.equal(costs.withCDN.perEpoch, costs.perEpoch)
-        assert.equal(costs.withCDN.perDay, costs.perDay)
-        assert.equal(costs.withCDN.perMonth, costs.perMonth)
+        assert.isTrue(costs.perMonth > costs.perEpoch)
       })
 
       it('should scale costs linearly with size', async () => {
@@ -707,9 +696,7 @@ describe('WarmStorageService', () => {
         const ratio = Number(costs10GiB.perEpoch) / Number(costs1GiB.perEpoch)
         assert.closeTo(ratio, 10, 0.01)
 
-        // Verify the relationship holds for day and month calculations
-        assert.equal(costs10GiB.perDay.toString(), (costs10GiB.perEpoch * 2880n).toString())
-        // For month calculation, allow for rounding errors due to integer division
+        // Verify the relationship holds for month calculation
         const expectedMonth = costs10GiB.perEpoch * TIME_CONSTANTS.EPOCHS_PER_MONTH
         const monthRatio = Number(costs10GiB.perMonth) / Number(expectedMonth)
         assert.closeTo(monthRatio, 1, 0.0001) // Allow 0.01% difference due to rounding