wadeking98 / aries-framework-javascript

Aries Framework JavaScript (Built using TypeScript)

Credo

Quickstart  |  Features  |  Contributing  |  License

Credo is a framework written in TypeScript for building decentralized identity solutions that aims to be compliant and interoperable with identity standards across the world. Credo is agnostic to any specific exchange protocol, credential format, signature suite or did method, but currently mainly focuses on alignment with OpenID4VC, DIDComm and Hyperledger Aries.

Quickstart

Documentation on how to get started with Credo can be found at https://credo.js.org/

Features

See Supported Features on the Credo website for a full list of supported features.

• 🏃 Platform agnostic - out of the box support for Node.JS and React Native
• 🔒 DIDComm and AIP - Support for DIDComm v1, and both v1 and v2 of the Aries Interop Profile.
• 🛂 Extendable DID resolver and registrar - out of the box support for did:web, did:key, did:jwk, did:peer, did:sov, did:indy and did:cheqd.
• 🔑 OpenID4VC - support for OpenID for Verifiable Credential Issuance, OpenID for Verifiable Presentations and Self-Issued OpenID Provider v2.
• 🪪 Multiple credential formats - W3C Verifiable Credential Data Model v1.1, SD-JWT VCs, and AnonCreds.
• 🏢 Multi-tenant - Optional multi-tenant module for managing multiple tenants under a single agent.

Packages

Package	Version
@credo-ts/core
@credo-ts/node
@credo-ts/react-native
@credo-ts/indy-vdr
@credo-ts/cheqd
@credo-ts/askar
@credo-ts/anoncreds
@credo-ts/openid4vc
@credo-ts/action-menu
@credo-ts/question-answer
@credo-ts/tenants
@credo-ts/drpc
@aries-framework/indy-sdk (deprecated, unmaintained after 0.4.x)
@aries-framework/anoncreds-rs (deprecated and combined with @credo-ts/anoncreds)
@credo-ts/openid4vc-client (deprecated in favour of @credo-ts/openid4vc)

Demo

To get to know the Credo issuance and verification flow, we built a demo to walk through it yourself together with agents Alice and Faber.

• OpenID4VC and SD-JWT VC demo in the /demo-openid directory.
• DIDComm and AnonCreds demo in the /demo directory.

Contributing

If you would like to contribute to the framework, please read the Framework Developers README and the CONTRIBUTING guidelines. These documents will provide more information to get you started!

There are regular community working groups to discuss ongoing efforts within the framework, 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.

License

OpenWallet Foundation Credo is licensed under the Apache License Version 2.0 (Apache-2.0).