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.
React Native SDK
The Privacy Boost React Native SDK (@sunnyside-io/privacy-boost-react-native) wraps the Rust core via UniFFI-generated bindings, giving you a TypeScript surface backed by native iOS and Android binaries — no WebView, no JS-side proving.
Features
- TypeScript-first API — same idioms as the web SDK, native execution
- Promise-based — works with
async/await, hooks, and any state library - Tagged-union
SdkErrorfor exhaustive runtime checks - Multi-chain via
ChainContextHandle— operate on multiple chains from one identity - Drop-in delegate hooks for Keychain, Passkey, and biometrics on both platforms
- Identical core to TypeScript / iOS / Android SDKs (same proofs, same network protocol)
Installation
pod install; Android picks up the AAR automatically. See the installation guide for native setup details and any Hermes/Expo caveats.
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 |
sdk.createChainContext(config) | Open a chain-scoped handle |
Documentation
Getting Started
Guides
- Deposits
- Withdrawals
- Transfers
- Balances
- Transactions
- Multi-Chain
- Wallet Integration
- Session Storage
- Error Handling
Advanced
Reference
Requirements
- React Native 0.71+
- iOS deployment target 14+ (16+ for Passkey defaults)
- Android
minSdkVersion26+ (34+ for Passkey defaults) - Hermes or JSC (both supported)
Related
- Multi-Chain Concepts — architecture overview
- Authentication Concepts — auth flow details
- Quickstart — 5-minute integration
- TypeScript SDK — sibling SDK with the same API surface