@litentry/client-sdk

@heima/client-sdk

This package provides helpers for dApps to interact with the Heima Protocol.

The Enclave is the Heima'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/parachain-api @litentry/sidechain-api @heima/client-sdk
  

• Set the right environment

  Heima's Protocol is currently available in three main stages: local (development), tee-dev (staging), and tee-prod (production).

  You can set what stage to use by setting the HEIMA_NETWORK environment variable. Valid values are:

  • heima-local: will point to a local enclave ws://localhost:2100
  • heima-dev (default): will point to tee-dev's Enclave.
  • heima-prod: will point to tee-prod's Enclave.

  NX_* prefixed env variables (NX projects) will work too.

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 Heima 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/@heima/client-sdk?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

These are the steps for publishing the package locally for development purposes.

• 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 client-sdk:lint
  
  pnpm nx run client-sdk:test
  

  Before running the tests, make sure you have a local omni-executor running, see omni-executor README for more information.

Publish new versions

• Bump the version on package.json to for instance 1.0.0.

• Update the latest documentation

  pnpm nx run client-sdk:generate-doc
  

• Build the project

  pnpm nx run client-sdk:build
  

• Publish the distribution files

  pnpm nx run client-sdk:publish --ver 1.0.0 --tag latest