Startseite Erkunden Hilfe
Anmelden
cesar
/
cdk
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

Cashu Development Kit

Struktur: c63fc02a5a
Branches Tags
cdk
ZIP TAR.GZ
thesimplekid c63fc02a5a Prepare v0.8.0 (#672) vor 4 Wochen
.config e2041d3928 chore: flakebox install vor 7 Monaten
.github c63fc02a5a Prepare v0.8.0 (#672) vor 4 Wochen
.helix 47ee54d7f5 feat: mint management rpc server and client cli vor 2 Monaten
LICENSES 5f2fd0bbc5 chore: rename for CDK vor 1 Jahr
crates c63fc02a5a Prepare v0.8.0 (#672) vor 4 Wochen
misc be93ff2384 Clear and Blind Auth (#510) vor 1 Monat
.envrc bf5ea01c1f improve: nix flakebox fmt vor 1 Jahr
.gitignore be93ff2384 Clear and Blind Auth (#510) vor 1 Monat
.typos.toml be93ff2384 Clear and Blind Auth (#510) vor 1 Monat
CHANGELOG.md e3570c3e98 Wallet dleq (#667) vor 1 Monat
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE vor 1 Jahr
Cargo.toml c63fc02a5a Prepare v0.8.0 (#672) vor 4 Wochen
DEVELOPMENT.md 27520506c0 Fix link in DEVELOPMENT.md vor 2 Monaten
Dockerfile dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) vor 4 Monaten
LICENSE 5f2fd0bbc5 chore: rename for CDK vor 1 Jahr
README.md f5be0ceeb6 chore: remove phd vor 1 Monat
SECURITY.md f0579071c1 release: v0.1.0 vor 9 Monaten
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) vor 4 Monaten
flake.lock 4c4bde0fe4 chore: update flake vor 1 Monat
flake.nix be93ff2384 Clear and Blind Auth (#510) vor 1 Monat
justfile c63fc02a5a Prepare v0.8.0 (#672) vor 4 Wochen
rust-toolchain.toml d7e84aea9a chore: update stable rust vor 3 Monaten
rustfmt.toml d46d4c5bd8 chore: rust fmt vor 5 Monaten

README.md

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

crates.io Documentation

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-lnbits: LNbits Lightning backend for mint.
    • cdk-fake-wallet: Fake Lightning backend for mint. To be used only for testing, quotes are automatically filled.
    • cdk-mint-rpc: Mint management gRPC server and cli.
  • 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.