Cashu Development Kit

Cesar Rodas 066b147f8e Share the kv-store with the wallet and the mint 1 сар өмнө
.github c7f6af0749 fix: clippy warn (#1063) 1 сар өмнө
.helix 47ee54d7f5 feat: mint management rpc server and client cli 8 сар өмнө
crates 066b147f8e Share the kv-store with the wallet and the mint 3 долоо хоног өмнө
misc 75a3e6d2c7 Prometheus crate (#883) 1 сар өмнө
.envrc bf5ea01c1f improve: nix flakebox fmt 2 жил өмнө
.gitignore be93ff2384 Clear and Blind Auth (#510) 6 сар өмнө
.goosehints 735de32161 feat: sig all (#862) 2 сар өмнө
.typos.toml be93ff2384 Clear and Blind Auth (#510) 6 сар өмнө
CHANGELOG.md 5518ad2654 feat(cdk): add quote_id field to transactions for quote tracking (#1041) 1 сар өмнө
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE 1 жил өмнө
Cargo.toml 2c9333449a fix: replace std::time with instant for wasm (#1060) 1 сар өмнө
DEVELOPMENT.md 4b8c8b08da docs(DEVELOPMENT.md): clarify Nix usage and add alternative setup instructions 2 сар өмнө
Dockerfile 75a3e6d2c7 Prometheus crate (#883) 1 сар өмнө
Dockerfile.arm 4de5566451 feat: use trixie (#998) 1 сар өмнө
LICENSE 5f2fd0bbc5 chore: rename for CDK 1 жил өмнө
README.md 7246ea2e10 fix: bolt12 is nut25 (#1020) 1 сар өмнө
REGTEST_GUIDE.md a97eb84db6 chore: update docs 3 сар өмнө
SECURITY.md f0579071c1 release: v0.1.0 1 жил өмнө
docker-compose.postgres.yaml 28a01398fd Add PostgreSQL support for mint and wallet (#878) 1 сар өмнө
docker-compose.yaml 75a3e6d2c7 Prometheus crate (#883) 1 сар өмнө
flake.lock df8b78043e chore: update flake (#1018) 1 сар өмнө
flake.nix df8b78043e chore: update flake (#1018) 1 сар өмнө
justfile 21b4080810 FFI bindings for Wallet (#932) 1 сар өмнө
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 5 сар өмнө
rustfmt.toml d46d4c5bd8 chore: rust fmt 11 сар өмнө

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

LDK Node Network Configuration

For detailed configuration examples for running CDK with LDK Node on different Bitcoin networks (Mutinynet, Testnet, Mainnet), see LDK Node Network Guide.

Quick Start with Mutinynet (Recommended for Testing):

[ln]
ln_backend = "ldk-node"

[ldk_node]
bitcoin_network = "signet"
esplora_url = "https://mutinynet.com/api"
rgs_url = "https://rgs.mutinynet.com/snapshot/0"
gossip_source_type = "rgs"

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.