If you're looking to use the Veramo CLI with cheqd or develop a proof-of-concept application, use the official Veramo CLI setup guide.

Step 1: Install requisite packages

1.1. Install Veramo CLI

This step is exactly :

Note: Depending on your system permissions, you might be prompted for additional permissions. Add sudo to the beginning of the command in case that happens.

Verify the installation was correct. Command below should output latest version of Veramo you installed.

1.2. Install the did-provider-cheqd package

Install the did-provider-cheqd NPM package in a similar fashion:

You can check all of your NPM package versions by running the command:

Step 2: Modify the cheqd plugin Agent configuration file

2.1. Get the agent.yml configuration file

Download the file that contains the configuration for cheqd network to be used with Veramo CLI.

You can do this in terminal through:

Note: Alternatively, you can also fetch this by the repository.

2.2. Open the agent.yml file in an editor to customise the config

You can open the agent.yml in a text editor/IDE of your choice to edit a few mandatory settings.

In terminal, you can edit the agent.yml file using an editor like nano:

Make sure you provide the actual relative/absolute path to the file.

2.3. 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.

Take the key generated and replace the value under dbEncryptionKey in the agent.yml file.

2.4. Set your DID Resolver endpoint

In order to be able to read/query did:cheqd entries from the ledger, you need to configure a REST API endpoint for a instance.

The default value is set to resolver.cheqd.net, which is an instance of the cheqd DID Resolver hosted by the cheqd team. This DID Resolver instance can handle requests for did:cheqd:mainnet as well as did:cheqd:testnet namespaces.

If you want, you can replace the url property with a different REST API endpoint for a different instance of the cheqd DID Resolver.

Alternative/Optional: Use Universal Resolver instead

Note: This configuration is an advanced step and not recommended for most users. Skip it and continue to the next step in most cases, unless you know why you want to switch the resolver interface.

If you plan on interacting with multiple DID methods using Veramo CLI, you can alternatively query did:cheqd using instead. This allows your CLI configuration to handle .

Firstly, comment out the custom did-cheqd-resolver entry and uncomment the universal-resolver entry. This tells Veramo CLI to use the Universal Resolver interface for did:cheqd.

Also comment out this section for the did-cheqd-resolver:

Finally, uncomment and configure the universal-resolver interface:

2.5. Add cheqd Testnet to your Leap wallet

In order to add cheqd Testnet to your Leap extension, please follow the following tutorial:

2.6. Configure your cheqd/Cosmos account keys and RPC endpoints

While reading/querying from the cheqd ledger incurs no cost, if you want to to cheqd ledger, you need to pay transaction fees for the ledger writes.

You need to configure this in under didManager section as shown above, where you'll need to edit:

1. cosmosPayerMnemonic: . 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

2.7. Save the agent.yml file and exit

Make sure all your edits above are persisted and saved to a file that you can access.

Step 3: Verify your configuration file is correct

Once you've completed Step 2 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.

If the config check throws an error, check out our to see common errors and fixes.

Next steps

Now that your Veramo CLI installation is successfully set up to work with cheqd, try following our tutorials for:

This guide provides common errors and potential fixes for them if you encountered errors when setting up Veramo CLI.

Common errors when setting up Veramo CLI

1. Cannot find module @cheqd/did-provider-cheqd

This error typically happens when the version of did-provider-cheqd is incompatible with the version of Veramo CLI being used.

This can happen if you didn't use the npm -g ("global") flag when installing the packages, and have a conflicting package version for any of the required packages in the folder where you executed this command from.

To verify if this is the case, check the version number of globally-installed NPM packages. Your list may be shorter or longer than this list, but pay close attention to the @cheqd/did-provider-cheqd and @veramo/cli versions.

Compare and contrast this from the output from the same folder where the command failed without the --global / -g flag:

In this example above, you'll see that the version of the @veramo/cli package is not the same one as the global one. This could equally happen with the @cheqd/did-provider-cheqd version.

Doing a global install for both packages will ensure that you've got the correct packages, regardless of which folder the agent.yml file is kept in.

2. Invalid word count in mnemonic

This error is thrown if the cosmosPayerMnemonic value is set to an incorrect number of words (it should either be 12 or 24 words), or if it's left to the default value of 'your cosmos payer mnemonic'.

Note: You can use the same mnemonic for both mainnet and testnet, since the same account address has separate balances on different networks.

Heads-up: Even if you're trying it on testnet you still need to put cosmosPayerMnemonic for your mainnet (You can use the same cosmosPayerMnemonic). Otherwise, you will still be getting the same error as above when you run veramo config check -f agent.yml.

3. Running wget -c https://raw.githubusercontent.com/cheqd/did-provider-cheqd/main/agent.yml command is giving you errors

• First, create agent.yml file at root directory level.

• Second, , copy everything from there and paste it in your agent.yml file. And you're good to go. 😉