From 2d5b2d5798e79af8229ee1a57891f5f48d0d8778 Mon Sep 17 00:00:00 2001 From: Tweeddalex <79993234+Tweeddalex@users.noreply.github.com> Date: Wed, 25 May 2022 02:46:29 +0100 Subject: [PATCH 1/7] Started ReadMe to be filled in --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e11ce56..143b8e94 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # did:cheqd DID Resolver -STATUS: In development +## ℹī¸ Overview +cheqd DID resovler offers multiple implementations for resolving cheqd DIDs, according to the [cheqd DID method](https://docs.cheqd.io/node/architecture/adr-list/adr-002-cheqd-did-method#:~:text=Summary,on%20the%20Cosmos%20blockchain%20framework.) + +This resolver aims to make it easy for third parties to resolve cheqd DIDs, using either a full DID resolver, a proxy DID resolver or through the [Universal Resolver](https://dev.uniresolver.io/). + +## 🧑‍đŸ’ģ🛠 Developer Guide + +### Full DID Resolver + +Todo + + +### Proxy DID Resolver + +Todo + +### Universal Resolver + +Todo + +## 🙋 Find us elsewhere + +[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/intent/follow?screen_name=cheqd_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](http://cheqd.link/linkedin) [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](http://cheqd.link/join-cheqd-slack) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/) From 4beb6af356764a499f342e59d3667cfe37e64a51 Mon Sep 17 00:00:00 2001 From: Tweeddalex <79993234+Tweeddalex@users.noreply.github.com> Date: Wed, 25 May 2022 02:54:57 +0100 Subject: [PATCH 2/7] Updated readme --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 143b8e94..75d545d4 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,43 @@ cheqd DID resovler offers multiple implementations for resolving cheqd DIDs, acc This resolver aims to make it easy for third parties to resolve cheqd DIDs, using either a full DID resolver, a proxy DID resolver or through the [Universal Resolver](https://dev.uniresolver.io/). +## Example DIDs +``` + did:cheqd:mainnet:1g7d92hf83h67fh6 + did:cheqd:testnet:1g7d92hf83h67fh6 +``` + ## 🧑‍đŸ’ģ🛠 Developer Guide -### Full DID Resolver +## Full DID Resolver + +Todo + +## Proxy DID Resolver Todo +## Universal Resolver + +The Universal Resolver wraps an API around a number of co-located Docker containers running DID-method-specific drivers. -### Proxy DID Resolver +### Build and Run (Docker) Todo -### Universal Resolver +### Driver Environment Variables + +The driver recognizes the following environment variables: Todo +### Driver Metadata + +The driver returns the following metadata in addition to a DID document: + +Todo + + ## 🙋 Find us elsewhere [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/intent/follow?screen_name=cheqd_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](http://cheqd.link/linkedin) [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](http://cheqd.link/join-cheqd-slack) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/) From fdfe9076c72ad892700cbd732248400240e3992f Mon Sep 17 00:00:00 2001 From: toktar Date: Fri, 15 Jul 2022 18:18:20 +0300 Subject: [PATCH 3/7] Add different modes description + response example --- README.md | 116 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 101 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 75d545d4..c0a5f58c 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,132 @@ # did:cheqd DID Resolver ## ℹī¸ Overview + cheqd DID resovler offers multiple implementations for resolving cheqd DIDs, according to the [cheqd DID method](https://docs.cheqd.io/node/architecture/adr-list/adr-002-cheqd-did-method#:~:text=Summary,on%20the%20Cosmos%20blockchain%20framework.) This resolver aims to make it easy for third parties to resolve cheqd DIDs, using either a full DID resolver, a proxy DID resolver or through the [Universal Resolver](https://dev.uniresolver.io/). ## Example DIDs + +```commandline + did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY + did:cheqd:testnet:MTMxDQKMTMxDQKMT ``` - did:cheqd:mainnet:1g7d92hf83h67fh6 - did:cheqd:testnet:1g7d92hf83h67fh6 + +## Quick Start + +If you do not want to install anything, but just want to resolve a DID right now, then make a request in the browser https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY: + +or through the terminal: + +```bash +curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY ``` +### Response example + +```json + { + "didResolutionMetadata":{ + "contentType":"application/did+ld+json", + "retrieved":"2022-07-15T14:55:16Z", + "did":{ + "didString":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", + "methodSpecificId":"zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", + "method":"cheqd" + } + }, + "didDocument":{ + "@context":[ + "https://www.w3.org/ns/did/v1" + ], + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", + "verificationMethod":[ + { + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#key1", + "type":"Ed25519VerificationKey2020", + "controller":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", + "publicKeyMultibase":"zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkYsWCo7fztHtepn" + } + ], + "authentication":[ + "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#key1" + ], + "service":[ + { + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#website", + "type":"LinkedDomains", + "serviceEndpoint":"https://www.cheqd.io" + }, + { + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#non-fungible-image", + "type":"LinkedDomains", + "serviceEndpoint":"https://gateway.ipfs.io/ipfs/bafybeihetj2ng3d74k7t754atv2s5dk76pcqtvxls6dntef3xa6rax25xe" + }, + { + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#twitter", + "type":"LinkedDomains", + "serviceEndpoint":"https://twitter.com/cheqd_io" + }, + { + "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#linkedin", + "type":"LinkedDomains", + "serviceEndpoint":"https://www.linkedin.com/company/cheqd-identity/" + } + ] + }, + "didDocumentMetadata":{ + "created":"2022-04-05T11:49:19Z", + "versionId":"EDEAD35C83E20A72872ACD3C36B7BA42300712FC8E3EEE1340E47E2F1B216B2D" + } + } +``` + +[Read more about cheqd DID resolver features](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-cheqd-universal-resolver-driver.md) + ## 🧑‍đŸ’ģ🛠 Developer Guide ## Full DID Resolver -Todo +For starting Full DID Resolver use -## Proxy DID Resolver +```bash +docker compose --profile full up --build +``` -Todo +After you can check if it works -## Universal Resolver +```bash +curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY +``` -The Universal Resolver wraps an API around a number of co-located Docker containers running DID-method-specific drivers. +Response should be the same with [this example](#response-example) + +[Read more about Full DID Resolver configuration](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-full-cheqd-did-resolver.md) + +## Proxy DID Resolver -### Build and Run (Docker) +You can use light profile: -Todo +```commandline +docker compose --profile light up --build +``` -### Driver Environment Variables +for having an opportunity to make a localhost requests -The driver recognizes the following environment variables: +```commandline +curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY +``` -Todo +with [this kind]((#response-example)) of responses redirected from https://resolver.cheqd.net -### Driver Metadata +[More about light DID Resolver](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-light-cheqd-did-resolver.md) -The driver returns the following metadata in addition to a DID document: +## Universal Resolver -Todo +The Universal Resolver wraps an API around a number of co-located Docker containers running DID-method-specific drivers. +Integration phase: in progress ## 🙋 Find us elsewhere From 3fa13a7e99088810809822b11fcfef8f0f85685e Mon Sep 17 00:00:00 2001 From: toktar Date: Fri, 15 Jul 2022 18:22:29 +0300 Subject: [PATCH 4/7] Fix links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0a5f58c..fe215bf1 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ for having an opportunity to make a localhost requests curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY ``` -with [this kind]((#response-example)) of responses redirected from https://resolver.cheqd.net +with [this kind](#response-example) of responses redirected from `https://resolver.cheqd.net` [More about light DID Resolver](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-light-cheqd-did-resolver.md) From 070a061fd9f0bacb2b2b6d3794708843b59bfb1b Mon Sep 17 00:00:00 2001 From: Alex Tweeddale <79993234+Tweeddalex@users.noreply.github.com> Date: Mon, 18 Jul 2022 06:05:39 +0100 Subject: [PATCH 5/7] Update README.md Made minor grammatical changes --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fe215bf1..7ee9122e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ cheqd DID resovler offers multiple implementations for resolving cheqd DIDs, according to the [cheqd DID method](https://docs.cheqd.io/node/architecture/adr-list/adr-002-cheqd-did-method#:~:text=Summary,on%20the%20Cosmos%20blockchain%20framework.) -This resolver aims to make it easy for third parties to resolve cheqd DIDs, using either a full DID resolver, a proxy DID resolver or through the [Universal Resolver](https://dev.uniresolver.io/). +This resolver aims to make it easy for third parties to resolve cheqd DIDs, using either a Full DID resolver, a Light DID resolver or through the [Universal Resolver](https://dev.uniresolver.io/). ## Example DIDs @@ -15,9 +15,11 @@ This resolver aims to make it easy for third parties to resolve cheqd DIDs, usin ## Quick Start -If you do not want to install anything, but just want to resolve a DID right now, then make a request in the browser https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY: +If you do not want to install anything, but just want to resolve a DID, then you can make a request in the browser: -or through the terminal: +https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY + +or through the command terminal: ```bash curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY @@ -88,13 +90,13 @@ curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDB ## Full DID Resolver -For starting Full DID Resolver use +For initiating the Full DID Resolver, use: ```bash docker compose --profile full up --build ``` -After you can check if it works +After, you can check if it works: ```bash curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY @@ -104,15 +106,15 @@ Response should be the same with [this example](#response-example) [Read more about Full DID Resolver configuration](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-full-cheqd-did-resolver.md) -## Proxy DID Resolver +## Light DID Resolver -You can use light profile: +For initiating the Light DID Resolver, use: ```commandline docker compose --profile light up --build ``` -for having an opportunity to make a localhost requests +To make a localhost request, you can use: ```commandline curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY From 5e00081ebfafdbabaa6361b05f2dab36529c8e21 Mon Sep 17 00:00:00 2001 From: toktar Date: Tue, 26 Jul 2022 14:00:22 +0300 Subject: [PATCH 6/7] Update Universal Resolver description --- README.md | 90 ++++++++++--------------------------------------------- 1 file changed, 15 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 7ee9122e..7505c46c 100644 --- a/README.md +++ b/README.md @@ -25,65 +25,6 @@ or through the command terminal: curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY ``` -### Response example - -```json - { - "didResolutionMetadata":{ - "contentType":"application/did+ld+json", - "retrieved":"2022-07-15T14:55:16Z", - "did":{ - "didString":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", - "methodSpecificId":"zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", - "method":"cheqd" - } - }, - "didDocument":{ - "@context":[ - "https://www.w3.org/ns/did/v1" - ], - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", - "verificationMethod":[ - { - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#key1", - "type":"Ed25519VerificationKey2020", - "controller":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY", - "publicKeyMultibase":"zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkYsWCo7fztHtepn" - } - ], - "authentication":[ - "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#key1" - ], - "service":[ - { - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#website", - "type":"LinkedDomains", - "serviceEndpoint":"https://www.cheqd.io" - }, - { - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#non-fungible-image", - "type":"LinkedDomains", - "serviceEndpoint":"https://gateway.ipfs.io/ipfs/bafybeihetj2ng3d74k7t754atv2s5dk76pcqtvxls6dntef3xa6rax25xe" - }, - { - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#twitter", - "type":"LinkedDomains", - "serviceEndpoint":"https://twitter.com/cheqd_io" - }, - { - "id":"did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY#linkedin", - "type":"LinkedDomains", - "serviceEndpoint":"https://www.linkedin.com/company/cheqd-identity/" - } - ] - }, - "didDocumentMetadata":{ - "created":"2022-04-05T11:49:19Z", - "versionId":"EDEAD35C83E20A72872ACD3C36B7BA42300712FC8E3EEE1340E47E2F1B216B2D" - } - } -``` - [Read more about cheqd DID resolver features](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-cheqd-universal-resolver-driver.md) ## 🧑‍đŸ’ģ🛠 Developer Guide @@ -102,33 +43,32 @@ After, you can check if it works: curl -X GET https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY ``` -Response should be the same with [this example](#response-example) - [Read more about Full DID Resolver configuration](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-full-cheqd-did-resolver.md) ## Light DID Resolver -For initiating the Light DID Resolver, use: +Status: In development -```commandline -docker compose --profile light up --build -``` - -To make a localhost request, you can use: +[More about light DID Resolver](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-light-cheqd-did-resolver.md) -```commandline -curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY -``` +## Universal Resolver -with [this kind](#response-example) of responses redirected from `https://resolver.cheqd.net` +The [Universal Resolver](https://github.com/decentralized-identity/universal-resolver) wraps an API around a number of co-located Docker containers running DID-method-specific drivers. -[More about light DID Resolver](https://github.com/cheqd/identity-docs/blob/main/tutorials/resolver/using-light-cheqd-did-resolver.md) +For a [quick start](https://github.com/decentralized-identity/universal-resolver#quick-start) -## Universal Resolver +```bash +git clone https://github.com/decentralized-identity/universal-resolver +cd universal-resolver/ +docker-compose -f docker-compose.yml pull +docker-compose -f docker-compose.yml up +``` -The Universal Resolver wraps an API around a number of co-located Docker containers running DID-method-specific drivers. +You should then be able to resolve identifiers locally using simple `curl` requests as follow: -Integration phase: in progress +```bash +curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY +``` ## 🙋 Find us elsewhere From 3e19261517d7fb483aa638043e6ed1d6e1018a49 Mon Sep 17 00:00:00 2001 From: toktar Date: Tue, 26 Jul 2022 15:24:21 +0300 Subject: [PATCH 7/7] Make linter happy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7505c46c..cfc4aceb 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This resolver aims to make it easy for third parties to resolve cheqd DIDs, usin If you do not want to install anything, but just want to resolve a DID, then you can make a request in the browser: -https://resolver.cheqd.net/1.0/identifiers/did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1JXfUY7oVWkY + or through the command terminal: