Cashu Development Kit

thesimplekid 4a0637a6a5 feat: itests select db 6 miesięcy temu
.config e2041d3928 chore: flakebox install 7 miesięcy temu
.github f9bb5eb913 feat: itests 6 miesięcy temu
.helix 04a463be1f feat(wallet): make wallet single mint and unit 9 miesięcy temu
LICENSES 5f2fd0bbc5 chore: rename for CDK 1 rok temu
bindings f9b9d30a11 feat: remove custom payment methods 7 miesięcy temu
crates 4a0637a6a5 feat: itests select db 6 miesięcy temu
misc 4a0637a6a5 feat: itests select db 6 miesięcy temu
.envrc bf5ea01c1f improve: nix flakebox fmt 1 rok temu
.gitignore 6a315fc3b9 feat: mintd axum server 9 miesięcy temu
.pre-commit-config.yaml 1eb14703a5 refactor: cdk MSRV 7 miesięcy temu
.typos.toml 476ecd4eda fix typos check 7 miesięcy temu
CHANGELOG.md cb0982e60d chore: changelog 7 miesięcy temu
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 rok temu
Cargo.toml 1eb14703a5 refactor: cdk MSRV 7 miesięcy temu
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 rok temu
README.md 1eb14703a5 refactor: cdk MSRV 7 miesięcy temu
SECURITY.md f0579071c1 release: v0.1.0 9 miesięcy temu
flake.lock 1eb14703a5 refactor: cdk MSRV 7 miesięcy temu
flake.nix f9bb5eb913 feat: itests 6 miesięcy temu
justfile f9bb5eb913 feat: itests 6 miesięcy temu
rustfmt.toml 1eb14703a5 refactor: cdk MSRV 7 miesięcy temu

README.md

Warning This project is in early development, it does however work with real sats! Always use amounts you don't mind loosing.

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-fake-wallet: Fake Lightning backend for mint. To be used only for testing, quotes are automatically filled.
  • Binaries:

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:

MSRV

Bindings

Experimental bindings can be found in the bindings folder.

License

Code is under the MIT License

Contribution

All contributions 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.