Home Esplora Aiuto
Accedi
cesar
/
cdk
1
0
Forka 0
File Problemi 0 Pull Requests 0 Wiki

Cashu Development Kit

Albero (Tree): cd71cd47d9
Rami (Branch) Tag
cdk
ZIP TAR.GZ
thesimplekid cd71cd47d9 Merge pull request #669 from ok300/ok300-simplify-fee-reserve 1 mese fa
.config e2041d3928 chore: flakebox install 7 mesi fa
.github 9170fbe86c ci: Make all jobs depend on pre-commit-checks passing 1 mese fa
.helix 47ee54d7f5 feat: mint management rpc server and client cli 2 mesi fa
LICENSES 5f2fd0bbc5 chore: rename for CDK 1 anno fa
crates 13475be580 Simplify fee calculation 1 mese fa
misc 162507c492 feat: payment processor 1 mese fa
.envrc bf5ea01c1f improve: nix flakebox fmt 1 anno fa
.gitignore 827e4aebde Refactor mintd used in itest (#616) 1 mese fa
.typos.toml 476ecd4eda fix typos check 7 mesi fa
CHANGELOG.md e3570c3e98 Wallet dleq (#667) 1 mese fa
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 anno fa
Cargo.toml 162507c492 feat: payment processor 1 mese fa
DEVELOPMENT.md 27520506c0 Fix link in DEVELOPMENT.md 2 mesi fa
Dockerfile dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 4 mesi fa
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 anno fa
README.md f5be0ceeb6 chore: remove phd 1 mese fa
SECURITY.md f0579071c1 release: v0.1.0 9 mesi fa
docker-compose.yaml dcca57dbd1 Introduce pluggable backend cache for the HTTP layer. (#495) 4 mesi fa
flake.lock 4c4bde0fe4 chore: update flake 1 mese fa
flake.nix 619a89060c chore: msrv of half 1 mese fa
justfile 162507c492 feat: payment processor 1 mese fa
rust-toolchain.toml d7e84aea9a chore: update stable rust 3 mesi fa
rustfmt.toml d46d4c5bd8 chore: rust fmt 5 mesi fa

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.