Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.privacyboost.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Deposits

This guide covers depositing tokens from your wallet into your private balance.

​
Basic Deposit

do {
    let result = try await sdk.shield(
        tokenAddress: "0x...token-address",
        amount: "1000000000000000000" // 1 token (18 decimals)
    )
    print("Transaction hash: \(result.txHash)")
    print("Commitment: \(result.commitment)")
} catch {
    print("Deposit failed: \(error)")
}

​
Deposit Parameters

ParameterTypeRequiredDescription
tokenAddressStringYesERC-20 token contract address
amountStringYesAmount in wei (smallest unit)

​
Deposit Steps

When a deposit is submitted, the SDK executes these steps in order:
StepDescription
WrappingWrapping ETH to WETH (if depositing ETH)
ApprovingApproving token spending on the shield contract
ShieldingExecuting the deposit transaction
RegisteringRegistering the deposit with the indexer
ComplianceWaiting for compliance verification

​
Deposit Result

struct DepositResult {
    let txHash: String      // Main deposit transaction hash
    let commitment: String  // Note commitment
    let fee: String         // Fee paid (in wei)
}

​
Depositing ETH

To deposit native ETH, use the zero address. The SDK automatically wraps ETH to WETH: 
let ethAddress = "0x0000000000000000000000000000000000000000"

do {
    let result = try await sdk.shield(
        tokenAddress: ethAddress,
        amount: "1000000000000000000" // 1 ETH
    )
    print("Deposit tx: \(result.txHash)")
} catch {
    print("ETH deposit failed: \(error)")
}
The SDK automatically:
  1. Wraps ETH to WETH
  2. Approves WETH spending
  3. Deposits WETH to the shield contract

​
Parsing Amounts

Use helper functions to convert between human-readable and wei formats: 
// Parse human-readable amount to wei string
let weiAmount = try sdk.parseAmount("1.5", decimals: 18)
// Returns: "1500000000000000000"

// Format wei string to human-readable
let formatted = try sdk.formatAmount("1500000000000000000", decimals: 18)
// Returns: "1.5"

// For USDC (6 decimals)
let usdcWei = try sdk.parseAmount("100.0", decimals: 6)
// Returns: "100000000"

​
Error Handling

do {
    let result = try await sdk.shield(
        tokenAddress: tokenAddress,
        amount: amount
    )
} catch SDKError.insufficientBalance {
    print("Not enough tokens in wallet")
} catch SDKError.invalidAmount {
    print("Invalid amount format")
} catch SDKError.walletError(let message) {
    print("Wallet error: \(message)")
} catch SDKError.signatureRejected {
    print("User rejected the transaction")
} catch SDKError.networkError(let message) {
    print("Network error: \(message)")
} catch {
    print("Deposit error: \(error)")
}

​
Best Practices

​
1. Validate Amounts Before Depositing

func validateDepositAmount(_ amount: String, walletBalance: String) throws {
    guard let amountValue = UInt64(amount), amountValue > 0 else {
        throw SDKError.invalidAmount
    }
    guard let balanceValue = UInt64(walletBalance),
          amountValue <= balanceValue else {
        throw SDKError.insufficientBalance
    }
}

​
2. Refresh Balance After Deposit

let result = try await sdk.shield(
    tokenAddress: tokenAddress,
    amount: amount
)

// Refresh balance to reflect the deposit
let updatedBalance = try await sdk.getBalance(tokenAddress: tokenAddress)
print("New shielded balance: \(updatedBalance.shieldedBalance)")

​
3. Handle Long Operations

Deposits involve multiple on-chain transactions and may take time. Show appropriate loading states in your UI and avoid blocking the main thread.

​
Next Steps