Cashu Development Kit

Cesar Rodas b8171ab09f Fixed bug with Default as described in https://github.com/cashubtc/cdk/pull/473#discussion_r1871032297 1 maand geleden
.config e2041d3928 chore: flakebox install 4 maanden geleden
.github c8f82b29d0 chore: remove bindings from cdk repo 1 maand geleden
.helix 9d65b603bc feat: mintd use mint builder 2 maanden geleden
LICENSES 5f2fd0bbc5 chore: rename for CDK 9 maanden geleden
crates b8171ab09f Fixed bug with Default as described in https://github.com/cashubtc/cdk/pull/473#discussion_r1871032297 1 maand geleden
misc 04d38ef4c0 Introduce subscription support in the Wallet crate. 1 maand geleden
.envrc bf5ea01c1f improve: nix flakebox fmt 1 jaar geleden
.gitignore a0dca228b9 nix mintd pkg (#486) 1 maand geleden
.typos.toml 476ecd4eda fix typos check 4 maanden geleden
CHANGELOG.md 5ad4328a4e chore: changelog 1 maand geleden
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 9 maanden geleden
Cargo.lock 04d38ef4c0 Introduce subscription support in the Wallet crate. 1 maand geleden
Cargo.toml a0dca228b9 nix mintd pkg (#486) 1 maand geleden
DEVELOPMENT.md 4c46d5c799 docs: add development doc 2 maanden geleden
Dockerfile d4975c7170 add docker support for cdk-mintd (#480) 1 maand geleden
LICENSE 5f2fd0bbc5 chore: rename for CDK 9 maanden geleden
README.md 39b2207ea6 docs: link dev in readme 1 maand geleden
SECURITY.md f0579071c1 release: v0.1.0 6 maanden geleden
flake.lock a0dca228b9 nix mintd pkg (#486) 1 maand geleden
flake.nix a0dca228b9 nix mintd pkg (#486) 1 maand geleden
justfile 4c46d5c799 docs: add development doc 2 maanden geleden
rust-toolchain.toml e95e95e3e2 build: add rust-toolchain.toml file 2 maanden geleden
rustfmt.toml d46d4c5bd8 chore: rust fmt 2 maanden geleden

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 :construction:

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.