Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sidetree-kenhuang

decentralized-identity9Apache-2.00.5.4TypeScript support: included

Node.js implementation of the Sidetree protocol.

readme

Sidetree Node.js implementation

The Node.js implementation of a blockchain-agnostic Sidetree Node using TypeScript.

Build Status

See the protocol document for the full Sidetree protocol specification.

See the implementation document for the detailed description of this implementation.

Contribution Guidelines:

  1. Must pass npm run test.
  2. Must pass npm run lint.
  3. Prefix an interface that require implementation with I. e.g. ITransactionProcessor.
  4. Suffix a data-holder interface (without definition of methods) with Model. e.g. TransactionModel.
  5. Use default export if class/interface name matches the file name.
  6. Sort imports.

Docker

NOTE: 2019-08-13: docker-compose out-of-date, needs to be udpated.

The Sidetree components are available via docker containers . Please see the docker document to find out details on building and running.