Packages | Contributing | License
Credo Extensions hosts libraries built on top of Credo, including ledger-based DID integrations.
If you're just getting started the Credo repo is probably the place to start.
| Package | Description |
|---|---|
| @credo-ts/indy-vdr | Indy DID registration/resolution, ledger pools, endorsement and AnonCreds registry |
| @credo-ts/hedera | Hedera DID registration/resolution and optional AnonCreds registry |
| @credo-ts/cheqd | Cheqd DID registration/resolution, DID-linked resources and optional AnonCreds registry |
The ledger packages include their complete test suites and optional AnonCreds entry points. They are maintained and released from this repository against the Credo versions listed in pnpm-workspace.yaml.
- Push notifications is now part of DIDComm Mediator Credo, available as
@credo-ts/didcomm-push-notifications. - React hooks is now part of Bifold Wallet, available as
@bifold/react-hooks. - BLE transport (
@credo-ts/transport-ble) has moved to Credo DIDComm Extensions. @credo-ts/redux-storehas been removed from this repository.@credo-ts/resthas been removed from this repository, along with its Docker image deployment workflow.
If you would like to contribute to this repository, please read the CONTRIBUTING guidelines. These documents will provide more information to get you started!
The monorepo uses Node.js 22+, pnpm, Biome, tsdown, Vitest, and Changesets, aligned with Credo-ts main. Run pnpm install, pnpm validate, pnpm build, and pnpm test to validate changes.
Credo development dependencies are pinned to the same published alpha in pnpm-workspace.yaml.
Use catalog: for those dependencies rather than workspace:*, sibling-repository paths or moving dist-tags.
Published Credo packages should use compatible semver ranges for peer dependencies and keep matching catalog:
development dependencies for tests. Update the pins together and verify compatibility with the shared tests before
adopting another alpha.
Runtime dependencies belong in each package's manifest; root development dependencies support the shared tests only.
Shared utilities in tests/helpers.ts provide unit-test agent contexts, Node KMS backends
and typed mock helpers using public package exports. tests/agent.ts provides full-agent
options with a unique, in-memory Askar store per call. Call agent.initialize() before use and always
await agent.shutdown() during cleanup. These helpers intentionally do not mirror Credo's internal test-helper
signatures or pull in its Drizzle and DIDComm test infrastructure.
Run pnpm test:unit for offline tests and pnpm test:e2e for *.e2e.test.ts suites.
Shared helper tests are discovered alongside package tests. CI runs unit and E2E suites separately;
both jobs require tests to be discovered.
Ledger packages keep their test ledgers in separate Docker Compose files. Start the Indy pool before running the E2E tests:
docker compose up -d --build --wait --wait-timeout 600
pnpm test:e2e
docker compose downOn Apple Silicon, use docker compose -f docker-compose.yml -f docker-compose.arm.yml in place of
docker compose for both startup and shutdown. The pool exposes ports 9701–9708 and its health check waits
for the transaction author agreement and test endorser/trustee identities to be seeded.
GENESIS_TXN_PATH can point to an alternative genesis file, but that ledger must have the same test identities
and transaction author agreement configured. The cheqd E2E tests also need the cheqd ledger from
packages/cheqd/docker-compose.yml; see the
cheqd README. Test seeds and the in-memory wallet key are test-only fixtures.
No sibling checkout of Credo is needed for development or CI.
There are regular community working groups to discuss ongoing efforts within Credo, showcase items you've built with Credo, or ask questions. See Meeting Information for up to date information on the meeting schedule. Everyone is welcome to join!
We welcome you to join our mailing list and Discord channel. See the Wiki for up to date information.
Credo is licensed under the Apache License Version 2.0 (Apache-2.0).
