https://github.com/onflow/flow-wallet-kit
Flow Blockchain SDK for mobile
https://github.com/onflow/flow-wallet-kit
android cryptocurrency cryptowallet flow flow-blockchain ios wallet
Last synced: about 2 months ago
JSON representation
Flow Blockchain SDK for mobile
- Host: GitHub
- URL: https://github.com/onflow/flow-wallet-kit
- Owner: onflow
- License: mit
- Created: 2023-11-13T06:06:00.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-29T04:54:27.000Z (about 2 months ago)
- Last Synced: 2025-04-29T05:31:31.772Z (about 2 months ago)
- Topics: android, cryptocurrency, cryptowallet, flow, flow-blockchain, ios, wallet
- Language: Kotlin
- Homepage: https://flow-wallet-kit.vercel.app/docs
- Size: 3.74 MB
- Stars: 2
- Watchers: 9
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://deepwiki.com/onflow/Flow-Wallet-Kit)
# 🚀 Flow Wallet Kit
A cross-platform SDK for integrating **Flow blockchain wallet** functionality into iOS and Android applications. This SDK provides a **secure interface** for managing Flow accounts and handling transactions across networks.
---
## 🗺️ Roadmap
Here's what's been built and what's coming next:
### ✅ Done
- [x] 🔐 Create and store private key
- [x] 🔑 Support multiple private key types
- [x] 🌐 Handle Flow accounts across networks
- [x] 🧩 Manage COA (Cadence Owned Account)
- [x] 👶 Manage child accounts
### 🔜 To Do
- [ ] 💰 Token balance querying
- [ ] ☁️ All-type backup support (e.g. cloud)
- [ ] 🌐 WalletConnect integration
- [ ] 🔄 FCL (Flow Client Library) support
- [ ] ⛓️ Multi-chain support for other blockchains
---
## 📚 Documentation
Visit our comprehensive documentation at [flow-wallet-kit.vercel.app/docs](https://flow-wallet-kit.vercel.app/docs)
Or visit Deepwiki at [deepwiki.com/onflow/Flow-Wallet-Kit](https://deepwiki.com/onflow/Flow-Wallet-Kit)
Platform-specific guides are also available here:
- 📱 [iOS Documentation](iOS/README.md)
- 🤖 [Android Documentation](Android/README.md)
---
## 🔐 Hardware-Backed Key Security
We prioritize **secure private key handling** using platform-native secure hardware modules:
- 🧱 **Secure Enclave (iOS)**: Flow private keys can be securely generated and stored in the Secure Enclave using the `SecureElementProvider`.
- 🛡️ **Android Keystore (Android)**: Private keys are protected with hardware-backed Android Keystore using the `HardwareBackedStorage` implementation.
These solutions help prevent private key extraction and elevate the security standard for mobile Flow wallets.
---
## 🏗️ Architecture
Check out the full docs in here: [Architecture](./docs/architecture.md)
### 🧱 Core Components
- **Storage Protocol**: Secure data storage across platforms
- **Key Protocol**: Consistent key management
- **Crypto**: Secure encryption, derivation, hashing
- **Wallet**: Modular wallet handling
- **Account**: Multi-network and child account management
- **Security**: Hardware + software crypto implementations
- **Network**: Key Indexer API integration
---
## ✅ Features
### 🔐 Security & Storage
- **Secure Storage Protocol** (platform-agnostic)
- **iOS**:
- 🔑 `KeychainStorage`: Secure key storage via Keychain
- 📁 `FileSystemStorage`: Encrypted file-based storage
- **Android**:
- 🛡️ `HardwareBackedStorage`: Uses Android Keystore
- 📁 `FileSystemStorage`: Encrypted file-based storage
- 🧠 `InMemoryStorage`: Volatile, memory-only storage
- ✨ Common:
- Cacheable interfaces
- Encrypted storage
- Hardware-backed protection (when available)
- **Key Management Protocol**
- 🔐 `PrivateKeyProvider`: Supports ECDSA P-256 & secp256k1
- 🧱 `SecureElementProvider`: Secure Enclave / Keystore
- 🌱 `SeedPhraseProvider`: BIP-39 + HD Wallet
- **Backup**
- 🔒 Platform-specific basic secure backups
### 🔒 Cryptographic Operations
- **Encryption**
- AES-GCM & ChaCha20-Poly1305
- **Key Derivation**
- BIP-39 & HD Wallet support
- **Hashing**
- Secure data integrity functions
### 👛 Core Wallet Types
- **Watch Wallet**: Address-only
- **Key Wallet**: Private key or seed phrase + 🔍 Key Indexer API integration
### 👥 Account Management
- Multi-account, cross-network support
- Child account management
- 🔁 Flow-EVM account compatibility
---
## 🧪 Development Status
This SDK is **under active development**! 🛠️
We're focused on robust cross-platform key and account management. More features like balance queries and WalletConnect are on the way!
---
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## 💬 Support
Found a bug? Need help?
Please open an issue in the repo or contact the maintainers.