Cashu Development Kit

Cesar Rodas 1e0055e740 Use RwLock to update cache support on the fly 11 kuukautta sitten
.github 4997af879a refactor(ci): move flake check from CI to separate daily workflow 11 kuukautta sitten
.helix 47ee54d7f5 feat: mint management rpc server and client cli 1 vuosi sitten
crates 1e0055e740 Use RwLock to update cache support on the fly 11 kuukautta sitten
misc 7ee0fe0385 feat(misc): add Goose AI recipes for automated changelog and git message generation 11 kuukautta sitten
.envrc bf5ea01c1f improve: nix flakebox fmt 2 vuotta sitten
.gitignore be93ff2384 Clear and Blind Auth (#510) 1 vuosi sitten
.goosehints 735de32161 feat: sig all (#862) 11 kuukautta sitten
.typos.toml be93ff2384 Clear and Blind Auth (#510) 1 vuosi sitten
CHANGELOG.md 9df904648e fix(cashu): preserve original case for custom CurrencyUnit values 11 kuukautta sitten
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 2 vuotta sitten
Cargo.toml ae6c107809 feat: bolt12 11 kuukautta sitten
DEVELOPMENT.md a97eb84db6 chore: update docs 1 vuosi sitten
Dockerfile c7dfb43071 fix GLIBC compatibility issue 1 vuosi sitten
Dockerfile.arm c7dfb43071 fix GLIBC compatibility issue 1 vuosi sitten
LICENSE 5f2fd0bbc5 chore: rename for CDK 2 vuotta sitten
README.md 44ca7e48dc feat: remove rexie 1 vuosi sitten
REGTEST_GUIDE.md a97eb84db6 chore: update docs 1 vuosi sitten
SECURITY.md f0579071c1 release: v0.1.0 2 vuotta sitten
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 1 vuosi sitten
flake.lock fef1cda009 refactor(flake): remove crane build system and simplify flake dependencies 11 kuukautta sitten
flake.nix fef1cda009 refactor(flake): remove crane build system and simplify flake dependencies 11 kuukautta sitten
justfile 7ee0fe0385 feat(misc): add Goose AI recipes for automated changelog and git message generation 11 kuukautta sitten
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 1 vuosi sitten
rustfmt.toml d46d4c5bd8 chore: rust fmt 1 vuosi sitten

README.md

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

crates.io Documentation

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:

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 :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 :heavy_check_mark:
18 Payment Requests :heavy_check_mark:
19 Cached responses :heavy_check_mark:
20 Signature on Mint Quote :heavy_check_mark:
21 Clear Authentication :heavy_check_mark:
22 Blind Authentication :heavy_check_mark:
23 Payment Method: BOLT11 :heavy_check_mark:

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.