feat: light (offchain) DIDs #408
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…endpoints as part of light DID identifier
|
@tjwelde I think this PR could be reviewed now. The getting started and examples are clearly still failing (probably the scope of another PR). Tests on Node 14 are failing because of the lack of extensive coverage. For Node 16 it seems to be the very same problem that has been going on for a while. Integration tests with master are obviously failing, while the ones with develop have mostly gone through, with some timeout errors for some balance-specific stuff which I do not think is to be taken into consideration. |
tjwelde
suggested changes
Sep 6, 2021
| did = did.concat(':', encodedDetails) | ||
| } | ||
|
|
||
| super( |
There was a problem hiding this comment.
really like the abstraction with the DIDDetails parent class
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes KILTProtocol/ticket#1531
This PR adds support for light (or off-chain) DIDs. The new class of DIDs are still compliant with the same
IDidDetailsinterface, so they are completely transparent to the users. A light DID is created by specifying an authentication key (which can beed25519,sr25519, orecdsa), and optionally an encryption key and some service endpoints. The latter two, if present, are CBOR serialised and Base64 encoded and are added as part of the DID string itself.This PR also changes the structure of DIDs in general, as support for versioning has been added. An example of a full DID is the following:
did:kilt:v1:4r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs, while a light DID that only specifies an authentication key would have the following structure:did:kilt:light:v1:004r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs. The first two00in the identifier represent the type of the authentication key that has been encoded to be the DID identifier.EDIT AFTER PR REVIEW
DID version 1 skip the
v1bit in the URI, so a full DID v1 isdid:kilt:4r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjswhile a light DID v1 isdid:kilt:light:004r1WkS3t8rbCb11H8t3tJvGVCynwDXSUBiuGB6sLRHzCLCjs.How to test:
Run
yarn test. All unit tests and integration tests are passing (for Node 14). I did not add much coverage to the existing test cases as I think that is out of the scope for this PR. Next PR could include updating the getting-started guides and examples with the latest version (that uses DIDs everywhere).Checklist: