Cashu Development Kit

thesimplekid 66932b387d chore: changelog 1 год назад
.config e2041d3928 chore: flakebox install 1 год назад
.github 1eb14703a5 refactor: cdk MSRV 1 год назад
.helix 04a463be1f feat(wallet): make wallet single mint and unit 1 год назад
LICENSES 5f2fd0bbc5 chore: rename for CDK 1 год назад
bindings 1f81b24f40 feat: try_sum for amounts 1 год назад
crates 2497691c7e Update example.config.toml for fees 1 год назад
misc e065662328 chore: justfile doc check 1 год назад
.envrc bf5ea01c1f improve: nix flakebox fmt 2 лет назад
.gitignore 6a315fc3b9 feat: mintd axum server 1 год назад
.pre-commit-config.yaml 1eb14703a5 refactor: cdk MSRV 1 год назад
.typos.toml 476ecd4eda fix typos check 1 год назад
CHANGELOG.md 66932b387d chore: changelog 1 год назад
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 год назад
Cargo.toml 1eb14703a5 refactor: cdk MSRV 1 год назад
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 год назад
README.md 1eb14703a5 refactor: cdk MSRV 1 год назад
SECURITY.md f0579071c1 release: v0.1.0 1 год назад
flake.lock 1eb14703a5 refactor: cdk MSRV 1 год назад
flake.nix 54e67b5386 chore: pin tokio 1 год назад
justfile 1eb14703a5 refactor: cdk MSRV 1 год назад
rustfmt.toml 1eb14703a5 refactor: cdk MSRV 1 год назад

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.