@web3auth/react-native-sdk
Advanced tools
Weekly downloads
Readme
Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.
Checkout the official Web3Auth Documentation and SDK Reference to get started!
...and a lot more
For iOS, only iOS 12+ supported since we requires ASWebAuthenticationSession.
For Android, Custom Tab support is required.
In React Native, you have the choice to use one of the following workflows:
npm install @web3auth/react-native-sdk
Hop on to the Web3Auth Dashboard and create a new project. Use the Client ID of the project to start your integration.
Add {YOUR_APP_PACKAGE_NAME}://auth
to Whitelist URLs.
Copy the Project ID for usage later.
When using our SDK with a Expo-based React Native app (aka managed workflow, you have to install the expo-web-browser
package as a WebBrowser
implementation.)
expo install expo-web-browser
To allow the SDK to work with exported Expo Android apps, you need to place a designated scheme into app.json
, like below:
{
"expo": {
"scheme": "web3authexposample"
}
}
When using our SDK with a bare workflow React Native app, you have to install a WebBrowser
implementation made by us.
npm install --save @toruslabs/react-native-web-browser
scheme
parameter in the redirectUrl
is specificable, and has to be added into the AndroidManifest.xml
.<data android:scheme="web3authrnexample" />
scheme
parameter in the redirectUrl
is specificable here as well, however, it does not need to be added as a iOS Custom URL Scheme. You may add the scheme
to your iOS Info.plist
, but it is not required.For example, the scheme mentioned is web3authrnexample
and the redirectUrl
mentioned is ${scheme}://openlogin
, we will whitelist:
web3authrnexample://openlogin
In your sign-in activity', create an Web3Auth
instance with your Web3Auth project's configurations and
configure it like this:
import * as WebBrowser from 'expo-web-browser';
import Web3Auth, { LOGIN_PROVIDER, OPENLOGIN_NETWORK } from "@web3auth/react-native-sdk";
const web3auth = new Web3Auth(WebBrowser, {
clientId,
network: OPENLOGIN_NETWORK.TESTNET, // or other networks
});
const info = await web3auth.login({
loginProvider: LOGIN_PROVIDER.GOOGLE,
redirectUrl: resolvedRedirectUrl,
mfaLevel: 'mandatory', // optional
curve: 'secp256k1', // optional
});
import * as WebBrowser from '@toruslabs/react-native-web-browser';
import Web3Auth, { LOGIN_PROVIDER, OPENLOGIN_NETWORK } from "@web3auth/react-native-sdk";
const web3auth = new Web3Auth(WebBrowser, {
clientId,
network: OPENLOGIN_NETWORK.TESTNET, // or other networks
});
const info = await web3auth.login({
loginProvider: LOGIN_PROVIDER.GOOGLE,
redirectUrl: resolvedRedirectUrl,
mfaLevel: 'mandatory', // optional
curve: 'secp256k1', // optional
});
Checkout the examples for your preferred blockchain and platform in our examples repository
Checkout the Web3Auth Demo to see how Web3Auth can be used in an application.
Further checkout the example folder within this repository, which contains a sample app.
FAQs
Web3Auth SDK that supports Bare (Standalone) and Expo React Native apps.
The npm package @web3auth/react-native-sdk receives a total of 371 weekly downloads. As such, @web3auth/react-native-sdk popularity was classified as not popular.
We found that @web3auth/react-native-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.