Skip to content

Commit

Permalink
Merge pull request #17 from DTLab-LabCN/main
Browse files Browse the repository at this point in the history
Content updates to documentation
  • Loading branch information
regiseloi-idlab authored Jan 20, 2025
2 parents da6b5bf + 4225e0a commit 3bd8637
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 56 deletions.
2 changes: 1 addition & 1 deletion docs/dtt_overview/dtt_how_can_i_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 3

# How can I contribute to DTT?

We work on a variety of projects in the digital credential space that require different skill sets and expertise. We look to collaborators to contribute to DTLab projects, to ensure we have the right breadth and depth when we need it. Collaborators may be DTLab any government, organization, or individual. DTLab welcomes everyone in collaborating with us on a project.
DTT is currently being developed by DTLab and its partners. We are currently considering open-sourcing some or all of its components to better server the community.

If you are interested in trying out DTT, have feedback, or suggestions for us, please [Contact us!](mailto:[email protected])
2 changes: 1 addition & 1 deletion docs/w3c_did/did_about.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ More information on the godiddy resolver service can be found [here](https://doc
* [W3C DID Core Recommendation 1.0](https://www.w3.org/TR/did-core/)

* Get involved:
* [W3C DID Working Group](https://www.w3.org/2019/did-wg/)
* [W3C Decentralized Identifier Working Group](https://www.w3.org/groups/wg/did/)
* [DIF Identifiers & Discovery Working Group](https://github.com/decentralized-identity/identifiers-discovery/)
8 changes: 4 additions & 4 deletions docs/w3c_did/did_how_to_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ sidebar_position: 3

# How to use this test suite

Please complete the access request form on the [DTT landing page](https://dtt.dtlab-labcn.app/) or contact [[email protected]](mailto:[email protected]) if you don't have a user account for DTT.
Please complete the access request form on the [DTT landing page](https://dtt.dtlab-labcn.app/) or contact [[email protected]](mailto:[email protected]) if you don't have a user account for DTT.

To get started, enter the URL representing a DID, and click on **Resolve DID**.
To get started, enter the URL representing a DID, and click on **Resolve DID URL**.

## Need examples to try it out?

[https://dev.uniresolver.io/](https://dev.uniresolver.io/) and [https://godiddy.com/app/resolve](https://godiddy.com/app/resolve) provide a number of examples for a variety of DID methods.
Here are a few to get you started!

>`did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47`
>`did:ebsi:zkC6cUFUs3FiRp2xedNwih2`
>`did:cheqd:mainnet:Ps1ysXP2Ae6GBfxNhNQNKN`\
>`did:ebsi:zkC6cUFUs3FiRp2xedNwih2`\
>`did:indy:indicio:demo:KKyAeG7woJMV6MhhAREVKp`
2 changes: 1 addition & 1 deletion docs/w3c_did/did_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Decentralized identifiers (DID) are unique and persistent identifiers that do no
From the [W3C DID Core Recommendation](https://www.w3.org/TR/did-core/):
DIDs are *URIs* that associate a *DID subject* with a *DID document* allowing trustable interactions associated with that subject. Each DID document can express cryptographic material, *verification methods*, or *services*, which provide a set of mechanisms enabling a *DID controller* to prove control of the DID. Services **enable trusted interactions** associated with the DID subject.

## A simple example {#a-simple-example}
## DID URL syntax overview {#did_url_syntax_overview}

A DID is a simple text string consisting of three parts:

Expand Down
10 changes: 2 additions & 8 deletions docs/w3c_did/did_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,12 @@ sidebar_position: 4

# Test results

## How to inspect and understand your test results {#how-to-inspect-and-understand-your-test-results}

**_TO-DO_**: plain English overview of results, maybe in the form of a simple checklist?

## Common errors and their meaning {#common-errors-and-their-meaning}

| Error code | Description | What it might mean |
| ---------- | ----------- | ------------------ |
| 400 | _DID Syntax Invalid: DID must start with [did:]_ | Check your input and the provided examples to ensure it's a DID. |
| 404 | _DID or DID URL not found_ | For did:web specifically, this usually suggests that the `/.well-known/did.json` file is not available. |
| 406 | _Representation not supported_ | DID documents can be created in different formats. This error suggests a mismatch between the type of representation requested and what is available. |
| 410 | _DID deactivated_ | The DID was successfully resolved, but it is no longer active. |
| 501 | _DID method not supported_ | DTT is not currently configured to have access to a driver for this DID method, or a driver hasn’t been implemented yet. |

## How to save and share your test results {#how-to-save-and-share-your-test-results}

**_FUTURE_**: intro to Allure report framework
8 changes: 4 additions & 4 deletions docs/w3c_did/did_specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Each DID method requires the implementation of a *driver* to enable implementati
While all DID methods must conform to the W3C DID Core specification, different use cases and requirements have led to the creating of different and complementary DID methods. Some are fairly well defined and are used in production, whereas others are more experimental and not as completely defined yet.
Defining how a DID and DID document are created, resolved, and managed on a specific blockchain or “target system” is the role of a DID method specification.

Here are some of the DID methods most actively used and discussed by the community. For more information, please consult the [DID Method Registry](https://w3c.github.io/did-spec-registries/#did-methods).
Here are some of the DID methods most actively used and discussed by the community. For more information, please consult the [Decentralized Identifyer Extensions repository](https://w3c.github.io/did-extensions/).

| DID method | Specification | Status |
| ---------- | ------------- | ------ |
| did:indy | [https://github.com/hyperledger/indy-did-method](https://github.com/hyperledger/indy-did-method) | |
| did:key | [https://w3c-ccg.github.io/did-method-key](https://w3c-ccg.github.io/did-method-key) | The did:key Method v0.7 |
| did:peer | [https://identity.foundation/peer-did-method-spec](https://identity.foundation/peer-did-method-spec) | Peer DID Method Specification |
| did:tdw | [https://identity.foundation/trustdidweb/](https://identity.foundation/trustdidweb/) | Trust DID Web - The did:tdw DID Method |
| did:peer | [https://identity.foundation/peer-did-method-spec](https://identity.foundation/peer-did-method-spec) | Peer DID Method Specification v1.0 Draft |
| did:web | [https://w3c-ccg.github.io/did-method-web](https://w3c-ccg.github.io/did-method-web) | Unofficial draft authored by the [W3C Credentials Community Group](https://www.w3.org/community/credentials/). |
| did:webvh | [https://identity.foundation/didwebvh/](https://identity.foundation/didwebvh/) | DID Web + Verifiable History (did:webvh) is an enhancement to the did:web DID method |
| did:indy | [https://github.com/hyperledger/indy-did-method](https://github.com/hyperledger/indy-did-method) | |
| did:x509 | [https://github.com/microsoft/did-x509](https://github.com/microsoft/did-x509) | DRAFT: did:x509 Decentralized Identifier Method Specification |
4 changes: 1 addition & 3 deletions docs/w3c_vcdm/vcdm_about.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
sidebar_position: 6
sidebar_position: 4
---

# About the W3C VCDM test suite

**_TODO_**: explain where this version of the test suite comes from, where the repo is, and how it’s configured

## Additional resources

* Learn more about the W3C Verifiable Credential Data Model:
Expand Down
16 changes: 13 additions & 3 deletions docs/w3c_vcdm/vcdm_how_to_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,18 @@ sidebar_position: 3

# How to use this test suite

The purpose of this test suite is to test an issued Verifiable Credential for conformance with the VC data model 1.1 specification.
The purpose of this test suite is to test an issued Verifiable Credential for conformance with the VC data model [1.1](https://www.w3.org/TR/vc-data-model/) or [2.0](https://www.w3.org/TR/vc-data-model-2.0/) specifications.
Simply paste a valid JSON payload and click on **Validate JSON**. This will bring you to a **Credential Summary** screen with a visual representation of the parsed and validated payload. Click on **See Test Results** to get access to the full conformance test results.

[https://dtt.dtlab-labcn.app/test-suites/credentials/w3c](https://dtt.dtlab-labcn.app/test-suites/credentials/w3c)
## Verifiable Presentations {#verifiable_presentations}

**_TODO_**: How to access / configure this test suite: availability test/prod, user account, etc.
A Verifiable Presentation (VP) is derived from one or more Verifiable Credentials (VC) issued by one or more issuers. For example, a VP may contain assertions proofing the holder’s identity, address and proof of income, derived from 3 different VCs from different issuers. Try it out with the VP sample provided!

## Testing for conformity with v1.1 versus v2.0 of the specification {#testing_v1.1_vs_v2.0}

DTT relies on the context provided in a Verifiable Credential payload to determine which version of the specification to test against. Specically:

| W3C VCDM version number | Expected context |
| ---------- | ------------- |
| v1.1 | `"https://www.w3.org/2018/credentials/v1"` |
| v2.0 | `"https://www.w3.org/ns/credentials/v2"` |
11 changes: 0 additions & 11 deletions docs/w3c_vcdm/vcdm_input.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/w3c_vcdm/vcdm_results.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/w3c_vcdm/vcdm_specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ sidebar_position: 2

# Standards and specifications for the W3C Verifiable Credential Data Model

**_TODO_**: write brief intro with explanation for current versions and status

[Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)
The W3C [Verifiable Credentials Data Model v1.1](https://www.w3.org/TR/vc-data-model/) specification was published as a recommendation in March of 2022, while the [Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/) specification was first published as a Candidate Recommendation Draft in 2024. There are various clarifications and updates worth being aware of, such as the way validity and expiration dates are handled. Happy exploring with DTT!

0 comments on commit 3bd8637

Please sign in to comment.