Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
ankurdotb authored Jan 22, 2025
2 parents f2ee5ea + a2157be commit becb6e0
Show file tree
Hide file tree
Showing 41 changed files with 17,517 additions and 318 deletions.
Binary file added .gitbook/assets/Keplr to Leap Wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/Leap to Keplr wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16,519 changes: 16,519 additions & 0 deletions .gitbook/assets/swagger.json

Large diffs are not rendered by default.

28 changes: 23 additions & 5 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
* [TAO -> SubTAO](studio/trust-registries/verifiable-accreditation-trust-chain-model/tao-greater-than-subtao.md)
* [TAO -> TI](studio/trust-registries/verifiable-accreditation-trust-chain-model/tao-greater-than-ti.md)
* [Referencing Trust Registry within a Verifiable Credential](studio/trust-registries/verifiable-accreditation-trust-chain-model/referencing.md)
* [Create Verifiable Accreditation](studio/trust-registries/create-accreditation.md)
* [Issue Verifiable Accreditation](studio/trust-registries/issue-accreditation.md)
* [Verify Verifiable Accreditation](studio/trust-registries/verify-verifiable-accreditation.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)
Expand Down Expand Up @@ -97,6 +98,19 @@
* [Create a new Resource version within existing Collection](sdk/veramo-plugin/did-linked-resources/create-new-version.md)
* [🍏 Credo](sdk/credo.md)
* [🫐 Walt.id SSI Kit](sdk/ssi-kit.md)
* [🍊 ACA-Py](sdk/aca-py/README.md)
* [Setup ACA-Py Agent](sdk/aca-py/setup-aca-py-agent.md)
* [Decentralized Identifiers (DIDs)](sdk/aca-py/decentralized-identifiers-dids/README.md)
* [Create a DID](sdk/aca-py/decentralized-identifiers-dids/create-a-did.md)
* [Update a DID](sdk/aca-py/decentralized-identifiers-dids/update-a-did.md)
* [Deactivate a DID](sdk/aca-py/decentralized-identifiers-dids/deactivate-a-did.md)
* [DID-Linked Resources](sdk/aca-py/did-linked-resources/README.md)
* [Create AnonCreds Schema](sdk/aca-py/did-linked-resources/create-anoncreds-schema.md)
* [Create AnonCreds Credential Definition](sdk/aca-py/did-linked-resources/create-anoncreds-credential-definition.md)
* [Verifiable Credentials and Presentations](sdk/aca-py/verifiable-credentials-and-presentations/README.md)
* [Issue a Verifiable Credential](sdk/aca-py/verifiable-credentials-and-presentations/issue-a-verifiable-credential.md)
* [Present a Verifiable Credential](sdk/aca-py/verifiable-credentials-and-presentations/present-a-verifiable-credential.md)
* [Revoke a Verifiable Credential](sdk/aca-py/verifiable-credentials-and-presentations/revoke-a-verifiable-credential.md)

## 🏗️ Architecture

Expand Down Expand Up @@ -139,8 +153,10 @@
* [Identity Write Pricing](network/cheqd/identity-write-pricing.md)
* [Comparison to Hyperledger Indy](network/cheqd/comparison-to-hyperledger-indy.md)
* [⏩ Setup your Wallet](network/wallets/README.md)
* [Setup Leap Wallet](network/wallets/setup-leap-wallet.md)
* [Setup Keplr wallet](network/wallets/keplr-setup.md)
* [Setup Leap Wallet](network/wallets/setup-leap-wallet/README.md)
* [Congifure cheqd testnet for Leap](network/wallets/setup-leap-wallet/testnet.md)
* [Setup Keplr Wallet](network/wallets/keplr-setup.md)
* [Migrate from Keplr to Leap Wallet](network/wallets/migrate.md)
* [↪️ Useful Tools and APIs](network/tools/README.md)
* [Block Explorer](network/tools/block-explorer.md)
* [Testnet Faucet](network/tools/testnet-faucet.md)
Expand All @@ -160,14 +176,16 @@
* [0.6.x](network/network-upgrades/2022/0.6.x.md)
* [2023](network/network-upgrades/2023/README.md)
* [1.x](network/network-upgrades/2023/1.x.md)
* [2024](network/network-upgrades/2024.md)
* [2024](network/network-upgrades/2024/README.md)
* [2.x](network/network-upgrades/2024/2.x.md)
* [3.x](network/network-upgrades/2024/3.x.md)
* [Root Cause Analysis of outages](network/network-upgrades/root-cause-analysis-of-outages/README.md)
* [v1.x upgrade RCA](network/network-upgrades/root-cause-analysis-of-outages/v1.x-upgrade-rca.md)

