Skip to main content
Version: 1.0.5

Installation

We provide SDKs for developing projects in: NodeJS, Go, React Native (Android and iOS) and Web projects (both websites and browser extensions).

NodeJS, React Native and Web​

To use the SDK in an existing project you simply need to:

  1. Obtain an NPM auth token and an API_KEY from the Sodot team.

  2. Create a .npmrc file in your project's root directory (the same directory as your package.json file).
    Then, copy and paste the following as-is into your .npmrc:

@sodot:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
  1. Add the npm token as an environment variable, e.g. in a terminal session run:
export NPM_TOKEN="<YOUR_NPM_TOKEN>"

The npm token is in the form of: "npm_a1b2c3d4e5f6g7h8i9j0klmnopqrstuvwxyz..."

  1. Add it to your project:
$ yarn add @sodot/sodot-react-native-sdk
# Due to limitations in React Native this must also be explicitly added to any project using the SDK.
$ yarn add react-native-encrypted-storage react-native-get-random-values
$ npx pod-install

You can now start generating keys and signing.