Cashu Development Kit

Cesar Rodas a3f8addb2f Remove macro il y a 2 mois
.config e2041d3928 chore: flakebox install il y a 7 mois
.github e5f2fb451f chore: msrv cashu workflow il y a 2 mois
.helix dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) il y a 3 mois
LICENSES 5f2fd0bbc5 chore: rename for CDK il y a 11 mois
crates a3f8addb2f Remove macro il y a 2 mois
misc 760564cee0 Introduce subscription support in the Wallet crate. il y a 3 mois
.envrc bf5ea01c1f improve: nix flakebox fmt il y a 1 an
.gitignore 80af715de7 Remove .DS_Store and ban it il y a 2 mois
.typos.toml 476ecd4eda fix typos check il y a 6 mois
CHANGELOG.md b4c11c6345 chore: RELEASE mintd v0.6.1 il y a 2 mois
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE il y a 11 mois
Cargo.lock 708b7c4c7b Merge remote-tracking branch 'origin/main' into feature/cdk-common il y a 2 mois
Cargo.toml 0e12314643 chore: Release 0.6.0 il y a 3 mois
DEVELOPMENT.md fec20b38e8 Update DEVELOPMENT.md-change discord to Matrx il y a 3 mois
Dockerfile dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) il y a 3 mois
LICENSE 5f2fd0bbc5 chore: rename for CDK il y a 11 mois
README.md 8ac766dd62 chore: update readme for mint sig il y a 2 mois
SECURITY.md f0579071c1 release: v0.1.0 il y a 9 mois
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) il y a 3 mois
flake.lock d7e84aea9a chore: update stable rust il y a 2 mois
flake.nix d7e84aea9a chore: update stable rust il y a 2 mois
justfile 4c46d5c799 docs: add development doc il y a 4 mois
rust-toolchain.toml d7e84aea9a chore: update stable rust il y a 2 mois
rustfmt.toml d46d4c5bd8 chore: rust fmt il y a 4 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.

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-strike: Strike Lightning backend for mint.
    • cdk-lnbits: LNbits Lightning backend for mint.
    • cdk-phoenixd: Phoenixd Lightning backend for mint.
    • cdk-fake-wallet: Fake Lightning backend for mint. To be used only for testing, quotes are automatically filled.
  • 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:

Bindings

Experimental JS bindings can be found in the bindings repository.

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.