@account-kit/react-native-signer

4.48.0 • Public • Published

@account-kit/react-native-signer (Alpha)

React Native compatible Alchemy signer impl

⚠️ Alpha ⚠️

This is an alpha release of the library. Only the Android platform is supported at this time.

Installation

npm install @account-kit/react-native-signer

Usage

This package requires several packages containing native modules to be installed in your project. Check out their docs at the following links for installation instructions.

Passkeys

If using passkeys, there are iOS- and Android-specific steps to link your app to an associated domain to which the passkeys will be connected. This means hosting specific JSON files from a domain you control. For details on this, see the instructions in the react-native-passkey README.

Deep Linking

We recommend using emails containing OTP codes (the default setting) to avoid the need for this step.

If using emails with magic links, your app will need to be configured to handle deep linking. Check out the React Native docs for more information. You will also need a way to trigger the deep link via a http or https url. This can be done in a viarety of ways ranging from universal links to setting up a custom redirect server.

See the example app for usage information.

Contributing

  1. Clone the repo
  2. run yarn in the root of the repo
  3. make changes in rn-signer/src
  4. cd into account-kit/rn-signer/example
  5. add a .env file which contains API_KEY={alchemy_api_key}. This API Key needs to correspond to an app that has Embedded Accounts enabled (https://dashboard.alchemy.com/accounts).
  6. run yarn android to start the example app. You will need to make sure you do the env setup here: https://reactnative.dev/docs/set-up-your-environment to be able to run the app on android

Made with create-react-native-library

Package Sidebar

Install

npm i @account-kit/react-native-signer

Weekly Downloads

13,794

Version

4.48.0

License

none

Unpacked Size

198 kB

Total Files

147

Last publish

Collaborators

  • alchemy-team