Sidetree Node

Sidetree Node implements SideTree API anchored against a ledger. API follows Sidetree Protocol Specification.

Sidetree Protocol Go Implementation

Sidetree node exposes a set of REST API that enables the creation of new DIDs and their initial state, subsequent DID Document updates and DID Document resolutions. API uses design first approach to generate a server stub for API using go swagger. The API structure is defined in swagger.yaml.

Sidetree REST API

DID and DID Document Creation

Request Path

Post /sidetree/v1/operations

DID Document resolution

Request Path

GET  /sidetree/v1/identifiers/{DidOrDidDocument}

Updating a DID Document

Request Path

Post /sidetree/v1/operations

DID Deletion

Request Path

Post /sidetree/v1/operations

DID Resolution

The Request handler resolve operation uses Operation processor resolves method by passing input parameter DIDUniqueSuffix to its DID document. Operation processor resolve iterate over all operations and apply each operation in chronological order to build a complete DID Document.

Note

To follow the sample Request and Response for each of the above operation. Refer to Sidetree Protocol.

Have Questions?

We try to maintain a comprehensive set of documentation for various audiences. However, we realize that often there are questions that remain unanswered. For any technical questions relating to TrustBloc not answered here, please use

Gitter (an alternative to Slack) on the #trustbloc-questions channel.

Note

Please, when asking about problems you are facing tell us about the environment in which you are experiencing those problems including the OS, which version of Docker you are using, etc.