@0xpolygonid/js-sdk

Polygon ID JS SDK

SDK to work with Polygon ID using JavaScript and TypeScript languages.

Disclaimer

Polygon ID JS SDK is in public now. It may still contain bugs or missing functionality, that it will be added in next versions.

Usage

Installation:

npm install @0xpolygonid/js-sdk

See tests for examples on how to use SDK.

Tests

Run unit tests:

npm run test

Note: mtp / sig / auth / rhs files contain integration tests!

To run them, please set following variables:

export WALLET_KEY="...key in hex format"
export RPC_URL="...url to network rpc node"
export RHS_URL="..reverse hash service url"
export IPFS_URL="url for ipfs"
export STATE_CONTRACT_ADDRESS="state contract address"
export RHS_CONTRACT_ADDRESS="reverse hash service contract address"

And place actual circuits to test/proofs/testdata

Documentation

Generate documentation

1. Define path where documentation repository is located, for example:

       const DOCS_DIR = '../js-sdk-tutorials/docs/api';
   

2.      npm run tsc:declaration:watch
   

3.      npm run doc:watch:website
   

Documentation can be found here