Documentation Index
Fetch the complete documentation index at: https://docs.cavos.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Wallet Lifecycle
Not Created -> Created (local + backend) -> Deployed (on-chain)
Create Wallet
Automatic (Recommended)
createWallet() handles the full flow:
const { createWallet, address } = useCavosNative();
await createWallet();
// User saw FaceID/TouchID prompt
// Wallet created and deployed
console.log('Address:', address);
Smart Flow
createWallet() implements smart recovery:
- Check for existing passkey
- If exists, authenticate and recover from backend
- If not, create new passkey and wallet
- Deploy wallet gaslessly
- Backup to backend
Load Existing Wallet
If you know a wallet exists locally:
const { loadWallet, hasWalletLocally } = useCavosNative();
// Check first
if (await hasWalletLocally()) {
await loadWallet(); // Prompts for biometric
}
Recover Wallet
For users on new devices with synced passkeys:
const { recoverWallet } = useCavosNative();
try {
await recoverWallet();
// Wallet recovered from backend
} catch (error) {
// No wallet found for this passkey
}
Check Wallet Status
Has Wallet Locally
const { hasWalletLocally } = useCavosNative();
const exists = await hasWalletLocally();
Is Deployed On-Chain
const { cavos } = useCavosNative();
const deployed = await cavos.isAccountDeployed();
Address
const { address } = useCavosNative();
// or
const { cavos } = useCavosNative();
const address = cavos.getAddress();
Balance
const { cavos } = useCavosNative();
const balance = await cavos.getBalance();
Funding Address
const fundingAddress = cavos.getFundingAddress();
Clear Wallet
Remove wallet from local storage:
const { clearWallet } = useCavosNative();
await clearWallet();
Logout
Full logout including OAuth session:
const { logout } = useCavosNative();
await logout();
// Session and wallet cleared
Storage Details
React Native SDK uses expo-secure-store:
| Data | Storage | Encryption |
|---|
| OAuth tokens | SecureStore | OS-level |
| Wallet metadata | SecureStore | OS-level |
| Encrypted private key | SecureStore | Passkey AES-GCM |
Advanced: Direct SDK Access
const { cavos } = useCavosNative();
// Get starknet.js Account
const account = cavos.getAccount();
// Check passkey mode
const isPasskey = cavos.isPasskeyOnlyMode();
// Get wallet mode
const mode = cavos.walletManager?.getMode(); // 'passkey-only' | 'oauth'
