> For the complete documentation index, see [llms.txt](https://docs.cheqd.io/product/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cheqd.io/product/sdk/credo/set-up-agent.md).
# Setup Credo Agent
Setup your Credo Agent to get started.
This guide walks you through the setup process for a **Credo Agent** with support for **cheqd DIDs** and **AnonCreds**.
## Prerequisites
Before you begin, make sure you have the following:
* **Node.js** v16 or v18
* **Yarn** or **npm** installed
* A working **Node.js** or **React Native** project
* Follow the Getting Started guide if you're new to Credo
## Installing Cheqd
To enable cheqd in your agent, install the required package:
```bash
yarn add @credo-ts/cheqd
# or
npm install @credo-ts/cheqd
```
This package provides everything needed to register, resolve, and interact with `did:cheqd` identifiers and AnonCreds objects.
### React Native Support
If you're using **React Native**, additional steps are needed to support `cosmjs`:
#### 1. Use `cosmjs-rn` packages
Update your `package.json` using **npm overrides** or **Yarn resolutions**:
**Example (NPM `overrides`):**
```json
{
"overrides": {
"@cosmjs/amino": "npm:@cosmjs-rn/amino@^0.27.1",
"@cosmjs/encoding": "npm:@cosmjs-rn/encoding@^0.27.1",
"@cosmjs/math": "npm:@cosmjs-rn/math@^0.27.1",
"@cosmjs/stargate": "npm:@cosmjs-rn/stargate@^0.27.1",
"@cosmjs/tendermint-rpc": "npm:@cosmjs-rn/tendermint-rpc@^0.27.1",
"@cosmjs/utils": "npm:@cosmjs-rn/utils@^0.27.1",
"@cosmjs/proto-signing": "npm:@cosmjs-rn/proto-signing@^0.27.1",
"@cosmjs/crypto": "npm:@cosmjs-rn/crypto@^0.27.1"
}
}
```
**Example (Yarn `resolutions`):**
```json
{
"resolutions": {
"@cosmjs/amino": "npm:@cosmjs-rn/amino@^0.27.1",
"@cosmjs/encoding": "npm:@cosmjs-rn/encoding@^0.27.1",
"@cosmjs/math": "npm:@cosmjs-rn/math@^0.27.1",
"@cosmjs/stargate": "npm:@cosmjs-rn/stargate@^0.27.1",
"@cosmjs/tendermint-rpc": "npm:@cosmjs-rn/tendermint-rpc@^0.27.1",
"@cosmjs/utils": "npm:@cosmjs-rn/utils@^0.27.1",
"@cosmjs/proto-signing": "npm:@cosmjs-rn/proto-signing@^0.27.1",
"@cosmjs/crypto": "npm:@cosmjs-rn/crypto@^0.27.1"
}
}
```
#### 2. Add Buffer Polyfill
Install the `buffer` package:
```bash
bashCopyEdityarn add buffer
```
Create a `shim.js` file:
```ts
tsCopyEditimport { Buffer } from 'buffer'
global.Buffer = Buffer
```
Then, import this shim in your entry point (e.g. before your `App.tsx` is rendered):
```ts
tsCopyEditimport './shim'
```
### Adding cheqd to the Agent[](https://credo.js.org/guides/getting-started/set-up/cheqd#adding-the-cheqd-to-the-agent)
After installing the dependencies, we can register the cheqd module on the agent by adding the below code snippet to the agent constructor.
```typescript
import { Agent, DidsModule, KeyType, DidDocument } from '@credo-ts/core'
import { agentDependencies } from '@credo-ts/node'
import { AskarModule } from '@credo-ts/askar'
import { askar } from '@openwallet-foundation/askar-nodejs'
import {
ConnectionsModule,
V2ProofProtocol,
V2CredentialProtocol,
ProofsModule,
AutoAcceptProof,
AutoAcceptCredential,
CredentialsModule,
HttpOutboundTransport,
getDefaultDidcommModules,
} from '@credo-ts/didcomm'
import {
CheqdAnonCredsRegistry,
CheqdDidRegistrar,
CheqdDidResolver,
CheqdModule,
CheqdModuleConfig,
} from '@credo-ts/cheqd'
import { AnonCredsModule } from '@credo-ts/anoncreds'
import { anoncreds } from '@hyperledger/anoncreds-nodejs'
const agent = new Agent({
config,
dependencies: agentDependencies,
modules: {
dids: new DidsModule({
registrars: [new CheqdDidRegistrar()],
resolvers: [new CheqdDidResolver()],
}),
// AnonCreds
anoncreds: new AnonCredsModule({
registries: [new CheqdAnonCredsRegistry()],
anoncreds,
}),
// Add cheqd module
cheqd: new CheqdModule(
new CheqdModuleConfig({
networks: [
{
network: '',
cosmosPayerSeed: '',
},
],
})
),
// Indy VDR can optionally be used with Askar as wallet and storage implementation
askar: new AskarModule({
askar,
}),
connections: new ConnectionsModule({
autoAcceptConnections: true,
}),
credentials: new CredentialsModule({
autoAcceptCredentials: AutoAcceptCredential.ContentApproved,
credentialProtocols: [
new V2CredentialProtocol({
credentialFormats: [new LegacyIndyCredentialFormatService(), new AnonCredsCredentialFormatService()],
}),
],
}),
},
})
```
The `cosmosPayerSeed` can be a 32-bit seed value or mnemonic. You can manage the account in a Cosmos wallet such as Keplr: see [Setup Keplr Wallet](/product/network/wallets/keplr-setup.md).
{% hint style="info" %}
**Fund the account behind `cosmosPayerSeed` on testnet.** A new address does not exist on chain until it holds CHEQ. Request testnet CHEQ for its `cheqd1…` address from the [Testnet Faucet](/product/network/tools/testnet-faucet.md) in cheqd Studio, which funds any cheqd testnet address.
{% endhint %}
## Next steps
Now that your Credo agent is successfully set up to work with cheqd, try following our tutorials for creating a new DID or issuing Verifiable Credentials.
Create a DID
Create an Issuer DID with the did:cheqd DID method using Credo.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.cheqd.io/product/sdk/credo/set-up-agent.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.