Cashu Development Kit

thesimplekid 5db6eaa858 fix: default state sql 8 mesiacov pred
.config 3cec49ce0d fix: flake 11 mesiacov pred
.github 04a463be1f feat(wallet): make wallet single mint and unit 8 mesiacov pred
.helix 04a463be1f feat(wallet): make wallet single mint and unit 8 mesiacov pred
LICENSES 5f2fd0bbc5 chore: rename for CDK 11 mesiacov pred
bindings b528964fb6 chore: readmes 8 mesiacov pred
crates 5db6eaa858 fix: default state sql 8 mesiacov pred
misc 04a463be1f feat(wallet): make wallet single mint and unit 8 mesiacov pred
.envrc bf5ea01c1f improve: nix flakebox fmt 1 rok pred
.gitignore bfc737f2f5 feat(cli): balance 9 mesiacov pred
.typos.toml 995a09f59d refactor: add token prefix tests 1 rok pred
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 11 mesiacov pred
Cargo.toml e8c954921f chore: update deps 8 mesiacov pred
LICENSE 5f2fd0bbc5 chore: rename for CDK 11 mesiacov pred
README.md dec11e232a chore: update readme 8 mesiacov pred
flake.lock bbc63306db feat: mint sqlite 9 mesiacov pred
flake.nix a07364c5c6 feat(mint/sqlite): use sql migrations 9 mesiacov pred
justfile 02fd33225c Add `misc/scripts` 11 mesiacov pred
rustfmt.toml ce0b309b66 chore: add code style and rust fmt 11 mesiacov pred

README.md

Warning This project is in early development, it does however work with real sats! Always use amounts you don't mind loosing.

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
  • Binaries:

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 :heavy_check_mark:
08 Overpaid Lightning fees :heavy_check_mark:
09 Signature restore :heavy_check_mark:
10 Spending conditions :heavy_check_mark:
11 Pay-To-Pubkey (P2PK) :heavy_check_mark:
12 DLEQ proofs :heavy_check_mark:
13 Deterministic secrets :heavy_check_mark:
14 Hashed Timelock Contracts (HTLCs) :heavy_check_mark:
15 Partial multi-path payments (MPP) :heavy_check_mark:
16 Animated QR codes :x:
17 WebSocket subscriptions :construction:

Bindings

Experimental bindings can be found in the bindings folder.

License

Code is under the MIT License

Contribution

All contributions 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.