@portal-hq/keychain

Portal Keychain

The @portal-hq/keychain package contains a storage adapter intended for use with the @portal-hq/core package.

This storage adapter allows end users to save MPC shares to their local device keychain using react-native-keychain.

Basic usage

1. Install the package in your React Native project.

   yarn add @portal-hq/keychain
   
   # OR #
   
   npm install --save @portal-hq/keychain
   

2. Import the package into the component where you initialize the Portal class

   import Portal from '@portal-hq/core'
   import Keychain from '@portal-hq/keychain'
   

3. Register your storage adapter and initialize the Portal class

   const keychain = new Keychain()
   const portal = new Portal({
     // ...your other config options
     keychain,
   })
   

Dependency linking

Because this package uses the react-native-keychain package (which contains native modules) there is some additional linking required to make it work with your React Native project.

Explicitly install the react-native-keychain package in your project.

yarn add react-native-keychain

# OR #

npm install --save react-native-keychain