@litentry/enclave v2.0.0
@litentry/enclave
This package provides helpers for dApps to interact with the Litentry Protocol's Enclave.
The Enclave is the Litentry's Trusted Execution Environment (TEE), that provides the hightest security and privacy for users to store their identity.
This is a browser package, it may not work as-is on Node.js due to Crypto Subtle and WebSocket differences, but the exposed RPC logic is the same.
Installation
Install from NPM
npm install @litentry/enclave
Set the right environment
Litentry's Protocol is currently available in three main stages: local (development),
tee-dev
(staging), andtee-prod
(production).You can set what stage to use by setting the
NX_PARACHAIN_NETWORK
orPARACHAIN_NETWORK
environment variable. Valid values are:litentry-local
: will point to a local enclavews://localhost:2000
litentry-dev
(default): will point totee-dev
's Enclave.litentry-internal
: will point totee-internal
's Enclave.litentry-prod
: will point totee-prod
's Enclave.
Versions
This package is distributed under two main tags: next
and latest
.
Versions in the pattern of x.x.x-next.x
feature the most recent code version to work with tee-dev
. E.g., 1.0.0-next.0
. Once stable and once the Litentry Protocol is upgraded, the version will be tagged as latest
and should be used against tee-prod
. E.g., 1.0.0
. You can find all versions on https://www.npmjs.com/package/@litentry/enclave?activeTab=versions
Examples & API documentation
Please refer to the examples
folder in this repository to learn more about all the available operations. The docs
folder includes detailed API information about.
Development
Quick start
Install dependencies
pnpm install
Spin up an local NPM registry
pnpm nx local-registry
Publish locally
Follow the steps of Publish new versions. The step 1 can be skipped.
As long as the local registry is up, any publishing will happen locally.
Run test and lint checks
pnpm nx run enclave:lint pnpm nx run enclave:test
Publish new versions
Bump the version on package.json to for instance
1.0.0
.Update the latest documentation
pnpm nx run enclave:generate-doc
Build the project
pnpm nx run enclave:build
Publish the distribution files
pnpm nx run enclave:publish --ver 1.0.0 --tag latest
9 days ago
9 days ago
9 days ago
8 days ago
11 days ago
11 days ago
11 days ago
17 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago