diff --git a/README.md b/README.md index 2c87b4d..65ee5ca 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ There are three core ways of integrating and building with cheqd: cheqd's identity functionality is fully standards compliant, ensuring interoperability and no vendor lock-in. cheqd's tooling and different product offerings offer a variety of building blocks for any Trusted Data Market. -
Create Decentralised Identifiers (DIDs)Fully W3C DID Core conformant Digital identifiers for establishing a root of trust in a given ecosystem. Utilising cheqd's DID method (did:cheqd).dids
Build DID-Linked Trust Registries Create industry-leading trust registries, using chains of Verifiable Accreditations, to secure your identity ecosytem.
Charge for CredentialsSetup encrypted Status Lists and other Resources with Payment Conditions to unlock, allowing issuers to set a price for verifying a Credential Status. payments
Issue Credentials and PresentationsFully W3C VC Data Model conformant Verifiable Credentials for establishing trust. Supporting JSON, JSON-LD, SD-JWT and AnonCreds through cheqd APIs and via cheqd's Partners.credentials
Create Status Lists on-ledgerSophisticated and first-of-its-kind cryptographically verifiable on-ledger files for establishing Trust and Reputability in a Verifiable Credential, utilising DID-Linked Resources. status-lists
Create DID-Linked ResourcesDigital resources, leveraging the cryptographic verifiability of DIDs and patterns of DID Core to anchor schemas, trust registries, status lists and more. did-linked-resources
+
Create Decentralised Identifiers (DIDs)Fully W3C DID Core conformant Digital identifiers for establishing a root of trust in a given ecosystem. Utilising cheqd's DID method (did:cheqd).dids
Build DID-Linked Trust Registries Create industry-leading trust registries, using chains of Verifiable Accreditations, to secure your identity ecosytem.
Charge for CredentialsSetup encrypted Status Lists and other Resources with Payment Conditions to unlock, allowing issuers to set a price for verifying a Credential Status. payments
Issue Credentials and PresentationsFully W3C VC Data Model conformant Verifiable Credentials for establishing trust. Supporting JSON, JSON-LD, SD-JWT and AnonCreds through cheqd APIs and via cheqd's Partners.credentials
Create Status Lists on-ledgerSophisticated and first-of-its-kind cryptographically verifiable on-ledger files for establishing Trust and Reputability in a Verifiable Credential, utilising DID-Linked Resources. status-lists
Create DID-Linked ResourcesDigital resources, leveraging the cryptographic verifiability of DIDs and patterns of DID Core to anchor schemas, trust registries, status lists and more. did-linked-resources
## Industry Standard DID Support diff --git a/SUMMARY.md b/SUMMARY.md index 5c8dd07..8f3fe06 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,41 +7,41 @@ * [👉 Set up your account](getting-started/get-started/set-up-account.md) * [🔄 Advanced configuration options](getting-started/get-started/advanced.md) -## 🟢 Start using cheqd - -* [🆔 Create DIDs and Identity keys](credential-service/dids/README.md) - * [Create Issuer DID](credential-service/dids/create-did.md) - * [Create Identity Keys and Subject DIDs](credential-service/dids/create-subject-did.md) - * [Resolve a DID](credential-service/dids/resolve-did.md) - * [Update or Deactivate DID](credential-service/dids/update-did.md) -* [✅ Issue Credentials and Presentations](credential-service/credentials/README.md) - * [Issue Credential](credential-service/credentials/issue-credential.md) - * [Setup Verida Wallet](credential-service/credentials/verida.md) - * [Verify Credential](credential-service/credentials/verify-credential.md) - * [Verify Presentation](credential-service/credentials/verify-presentation.md) - * [Revoke Credential](credential-service/credentials/revoke-credential.md) - * [Suspend or Unsuspend Credential](credential-service/credentials/suspend-credential.md) -* [♻️ Charge for Verifiable Credentials](credential-service/payments/README.md) - * [Charge for Status List](credential-service/payments/charge.md) - * [Issue Credential with Encrypted Status List](credential-service/payments/issue-credential.md) - * [Verifier pays Issuer](credential-service/payments/verifier-pays-issuer.md) - * [Bulk Update or Rotate Encryption Keys](credential-service/payments/update.md) -* [🎋 Create Status Lists](credential-service/status-lists/README.md) - * [Status List v2021](credential-service/status-lists/status-list-v2021/README.md) - * [Create Status List v2021](credential-service/status-lists/create-status-list.md) - * [Update Status List v2021](credential-service/status-lists/update-status-list.md) - * [Check Status List v2021](credential-service/status-lists/check.md) - * [Search Status List v2021](credential-service/status-lists/search.md) - * [Token Status List](credential-service/status-lists/token-status-list/README.md) - * [Create Token Status List](credential-service/status-lists/token-status-list/create-token-status-list.md) - * [Update Token Status List](credential-service/status-lists/token-status-list/update-token-status-list.md) -* [↕️ Create DID-Linked Resources](credential-service/did-linked-resources/README.md) - * [Create DID-Linked Resource](credential-service/did-linked-resources/create-dlr.md) - * [Search DID-Linked Resource](credential-service/did-linked-resources/search.md) - * [Understanding DID-Linked Resources](credential-service/did-linked-resources/understanding-dlrs/README.md) - * [Context for developing DID-Linked Resources](credential-service/did-linked-resources/understanding-dlrs/context.md) - * [Technical composition of DID-Linked Resources](credential-service/did-linked-resources/understanding-dlrs/technical-composition.md) - * [Referencing DID-Linked Resources in VCs](credential-service/did-linked-resources/understanding-dlrs/referencing.md) +## 🟢 Start using cheqd + +* [🆔 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) + * [Resolve a DID](studio/dids/resolve-did.md) + * [Update or Deactivate DID](studio/dids/update-did.md) +* [✅ Issue Credentials and Presentations](studio/credentials/README.md) + * [Issue Credential](studio/credentials/issue-credential.md) + * [Setup Verida Wallet](studio/credentials/verida.md) + * [Verify Credential](studio/credentials/verify-credential.md) + * [Verify Presentation](studio/credentials/verify-presentation.md) + * [Revoke Credential](studio/credentials/revoke-credential.md) + * [Suspend or Unsuspend Credential](studio/credentials/suspend-credential.md) +* [♻️ Charge for Verifiable Credentials](studio/payments/README.md) + * [Charge for Status List](studio/payments/charge.md) + * [Issue Credential with Encrypted Status List](studio/payments/issue-credential.md) + * [Verifier pays Issuer](studio/payments/verifier-pays-issuer.md) + * [Bulk Update or Rotate Encryption Keys](studio/payments/update.md) +* [🎋 Create Status Lists](studio/status-lists/README.md) + * [Status List v2021](studio/status-lists/status-list-v2021/README.md) + * [Create Status List v2021](studio/status-lists/status-list-v2021/create-status-list.md) + * [Update Status List v2021](studio/status-lists/status-list-v2021/update-status-list.md) + * [Check Status List v2021](studio/status-lists/status-list-v2021/check.md) + * [Search Status List v2021](studio/status-lists/status-list-v2021/search.md) + * [Token Status List](studio/status-lists/token-status-list/README.md) + * [Create Token Status List](studio/status-lists/token-status-list/create-token-status-list.md) + * [Update Token Status List](studio/status-lists/token-status-list/update-token-status-list.md) +* [↕️ Create DID-Linked Resources](studio/did-linked-resources/README.md) + * [Create DID-Linked Resource](studio/did-linked-resources/create-dlr.md) + * [Search DID-Linked Resource](studio/did-linked-resources/search.md) + * [Understanding DID-Linked Resources](studio/did-linked-resources/understanding-dlrs/README.md) + * [Context for developing DID-Linked Resources](studio/did-linked-resources/understanding-dlrs/context.md) + * [Technical composition of DID-Linked Resources](studio/did-linked-resources/understanding-dlrs/technical-composition.md) + * [Referencing DID-Linked Resources in VCs](studio/did-linked-resources/understanding-dlrs/referencing.md) ## 🛠️ Integrate an SDK diff --git a/advanced/anoncreds/credential-definition.md b/advanced/anoncreds/credential-definition.md index 7afd5a2..3ffb362 100644 --- a/advanced/anoncreds/credential-definition.md +++ b/advanced/anoncreds/credential-definition.md @@ -2,7 +2,7 @@ description: cheqd support for Ledger-Agnostic AnonCreds CredDefs --- -# Credential Definitions ("CredDefs") +# Credential Definitions ## cheqd AnonCreds Object Method for CredDefs @@ -145,7 +145,7 @@ An example of a CredDef Object content with revocation is below: ### cheqd CredDef ID -cheqd uses [DID-Linked Resources](../../credential-service/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. +cheqd uses [DID-Linked Resources](../../studio/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. cheqd resources module uses the following path-based syntax: @@ -182,7 +182,7 @@ The cheqd CredDef request format comprises of: Both of these inputs are required to provide the ledger enough information to: -1. Populate a [cheqd DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/); and +1. Populate a [cheqd DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/); and 2. Compile a standardised AnonCreds CredDef object in the [Response format](credential-definition.md#cheqd-creddef-response-format). #### cheqd CredDef Resource file @@ -244,7 +244,7 @@ Or with revocation: } ``` -This CredDef Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../credential-service/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: +This CredDef Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../studio/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: | CredDef Object field | CredDef Object expected input | Mapped Payload file field | Mapped Payload file input | | -------------------- | ----------------------------- | ------------------------- | ------------------------- | @@ -278,7 +278,7 @@ Below is an example of a Payload file: } ``` -When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: +When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: | Additional parameter | Expected input | Rationale | | -------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/advanced/anoncreds/revocation-registry-definition.md b/advanced/anoncreds/revocation-registry-definition.md index 3e74b5d..7ee33e7 100644 --- a/advanced/anoncreds/revocation-registry-definition.md +++ b/advanced/anoncreds/revocation-registry-definition.md @@ -75,7 +75,7 @@ For example, the on-ledger Revocation Registry Definition Object Content is as f ### cheqd Revocation Registry Definition Object ID -cheqd uses [DID-Linked Resources](../../credential-service/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. +cheqd uses [DID-Linked Resources](../../studio/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. cheqd resources module uses the following format: @@ -112,7 +112,7 @@ The cheqd revocation registry definition request format comprises of: Both of these inputs are required to provide the ledger enough information to: -1. Populate a [cheqd DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/); and +1. Populate a [cheqd DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/); and 2. Compile a standardised AnonCreds revocation registry definition object in the [Response format](revocation-registry-definition.md#cheqd-revocation-registry-definition-response-format). #### Revocation Registry Definition Resource file @@ -142,7 +142,7 @@ In the example below, the content should be saved as a file, for example: `degre Note: The associated Credential Definition specified must have enabled revocation support for the Revocation Registry Definition to be able to be used properly in an SDK. {% endhint %} -This Revocation Registry Definition Resource file fields should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../credential-service/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: +This Revocation Registry Definition Resource file fields should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../studio/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: | Resource file field | Resource file input | Payload file field | Payload file input | | ------------------- | ------------------- | ------------------ | ---------------------- | @@ -176,7 +176,7 @@ Below is an example of a Payload file: } ``` -When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: +When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: | Additional parameter | Expected input | Rationale | | -------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/advanced/anoncreds/revocation-status-list.md b/advanced/anoncreds/revocation-status-list.md index 73e51ce..11048d9 100644 --- a/advanced/anoncreds/revocation-status-list.md +++ b/advanced/anoncreds/revocation-status-list.md @@ -53,7 +53,7 @@ Therefore, for each new Revocation Status List, the the `revocRegDefId` remains ### cheqd Revocation Status List Object ID -cheqd uses [DID-Linked Resources](../../credential-service/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. +cheqd uses [DID-Linked Resources](../../studio/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. cheqd resources module uses the following format: @@ -90,7 +90,7 @@ The cheqd AnonCreds Status List request format comprises of: Both of these inputs are required to provide the ledger enough information to: -1. Populate a [cheqd DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/); and +1. Populate a [cheqd DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/); and 2. Compile a standardised AnonCreds Revocation Registry Definition object in the [Response format](revocation-status-list.md#cheqd-status-list-response-format). #### Status List Resource file @@ -107,7 +107,7 @@ In the example below, the content should be saved as a file, for example: `degre } ``` -This Status List Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../credential-service/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: +This Status List Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../studio/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: | Resource file field | Resource file input | Payload file field | Payload file input | | ------------------- | -------------------- | ------------------ | --------------------- | @@ -140,7 +140,7 @@ Below is an example of a Payload file: } ``` -When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: +When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: | Additional parameter | Expected input | Rationale | | -------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/advanced/anoncreds/schema.md b/advanced/anoncreds/schema.md index b662c72..a1a7826 100644 --- a/advanced/anoncreds/schema.md +++ b/advanced/anoncreds/schema.md @@ -46,7 +46,7 @@ For example: ### cheqd Schema ID -cheqd uses [DID-Linked Resources](../../credential-service/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. +cheqd uses [DID-Linked Resources](../../studio/did-linked-resources/understanding-dlrs/) to identify individual resources, associated with a DID, using fully resolvable DID URLs. cheqd resources implementation uses the following path-based syntax: @@ -73,7 +73,7 @@ The cheqd schema request format comprises of: Both of these inputs are required to provide the ledger enough information to: -1. Populate a [cheqd DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/); and +1. Populate a [cheqd DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/); and 2. Compile a standardised AnonCreds schema object in the [Response format](schema.md#cheqd-schema-response-format). #### cheqd Schema Resource file @@ -90,7 +90,7 @@ In the example below, the content should be saved as a JSON file, for example: ` } ``` -This Schema Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../credential-service/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: +This Schema Resource file inputs should be replicated where possible within the Payload file, to populate a [DID-Linked resource](../../studio/did-linked-resources/understanding-dlrs/) stored on cheqd, with the following mapping: | Resource file field | Payload file field | | ------------------- | ------------------ | @@ -122,7 +122,7 @@ Below is an example of a Payload file: } ``` -When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../credential-service/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: +When passing the Payload file to the ledger, additional inputs may be required within the Payload file to populate the [DID-Linked Resource](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is: | Additional parameter | Expected input | Rationale | | -------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/advanced/tooling/advanced.md b/advanced/tooling/advanced.md index ac3b535..159b0a8 100644 --- a/advanced/tooling/advanced.md +++ b/advanced/tooling/advanced.md @@ -11,7 +11,7 @@ The [ledger code package `cheqd-node`](https://github.com/cheqd/cheqd-node) is b There are two custom modules on cheqd ledger related to identity functionality: 1. `cheqd` module, for everything related to Decentralized Identifiers (DIDs) -2. `resource` module, for [DID-Linked Resources](../../credential-service/did-linked-resources/understanding-dlrs/) +2. `resource` module, for [DID-Linked Resources](../../studio/did-linked-resources/understanding-dlrs/) ## Developing Golang apps for cheqd diff --git a/advanced/tooling/cheqd-node-cli/create-resource.md b/advanced/tooling/cheqd-node-cli/create-resource.md index e7fd041..82bdf35 100644 --- a/advanced/tooling/cheqd-node-cli/create-resource.md +++ b/advanced/tooling/cheqd-node-cli/create-resource.md @@ -1,6 +1,6 @@ # Creating a DID-Linked Resource using cheqd Cosmos CLI -The purpose of this document is to outline how someone can create a Resource on the cheqd network using [cheqd Cosmos CLI](create-did.md). The process that's followed is similar to what's described in the [high-level Resource creation flow](../../../credential-service/did-linked-resources/understanding-dlrs/technical-composition.md). +The purpose of this document is to outline how someone can create a Resource on the cheqd network using [cheqd Cosmos CLI](create-did.md). The process that's followed is similar to what's described in the [high-level Resource creation flow](../../../studio/did-linked-resources/understanding-dlrs/technical-composition.md). ## Pre-requisites diff --git a/getting-started/get-started/README.md b/getting-started/get-started/README.md index 95edc43..eda546e 100644 --- a/getting-started/get-started/README.md +++ b/getting-started/get-started/README.md @@ -18,7 +18,7 @@ With these APIs, it simplifies the developer experience, helping customers build cheqd Studio directly leverages our [Veramo SDK Plugin](https://github.com/cheqd/did-provider-cheqd), making a wide array of features available from launch, including: -
DIDs and Identity KeysCreate did:cheqd DIDs for credential issuers and for DID-Linked Resourcesdids
Trust RegistriesCreate chains of trusted Verifiable Accreditations for EU digital identity markets and beyond
PaymentsCreate commercial models for verifiable credentials, such as verifier-pays-issuerpayments
Status ListsCreate status lists, including Status List v2021 and Token Status Liststatus-lists
CredentialsIssue any type of credential, including SD-JWT, VCDM and AnonCreds via our partners, including trust registries, status lists and payments.credentials
ResourcesCreate custom resources for policies, presentation definitions, schemas and visual representations of credentialsdid-linked-resources
+
DIDs and Identity KeysCreate did:cheqd DIDs for credential issuers and for DID-Linked Resourcesdids
Trust RegistriesCreate chains of trusted Verifiable Accreditations for EU digital identity markets and beyond
PaymentsCreate commercial models for verifiable credentials, such as verifier-pays-issuerpayments
Status ListsCreate status lists, including Status List v2021 and Token Status Liststatus-lists
CredentialsIssue any type of credential, including SD-JWT, VCDM and AnonCreds via our partners, including trust registries, status lists and payments.credentials
ResourcesCreate custom resources for policies, presentation definitions, schemas and visual representations of credentialsdid-linked-resources
## Understanding the different modes and client choices diff --git a/sdk/veramo-plugin/did-linked-resources/README.md b/sdk/veramo-plugin/did-linked-resources/README.md index ba97bef..dfb6909 100644 --- a/sdk/veramo-plugin/did-linked-resources/README.md +++ b/sdk/veramo-plugin/did-linked-resources/README.md @@ -6,7 +6,7 @@ ## Get started -
Create DID-Linked ResourceCreate a custom DID-Linked Resource for a schema, Trust Registry or other persistent data file.create-dlr.md
Create Status ListCreate an on-ledger Status List associated with a DID.status-lists
Understanding DID-Linked ResourcesDetailed guide explaining the context and technical composition of DID-Linked Resources on cheqd.understanding-dlrs
DID Resolution and DID URL DereferencingArchitecture decision record explaining the different parameters for fetching DID Document data on cheqd, including DID-Linked Resourcesadr-005-did-resolution-and-did-url-dereferencing.md
+
Create DID-Linked ResourceCreate a custom DID-Linked Resource for a schema, Trust Registry or other persistent data file.create-dlr.md
Create Status ListCreate an on-ledger Status List associated with a DID.status-lists
Understanding DID-Linked ResourcesDetailed guide explaining the context and technical composition of DID-Linked Resources on cheqd.understanding-dlrs
DID Resolution and DID URL DereferencingArchitecture decision record explaining the different parameters for fetching DID Document data on cheqd, including DID-Linked Resourcesadr-005-did-resolution-and-did-url-dereferencing.md
## Alternatives diff --git a/sdk/veramo-plugin/payments/learn/privacy-considerations.md b/sdk/veramo-plugin/payments/learn/privacy-considerations.md index 327b390..bd6bd87 100644 --- a/sdk/veramo-plugin/payments/learn/privacy-considerations.md +++ b/sdk/veramo-plugin/payments/learn/privacy-considerations.md @@ -6,7 +6,7 @@ description: Understand how privacy is protected throughout the payment flow ## Privacy considerations -cheqd's implementation of Credential Payments uses encrypted [DID-Linked Resources](../../../../credential-service/did-linked-resources/understanding-dlrs/) (such as a Status Lists), with Payment Conditions required to unlock. Learn about cheqd's Access Control Condition logic below: +cheqd's implementation of Credential Payments uses encrypted [DID-Linked Resources](../../../../studio/did-linked-resources/understanding-dlrs/) (such as a Status Lists), with Payment Conditions required to unlock. Learn about cheqd's Access Control Condition logic below:
Access Control ConditionsUnderstand how cheqd gates encrypted resources using payment conditions and Access Control logic.
diff --git a/sdk/veramo-plugin/status-list-v2021/README.md b/sdk/veramo-plugin/status-list-v2021/README.md index 74252d9..66ce828 100644 --- a/sdk/veramo-plugin/status-list-v2021/README.md +++ b/sdk/veramo-plugin/status-list-v2021/README.md @@ -24,7 +24,7 @@ The issuer keeps a bitstring list of all Verifiable Credentials it has issued. T ### Where does cheqd store the Status List? -cheqd stores each Status List and subsequent entries on-ledger as [DID-Linked Resource](../../../architecture/adr-list/adr-002-did-linked-resources.md) versions. This has notable benefits, including the provenance, legitimacy and security of the Status List. For a full list of benefits, see [the context for creating DID-Linked Resources](../../../credential-service/did-linked-resources/understanding-dlrs/context.md). +cheqd stores each Status List and subsequent entries on-ledger as [DID-Linked Resource](../../../architecture/adr-list/adr-002-did-linked-resources.md) versions. This has notable benefits, including the provenance, legitimacy and security of the Status List. For a full list of benefits, see [the context for creating DID-Linked Resources](../../../studio/did-linked-resources/understanding-dlrs/context.md). ## Alternatives diff --git a/sdk/veramo-plugin/status-list-v2021/statuslist2021-resources.md b/sdk/veramo-plugin/status-list-v2021/statuslist2021-resources.md index beb2b47..a8b99a6 100644 --- a/sdk/veramo-plugin/status-list-v2021/statuslist2021-resources.md +++ b/sdk/veramo-plugin/status-list-v2021/statuslist2021-resources.md @@ -8,7 +8,7 @@ The [Status List 2021 Specification](https://w3c-ccg.github.io/vc-status-list-20 Using cheqd's Resource Module, the same benefits may be achieved. In fact, storing a StatusList as an on-ledger Resource is a much better application of technology than using a Verifiable Credential for the same purpose. -By storing a StatusList on the cheqd Network as a Resource, it creates a much more resilient and decentralised mechanism for storing and maintaining the revocation/suspension status of Verifiable Credentials. The [benefits of using the cheqd Resource module over traditional centralised architecture are detailed here](../../../credential-service/did-linked-resources/understanding-dlrs/context.md). +By storing a StatusList on the cheqd Network as a Resource, it creates a much more resilient and decentralised mechanism for storing and maintaining the revocation/suspension status of Verifiable Credentials. The [benefits of using the cheqd Resource module over traditional centralised architecture are detailed here](../../../studio/did-linked-resources/understanding-dlrs/context.md). Moreover, cheqd's Resource Module enables individual Resources to be referenced and retrieved using a DID URL in conformance with DID Core. This is being standardized at [the Trust over IP Foundation](https://trustoverip.org/) within a specification called [DID URLs for Digital Resources](https://wiki.trustoverip.org/display/HOME/DID-Linked+Resources+Specification). diff --git a/credential-service/credentials/README.md b/studio/credentials/README.md similarity index 100% rename from credential-service/credentials/README.md rename to studio/credentials/README.md diff --git a/credential-service/credentials/issue-credential.md b/studio/credentials/issue-credential.md similarity index 100% rename from credential-service/credentials/issue-credential.md rename to studio/credentials/issue-credential.md diff --git a/credential-service/credentials/revoke-credential.md b/studio/credentials/revoke-credential.md similarity index 100% rename from credential-service/credentials/revoke-credential.md rename to studio/credentials/revoke-credential.md diff --git a/credential-service/credentials/suspend-credential.md b/studio/credentials/suspend-credential.md similarity index 100% rename from credential-service/credentials/suspend-credential.md rename to studio/credentials/suspend-credential.md diff --git a/credential-service/credentials/verida.md b/studio/credentials/verida.md similarity index 100% rename from credential-service/credentials/verida.md rename to studio/credentials/verida.md diff --git a/credential-service/credentials/verify-credential.md b/studio/credentials/verify-credential.md similarity index 100% rename from credential-service/credentials/verify-credential.md rename to studio/credentials/verify-credential.md diff --git a/credential-service/credentials/verify-presentation.md b/studio/credentials/verify-presentation.md similarity index 100% rename from credential-service/credentials/verify-presentation.md rename to studio/credentials/verify-presentation.md diff --git a/credential-service/did-linked-resources/README.md b/studio/did-linked-resources/README.md similarity index 100% rename from credential-service/did-linked-resources/README.md rename to studio/did-linked-resources/README.md diff --git a/credential-service/did-linked-resources/create-dlr.md b/studio/did-linked-resources/create-dlr.md similarity index 100% rename from credential-service/did-linked-resources/create-dlr.md rename to studio/did-linked-resources/create-dlr.md diff --git a/credential-service/did-linked-resources/search.md b/studio/did-linked-resources/search.md similarity index 100% rename from credential-service/did-linked-resources/search.md rename to studio/did-linked-resources/search.md diff --git a/credential-service/did-linked-resources/understanding-dlrs/README.md b/studio/did-linked-resources/understanding-dlrs/README.md similarity index 100% rename from credential-service/did-linked-resources/understanding-dlrs/README.md rename to studio/did-linked-resources/understanding-dlrs/README.md diff --git a/credential-service/did-linked-resources/understanding-dlrs/context.md b/studio/did-linked-resources/understanding-dlrs/context.md similarity index 100% rename from credential-service/did-linked-resources/understanding-dlrs/context.md rename to studio/did-linked-resources/understanding-dlrs/context.md diff --git a/credential-service/did-linked-resources/understanding-dlrs/referencing.md b/studio/did-linked-resources/understanding-dlrs/referencing.md similarity index 100% rename from credential-service/did-linked-resources/understanding-dlrs/referencing.md rename to studio/did-linked-resources/understanding-dlrs/referencing.md diff --git a/credential-service/did-linked-resources/understanding-dlrs/technical-composition.md b/studio/did-linked-resources/understanding-dlrs/technical-composition.md similarity index 100% rename from credential-service/did-linked-resources/understanding-dlrs/technical-composition.md rename to studio/did-linked-resources/understanding-dlrs/technical-composition.md diff --git a/credential-service/dids/README.md b/studio/dids/README.md similarity index 100% rename from credential-service/dids/README.md rename to studio/dids/README.md diff --git a/credential-service/dids/create-did.md b/studio/dids/create-did.md similarity index 100% rename from credential-service/dids/create-did.md rename to studio/dids/create-did.md diff --git a/credential-service/dids/create-subject-did.md b/studio/dids/create-subject-did.md similarity index 100% rename from credential-service/dids/create-subject-did.md rename to studio/dids/create-subject-did.md diff --git a/credential-service/dids/resolve-did.md b/studio/dids/resolve-did.md similarity index 100% rename from credential-service/dids/resolve-did.md rename to studio/dids/resolve-did.md diff --git a/credential-service/dids/update-did.md b/studio/dids/update-did.md similarity index 100% rename from credential-service/dids/update-did.md rename to studio/dids/update-did.md diff --git a/credential-service/payments/README.md b/studio/payments/README.md similarity index 100% rename from credential-service/payments/README.md rename to studio/payments/README.md diff --git a/credential-service/payments/charge.md b/studio/payments/charge.md similarity index 99% rename from credential-service/payments/charge.md rename to studio/payments/charge.md index ec94a1d..cfd5c83 100644 --- a/credential-service/payments/charge.md +++ b/studio/payments/charge.md @@ -38,7 +38,7 @@ Using this API will create a regular Status List on-ledger, where the contents o -For the purpose of this tutorial, we will assume the user is creating an encrypted Status List. For unencrypted Status Lists, [follow the tutorial here](../status-lists/create-status-list.md). +For the purpose of this tutorial, we will assume the user is creating an encrypted Status List. For unencrypted Status Lists, [follow the tutorial here](../status-lists/status-list-v2021/create-status-list.md). ## Step 4: Create encrypted Status List diff --git a/credential-service/payments/issue-credential.md b/studio/payments/issue-credential.md similarity index 100% rename from credential-service/payments/issue-credential.md rename to studio/payments/issue-credential.md diff --git a/credential-service/payments/update.md b/studio/payments/update.md similarity index 100% rename from credential-service/payments/update.md rename to studio/payments/update.md diff --git a/credential-service/payments/verifier-pays-issuer.md b/studio/payments/verifier-pays-issuer.md similarity index 100% rename from credential-service/payments/verifier-pays-issuer.md rename to studio/payments/verifier-pays-issuer.md diff --git a/credential-service/status-lists/README.md b/studio/status-lists/README.md similarity index 100% rename from credential-service/status-lists/README.md rename to studio/status-lists/README.md diff --git a/credential-service/status-lists/status-list-v2021/README.md b/studio/status-lists/status-list-v2021/README.md similarity index 100% rename from credential-service/status-lists/status-list-v2021/README.md rename to studio/status-lists/status-list-v2021/README.md diff --git a/credential-service/status-lists/check.md b/studio/status-lists/status-list-v2021/check.md similarity index 95% rename from credential-service/status-lists/check.md rename to studio/status-lists/status-list-v2021/check.md index 5dbed8f..502116e 100644 --- a/credential-service/status-lists/check.md +++ b/studio/status-lists/status-list-v2021/check.md @@ -70,7 +70,7 @@ The index within the bitstring that the user wants to query. For example: To automatically make a payment to an Issuer in order to verify an encrypted Status List, follow the tutorial here: -
Verifier pays IssuerUnderstand how a Verifier pays an Issuer to decrypt an encrypted Status List and verify a Credential Status.verifier-pays-issuer.md
+
Verifier pays IssuerUnderstand how a Verifier pays an Issuer to decrypt an encrypted Status List and verify a Credential Status.verifier-pays-issuer.md
### Option 2. Publish a JSON Payload diff --git a/credential-service/status-lists/create-status-list.md b/studio/status-lists/status-list-v2021/create-status-list.md similarity index 94% rename from credential-service/status-lists/create-status-list.md rename to studio/status-lists/status-list-v2021/create-status-list.md index 1068da5..4ee3c36 100644 --- a/credential-service/status-lists/create-status-list.md +++ b/studio/status-lists/status-list-v2021/create-status-list.md @@ -10,17 +10,17 @@ Users are able to create [Verifiable Credential Status List v2021](https://www.w Make sure you have set up your account with cheqd Studio and are logged in, using our guide below: -
Set up your accountSet up your account with cheqd Studio and log in to start using the APIs.set-up-account.md
+
Set up your accountSet up your account with cheqd Studio and log in to start using the APIs.set-up-account.md
## Step 2: Create a DID Before you can create a Status List, you need to create a DID which is used to link the Status List on-ledger. Use the API in the page below to create a DID: -
Create an Issuer DIDCreate a W3C conformant DID on cheqd using the did:cheqd DID Method.create-did.md
+
Create an Issuer DIDCreate a W3C conformant DID on cheqd using the did:cheqd DID Method.create-did.md
## Step 3: Select the unencrypted Status List API -When [creating a Status List](./), a user will have the following options: +When [creating a Status List](../), a user will have the following options:
@@ -38,7 +38,7 @@ Using this API will create a regular Status List on-ledger, where the contents o
-For the purpose of this tutorial, we will assume the user is creating an unencrypted Status List. For encrypted Status Lists, [follow the tutorial here](../payments/charge.md). +For the purpose of this tutorial, we will assume the user is creating an unencrypted Status List. For encrypted Status Lists, [follow the tutorial here](../../payments/charge.md). ## Step 4: Create unencrypted Status List diff --git a/credential-service/status-lists/search.md b/studio/status-lists/status-list-v2021/search.md similarity index 100% rename from credential-service/status-lists/search.md rename to studio/status-lists/status-list-v2021/search.md diff --git a/credential-service/status-lists/update-status-list.md b/studio/status-lists/status-list-v2021/update-status-list.md similarity index 100% rename from credential-service/status-lists/update-status-list.md rename to studio/status-lists/status-list-v2021/update-status-list.md diff --git a/credential-service/status-lists/token-status-list/README.md b/studio/status-lists/token-status-list/README.md similarity index 100% rename from credential-service/status-lists/token-status-list/README.md rename to studio/status-lists/token-status-list/README.md diff --git a/credential-service/status-lists/token-status-list/create-token-status-list.md b/studio/status-lists/token-status-list/create-token-status-list.md similarity index 100% rename from credential-service/status-lists/token-status-list/create-token-status-list.md rename to studio/status-lists/token-status-list/create-token-status-list.md diff --git a/credential-service/status-lists/token-status-list/update-token-status-list.md b/studio/status-lists/token-status-list/update-token-status-list.md similarity index 100% rename from credential-service/status-lists/token-status-list/update-token-status-list.md rename to studio/status-lists/token-status-list/update-token-status-list.md