Domů Procházet Nápověda
Přihlásit se
cesar
/
cdk
1
0
Rozštěpit 0
Soubory Úkoly 0 Pull Requesty 0 Wiki

Cashu Development Kit

Větev: minor-avoid-cloning
Větve Značky
cdk
ZIP TAR.GZ
Cesar Rodas 0aad2aacb9 Improve Http client před 1 měsícem
.config e2041d3928 chore: flakebox install před 4 měsíci
.github 4e7f55e5b0 docs: pull request template před 2 měsíci
.helix 9d65b603bc feat: mintd use mint builder před 2 měsíci
LICENSES 5f2fd0bbc5 chore: rename for CDK před 9 měsíci
bindings 479b4e78e5 Merge pull request #398 from prusnak/mint-info-urls před 2 měsíci
crates 0aad2aacb9 Improve Http client před 1 měsícem
misc 187664439c refactor: mint into mods před 3 měsíci
.envrc bf5ea01c1f improve: nix flakebox fmt před 1 rokem
.gitignore f3be8fe393 feat: remove precommit use in ci před 2 měsíci
.typos.toml 476ecd4eda fix typos check před 4 měsíci
CHANGELOG.md 23eadbe35b chore: changelog před 2 měsíci
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE před 9 měsíci
Cargo.toml c25bf79e8c Cache `SwapResponse`, `MeltBolt11Response` and `MintBolt11Response` (#361) před 3 měsíci
DEVELOPMENT.md 4c46d5c799 docs: add development doc před 2 měsíci
LICENSE 5f2fd0bbc5 chore: rename for CDK před 9 měsíci
README.md 23eadbe35b chore: changelog před 2 měsíci
SECURITY.md f0579071c1 release: v0.1.0 před 6 měsíci
flake.lock f3be8fe393 feat: remove precommit use in ci před 2 měsíci
flake.nix 2231a54911 chore: rust comps as extentions před 2 měsíci
justfile 4c46d5c799 docs: add development doc před 2 měsíci
rust-toolchain.toml e95e95e3e2 build: add rust-toolchain.toml file před 2 měsíci
rustfmt.toml d46d4c5bd8 chore: rust fmt před 2 měsíci

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:

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 bindings can be found in the bindings folder.

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.