-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from decentralized-identity/docs/readme-updates
Update the readme
- Loading branch information
Showing
1 changed file
with
28 additions
and
28 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,32 @@ | ||
# DIDComm Browser Demo | ||
|
||
## Secrets stored in the browser per profile | ||
The [DIDComm Browser Demo][demo] contains a fully functioning DIDComm v2 | ||
application, capable of both sending and receiving DIDComm messages through a | ||
DIDComm v2 capable mediator. The purpose of the [DIDComm Demo][demo] is to help | ||
people understand the basics of [DID Communication][didcomm] without burdening | ||
them with all the complexities of optional protocols, such as those pertaining | ||
to verifiable credentials. With this in mind, only the following DIDComm | ||
protocols have been implemented: | ||
|
||
Secrets are stored in the browser under profiles. The profile data looks like: | ||
Protocols pertaining to mediation: | ||
- https://didcomm.org/coordinate-mediation/3.0/ | ||
- https://didcomm.org/messagepickup/3.0/ | ||
|
||
```json | ||
{ | ||
"secrets": [ | ||
{ | ||
"id": "did:example:charlie#key-1", | ||
"type": "JsonWebKey2020", | ||
"privateKeyJwk": { | ||
"crv": "Ed25519", | ||
"d": "T2azVap7CYD_kB8ilbnFYqwwYb5N-GcD6yjGEvquZXg", | ||
"kty": "OKP", | ||
"x": "VDXDwuGKVq91zxU6q7__jLDUq8_C5cuxECgd-1feFTE" | ||
} | ||
}, | ||
{ | ||
"id": "did:example:charlie#key-2", | ||
"type": "JsonWebKey2020", | ||
"privateKeyJwk": { | ||
"crv": "Ed25519", | ||
"d": "T2azVap7CYD_kB8ilbnFYqwwYb5N-GcD6yjGEvquZXg", | ||
"kty": "OKP", | ||
"x": "VDXDwuGKVq91zxU6q7__jLDUq8_C5cuxECgd-1feFTE" | ||
} | ||
} | ||
] | ||
} | ||
``` | ||
Core Protocols: | ||
- https://didcomm.org/routing/2.0/ (via the [didcomm][didcommts] typescript library) | ||
- https://didcomm.org/discover-features/2.0/ | ||
- https://didcomm.org/trust-ping/2.0/ | ||
|
||
Protocols implemented to make the demo be easier to use: | ||
- https://didcomm.org/basicmessage/2.0/ | ||
- https://didcomm.org/user-profile/1.0/ | ||
|
||
Along with the above protocols, `only did:peer:2` DIDs are supported at this | ||
time. The [DIDComm Demo][demo] creates a new `did:peer:2` DID upon page load | ||
and connects to a mediator (via the mediator's `did:peer:2` DID) to negotiate | ||
mediation. Once the negotiation has completed, the demo's DID will appear at | ||
the top of the screen. | ||
|
||
[demo]: https://demo.didcomm.org | ||
[didcomm]: https://didcomm.org | ||
[didcommts]: https://www.npmjs.com/package/didcomm |