Cashu Development Kit

thesimplekid 7b18e47ce5 Merge pull request #962 from thesimplekid/justfile_errors il y a 2 mois
.github 7b18e47ce5 Merge pull request #962 from thesimplekid/justfile_errors il y a 2 mois
.helix 47ee54d7f5 feat: mint management rpc server and client cli il y a 8 mois
crates 325afd75f7 fix: allow paid and issued bolt12 quotes to settle internally il y a 2 mois
misc 8c66114b27 chore: free disk space on ci il y a 2 mois
.envrc bf5ea01c1f improve: nix flakebox fmt il y a 2 ans
.gitignore be93ff2384 Clear and Blind Auth (#510) il y a 6 mois
.goosehints 735de32161 feat: sig all (#862) il y a 2 mois
.typos.toml be93ff2384 Clear and Blind Auth (#510) il y a 6 mois
CHANGELOG.md ec9108d69d feat: bump msrv from 1.75.0 to 1.85.0 il y a 2 mois
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE il y a 1 an
Cargo.toml ec9108d69d feat: bump msrv from 1.75.0 to 1.85.0 il y a 2 mois
DEVELOPMENT.md 4b8c8b08da docs(DEVELOPMENT.md): clarify Nix usage and add alternative setup instructions il y a 2 mois
Dockerfile c7dfb43071 fix GLIBC compatibility issue il y a 3 mois
Dockerfile.arm c7dfb43071 fix GLIBC compatibility issue il y a 3 mois
LICENSE 5f2fd0bbc5 chore: rename for CDK il y a 1 an
README.md 44ca7e48dc feat: remove rexie il y a 3 mois
REGTEST_GUIDE.md a97eb84db6 chore: update docs il y a 3 mois
SECURITY.md f0579071c1 release: v0.1.0 il y a 1 an
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) il y a 10 mois
flake.lock fef1cda009 refactor(flake): remove crane build system and simplify flake dependencies il y a 2 mois
flake.nix ec9108d69d feat: bump msrv from 1.75.0 to 1.85.0 il y a 2 mois
justfile 7b18e47ce5 Merge pull request #962 from thesimplekid/justfile_errors il y a 2 mois
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 il y a 5 mois
rustfmt.toml d46d4c5bd8 chore: rust fmt il y a 11 mois

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.