sidetree icon indicating copy to clipboard operation
sidetree copied to clipboard

Do we have an example for using this sidetree core ?

Open bjwswang opened this issue 4 years ago • 11 comments

I am recently leanring to use sidetree to manage DIDs . There are many protocols without any example code which is really not good for beginners . I start a sidertree core node,then I want to send a request to sidetree core node to create a new did. There is doc showing what data the api needs, but the data itself is complicated to construct. That would be better if an example is there .

bjwswang avatar May 06 '20 11:05 bjwswang

Hi @OR13 , do you konw where to start ? Thank you in advance!

bjwswang avatar May 07 '20 02:05 bjwswang

I found lots of unit tests here https://github.com/decentralized-identity/sidetree/blob/master/tests/core which also contains the code but not very clear to beginners.

bjwswang avatar May 07 '20 02:05 bjwswang

@OR13 btw... do we have any IRC or slack channel for communication ?

bjwswang avatar May 07 '20 08:05 bjwswang

@bjwswang we don't currently have any community chat, but its clear that one would be helpful. cc @csuwildcat @thehenrytsai ...

The current version of sidetree is fairly unstable, and we are still working towards spec v1.

hopefully the documentation for beginners will emerge as we get closer to spec v1 release.

OR13 avatar May 07 '20 16:05 OR13

@OR13 excellent!

bjwswang avatar May 08 '20 06:05 bjwswang

@bjwswang I'm also very interested in documenting and using sidetree. I started a Github Repo with a tutorial here: https://github.com/ownyourdata/did-ion

@csuwildcat @OR13 when do you think it makes sense to start working on a Tutorial vor v1.0? I don't have a problem if things change and I need to redo sections (as long as things already start converging :-)

fabianekc avatar May 17 '20 11:05 fabianekc

I'd say folks can feel confident working on this sort of stuff by ~May 27th, which will be absolute last call for any mods to major aspects of this version of the spec before it goes out for testing with beta implementations.

csuwildcat avatar May 17 '20 13:05 csuwildcat

@fabianekc maybe we can contribute a best practice tutorial for this sidetree protocol. btw.. what's the difference between ION and sidetree ?

bjwswang avatar Jun 08 '20 12:06 bjwswang

Sidetree is a Ledger Agnostic Protocol for building scalable decentralized identifiers which is developed under DIF IPR Protection, by many companies, including Microsoft, SecureKey, Mattr and Transmute, here:

https://github.com/decentralized-identity/sidetree

The sidetree spec, and reference implementation for typescript is hosted in this repo ^.

ION is a DID Method built on Bitcoin and IPFS using the Sidetree Protocol... its primary contributors are Microsoft employees, but there are others, its repo is here:

https://github.com/decentralized-identity/ion

Element is a DID Method built on Ethereum and IPFS using the Sidetree Protocol... its primary contributors are Transmute employees, but there are others, its repo is here:

https://github.com/decentralized-identity/element

TrustBloc is a DID MEthod built on Hyperledger Fabric and IPFS using the Sidetree Protocol... its primary contributors are SecureKey employees, but there are others, its repo is here:

https://github.com/trustbloc/trustbloc-did-method

Unfortunately, due to repository / module software architecture decisions beyond my control... sidetree reference implementation is almost 90% the same as ION... which is great for ION, but kinda sucks for Element and Trustbloc... We will be addressing this issue when we can. you can track progress on it here: https://github.com/decentralized-identity/sidetree/issues/346

OR13 avatar Jun 09 '20 18:06 OR13

@OR13 thanks a lot for this summary - I'll include it in the tutorial.

@bjwswang my plan is to start again on the weekend and use the dev branch of ION (https://github.com/decentralized-identity/ion/tree/dev) If you like I can invite you to the OwnYourData Slack and we can discuss any open questions there.

In the long run it would be great to extend the Tutorial also to Element (the notary service from OwnYourData uses the Ethereum mainnet and it'd be nice to focus on a single blockchain for me)

fabianekc avatar Jun 10 '20 08:06 fabianekc

FYI: Sidetree 1.0 is days away from a final draft and we're reading for community review. If this is still a ticket with action items to track, let us know.

csuwildcat avatar Jan 20 '21 05:01 csuwildcat

Closing, handled.

decentralgabe avatar Feb 07 '23 18:02 decentralgabe