Cashu Development Kit

thesimplekid e76b53a637 feat: mprocs inter only regtest пре 3 месеци
.github f62992238a refactor: remove redb mint database пре 3 месеци
.helix 47ee54d7f5 feat: mint management rpc server and client cli пре 8 месеци
crates dc3214894f Merge pull request #873 from thesimplekid/remove_mint_quote_startup_check пре 3 месеци
misc e76b53a637 feat: mprocs inter only regtest пре 3 месеци
.envrc bf5ea01c1f improve: nix flakebox fmt пре 2 година
.gitignore be93ff2384 Clear and Blind Auth (#510) пре 6 месеци
.typos.toml be93ff2384 Clear and Blind Auth (#510) пре 6 месеци
CHANGELOG.md 4b82fa82a7 chore: release summary пре 3 месеци
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE пре 1 година
Cargo.toml 56ff5c3f19 chore: bump v0.11 пре 3 месеци
DEVELOPMENT.md 5df983c388 chore: fix typo in DEVELOPMENT.md (#720) пре 6 месеци
Dockerfile c7dfb43071 fix GLIBC compatibility issue пре 3 месеци
Dockerfile.arm c7dfb43071 fix GLIBC compatibility issue пре 3 месеци
LICENSE 5f2fd0bbc5 chore: rename for CDK пре 1 година
MPROCS_INTEGRATION.md 4028824b1a feat: mprocs regtest пре 3 месеци
MPROCS_MODES.md 4028824b1a feat: mprocs regtest пре 3 месеци
README.md 7251121d8e chore: update readme got bolt11 пре 4 месеци
REGTEST_QUICKSTART.md 4028824b1a feat: mprocs regtest пре 3 месеци
SECURITY.md f0579071c1 release: v0.1.0 пре 1 година
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) пре 10 месеци
flake.lock 4f4605df9e chore: update flake пре 3 месеци
flake.nix 4028824b1a feat: mprocs regtest пре 3 месеци
justfile e76b53a637 feat: mprocs inter only regtest пре 3 месеци
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 пре 5 месеци
rustfmt.toml d46d4c5bd8 chore: rust fmt пре 11 месеци

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-rexie: Rexie Storage backend for browsers.
    • 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.