Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheqd/did-provider-cheqd
Veramo SDK plugin for the did:cheqd DID method
https://github.com/cheqd/did-provider-cheqd
cheqd cosmos-sdk hacktoberfest veramo veramo-plugin verifiable-credentials w3c-did
Last synced: about 2 months ago
JSON representation
Veramo SDK plugin for the did:cheqd DID method
- Host: GitHub
- URL: https://github.com/cheqd/did-provider-cheqd
- Owner: cheqd
- License: apache-2.0
- Created: 2022-04-25T10:28:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:28:38.000Z (about 2 months ago)
- Last Synced: 2024-10-26T01:32:15.426Z (about 2 months ago)
- Topics: cheqd, cosmos-sdk, hacktoberfest, veramo, veramo-plugin, verifiable-credentials, w3c-did
- Language: TypeScript
- Homepage: https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd
- Size: 13.5 MB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Veramo SDK plugin for cheqd DID method
[](https://github.com/cheqd/did-provider-cheqd/releases/latest)  [](https://github.com/cheqd/did-provider-cheqd/blob/main/LICENSE)
[](https://github.com/cheqd/did-provider-cheqd/releases/)  [](https://github.com/cheqd/did-provider-cheqd/graphs/contributors)
[](https://github.com/cheqd/did-provider-cheqd/actions/workflows/dispatch.yml) [](https://github.com/cheqd/did-provider-cheqd/actions/workflows/codeql.yml) 
## âšī¸ Overview
The purpose of this [`@cheqd/did-provider-cheqd` NPM package](https://www.npmjs.com/package/@cheqd/did-provider-cheqd) is to enable developers to interact with the cheqd ledger using [Veramo SDK](https://veramo.io/), a modular and pluggable client app SDK for decentralised identity and SSI applications.
This package includes [Veramo SDK Agent methods](https://veramo.io/docs/veramo_agent/plugins) for use with the [Veramo CLI NPM package](https://www.npmjs.com/package/@veramo/cli). It can also be consumed as an NPM package outside Veramo CLI for building your own applications with NPM.
The package's core functionality is borrowed from [Veramo Core NPM package](https://www.npmjs.com/package/@veramo/core). and extends this to include cheqd ledger functionality, such as creating and managing DIDs.
### đ `did:cheqd`-specific functionality
`did-provider-cheqd` is the first Veramo SDK plug-in that utilises the *DID Manager Update* method to offer a full-body DIDDoc update for a DID on cheqd ledger, rather than individual field update transactions used more commonly in other DID methods such as [`did:ethr`](https://github.com/uport-project/ethr-did).
New DID creation can also be done by passing a full-body DIDoc payload in JSON, rather than having to assemble the document field-by-field.
## đ§âđģđ Quick Start
These quick start steps provide the *minimal* configuration that you need to set Veramo CLI for use with cheqd.
Check out our [**advanced CLI setup guide**](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd/setup) for further customisations and [**troubleshooting Veramo CLI setup**](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd/troubleshooting) in case you run into any issues.
### 1. Install Veramo CLI and clone this repo
This step is exactly [as described in Veramo CLI docs](https://veramo.io/docs/veramo_agent/cli_tool/):
```bash
npm install -g @veramo/cli@latest
git clone https://github.com/cheqd/did-provider-cheqd.git
npm install
```
### 2. Generate a new local database encryption key
By default, the `did-provider-cheqd` package has a default SQLite database password, but it's a good idea to modify and change this to a new key unique to your install.
```bash
$ veramo config gen-key
X25519 raw private key (hex encoded):
4a5aeb56c7956dd6f3312e7094130a03afc060b95621fa3a86577aaf2b67cc1d
You can use this key with @veramo/kms-local#SecretBox
or replace the default agent.yml 'dbEncryptionKey' constant
```
Take the key generated and replace the value under `dbEncryptionKey` in the [`agent.yml`](https://github.com/cheqd/did-provider-cheqd/blob/main/agent.yml) file.
### 3. Configure your cheqd/Cosmos account keys and RPC endpoints
Configure the following properties under the `didManager` section:
1. `cosmosPayerMnemonic`: [Mnemonic associated with your cheqd/Comsos SDK account](https://docs.cheqd.io/node/docs/cheqd-cli/cheqd-cli-key-management). This is only stored locally, and the mnemonic is used to reconstitute the account address and keys used to pay for the transaction.
2. `rpcUrl`: For both `did:cheqd:mainnet:` as well as `did:cheqd:testnet:` sections, you can specify a Cosmos SDK RPC endpoint. This endpoint is where transactions are sent to. By default, this is populated with `rpc.cheqd.net` (for *mainnet*) and `rpc.cheqd.network` (for *testnet*), but you can can modify this to [a different hosted RPC endpoint for cheqd](https://cosmos.directory/cheqd/nodes) or even your own local/private RPC endpoint.
3. `defaultProvider` (optional): The default cheqd network is set to `did:cheqd:testnet` to allow developers to test out network functionality. However, if you prefer, you can switch this out to `did:cheqd:mainnet` instead.
### 4. Verify your configuration file is correct
Once you've completed the steps above, verify that your Veramo configuration is accurate using the following command. If your configuration is correct, you should get a success message like the one below.
```bash
$ veramo config check -f agent.yml
Your Veramo configuration seems fine. An agent can be created and the 'agent.execute()' method can be called on it.
```
### 5. Environment setup
1. `LIT_PROTOCOL_DEBUG` - Set this to `true` to enable debug logging for the LIT protocol. By default it is set to `false`.
## đ Documentation
[Tutorials, advanced configuration, and architecture for cheqd's Veramo plugin](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd) can be found on our [Identity Docs site](https://docs.cheqd.io/identity/).
## đŦ Community
Our [**Discord server**](http://cheqd.link/discord-github) is the primary chat channel for our open-source community, software developers, and node operators.
Please reach out to us there for discussions, help, and feedback on the project.
## đ Find us elsewhere
[](https://t.me/cheqd) [](http://cheqd.link/discord-github) [](https://twitter.com/intent/follow?screen\_name=cheqd\_io) [](http://cheqd.link/linkedin) [](https://blog.cheqd.io) [](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)