algazarra / sidetree

Sidetree Specification and Reference Implementation

View GitHub

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

See the latest spec for full Sidetree protocol specification.

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

Code Contributions:

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.

Spec Editing/Contributions:

1. Clone the repo.
2. Create a topic branch for your spec contributions.
3. Add the following entry to your local repo's .git/info/exclude file: spec/index.html.
4. run npm install
5. run npm run spec:edit
6. Open the generated index.html rendering of the spec, located in the spec/ directory, in your browser.
7. Modify files in the spec/markdown/ directory to make changes, which will render realtime in the index.html file you have open in your browser.
8. When you are happy with your changes, commit to your topic branch and open a Pull Request on GitHub and reviewers will be alerted to review for a potential merge.

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.