---

Veridian Wallet | Cardano Foundation

---

Overview

Veridian Wallet is an open source application developed by the Cardano Foundation. This project is the result of on-going research and development pertaining to the principles of Self-Sovereign Identity (SSI), Self-Certifying Identifiers (SCIs), Verifiable Data Registries (VDRs), and the standards, frameworks, and implementations available within the Cardano ecosystem and externally. The first release of the wallet provides an open source implementation demonstrating the Key Event Receipt Infrastructure (KERI) on Cardano. This wallet has undergone security auditing and penetration testing, and mitigations have been applied.

Check out our documentation to learn how to use the app, connect to infrastructure and start developing with KERI!

Features

• 📱 Android & iOS Support with native biometrics
• ☁️ High messaging availability with a KERIA cloud agent
• 🔐 Secure Enclave (SE) / Trusted Execution Environment (TEE) usage for seeds & secrets
• 🆔 KERI autonomic identifiers
  • Securely backed by a combination of KERI native witnesses and Cardano
  • Single-sig, group multi-sig
• 🎫 ACDC credentials exchanged using the IPEX protocol
• ⚡ Efficient over-the-wire communications using CESR encoding
• 🖥️ dApp integration using CIP-45

Future Developments

• Aries Askar compatible encryption-at-rest to replace SQLCipher
• Social and multi-device identifier recovery
• P2P Chat
• Delegated multi-sig for organisational identity
• Cardano-backed ACDC verifiable credential schemas

Standards & Protocols

• Key Event Receipt Infrastructure (KERI)
• Trust Over IP - Authentic Chained Data Container (ACDC)
• Composable Event Streaming Representation (CESR)

SSI Services

• KERIA Cloud Agent
• Signify-TS Edge Client
• Verifiable Credential Testing Tool
• KERI on Cardano

Network Architecture

Getting Started

Requirements

• Node.js: Version 20.
• npm: Compatible with the Node.js version.
• Xcode: For iOS emulation (latest version recommended).
• Android Studio: For Android emulation (latest version recommended).
• Capacitor: Version 7.0.0 (refer to package.json). For detailed environment setup, refer to the Capacitor Environment Setup Guide.
• Mobile Device: iOS or Android for running the app on physical devices.
• Docker, Docker Compose.

Ensure that your system meets these requirements to successfully use and develop the Identity Wallet application.

Cloning the Repository

git clone https://github.com/cardano-foundation/veridian-wallet.git
cd veridian-wallet
make init # This will configure the git hooks

Preparing the App

This project uses a specific node version (check the requirements section above). You can optionally use nvm to manage and switch between different Node.js versions on your computer.

Before running the App, ensure that all dependencies are installed and the app is built properly. In the project root directory, run the following commands:

npm install

Running in the Browser

The development server depends on a local KERIA and credential issuance server setup. The Docker Compose file can be used to quickly bring these services up.

docker-compose up -d --build
npm run dev

This command starts the development server and allows you to preview the application on your browser by opening this localhost address:

http://localhost:3003/

Running in an Emulator

You can discover how to run the application in an emulator by following this link.

End-to-End (E2E) Testing

You can gain additional insights into end-to-end testing by visiting the provided link.

Additional Tutorials

• Customizing Splash Screens and Icons

Contributing

All contributions are welcome! Please feel free to open a new thread on the issue tracker or submit a new pull request.

Please read Contributing in advance. Thank you for contributing!

Additional Documents

• Code of Conduct
• Security
• Changelog

Troubleshooting

If you encounter any issues or have questions, please drop us a message on our Discord channel. We are here to help!

👨‍💻 Join our Discord! 👩‍💻

Resources

KERI

• Key Event Receipt Infrastructure
• Resources
• KERIA
• Signify-TS
• Cardano Backer

Standards, Frameworks and Governance

• SSI Frameworks Overview
• Trust over IP
• Global Legal Entity Identifier Foundation (GLIEF)
• vLEI ISO Standardization

License

This project was previously licensed under MPL-2.0 up until commit 49f9811c363bb1c05a5349d4aa3434793a1b3a39. It is now licensed under Apache 2.0. Any prior versions remain available under MPL-2.0.

Please also found our open source attributions.