Cashu Development Kit

Cesar Rodas 9272347641 Rename structs 1 ヶ月 前
.config e2041d3928 chore: flakebox install 4 ヶ月 前
.github c8f82b29d0 chore: remove bindings from cdk repo 1 ヶ月 前
.helix 9d65b603bc feat: mintd use mint builder 2 ヶ月 前
LICENSES 5f2fd0bbc5 chore: rename for CDK 9 ヶ月 前
crates 9272347641 Rename structs 1 ヶ月 前
misc 760564cee0 Introduce subscription support in the Wallet crate. 1 ヶ月 前
.envrc bf5ea01c1f improve: nix flakebox fmt 1 年間 前
.gitignore a0dca228b9 nix mintd pkg (#486) 1 ヶ月 前
.typos.toml 476ecd4eda fix typos check 4 ヶ月 前
CHANGELOG.md 9f0df32348 chore: readme 1 ヶ月 前
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 9 ヶ月 前
Cargo.lock 6ad03c0f22 Add ArcSwap to update Mint configuration at runtime 1 ヶ月 前
Cargo.toml a0dca228b9 nix mintd pkg (#486) 1 ヶ月 前
DEVELOPMENT.md fec20b38e8 Update DEVELOPMENT.md-change discord to Matrx 1 ヶ月 前
Dockerfile 9cb684e5db feat: docker-compose 1 ヶ月 前
LICENSE 5f2fd0bbc5 chore: rename for CDK 9 ヶ月 前
README.md 9f0df32348 chore: readme 1 ヶ月 前
SECURITY.md f0579071c1 release: v0.1.0 6 ヶ月 前
docker-compose.yaml 9cb684e5db feat: docker-compose 1 ヶ月 前
flake.lock a0dca228b9 nix mintd pkg (#486) 1 ヶ月 前
flake.nix a0dca228b9 nix mintd pkg (#486) 1 ヶ月 前
justfile 4c46d5c799 docs: add development doc 2 ヶ月 前
rust-toolchain.toml e95e95e3e2 build: add rust-toolchain.toml file 2 ヶ月 前
rustfmt.toml d46d4c5bd8 chore: rust fmt 2 ヶ月 前

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:

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.