aries-framework

Aries Framework JavaScript

Features  |  Getting started  |  Contributing  |  License

Aries Framework JavaScript is a framework written in TypeScript for building SSI Agents and DIDComm services that aims to be compliant and interoperable with the standards defined in the Aries RFCs.

Features

Some features are not yet supported, but are on our roadmap. Check the roadmap for more information.

• ✅ React Native
• ✅ Node.JS
• ✅ Issue Credential Protocol (RFC 0036)
• ✅ Present Proof Protocol (RFC 0037)
• ✅ Connection Protocol (RFC 0160)
• ✅ Basic Message Protocol (RFC 0095)
• ✅ Indy Credentials (with did:sov support)
• ✅ HTTP Transport
• ✅ Mediator Coordination Protocol (RFC 0211)
• 🚧 Revocation of Indy Credentials
• 🚧 Electron
• 🚧 WebSocket Transport
• ❌ Browser
• ❌ Connection-less Issuance and Verification
• ❌ Issue Credential V2, Present Proof V2, DID Exchange Protocol, Out-Of-Band
• ❌ W3C Linked Data VCs, BBS+ Signatures

Getting Started

Platform Specific Setup

In order to use Aries Framework JavaScript some platform specific dependencies and setup is required. See our guides below to quickly set up you project with Aries Framework JavaScript for NodeJS, React Native and Electron.

• React Native
• NodeJS
• Electron

Usage

Now that your project is setup and everything seems to be working, it is time to start building! Follow these guides below to get started!

1. Agent
2. Transports
3. Connections
4. Routing
5. Ledger
6. Credentials
7. Proofs
8. Logging

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!

License

Hyperledger Aries Framework JavaScript is licensed under the Apache License Version 2.0 (Apache-2.0).