Cashu Development Kit

Cesar Rodas 77ead1b158 Remove cdk-database 2 kuukautta sitten
.config e2041d3928 chore: flakebox install 7 kuukautta sitten
.github 8fe0982c6d Introduce `cashu` to host the shared types, traits and other common code (#519) 2 kuukautta sitten
.helix dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 3 kuukautta sitten
LICENSES 5f2fd0bbc5 chore: rename for CDK 11 kuukautta sitten
crates 77ead1b158 Remove cdk-database 2 kuukautta sitten
misc 760564cee0 Introduce subscription support in the Wallet crate. 3 kuukautta sitten
.envrc bf5ea01c1f improve: nix flakebox fmt 1 vuosi sitten
.gitignore 8fe0982c6d Introduce `cashu` to host the shared types, traits and other common code (#519) 2 kuukautta sitten
.typos.toml 476ecd4eda fix typos check 6 kuukautta sitten
CHANGELOG.md b4c11c6345 chore: RELEASE mintd v0.6.1 2 kuukautta sitten
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 11 kuukautta sitten
Cargo.lock 77ead1b158 Remove cdk-database 2 kuukautta sitten
Cargo.toml 0e12314643 chore: Release 0.6.0 3 kuukautta sitten
DEVELOPMENT.md fec20b38e8 Update DEVELOPMENT.md-change discord to Matrx 3 kuukautta sitten
Dockerfile dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 3 kuukautta sitten
LICENSE 5f2fd0bbc5 chore: rename for CDK 11 kuukautta sitten
README.md 8ac766dd62 chore: update readme for mint sig 2 kuukautta sitten
SECURITY.md f0579071c1 release: v0.1.0 9 kuukautta sitten
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 3 kuukautta sitten
flake.lock d7e84aea9a chore: update stable rust 2 kuukautta sitten
flake.nix d7e84aea9a chore: update stable rust 2 kuukautta sitten
justfile 4c46d5c799 docs: add development doc 4 kuukautta sitten
rust-toolchain.toml d7e84aea9a chore: update stable rust 2 kuukautta sitten
rustfmt.toml d46d4c5bd8 chore: rust fmt 4 kuukautta 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.

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.