Cashu Development Kit

thesimplekid 4b82fa82a7 chore: release summary 1 mēnesi atpakaļ
.github f62992238a refactor: remove redb mint database 1 mēnesi atpakaļ
.helix 47ee54d7f5 feat: mint management rpc server and client cli 6 mēneši atpakaļ
crates b4728d7257 feat: refund multi sig 1 mēnesi atpakaļ
misc 238b09d56a Split the database trait into read and transactions. (#826) 1 mēnesi atpakaļ
.envrc bf5ea01c1f improve: nix flakebox fmt 1 gadu atpakaļ
.gitignore be93ff2384 Clear and Blind Auth (#510) 4 mēneši atpakaļ
.typos.toml be93ff2384 Clear and Blind Auth (#510) 4 mēneši atpakaļ
CHANGELOG.md 4b82fa82a7 chore: release summary 1 mēnesi atpakaļ
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 gadu atpakaļ
Cargo.toml 56ff5c3f19 chore: bump v0.11 1 mēnesi atpakaļ
DEVELOPMENT.md 5df983c388 chore: fix typo in DEVELOPMENT.md (#720) 3 mēneši atpakaļ
Dockerfile dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 7 mēneši atpakaļ
Dockerfile.arm 19da3ac268 adding docker build workflow for arm64 images (#770) 2 mēneši atpakaļ
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 gadu atpakaļ
README.md 7251121d8e chore: update readme got bolt11 2 mēneši atpakaļ
SECURITY.md f0579071c1 release: v0.1.0 1 gadu atpakaļ
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 7 mēneši atpakaļ
flake.lock 4f4605df9e chore: update flake 1 mēnesi atpakaļ
flake.nix b7591d5750 fix: msrv of mintd pest 1 mēnesi atpakaļ
justfile 34d8ab763b fix: name of blinded_message col in blind_signature 1 mēnesi atpakaļ
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 3 mēneši atpakaļ
rustfmt.toml d46d4c5bd8 chore: rust fmt 8 mēneši atpakaļ

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.