Skip to content

Commit

Permalink
GITBOOK-313: Design your solution added
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweeddalex authored and gitbook-bot committed Jun 25, 2024
1 parent 92b937f commit d2b2a71
Show file tree
Hide file tree
Showing 17 changed files with 25 additions and 18 deletions.
20 changes: 11 additions & 9 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,23 @@
## ℹ️ Getting Started

* [Product Overview](README.md)
* [1️⃣ 1️⃣ Design your Solution](getting-started/design/README.md)
* [Establish Parties in Trust Ecosystem](getting-started/design/establish-parties.md)
* [Design your Trust Infrastructure](getting-started/design/trust-infrastructure/README.md)
* [Roots of Trust](getting-started/design/trust-infrastructure/roots-of-trust.md)
* [Verifiable Accreditations](getting-started/design/trust-infrastructure/verifiable-accreditations.md)
* [Accreditation and Issuance Policies](getting-started/design/trust-infrastructure/policies.md)
* [Data Models](getting-started/design/trust-infrastructure/data-models.md)
* [Governance Framework](getting-started/design/trust-infrastructure/governance-framework.md)
* [Establish Schemas for Accreditations and Credentials](getting-started/design/schemas.md)
* [Choose a Credential Issuance Provider](getting-started/design/choose-a-credential-issuance-provider.md)
* [Monetise your solution](getting-started/design/monetise-your-solution.md)
* [Get started with cheqd Studio](getting-started/studio/README.md)
* [👉 Set up your account](getting-started/studio/set-up-account.md)
* [🔄 Advanced configuration options](getting-started/studio/advanced.md)

## 🟢 Start using cheqd <a href="#studio" id="studio"></a>

* [1️⃣ Design your Solution](studio/design/README.md)
* [Establish Parties in Trust Ecosystem](studio/design/establish-parties.md)
* [Design your Trust Infrastructure](studio/design/trust-infrastructure/README.md)
* [Roots of Trust](studio/design/trust-infrastructure/roots-of-trust.md)
* [Verifiable Accreditations](studio/design/trust-infrastructure/verifiable-accreditations.md)
* [Accreditation and Issuance Policies](studio/design/trust-infrastructure/policies.md)
* [Data Models](studio/design/trust-infrastructure/data-models.md)
* [Governance Framework](studio/design/trust-infrastructure/governance-framework.md)
* [Establish Schemas for Accreditations and Credentials](studio/design/schemas.md)
* [🆔 Create DIDs and Identity keys](studio/dids/README.md)
* [Create Issuer DID](studio/dids/create-did.md)
* [Create Identity Keys and Subject DIDs](studio/dids/create-subject-did.md)
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Choose a Credential Issuance Provider

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ By completing this subsection, you will:
* Identify all actors and map out their roles and relationships.
* Define the rules and policies of your use case.
* Define the legal identities involved.
* Understand how to set up DIDs for your entities
* Define accreditations issued by the Trusted Accreditation Organisation.

\<todo>
2 changes: 2 additions & 0 deletions getting-started/design/monetise-your-solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Monetise your solution

File renamed without changes.
4 changes: 2 additions & 2 deletions studio/did-linked-resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Create digital Resources linked to cheqd DIDs on-ledger
---

# ↕ Create DID-Linked Resources
# Create DID-Linked Resources

