Monorepo containing the Typescript implementation of the Ceramic protocol.
This implementation of the Ceramic protocol is only partial and is missing multiple critical components. As development moves forward this readme will be updated with the latest project status.
Missing components:
- Anchor records - currently anchor records are mocked
This repo is made up of several different packages.
| Package | Current Version | Description |
|---|---|---|
| @ceramicnetwork/ceramic-core |  |
Ceramic protocol implementation |
| @ceramicnetwork/ceramic-cli |  |
Ceramic CLI and http daemon |
| @ceramicnetwork/ceramic-http-client |  |
Ceramic http client that can interact with a remote Ceramic node |
| @ceramicnetwork/3id-did-resolver |  |
DID resolver for 3IDs |
This project uses npm and lerna to manage packages and dependencies. To install dependencies for all packages in this repo:
$ npm run bootstrap
Then build all packages:
$ npm run build
$ npm test
There are two types of releases that can be made, prereleases and regular releases.
$ npm run publish:next
In any branch you can run the command above, this will create a prerelease with the version vx.x.x-alpha.n. It will also create a local commit for this release. This commit doesn't have to be committed.
$ npm run publish:latest
This command can only be run on the master branch, it will create a release commit and push it to master. It will also tag this commit and create a release on github. Make sure to set the GH_TOKEN environment variable before you run this command.
We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.