Expo
Learn how to integrate the Capsule SDK with Expo projects.
The Capsule SDK for Expo allows you to easily integrate secure and scalable wallet functionalities into your mobile applications. This guide covers the installation, setup, and usage of the Capsule SDK in Expo projects.
Prerequisites
To use Capsule, you need an API key. This key authenticates your requests to Capsule services and is essential for integration.
Don’t have an API key yet? Request access to the Developer Portal to create API keys, manage billing, teams, and more.
Dependency Installation
To get started with the Capsule SDK in your Expo project, install the required packages:
Project Setup
Follow these steps to set up the Capsule SDK in your Expo environment:
Set Up Associated Domains
Configure your app.json
file to enable passkey functionality and secure communication:
Important: Your teamId + bundleIdentifier
must be registered with the Capsule team to set up associated domains. For example, if your Team ID is A1B2C3D4E5
and Bundle Identifier is com.yourdomain.yourapp
, provide A1B2C3D4E5.com.yourdomain.yourapp
to Capsule. This is required by Apple for passkey security. Allow up to 24 hours for domain propagation.
Prebuild and Run
To integrate native modules and generate the necessary native code for both iOS and Android:
Run these commands after adding or updating packages with native code. This step is crucial for setting up the native environment for both iOS and Android platforms.
Configure Polyfills and Shims
- Configure Metro bundler by creating or updating
metro.config.js
in your project root:
- Create
shim.js
in your project root:
- Import shim in your apps entry in Expo this is likey
_layout.tsx
if you are using app directory orindex.js
:
Add WebView Crypto Polyfill
Add the PolyfillCrypto
component to your root App
component:
Using the Capsule SDK
The Capsule SDK provides two main authentication flows: creating a new user and logging in an existing user. Both flows utilize Native Passkeys for secure and seamless authentication. Follow the steps below to implement these flows in your Expo application.
Beta Testing Credentials
During beta testing, you can use any email ending in @test.usecapsule.com
(like dev@test.usecapsule.com) or US phone numbers (+1) in the format (area code)-555-xxxx
(like (425)-555-1234). Any OTP code will work for verification with these test credentials.
These credentials are for beta testing only. You can delete test users anytime in the beta developer console to free up user slots.
Create New User
This flow guides you through the process of registering a new user, verifying their email, and setting up their wallet.
Initialize Capsule Client
First, set up the Capsule client to enable SDK interactions:
Capsule offers two hosted environments: Environment.BETA
(alias Environment.DEVELOPMENT
) for
testing, and Environment.PROD
(alias Environment.PRODUCTION
) for live use. Select the
environment that matches your current development phase.
Register New User
Create a new user account by calling the createUser
method. This will automatically send a verification email to the user:
Verify Email
Once the user receives the verification code, call the verifyEmailBiometricsId
method to confirm their email:
Register Passkey and Create Wallet
Use the returned biometricsId to register the user’s passkey and create their wallet:
Complete New User Flow
Implement the full flow by combining all the previous steps:
It’s crucial to securely share the recoverySecret
with the user. This secret is necessary for account recovery in case the user loses access to their device. Ensure you have a secure method to display or store this secret for the user.
Login Existing User
This flow demonstrates how to authenticate an existing user using their email and passkey.
Initialize Capsule Client
Ensure the Capsule client is set up (if not already done):
Check User Existence and Login
Verify if the user exists and log them in using their passkey:
By following these steps, you can implement a secure and user-friendly authentication system in your Expo application using the Capsule SDK.
Examples
For practical implementations of the Capsule SDK in Expo environments, check out our GitHub repository:
Next Steps
After integrating Capsule, you can explore other features and integrations to enhance your Capsule experience. Here are some resources to help you get started:
Ecosystems
Learn how to use Capsule with popular Web3 clients and wallet connectors. We’ll cover integration with key libraries for EVM, Solana, and Cosmos ecosystems.
If you’re ready to go live with your Capsule integration, make sure to review our go-live checklist:
Troubleshooting
If you encounter issues during the integration or usage of the Capsule SDK in your Expo application, here are some common problems and their solutions:
For a more comprehensive list of solutions, including Expo-specific issues, visit our troubleshooting guide:
Support
If you’re experiencing issues that aren’t resolved by our troubleshooting resources, please contact our support team for assistance. To help us serve you better, include the following information in your support request:
1
A detailed description of the problem you’re encountering.
2
Any relevant error messages or logs.
3
Steps to reproduce the issue.
4
Details about your system or environment (e.g., device, operating system, software version).
Providing this information will enable our team to address your concerns more efficiently.
Was this page helpful?