Cashu Development Kit

Cesar Rodas 378c02ceb0 Update test пре 1 месец
.github 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
.helix 47ee54d7f5 feat: mint management rpc server and client cli пре 8 месеци
crates 378c02ceb0 Update test пре 2 недеља
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 bf6b672fdc chore: add tag to 0.13.0 пре 2 недеља
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE пре 1 година
Cargo.toml fb84343993 Bump v0.13 (#1106) пре 2 недеља
DEVELOPMENT.md 4b8c8b08da docs(DEVELOPMENT.md): clarify Nix usage and add alternative setup instructions пре 2 месеци
Dockerfile 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
Dockerfile.arm 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
Dockerfile.ldk-node 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
Dockerfile.ldk-node.arm 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
LICENSE 5f2fd0bbc5 chore: rename for CDK пре 1 година
README.md c64797ac6f chore: some docs (#1083) пре 3 недеља
REGTEST_GUIDE.md a97eb84db6 chore: update docs пре 3 месеци
SECURITY.md f0579071c1 release: v0.1.0 пре 1 година
docker-compose.ldk-node.yaml 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
docker-compose.postgres.yaml 28a01398fd Add PostgreSQL support for mint and wallet (#878) пре 1 месец
docker-compose.yaml 35a4be1429 feat(docker): add LDK Node mint service with dedicated Docker setup (#1108) пре 2 недеља
flake.lock df8b78043e chore: update flake (#1018) пре 1 месец
flake.nix df8b78043e chore: update flake (#1018) пре 1 месец
justfile 6ad2c3a67e chore: ffi to release пре 2 недеља
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

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.