fix(action): use fileSize to determine capacity when spendrate=0 (#132)

* Initial plan

* Fix payment balance calculation to account for upcoming file uploads

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

* Apply linting fixes to test file

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

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: BigLep <[email protected]>

Author: Copilot

src/test/unit/payments.compute.test.ts

@@ -2,6 +2,7 @@ import { TIME_CONSTANTS } from '@filoz/synapse-sdk'
 import { describe, expect, it } from 'vitest'
 import {
   computeAdjustmentForExactDays,
+  computeAdjustmentForExactDaysWithFile,
   computeAdjustmentForExactDeposit,
   computeTopUpForDuration,
   type PaymentStatus,
@@ -142,3 +143,38 @@ describe('computeAdjustmentForExactDeposit', () => {
     expect(res.clampedTarget).toBe(1_500n)
   })
 })
+
+describe('computeAdjustmentForExactDaysWithFile', () => {
+  it('calculates deposit for new file when rateUsed is 0', () => {
+    // Scenario: No existing storage, uploading first file
+    const status = makeStatus({ depositedAmount: 0n, lockupUsed: 0n, rateUsed: 0n })
+    const carSizeBytes = 1024 * 1024 * 1024 // 1 GiB
+    const pricePerTiBPerEpoch = 1_000_000_000_000_000n // 0.001 USDFC per TiB per epoch
+    const days = 30
+
+    const res = computeAdjustmentForExactDaysWithFile(status, days, carSizeBytes, pricePerTiBPerEpoch)
+
+    // Should require deposit for both lockup and runway
+    expect(res.delta).toBeGreaterThan(0n)
+    expect(res.newRateUsed).toBeGreaterThan(0n)
+    expect(res.newLockupUsed).toBeGreaterThan(0n)
+  })
+
+  it('adds file requirements to existing usage', () => {
+    // Scenario: Existing storage, adding another file
+    const rateUsed = 1_000_000_000_000_000_000n // 1 USDFC/epoch
+    const lockupUsed = rateUsed * BigInt(10) * TIME_CONSTANTS.EPOCHS_PER_DAY // 10 days worth
+    const depositedAmount = (lockupUsed * 12n) / 10n // 20% buffer
+    const status = makeStatus({ depositedAmount, lockupUsed, rateUsed })
+
+    const carSizeBytes = 1024 * 1024 * 1024 // 1 GiB
+    const pricePerTiBPerEpoch = 1_000_000_000_000_000n // 0.001 USDFC per TiB per epoch
+    const days = 30
+
+    const res = computeAdjustmentForExactDaysWithFile(status, days, carSizeBytes, pricePerTiBPerEpoch)
+
+    // New rate should be higher than existing
+    expect(res.newRateUsed).toBeGreaterThan(rateUsed)
+    expect(res.newLockupUsed).toBeGreaterThan(lockupUsed)
+  })
+})

upload-action/src/filecoin.js

@@ -2,6 +2,7 @@ import { promises as fs } from 'node:fs'
 import { RPC_URLS } from '@filoz/synapse-sdk'
 import {
   calculateStorageRunway,
+  computeAdjustmentForExactDaysWithFile,
   computeTopUpForDuration,
   depositUSDFC,
   getPaymentStatus,
@@ -71,7 +72,7 @@ export async function initializeSynapse(config, logger) {
  * @returns {Promise<PaymentStatus>} Updated payment status
  */
 export async function handlePayments(synapse, options, logger) {
-  const { minStorageDays, filecoinPayBalanceLimit } = options
+  const { minStorageDays, filecoinPayBalanceLimit, carSizeBytes } = options
 
   console.log('Checking current Filecoin Pay account balance...')
   const initialStatus = await getPaymentStatus(synapse)
@@ -82,9 +83,32 @@ export async function handlePayments(synapse, options, logger) {
   let requiredTopUp = 0n
 
   if (minStorageDays > 0) {
-    const { topUp } = computeTopUpForDuration(initialStatus, minStorageDays)
-    requiredTopUp = topUp
-    console.log(`Required top-up for ${minStorageDays} days of storage: ${formatUSDFC(requiredTopUp)} USDFC`)
+    const rateUsed = initialStatus.currentAllowances.rateUsed ?? 0n
+
+    // If there's an upcoming file upload and no existing usage, calculate deposit based on file size
+    if (rateUsed === 0n && carSizeBytes != null && carSizeBytes > 0) {
+      // Get pricing information to calculate file requirements
+      const storageInfo = await synapse.storage.getStorageInfo()
+      const pricePerTiBPerEpoch = storageInfo.pricing.noCDN.perTiBPerEpoch
+
+      // Calculate required deposit accounting for the new file
+      const { delta } = computeAdjustmentForExactDaysWithFile(
+        initialStatus,
+        minStorageDays,
+        carSizeBytes,
+        pricePerTiBPerEpoch
+      )
+
+      requiredTopUp = delta > 0n ? delta : 0n
+      console.log(
+        `Required top-up for ${minStorageDays} days of storage (including upcoming upload): ${formatUSDFC(requiredTopUp)} USDFC`
+      )
+    } else {
+      // Use existing logic for maintaining current usage
+      const { topUp } = computeTopUpForDuration(initialStatus, minStorageDays)
+      requiredTopUp = topUp
+      console.log(`Required top-up for ${minStorageDays} days of storage: ${formatUSDFC(requiredTopUp)} USDFC`)
+    }
   }
 
   // Check if deposit would exceed maximum balance if specified

upload-action/src/types.ts

@@ -70,6 +70,7 @@ export interface PRMetadata {
 export interface PaymentConfig {
   minStorageDays: number
   filecoinPayBalanceLimit?: bigint | undefined
+  carSizeBytes?: number | undefined
 }
 
 export interface UploadConfig {

upload-action/src/upload.js

@@ -154,7 +154,11 @@ export async function runUpload(buildContext = {}) {
       summary: 'Verifying account balance and calculating required deposits...',
     })
 
-    paymentStatus = await handlePayments(synapse, { minStorageDays, filecoinPayBalanceLimit }, logger)
+    paymentStatus = await handlePayments(
+      synapse,
+      { minStorageDays, filecoinPayBalanceLimit, carSizeBytes: context.carSize },
+      logger
+    )
 
     console.log('✓ Funding phase complete')