Installation

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

NodeJS, React Native and Web

npm registry being retired on 2026-08-01 The @sodot/* packages will be removed from the public npm registry on 2026-08-01. Use the Sodot JFrog Artifactory option below — the legacy npm option is kept for reference and will stop working on that date.

To use the SDK in an existing project:

Obtain an Artifactory access token (or, until 2026-08-01, an NPM auth token) and an API_KEY from the Sodot team.
Create a .npmrc file in your project's root directory (the same directory as your package.json file), and pick one of the following options:

Sodot JFrog Artifactory (recommended):

First, generate an Artifactory access token:

Sign in to the Sodot JFrog Artifactory using the sodot-auth option.
From the user menu in the top right corner, click Set Me Up → npm → select the sodot-npm repository.
Click the Generate Token & Create Instructions button and copy the generated token. (The token is valid for one year — regenerate it before it expires to avoid service disruptions.)

Then paste the following into your .npmrc:

@sodot:registry=https://repo.sodot.dev/artifactory/api/npm/sodot-npm/
//repo.sodot.dev/artifactory/api/npm/sodot-npm/:_authToken=${ARTIFACTORY_TOKEN}

And export the token you generated:

export ARTIFACTORY_TOKEN="<YOUR_TOKEN>"

npm (deprecated — stops working 2026-08-01):

Paste the following into your .npmrc:

@sodot:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

Then export your npm token:

export NPM_TOKEN="npm_<YOUR_TOKEN>"

Add it to your project:

React Native:

$ 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.