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.
iOS SDK
The Privacy Boost iOS SDK is a native Swift framework that wraps the Rust core via UniFFI. It exposes idiomatic Swift APIs (async throws, structs, enums with associated values) for shielding, unshielding, and private transfers.
Features
- Native Swift framework — no JavaScript bridge, no WebView
async/awaiteverywhere — works with Swift Concurrency and SwiftUI- Strongly-typed
SDKErrorenum with associated values for pattern matching - Drop-in defaults for Keychain, Passkey (iOS 16+), and biometrics
- Wallet-agnostic — implement
WalletDelegateonce for any signer - Identical core to the TypeScript / Android / React Native SDKs (same proofs, same network protocol)
Installation
Add the SwiftPM package to your project. See the installation guide for full details.Quick Example
Core Operations
| Method | Purpose |
|---|---|
sdk.shield(tokenAddress:amount:) | Deposit tokens into the shielded pool |
sdk.unshield(tokenAddress:amount:recipient:) | Withdraw to a public address |
sdk.send(tokenAddress:amount:recipientPrivacyAddress:) | Private transfer |
sdk.getBalance(tokenAddress:) | Single-token shielded + wallet balance |
sdk.getAllBalances() | All tracked balances |
sdk.getTransactionHistory(...) | Paginated history |
sdk.resolveIdentity(identifier:) | Look up a privacy address |
Documentation
Getting Started
Guides
- Deposits
- Withdrawals
- Transfers
- Balances
- Transactions
- Multi-Chain
- Wallet Integration
- Session Storage
- Error Handling
Advanced
Reference
Requirements
- iOS 14+ (iOS 16+ required for Passkey defaults)
- Swift 5.7+
- Xcode 14+
Related
- Multi-Chain Concepts — architecture overview
- Authentication Concepts — auth flow details
- Quickstart — 5-minute integration