Install or build
yarn add @docknetwork/sdkor
npm install @docknetwork/sdkto install the package from npm
- When building from source:
yarnto install the dependencies
yarn buildto create a distribution version.
Have a look at the concepts and tutorials. These are generated from markdown
present over here. Files prefixed with
concepts describe the concepts and files prefixed with
tutorials have a tutorial on using the API.
Checkout the API reference
The example scripts present in example directory are meant to demonstrate a complete feature. The following commands demonstrate different features.
Run example to create a new DID, register it, update its key and remove the DID.
Run example to resolve DID
Run example to see revocation
Run example to see verifiable credentials
Use Dock's substrate node: https://github.com/docknetwork/dock-substrate
Running dev node:
./target/release/dock-node --base-path /tmp/alice --chain local_poa_testnet --alice --port 30333 --ws-port 9944 --rpc-port 9933 --telemetry-url 'wss://telemetry.polkadot.io/submit/ 0'
mainnet tag of this repo when interacting with mainnet as the
master branch isn't guaranteed to be mainnet compatible.
Test and example Configuration
Configuration variables like websocket endpoint for node
FullNodeEndpoint, URI for account to pay for extrinsics
and keyring type
TestKeyringType can be set as environment variables (or in an .env file). If they are not set, default values as
specified in file test-constants.js are used.
The scripts read parameters from
.env file. The available parameters are shown in an example env file env_example
Run unit tests with
Run a single unit test module with
yarn test <module name or prefix>.
Run e2e integrations tests with
yarn test-integration (required node to be running)
You can run tests against a temporary node in docker like so:
./scripts/with_docker_test_node yarn test-integration
or with the alias:
and examples can be similarly run with:
Linting and type checking
We use JSDoc and TypeScript for static type checking during the CI process. PRs must pass linting and type checking to be accepted.
You can run via:
yarn lint --fix and