@heima-network/sidechain-api

Sidechain-api

This library contains the Litentry Network API types and types definitions.

These types were auto generated using Polkadot.js Type Generation

How to use it

• Install the package from NPM

  npm install @litentry/sidechain-api
  

• Import type definitions as needed:

  import type { LitentryIdentity } from "@litentry/sidechain-api";
  
  function myFunction(identity: LitentryIdentity) {
      // ...
  }
  

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.

Publish new versions

• Update your published package version number

• Update the CHANGELOG.md file.

• Build the package

  pnpm run build
  

• Publish the distribution files

  Use next tag for preview versions. Use latest tag for

  # for preview versions
  npm publish --access=public --tag next
  
  # for stable versions
  npm publish --access=public --tag latest
  

How to regenerate types

Please read the commands of client-api.