feat: deposit with permit integration (#202)

* feat: remove approval tx separate

* fix: docstring

* fix: use depositWithPermitAndApproveOperator

* fix: approved operator

* fix: else case

* fix: await tx.wait()

* fix: lint

* Update src/core/payments/index.ts

---------

Co-authored-by: Russell Dempsey <[email protected]>

Author: redpanda-f

src/common/upload-flow.ts

@@ -83,9 +83,6 @@ export async function performAutoFunding(synapse: Synapse, fileSize: number, spi
       log.indent(
         `Runway: ~${result.newRunwayDays} day(s)${result.newRunwayHours > 0 ? ` ${result.newRunwayHours} hour(s)` : ''}`
       )
-      if (result.approvalTx) {
-        log.indent(pc.gray(`Approval tx: ${result.approvalTx}`))
-      }
       if (result.transactionHash) {
         log.indent(pc.gray(`Transaction: ${result.transactionHash}`))
       }

src/core/payments/index.ts

@@ -238,14 +238,14 @@ export function validatePaymentRequirements(
 /**
  * Deposit USDFC into the Payments contract
  *
- * This demonstrates the two-step process required for depositing ERC20 tokens:
- * 1. Approve the Payments contract to spend USDFC (standard ERC20 approval)
- * 2. Call deposit to move funds into the Payments contract
+ * This demonstrates the single-step process required for depositing ERC20 tokens:
+ * 1. If approval is insufficient, use permit to approve and deposit in one transaction
+ * 2. If approval is sufficient, directly call deposit
  *
  * Example usage:
  * ```typescript
  * const amountToDeposit = ethers.parseUnits('100', 18) // 100 USDFC
- * const { approvalTx, depositTx } = await depositUSDFC(synapse, amountToDeposit)
+ * const { depositTx } = await depositUSDFC(synapse, amountToDeposit)
  * console.log(`Deposit transaction: ${depositTx}`)
  * ```
  *
@@ -257,36 +257,29 @@ export async function depositUSDFC(
   synapse: Synapse,
   amount: bigint
 ): Promise<{
-  approvalTx?: string
   depositTx: string
 }> {
-  const paymentsAddress = synapse.getPaymentsAddress()
+  const needsAllowanceUpdate = (await checkAllowances(synapse)).needsUpdate
+  const amountMoreThanCurrentAllowance =
+    (await synapse.payments.allowance(synapse.getPaymentsAddress(), TOKENS.USDFC)) < amount
 
-  // Step 1: Check current allowance
-  const currentAllowance = await synapse.payments.allowance(paymentsAddress, TOKENS.USDFC)
+  let tx: ethers.TransactionResponse
 
-  let approvalTx: string | undefined
-
-  // Step 2: Approve if needed (skip if already approved)
-  if (currentAllowance < amount) {
-    const approveTx = await synapse.payments.approve(paymentsAddress, amount, TOKENS.USDFC)
-    await approveTx.wait()
-    approvalTx = approveTx.hash
-  }
-
-  // Step 3: Make the deposit
-  const depositTransaction = await synapse.payments.deposit(amount, TOKENS.USDFC)
-  await depositTransaction.wait()
-
-  const result: { approvalTx?: string; depositTx: string } = {
-    depositTx: depositTransaction.hash,
+  if (amountMoreThanCurrentAllowance || needsAllowanceUpdate) {
+    tx = await synapse.payments.depositWithPermitAndApproveOperator(
+      amount,
+      synapse.getWarmStorageAddress(),
+      MAX_RATE_ALLOWANCE,
+      MAX_LOCKUP_ALLOWANCE,
+      BigInt(DEFAULT_LOCKUP_DAYS) * TIME_CONSTANTS.EPOCHS_PER_DAY
+    )
+  } else {
+    tx = await synapse.payments.deposit(amount, TOKENS.USDFC)
   }
 
-  if (approvalTx) {
-    result.approvalTx = approvalTx
-  }
+  await tx.wait()
 
-  return result
+  return { depositTx: tx.hash }
 }
 
 /**

src/payments/auto.ts

@@ -110,19 +110,6 @@ export async function runAutoSetup(options: PaymentSetupOptions): Promise<void>
     let actionsTaken = false
     let actualFilecoinPayTopUp = 0n
 
-    // Auto-set max allowances for WarmStorage
-    spinner.start('Configuring WarmStorage permissions...')
-    const allowanceResult = await checkAndSetAllowances(synapse)
-    if (allowanceResult.updated) {
-      spinner.stop(`${pc.green('✓')} WarmStorage permissions configured`)
-      log.line(pc.bold('Transaction:'))
-      log.indent(pc.gray(allowanceResult.transactionHash || 'Unknown'))
-      log.flush()
-      actionsTaken = true
-    } else {
-      spinner.stop(`${pc.green('✓')} WarmStorage permissions already configured`)
-    }
-
     if (status.filecoinPayBalance < targetFilecoinPayBalance) {
       const neededFilecoinPayTopUp = targetFilecoinPayBalance - status.filecoinPayBalance
       actualFilecoinPayTopUp = neededFilecoinPayTopUp
@@ -137,20 +124,22 @@ export async function runAutoSetup(options: PaymentSetupOptions): Promise<void>
       }
 
       spinner.start(`Depositing ${formatUSDFC(neededFilecoinPayTopUp)} USDFC...`)
-      const { approvalTx, depositTx } = await depositUSDFC(synapse, neededFilecoinPayTopUp)
+      const { depositTx } = await depositUSDFC(synapse, neededFilecoinPayTopUp)
       spinner.stop(`${pc.green('✓')} Deposited ${formatUSDFC(neededFilecoinPayTopUp)} USDFC`)
       actionsTaken = true
 
       log.line(pc.bold('Transaction details:'))
-      if (approvalTx) {
-        log.indent(pc.gray(`Approval: ${approvalTx}`))
-      }
       log.indent(pc.gray(`Deposit: ${depositTx}`))
       log.flush()
     } else {
       // Use a dummy spinner to get consistent formatting
       spinner.start('Checking deposit...')
-      spinner.stop(`${pc.green('✓')} Deposit already sufficient (${formatUSDFC(status.filecoinPayBalance)} USDFC)`)
+      const { updated, transactionHash } = await checkAndSetAllowances(synapse)
+      if (updated) {
+        spinner.stop(`${pc.green('✓')} Updated payment allowances, tx: ${transactionHash}`)
+      } else {
+        spinner.stop(`${pc.green('✓')} Deposit already sufficient (${formatUSDFC(status.filecoinPayBalance)} USDFC)`)
+      }
     }
 
     // Calculate capacity for final summary

src/payments/deposit.ts

@@ -135,13 +135,10 @@ export async function runDeposit(options: DepositOptions): Promise<void> {
     }
 
     spinner.start(`Depositing ${formatUSDFC(depositAmount)} USDFC...`)
-    const { approvalTx, depositTx } = await depositUSDFC(synapse, depositAmount)
+    const { depositTx } = await depositUSDFC(synapse, depositAmount)
     spinner.stop(`${pc.green('✓')} Deposit complete`)
 
     log.line(pc.bold('Transaction details:'))
-    if (approvalTx) {
-      log.indent(pc.gray(`Approval: ${approvalTx}`))
-    }
     log.indent(pc.gray(`Deposit: ${depositTx}`))
     log.flush()
 

src/payments/fund.ts

@@ -92,10 +92,9 @@ async function performAdjustment(params: {
       }
     }
     spinner.start(depositMsg)
-    const { approvalTx, depositTx } = await depositUSDFC(synapse, needed)
+    const { depositTx } = await depositUSDFC(synapse, needed)
     spinner.stop(`${pc.green('✓')} Deposit complete`)
     log.line(pc.bold('Transaction details:'))
-    if (approvalTx) log.indent(pc.gray(`Approval: ${approvalTx}`))
     log.indent(pc.gray(`Deposit: ${depositTx}`))
     log.flush()
   } else if (delta < 0n) {
@@ -197,7 +196,6 @@ export async function autoFund(options: AutoFundOptions): Promise<FundingAdjustm
   const depositMsg = `Depositing ${formatUSDFC(delta)} USDFC to ensure ${MIN_RUNWAY_DAYS} day(s) runway...`
   spinner?.message(depositMsg)
   const depositResult = await depositUSDFC(synapse, delta)
-  const approvalTx = depositResult.approvalTx
   const transactionHash = depositResult.depositTx
   spinner?.message(`${pc.green('✓')} Deposit complete`)
 
@@ -211,7 +209,6 @@ export async function autoFund(options: AutoFundOptions): Promise<FundingAdjustm
   return {
     adjusted: true,
     delta,
-    approvalTx,
     transactionHash,
     newDepositedAmount: updated.filecoinPayBalance,
     newRunwayDays: newRunway,

src/payments/interactive.ts

@@ -12,13 +12,12 @@ import { ethers } from 'ethers'
 import pc from 'picocolors'
 import {
   calculateDepositCapacity,
-  checkAllowances,
+  checkAndSetAllowances,
   checkFILBalance,
   checkUSDFCBalance,
   DEFAULT_LOCKUP_DAYS,
   depositUSDFC,
   getPaymentStatus,
-  setMaxAllowances,
   validatePaymentRequirements,
 } from '../core/payments/index.js'
 import { cleanupProvider, cleanupSynapseService } from '../core/synapse/index.js'
@@ -155,41 +154,6 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
     let depositAmount = 0n
     let actionsTaken = false // Track if any changes were made
 
-    // Check and optionally set max allowances for WarmStorage
-    s.start('Checking WarmStorage permissions...')
-    const allowanceCheck = await checkAllowances(synapse)
-
-    if (allowanceCheck.needsUpdate) {
-      s.stop(`${pc.yellow('⚠')} WarmStorage authorization required`)
-      log.line('')
-      log.line(pc.bold('WarmStorage Service Authorization'))
-      log.line('WarmStorage needs permissions to manage storage payments on your behalf.')
-      log.line('This is a one-time setup.')
-      log.line('')
-
-      const shouldSetAllowances = await confirm({
-        message: 'Authorize WarmStorage?',
-        initialValue: true,
-      })
-
-      if (isCancel(shouldSetAllowances)) {
-        cancel('Setup cancelled')
-        process.exit(1)
-      }
-
-      if (shouldSetAllowances) {
-        s.start('Setting WarmStorage permissions...')
-        const setResult = await setMaxAllowances(synapse)
-        s.stop(`${pc.green('✓')} WarmStorage permissions configured`)
-        log.indent(pc.gray(`Transaction: ${setResult.transactionHash}`))
-        actionsTaken = true
-      } else {
-        log.line(pc.yellow('⚠ Skipping WarmStorage authorization. You may need to set this before using storage.'))
-      }
-    } else {
-      s.stop(`${pc.green('✓')} WarmStorage permissions already configured`)
-    }
-
     // Show current deposit capacity
     const currentCapacity = calculateDepositCapacity(status.filecoinPayBalance, pricePerTiBPerEpoch)
     log.line(pc.bold('Current Storage Capacity:'))
@@ -258,12 +222,9 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
       depositAmount = ethers.parseUnits(amountStr, 18)
 
       s.start('Depositing USDFC...')
-      const { approvalTx, depositTx } = await depositUSDFC(synapse, depositAmount)
+      const { depositTx } = await depositUSDFC(synapse, depositAmount)
       s.stop(`${pc.green('✓')} Deposit complete`)
 
-      if (approvalTx) {
-        log.indent(pc.gray(`Approval tx: ${approvalTx}`))
-      }
       log.indent(pc.gray(`Deposit tx: ${depositTx}`))
       actionsTaken = true
 
@@ -278,6 +239,13 @@ export async function runInteractiveSetup(options: PaymentSetupOptions): Promise
       log.indent(`Total deposit: ${formatUSDFC(status.filecoinPayBalance + depositAmount)} USDFC`)
       log.indent(`Capacity: ~${newCapacityStr} for 1 month`)
       log.flush()
+    } else {
+      const { updated, transactionHash } = await checkAndSetAllowances(synapse)
+      if (updated) {
+        log.indent(`${pc.green('✓')} Updated payment allowances, tx: ${transactionHash}`)
+      } else {
+        log.indent(`${pc.green('✓')} Deposit already sufficient (${formatUSDFC(status.filecoinPayBalance)} USDFC)`)
+      }
     }
 
     // Final summary

src/payments/types.ts

@@ -25,8 +25,6 @@ export interface FundingAdjustmentResult {
   adjusted: boolean
   /** Amount deposited (positive) or withdrawn (negative) */
   delta: bigint
-  /** Approval transaction hash (if deposit required approval) */
-  approvalTx?: string | undefined
   /** Deposit or withdraw transaction hash */
   transactionHash?: string | undefined
   /** Updated deposited amount after adjustment */

src/test/unit/payments-setup.test.ts

@@ -93,9 +93,9 @@ describe('Payment Setup Tests', () => {
           lockupUsed: 0n,
         }),
         allowance: vi.fn().mockResolvedValue(ethers.parseUnits('0', 18)),
-        approve: vi.fn().mockResolvedValue({
+        depositWithPermitAndApproveOperator: vi.fn().mockResolvedValue({
           wait: vi.fn(),
-          hash: '0xapproval',
+          hash: '0xdepositWithPermitAndApproveOperator',
         }),
         deposit: vi.fn().mockResolvedValue({
           wait: vi.fn(),
@@ -166,21 +166,17 @@ describe('Payment Setup Tests', () => {
 
       const result = await depositUSDFC(mockSynapse, ethers.parseUnits('5', 18))
 
-      expect(result.approvalTx).toBeUndefined()
-      expect(result.depositTx).toBe('0xdeposit')
-      expect(mockSynapse.payments.approve).not.toHaveBeenCalled()
-      expect(mockSynapse.payments.deposit).toHaveBeenCalled()
+      expect(result.depositTx).toBe('0xdepositWithPermitAndApproveOperator')
+      expect(mockSynapse.payments.depositWithPermitAndApproveOperator).toHaveBeenCalled()
     })
 
     it('should approve and deposit when allowance insufficient', async () => {
       mockSynapse.payments.allowance.mockResolvedValue(ethers.parseUnits('0', 18))
 
       const result = await depositUSDFC(mockSynapse, ethers.parseUnits('5', 18))
 
-      expect(result.approvalTx).toBe('0xapproval')
-      expect(result.depositTx).toBe('0xdeposit')
-      expect(mockSynapse.payments.approve).toHaveBeenCalled()
-      expect(mockSynapse.payments.deposit).toHaveBeenCalled()
+      expect(result.depositTx).toBe('0xdepositWithPermitAndApproveOperator')
+      expect(mockSynapse.payments.depositWithPermitAndApproveOperator).toHaveBeenCalled()
     })
   })