Cashu Development Kit

vnprc 853f13fc85 fix(build): use OUT_DIR for migration files (#1088) 3 nedēļas atpakaļ
.github f4c5de7f36 fix: add free space to auth test (#1091) 3 nedēļas atpakaļ
.helix 47ee54d7f5 feat: mint management rpc server and client cli 8 mēneši atpakaļ
crates 853f13fc85 fix(build): use OUT_DIR for migration files (#1088) 3 nedēļas atpakaļ
misc 75a3e6d2c7 Prometheus crate (#883) 1 mēnesi atpakaļ
.envrc bf5ea01c1f improve: nix flakebox fmt 2 gadi atpakaļ
.gitignore be93ff2384 Clear and Blind Auth (#510) 6 mēneši atpakaļ
.goosehints 735de32161 feat: sig all (#862) 2 mēneši atpakaļ
.typos.toml be93ff2384 Clear and Blind Auth (#510) 6 mēneši atpakaļ
CHANGELOG.md 5518ad2654 feat(cdk): add quote_id field to transactions for quote tracking (#1041) 1 mēnesi atpakaļ
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 gadu atpakaļ
Cargo.toml 12164a0764 Fix Async FFI Constructors (#1085) 3 nedēļas atpakaļ
DEVELOPMENT.md 4b8c8b08da docs(DEVELOPMENT.md): clarify Nix usage and add alternative setup instructions 2 mēneši atpakaļ
Dockerfile 75a3e6d2c7 Prometheus crate (#883) 1 mēnesi atpakaļ
Dockerfile.arm 4de5566451 feat: use trixie (#998) 1 mēnesi atpakaļ
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 gadu atpakaļ
README.md c64797ac6f chore: some docs (#1083) 3 nedēļas atpakaļ
REGTEST_GUIDE.md a97eb84db6 chore: update docs 3 mēneši atpakaļ
SECURITY.md f0579071c1 release: v0.1.0 1 gadu atpakaļ
docker-compose.postgres.yaml 28a01398fd Add PostgreSQL support for mint and wallet (#878) 1 mēnesi atpakaļ
docker-compose.yaml 75a3e6d2c7 Prometheus crate (#883) 1 mēnesi atpakaļ
flake.lock df8b78043e chore: update flake (#1018) 1 mēnesi atpakaļ
flake.nix df8b78043e chore: update flake (#1018) 1 mēnesi atpakaļ
justfile 21b4080810 FFI bindings for Wallet (#932) 1 mēnesi atpakaļ
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 5 mēneši atpakaļ
rustfmt.toml d46d4c5bd8 chore: rust fmt 11 mēneši atpakaļ

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-postgres: PostgreSQL Storage backend.
    • cdk-redb: Redb Storage backend.
    • 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. Note: Only LNBits v1 API is supported.
    • cdk-ldk-node: LDK Node 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:
21 Clear Authentication :heavy_check_mark:
22 Blind Authentication :heavy_check_mark:
23 Payment Method: BOLT11 :heavy_check_mark:
25 Payment Method: BOLT12 :heavy_check_mark:

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.