Setup ACA-Py Agent
Set up your ACA-Py agent to start using cheqd.
Last updated
Was this helpful?
Set up your ACA-Py agent to start using cheqd.
Last updated
Was this helpful?
Before you begin, ensure you have a DID registrar and resolver running.
For testnet, you can use the (with cheqd driver) and a .
For mainnet, you must run your own cheqd DID registrar driver with the correct mnemonic configuration. Details are provided below.
To enable DID registration on Cheqd, you must deploy the Cheqd DID Registrar driver as a dedicated service. The fastest way to run the Cheqd Registrar driver is using the published docker image, for other options or to build your own container, check the .
Add the following under services
section of your docker-compose file.
Set the environment variables.
Run the driver.
The Cheqd Registrar must be run as driver-did-cheqd
because the Universal Registrar is configured with that name by default.
Add the following under services
section of your docker-compose file.
Start the Universal Registrar Service.
Confirm that the Cheqd Driver properties are correct and matches your settings.
To run your own DID Resolver, the following settings must be added to your docker-compose file
Add the following under services
section of your docker-compose file.
Run the resolver.
Cheqd ACA-Py Plugin supports configuring the Universal Registrar and DID Resolver URLs via a plugin-config.yml
file. These settings define how the agent interacts with the Cheqd network for DID operations.
plugin-config.yml
:Update the URLs if you have your hosted versions or using the Universal Resolver.
The Cheqd plugin only works with the askar-anoncreds
wallet type. Askar-anoncreds is the preferred wallet due to its support for AnonCreds and enhanced security features.
When starting ACA-Py, ensure that the wallet-type
is set to askar
. Example:
Using PostgreSQL as a wallet storage backend is recommended for scalability and data persistence.
Install PostgreSQL and create a database for ACA-Py.
Configure ACA-Py to use PostgreSQL, add the following to ./configs/settings.yml
:
Start ACA-Py with PostgreSQL-backed wallet storage.
Example Dockerfile:
Build the ACA-Py Agent docker image with the plugin.
Deploy the agent. Sample docker-compose is below.
Run the Agent.
Now that your ACA-Py agent is successfully set up to work with cheqd, try following our tutorials for creating a new DID or issuing Verifiable Credentials.
The Universal Registrar allows dynamic DID registration for multiple DID methods, including Cheqd. Setting it up ensures seamless DID creation without manual configurations for different DID methods. The fastest way to run the Universal Registrar is using the published docker container, for other options check the .
Where all the plugin settings are populated in ./configs/settings.yml
, a sample file is .
Create a DID
Create an Issuer DID using the did:cheqd DID method.
Issue a Verifiable Credential
Issue a Verifiable Credential using ACA-Py signed by a cheqd DID.