1.0.6 • Published 2 years ago

@decentralized-identity/sidetree v1.0.6

Weekly downloads
1,521
License
Apache-2.0
Repository
github
Last release
2 years ago

View GitHub

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

Build Status CI

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. run npm install
  4. run npm run spec:edit
  5. If you see errors like UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, open './www/spec/index.html'... create the missing directories and files and try again (they will be overritten).
  6. Type npx serve . in the root directory and open http://localhost:5000/www/spec.
  7. Modify files in the spec/markdown/ directory to make changes, refresh to see changes.
  8. Do not commit build assets.
  9. Try and make blocks of text small so that changes can be suggested easily on specific lines.
  10. 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.
  11. Make sure to tag people continiously to ensure your PR is reviewed in a timely manner.
  12. PRs that sit open without comments / reviews, will be closed at the editors discretion.

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.

Release Process

Refer to here for details on the release process of the artifacts in this repository.

1.0.6

2 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.12.1

3 years ago

0.12.0

3 years ago

0.11.0

4 years ago

0.10.0

4 years ago

0.9.1

4 years ago

0.9.0

4 years ago

0.8.0

4 years ago

0.7.0

4 years ago

0.6.1

4 years ago

0.6.0

4 years ago

0.5.0

5 years ago

0.4.1

5 years ago

0.4.0

5 years ago

0.3.0

5 years ago

0.2.0

5 years ago

0.1.13

5 years ago

0.1.12

5 years ago

0.1.11

5 years ago

0.1.10

5 years ago

0.1.9

5 years ago

0.1.7

5 years ago

0.1.6

5 years ago