mirror of
https://github.com/aljazceru/cdk.git
synced 2026-02-07 06:06:02 +01:00
3c4fce5c45
* feat: add keyset u32 mapping migration and duplicate handling - Add new database migration (version 3) to include u32 representation for keysets - Implement migration for both redb and SQL databases - Add duplicate detection and handling for keyset entries - Create unique index constraint for keyset_u32 column in SQL - Update keyset storage to include u32 identifiers - Handle backwards compatibility for existing databases * chore: clippy * refactor(cashu): simplify keyset ID verification logic - Consolidate match expression into a single expression - Use direct comparison with ensure_cdk macro - Improve readability of keyset ID validation * refactor(cdk): rename `fetch_keyset_keys` to `load_keyset_keys` for clarity - Renamed `fetch_keyset_keys` to `load_keyset_keys` across multiple modules to better reflect its behavior of loading keys from local storage or fetching from mint when missing. - Added debug logging to indicate when keys are being fetched from the mint. - Simplified key loading logic in `update_mint_keysets` by removing redundant existence checks. * chore: remove unused vec
Warning
This project is in early development, it does however work with real sats! Always use amounts you don't mind losing.
Cashu Development Kit
CDK is a collection of rust crates for Cashu wallets and mints written in Rust.
ALPHA This library is in early development, the api will change and should be used with caution.
Project structure
The project is split up into several crates in the crates/ directory:
- Libraries:
- cdk: Rust implementation of Cashu protocol.
- cdk-sqlite: SQLite Storage backend.
- cdk-redb: Redb Storage backend.
- cdk-axum: Axum webserver for mint.
- cdk-cln: CLN Lightning backend for mint.
- cdk-lnd: Lnd Lightning backend for mint.
- cdk-lnbits: LNbits Lightning backend for mint.
- cdk-fake-wallet: Fake Lightning backend for mint. To be used only for testing, quotes are automatically filled.
- cdk-mint-rpc: Mint management gRPC server and cli.
- Binaries:
- cdk-cli: Cashu wallet CLI.
- cdk-mintd: Cashu Mint Binary.
- cdk-mint-cli: Cashu Mint management gRPC client cli.
Development
For a guide to settings up a development environment see DEVELOPMENT.md
Implemented NUTs:
Mandatory
| NUT # | Description |
|---|---|
| 00 | Cryptography and Models |
| 01 | Mint public keys |
| 02 | Keysets and fees |
| 03 | Swapping tokens |
| 04 | Minting tokens |
| 05 | Melting tokens |
| 06 | Mint info |
Optional
| # | Description | Status |
|---|---|---|
| 07 | Token state check | ✔️ |
| 08 | Overpaid Lightning fees | ✔️ |
| 09 | Signature restore | ✔️ |
| 10 | Spending conditions | ✔️ |
| 11 | Pay-To-Pubkey (P2PK) | ✔️ |
| 12 | DLEQ proofs | ✔️ |
| 13 | Deterministic secrets | ✔️ |
| 14 | Hashed Timelock Contracts (HTLCs) | ✔️ |
| 15 | Partial multi-path payments (MPP) | ✔️ |
| 16 | Animated QR codes | ❌ |
| 17 | WebSocket subscriptions | ✔️ |
| 18 | Payment Requests | ✔️ |
| 19 | Cached responses | ✔️ |
| 20 | Signature on Mint Quote | ✔️ |
| 21 | Clear Authentication | ✔️ |
| 22 | Blind Authentication | ✔️ |
| 23 | Payment Method: BOLT11 | ✔️ |
License
Code is under the MIT License
Contribution
All contributions are welcome.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.
Please see the development guide.