Cashu Development Kit

thesimplekid 029f922326 feat: lnd ln backend 6 月之前
.config e2041d3928 chore: flakebox install 6 月之前
.github 029f922326 feat: lnd ln backend 6 月之前
.helix 04a463be1f feat(wallet): make wallet single mint and unit 8 月之前
LICENSES 5f2fd0bbc5 chore: rename for CDK 11 月之前
bindings da1acc4e6d feat: add mint_icon_url to mint details. (#282) 7 月之前
crates 029f922326 feat: lnd ln backend 6 月之前
misc e2041d3928 chore: flakebox install 6 月之前
.envrc bf5ea01c1f improve: nix flakebox fmt 1 年之前
.gitignore 6a315fc3b9 feat: mintd axum server 8 月之前
.rustfmt.toml e2041d3928 chore: flakebox install 6 月之前
.typos.toml 995a09f59d refactor: add token prefix tests 1 年之前
CHANGELOG.md 741370bc4b chore: update change log 6 月之前
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 11 月之前
Cargo.toml 029f922326 feat: lnd ln backend 6 月之前
LICENSE 5f2fd0bbc5 chore: rename for CDK 11 月之前
README.md 8ee5f62d62 fix(cdk-lnbits): Strike -> LNbits, LNBits -> LNbits 6 月之前
SECURITY.md f0579071c1 release: v0.1.0 8 月之前
flake.lock 95dbd18c9a chore: flake lock 6 月之前
flake.nix 029f922326 feat: lnd ln backend 6 月之前
justfile e2041d3928 chore: flakebox install 6 月之前
rustfmt.toml 029f922326 feat: lnd ln backend 6 月之前

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-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:

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.