10 KiB
Cardano Foundation | Identity Wallet
Disclaimer
Overview
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
- Direct-mode, witness-backed, Cardano-backed
- Single-sig, multi-sig
- 🎫 ACDC credentials exchanged using the IPEX protocol
- ⚡ Efficient over-the-wine communications using CESR encoding
- 🖥️ dApp integration using CIP-45
Future Developments
- Encryption at rest with local backup & restore (Compatible with Hyperledger Aries Askar)
- 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
Preview in your Browser
Disclaimer: This preview version is not intended to be used for any purposes other than previewing the application.
To experience the mobile application within the browser, please select one of the following links below, depending on whether you are accessing the preview version on your desktop or mobile device.
🔗 Preview the latest version of the Identity Wallet on your browser 🔗
Architecture
User Flows
In this section, you'll find detailed PDF documents outlining the various user flows within our application. These user flows serve as comprehensive guides, illustrating the application's user journeys step-by-step. Please feel free to explore and gain insight into the following user flows:
Getting Started
Requirements
- Node.js: Version 18.16.0.
- npm: Compatible with the Node.js version.
- Xcode: For iOS emulation (latest version recommended).
- Android Studio: For Android emulation (latest version recommended).
- Capacitor: Version 4.8.1 (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/cf-identity-wallet.git
cd cf-identity-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:
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.
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!