**"DID-Linked Resources"** are identified with a [`did:cheqd` Decentralized Identifier](../../architecture/adr-list/adr-002-did-linked-resources.md) with a [Universally Unique Identifier (UUID)](https://www.uuidgenerator.net/) that acts as a permanently-accessible link to fetch the resources from the cheqd ledger. We refer to this as the "**resource ID**". Through the "**resource ID**" or a set of DID URL query parameters, applications are able to persistently access a digital resource on the cheqd network.

Expand All @@ -16,4 +16,4 @@ description: Create digital Resources linked to cheqd DIDs on-ledger

Below are a list of alternatives for creating cheqd DID-Linked Resources.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>DID Registrar</strong></mark></td><td>Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the <a href="https://uniregistrar.io/">Universal Registrar</a>.</td><td><a href="../../advanced/did-registrar/">did-registrar</a></td></tr><tr><td><mark style="color:blue;"><strong>Veramo SDK Plugin</strong></mark></td><td>The <strong>Veramo SDK Plugin</strong> is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.</td><td><a href="../../sdk/veramo-plugin/">veramo-plugin</a></td></tr><tr><td><mark style="color:blue;"><strong>Aries Framework JavaScript</strong></mark></td><td>Aries Framework JavaScript is an SDK which <a href="https://hyperledger.github.io/anoncreds-spec/"><strong>supports ZKCreds (AnonCreds)</strong></a> natively with cheqd support. </td><td><a href="../../sdk/credo.md">credo.md</a></td></tr><tr><td><mark style="color:blue;"><strong>cheqd Cosmos CLI</strong></mark></td><td>Cosmos-native CLI for creating transactions on cheqd. Should be used for <strong>testing purposes only</strong>.</td><td></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>DID Registrar</strong></mark></td><td>Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the <a href="https://uniregistrar.io/">Universal Registrar</a>.</td><td><a href="../../advanced/did-registrar/">did-registrar</a></td></tr><tr><td><mark style="color:blue;"><strong>Veramo SDK Plugin</strong></mark></td><td>The <strong>Veramo SDK Plugin</strong> is an extension of the Veramo SDK, a JavaScript framework for Trusted Data, adding support for cheqd functionality.</td><td><a href="../../sdk/veramo-plugin/">veramo-plugin</a></td></tr><tr><td><mark style="color:blue;"><strong>Credo</strong></mark></td><td>Credo is an SDK which <strong>supports the European Architecture and Reference Framework (ARF)</strong> <strong>standards as well as AnonCreds</strong> with full cheqd support for DIDs. </td><td><a href="../../sdk/credo.md">credo.md</a></td></tr><tr><td><mark style="color:blue;"><strong>cheqd Cosmos CLI</strong></mark></td><td>Cosmos-native CLI for creating transactions on cheqd. Should be used for <strong>testing purposes only</strong>.</td><td></td></tr></tbody></table>
4 changes: 2 additions & 2 deletions studio/payments/learn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Build your knowledge about how cheqd's Credential Payment model works, including

## Get started

Using the Veramo SDK Plugin for cheqd, you can get started setting up your encrypted Status Lists with Access Control Conditions below:
Using cheqd Studio, you can get started setting up your encrypted Status Lists with Access Control Conditions below:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Charge for Status List</strong></mark></td><td>Set your payment conditions and encrypt a Status List 2021 Resource.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/charge.md">charge.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue Credential with Encrypted Status List</strong></mark></td><td>Issue a Verifiable Credential referencing an encrypted Status List in the Credential body.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/issue-paid-credential.md">issue-paid-credential.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Pay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Charge for Status List</strong></mark></td><td>Set your payment conditions and encrypt a Status List 2021 Resource.</td><td></td><td><a href="../charge.md">charge.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue Credential with Encrypted Status List</strong></mark></td><td>Issue a Verifiable Credential referencing an encrypted Status List in the Credential body.</td><td></td><td><a href="../issue-credential.md">issue-credential.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Pay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.</td><td></td><td><a href="../verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>

t
4 changes: 2 additions & 2 deletions studio/payments/learn/access-control-conditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,6 @@ Once an Access Control Condition has been set, the decryption keys are sharded b

## Get started

Using the Veramo SDK Plugin for cheqd, you can get started setting up your encrypted Status Lists with Access Control Conditions below:
Using cheqd Studio, you can get started setting up your encrypted Status Lists with Access Control Conditions below:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Charge for Status List</strong></mark></td><td>Set your payment conditions and encrypt a Status List 2021 Resource.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/charge.md">charge.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue Credential with Encrypted Status List</strong></mark></td><td>Issue a Verifiable Credential referencing an encrypted Status List in the Credential body.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/issue-paid-credential.md">issue-paid-credential.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Pay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.</td><td></td><td><a href="../../../sdk/veramo-plugin/payments/verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Charge for Status List</strong></mark></td><td>Set your payment conditions and encrypt a Status List 2021 Resource.</td><td></td><td><a href="../charge.md">charge.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue Credential with Encrypted Status List</strong></mark></td><td>Issue a Verifiable Credential referencing an encrypted Status List in the Credential body.</td><td></td><td><a href="../issue-credential.md">issue-credential.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Verifier pays Issuer</strong></mark></td><td>Pay an Issuer directly in CHEQ, meeting the Access Control Conditions. Verify the Credential to view the Status information.</td><td></td><td><a href="../verifier-pays-issuer.md">verifier-pays-issuer.md</a></td></tr></tbody></table>
2 changes: 1 addition & 1 deletion studio/trust-registries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ cheqd supports multiple Trust Registry Data Models, using its flexible DID and D

Learn about a data model below:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Verifiable Accreditation Trust Chain Model</strong></mark></td><td>Build our Trust Registry solution using DIDs and DID-Linked Resources based on the EBSI Trust Chain model.</td><td></td><td><a href="../../.gitbook/assets/cheqd_logo_card.jpg">cheqd_logo_card.jpg</a></td></tr><tr><td><mark style="color:blue;"><strong>OpenID Federation on cheqd</strong></mark></td><td>Deploy an OpenID Federation ecosystem on cheqd, using DIDs and DID-Linked Resources for Entity IDs and Entity Statements.</td><td><strong>Contact us</strong></td><td><a href="../../.gitbook/assets/OpenIDforWebsite.png">OpenIDforWebsite.png</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Verifiable Accreditation Trust Chain Model</strong></mark></td><td>Build our Trust Registry solution using DIDs and DID-Linked Resources based on the EBSI Trust Chain model.</td><td></td><td><a href="../../.gitbook/assets/cheqd_logo_card.jpg">cheqd_logo_card.jpg</a></td><td><a href="verifiable-accreditation-trust-chain-model.md">verifiable-accreditation-trust-chain-model.md</a></td></tr><tr><td><mark style="color:blue;"><strong>OpenID Federation on cheqd</strong></mark></td><td>Deploy an OpenID Federation ecosystem on cheqd, using DIDs and DID-Linked Resources for Entity IDs and Entity Statements.</td><td><strong>Contact us</strong></td><td><a href="../../.gitbook/assets/OpenIDforWebsite.png">OpenIDforWebsite.png</a></td><td></td></tr></tbody></table>

## Get started

Expand Down
4 changes: 2 additions & 2 deletions studio/trust-registries/create-accreditation.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ For a trusted ecosystem, these attestations are required to trace the legitimacy

<details>

<summary>Verifiable Accreditation to Attest Example</summary>
<summary>Example of Verifiable Accreditation to Attest</summary>

```json
{
Expand Down Expand Up @@ -164,7 +164,7 @@ SGVsbG8sIHdvcmxk

DID-Linked Resources are grouped by having identical **names** and **types**. This means if you want to create a new version of the same Resource, you will need to **specify the same name and type in the following request**.&#x20;

For Verifiable Accreditations, the "type" MUST be either: **`"VerifiableAccreditationToAccredit"`** or **`"VerifiableAccreditationToAccredit"`**
For Verifiable Accreditations, the "type" MUST be either: **`"VerifiableAccreditationToAccredit"`** or **`"VerifiableAccreditationToAttest"`**

For example:

Expand Down

0 comments on commit d2b2a71

Please sign in to comment.