## ⚖️ Legal

* [License](LICENSE.md)
* [Code of Conduct](CODE\_OF\_CONDUCT.md)
* [Code of Conduct](CODE_OF_CONDUCT.md)
* [Security Policy](SECURITY.md)

## 🆘 Support
Expand Down
12 changes: 6 additions & 6 deletions advanced/anoncreds/revocation-registry-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The required content and data model for the AnonCreds Revocation Registry Defini
* `z` - a public key used to sign the accumulator (described further below)
* `maxCredNum` - The maximum amount of Credentials that can be revoked in the Revocation Registry before a new one needs to be started
* `tailsLocation` - The URL pointing to the related tails file
* `tailsHash` - The hash of the tails file [TAILS\_FILE](https://hyperledger.github.io/anoncreds-spec/#term:tails\_file) (see also: [next section](https://hyperledger.github.io/anoncreds-spec/#tails-file-and-tails-file-generation)) resulting from hashing the tails file version prepended to the tails file as SHA256 and then encoded to base58.
* `tailsHash` - The hash of the tails file [TAILS\_FILE](https://hyperledger.github.io/anoncreds-spec/#term:tails_file) (see also: [next section](https://hyperledger.github.io/anoncreds-spec/#tails-file-and-tails-file-generation)) resulting from hashing the tails file version prepended to the tails file as SHA256 and then encoded to base58.

For example, the on-ledger Revocation Registry Definition Object Content is as fol

Expand Down Expand Up @@ -162,7 +162,7 @@ Below is an example of a Payload file:
"payload": {
"collectionId": "zF7rhDBfUt9d1gJPjx7s1J",
"id": "af20b1f0-5c4d-4037-9669-eaedddb9c2df",
"name": "universityDegree", // this is an additional input
"name": "universityDegree-1.0", // this is an additional input
"version": "2.0", // this is an optional additional input
"resourceType": "anonCredsRevocRegDef",
"alsoKnownAs": []
Expand All @@ -178,9 +178,9 @@ 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](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is:

| Additional parameter | Expected input | Rationale |
| -------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "name" | "\<insert same name as CredDef>" | The Payload file drawing inputs from the Resource file on its own does not provide the ledger the requisite amount of information to create a full DID-Linked Resource. resourceName must be provided as an additional input parameter |
| Additional parameter | Expected input | Rationale |
| -------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "name" | "\<insert same name as CredDef>-\<revocation tag>" | The Payload file drawing inputs from the Resource file on its own does not provide the ledger the requisite amount of information to create a full DID-Linked Resource. resourceName must be provided as an additional input parameter, as well as a revocation tag. There must be a hyphen between them. |

#### Publishing resource using CLI

Expand Down Expand Up @@ -208,7 +208,7 @@ Once you have created your Revocation Registry as a resource on cheqd, the follo
"resourceURI": "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1J/resources/af20b1f0-5c4d-4037-9669-eaedddb9c2df",
"resourceCollectionId": "zF7rhDBfUt9d1gJPjx7s1J",
"resourceId": "af20b1f0-5c4d-4037-9669-eaedddb9c2df",
"resourceName": "universityDegree",
"resourceName": "universityDegree-1.0",
"resourceType": "anonCredsRevocRegDef",
"resourceVersion": "2.0",
"mediaType": "application/json",
Expand Down
12 changes: 6 additions & 6 deletions advanced/anoncreds/revocation-status-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Below is an example of a Payload file:
"payload": {
"collectionId": "zF7rhDBfUt9d1gJPjx7s1J",
"id": "af20b1f0-5c4d-4037-9669-eaedddb9c2df",
"name": "universityDegree",
"name": "universityDegree-1.0",
"version": "",
"resourceType": "anonCredsStatusList",
"alsoKnownAs": []
Expand All @@ -142,9 +142,9 @@ 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](../../studio/did-linked-resources/understanding-dlrs/). In this instance, the only additional information required is:

| Additional parameter | Expected input | Rationale |
| -------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "name" | "\<insert same name as CredDef and RevocRegDef>" | The Payload file drawing inputs from the Resource file on its own does not provide the ledger the requisite amount of information to create a full DID-Linked Resource. resourceName must be provided as an additional input parameter |
| Additional parameter | Expected input | Rationale |
| -------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "name" | "\<insert same name as CredDef>-\<Revocation Tag>" | The Payload file drawing inputs from the Resource file on its own does not provide the ledger the requisite amount of information to create a full DID-Linked Resource. resourceName must be provided as an additional input parameter, as well as a revocation tag. There must be a hyphen between them. |

#### Publishing resource using CLI

Expand Down Expand Up @@ -172,7 +172,7 @@ Once you have created your Status List Object as a resource on cheqd, the follow
"resourceURI": "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1J/resources/9d26b902-555d-43bd-bac3-0bedeb462887",
"resourceCollectionId": "zF7rhDBfUt9d1gJPjx7s1J",
"resourceId": "9d26b902-555d-43bd-bac3-0bedeb462887",
"resourceName": "universityDegree",
"resourceName": "universityDegree-1.0",
"resourceType": "anonCredsStatusList",
"mediaType": "application/json",
"created": "2022-08-21T08:40:00Z",
Expand Down Expand Up @@ -230,7 +230,7 @@ Once the transaction has been created, the `resourceMetadata` will look like the
"resourceURI": "did:cheqd:mainnet:zF7rhDBfUt9d1gJPjx7s1J/resources/c154bc07-43f7-4b69-ac0c-5514001f2ca3",
"resourceCollectionId": "zF7rhDBfUt9d1gJPjx7s1J",
"resourceId": "513d8a44-6188-41c2-8de8-eda562f82947",
"resourceName": "universityDegree",
"resourceName": "universityDegree-1.0",
"resourceType": "anonCredsStatusList",
"mediaType": "application/json",
"created": "2022-09-01T04:30:01Z",
Expand Down
21 changes: 21 additions & 0 deletions network/network-upgrades/2024/2.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 2.x

## Dependency Upgrades:

* Upgrade Go version to at least v1.20, with v1.21 as the targeted latest stable.
* Upgrade Cosmos SDK from v0.46.x (being a fork at v0.46.10, applying Barberry vulnerability patch on top, along with IAVL forked at v0.19.5 applying pruning logic patch on top) to v0.47.x (latest: v0.47.8), including relevant cosmossdk.io indirect dependencies and IAVL package.
* The ideal outcome is removing all forks, upgrading direct, indirect dependencies to latest v0.47.x release line covering the set requirements to follow.
* Update Comet BFT (Tendermint v0.34.26) to match Cosmos SDK’s associated version (latest: v0.37.4).
* Update IBC from v6.1.1 to v7.x (latest: v7.3.2).
* Test suite updates in Ginkgo BDD for connecting to the latest Osmosis, transferring tokens, and querying DID-Linked Resources through IBC.

### Fixes:

* Address non-operational state sync issue by assessing remediation strategies used in similar contexts.
* Resolve non-operational pruning while retaining the panic-exit fix introduced in the forked v0.46.x compatible IAVL, exploring options for a permanent solution.

### CI + Tests:

* Update build, test, and release CI actions to target the latest Ubuntu LTS (latest: 22.04.3).
* Update build, release CI actions to target latest GoReleaser (latest: v1.24.0, requires Go v1.20+).
* Resolve possible testing suite adjustments derived from the aforementioned dependency upgrades, notably upgrade tests written in Ginkgo BDD testing framework.
7 changes: 7 additions & 0 deletions network/network-upgrades/2024/3.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 3.x

The upgrade is broken down into three primary areas of development:

1. **EIP-1559-Style Burn Mechanism**: Inspired by Ethereum’s model, any network transaction—whether a transfer, proof-of-stake delegation, or identity ledger update—will burn $CHEQ tokens, including “credential payments,” ensuring consistent protocol revenue via token burns.
2. **Fee Abstraction**: Anyone with a Cosmos token can now pay for transactions on the cheqd network, with these tokens converted into $CHEQ as needed. This feature enables stable payments using tokens like USDC, EUROe, or EURC, providing greater payment flexibility.
3. **General Burn Transaction**: A new option to burn $CHEQ tokens on demand, expanding use cases for token management.
File renamed without changes.
2 changes: 1 addition & 1 deletion network/network-upgrades/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ To ensure we upgrade all nodes on the network in the most efficient way whilst m

Take a look at our network upgrades across the years, including Root Cause Analysis of any Network outage.&#x20;

<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>2021</strong></mark></td><td>View our network ugrades from 2021.</td><td><a href="2021/">2021</a></td></tr><tr><td><mark style="color:blue;"><strong>2022</strong></mark></td><td>View our network ugrades from 2022.</td><td><a href="2022/">2022</a></td></tr><tr><td><mark style="color:blue;"><strong>2023</strong></mark></td><td>View our network ugrades from 2023.</td><td><a href="2023/">2023</a></td></tr><tr><td><mark style="color:blue;"><strong>2024</strong></mark></td><td>View our network ugrades from 2024.</td><td><a href="2024.md">2024.md</a></td></tr><tr><td><mark style="color:blue;"><strong>RCAs</strong></mark></td><td>View our Root Cause Analysis of Network outages.</td><td><a href="root-cause-analysis-of-outages/">root-cause-analysis-of-outages</a></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>2021</strong></mark></td><td>View our network ugrades from 2021.</td><td><a href="2021/">2021</a></td></tr><tr><td><mark style="color:blue;"><strong>2022</strong></mark></td><td>View our network ugrades from 2022.</td><td><a href="2022/">2022</a></td></tr><tr><td><mark style="color:blue;"><strong>2023</strong></mark></td><td>View our network ugrades from 2023.</td><td><a href="2023/">2023</a></td></tr><tr><td><mark style="color:blue;"><strong>2024</strong></mark></td><td>View our network ugrades from 2024.</td><td><a href="2024/">2024</a></td></tr><tr><td><mark style="color:blue;"><strong>RCAs</strong></mark></td><td>View our Root Cause Analysis of Network outages.</td><td><a href="root-cause-analysis-of-outages/">root-cause-analysis-of-outages</a></td></tr></tbody></table>
2 changes: 1 addition & 1 deletion network/wallets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ _Disclaimer: All information provided is intended to help users get set up on ch

When issuing credentials using the cheqd network, both testnet and mainnet, you will need to hold tokens to pay for the transaction. In this guide we offer options for setting up a wallet and adding cheqd's mainnet and testnet.

<table data-card-size="large" data-view="cards"><thead><tr><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>Leap Wallet</strong></mark></td><td>Manage your CHEQ natively through the Leap Wallet with full support on desktop, browser and mobile.</td><td><a href="../../.gitbook/assets/leap wallet.png">leap wallet.png</a></td><td><a href="setup-leap-wallet.md">setup-leap-wallet.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Keplr wallet</strong></mark></td><td>Add the cheqd extentsion to your Keplr wallet to get support on Keplr browser and desktop.</td><td><a href="../../.gitbook/assets/Keplr wallet.png">Keplr wallet.png</a></td><td><a href="keplr-setup.md">keplr-setup.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><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>Leap Wallet</strong></mark></td><td>Manage your CHEQ natively through the Leap Wallet with full support on desktop, browser and mobile.</td><td><a href="../../.gitbook/assets/leap wallet.png">leap wallet.png</a></td><td><a href="setup-leap-wallet/">setup-leap-wallet</a></td></tr><tr><td><mark style="color:blue;"><strong>Keplr Wallet</strong></mark></td><td>Add the cheqd extentsion to your Keplr Wallet to get support on Keplr browser and desktop.</td><td><a href="../../.gitbook/assets/Keplr wallet.png">Keplr wallet.png</a></td><td><a href="keplr-setup.md">keplr-setup.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Migrate from Keplr to Leap Wallet</strong></mark></td><td>Import your Keplr Wallet into Leap to access full cheqd support, including mobile app compatibility.</td><td><a href="../../.gitbook/assets/Keplr to Leap Wallet.png">Keplr to Leap Wallet.png</a></td><td><a href="migrate.md">migrate.md</a></td></tr></tbody></table>

## More on CHEQ

Expand Down
6 changes: 3 additions & 3 deletions network/wallets/keplr-setup.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
description: Setup Keplr wallet to access CHEQ
description: Setup Keplr Wallet to access CHEQ
---

# Setup Keplr wallet
# Setup Keplr Wallet

_Disclaimer: All information provided is intended to help users get set up on cheqd. However, we do not expressly recommend or mandate a certain approach. All actions taken are your personal responsibility._

## Overview

In this guide we'll share how to setup a Keplr wallet which you can use for paying for transactions on the cheqd network. We'll also share how to add the cheqd mainnet and testnet to your Keplr wallet.
In this guide we'll share how to setup a Keplr Wallet which you can use for paying for transactions on the cheqd network. We'll also share how to add the cheqd mainnet and testnet to your Keplr wallet.

## Setting up a Keplr Wallet on PC/Mac

Expand Down
Loading

0 comments on commit becb6e0

Please sign in to comment.