Startseite Erkunden Hilfe
Anmelden
cesar
/
cdk
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

Cashu Development Kit

Branch: feature/introduce-wallet-streams
Branches Tags
cdk
ZIP TAR.GZ
Cesar Rodas 373f361b70 Add wait.rs which is a good API for Bolt11 vor 1 Monat
.github 4e13c1958f feat: mintd db features vor 1 Monat
.helix 47ee54d7f5 feat: mint management rpc server and client cli vor 8 Monaten
crates 373f361b70 Add wait.rs which is a good API for Bolt11 vor 1 Monat
misc 761ed82554 feat: log to file (#967) vor 1 Monat
.envrc bf5ea01c1f improve: nix flakebox fmt vor 2 Jahren
.gitignore be93ff2384 Clear and Blind Auth (#510) vor 6 Monaten
.goosehints 735de32161 feat: sig all (#862) vor 2 Monaten
.typos.toml be93ff2384 Clear and Blind Auth (#510) vor 6 Monaten
CHANGELOG.md ec9108d69d feat: bump msrv from 1.75.0 to 1.85.0 vor 2 Monaten
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE vor 1 Jahr
Cargo.toml 761ed82554 feat: log to file (#967) vor 1 Monat
DEVELOPMENT.md 4b8c8b08da docs(DEVELOPMENT.md): clarify Nix usage and add alternative setup instructions vor 2 Monaten
Dockerfile c7dfb43071 fix GLIBC compatibility issue vor 3 Monaten
Dockerfile.arm c7dfb43071 fix GLIBC compatibility issue vor 3 Monaten
LICENSE 5f2fd0bbc5 chore: rename for CDK vor 1 Jahr
README.md 8dec41dd55 refactor(cdk-lnbits): migrate to LNbits v1 websocket API and remove w… (#987) vor 1 Monat
REGTEST_GUIDE.md a97eb84db6 chore: update docs vor 3 Monaten
SECURITY.md f0579071c1 release: v0.1.0 vor 1 Jahr
docker-compose.postgres.yaml 28a01398fd Add PostgreSQL support for mint and wallet (#878) vor 1 Monat
docker-compose.yaml 28a01398fd Add PostgreSQL support for mint and wallet (#878) vor 1 Monat
flake.lock fef1cda009 refactor(flake): remove crane build system and simplify flake dependencies vor 2 Monaten
flake.nix 8c425dee8c chore(flake): add NIX_PATH for flake vor 1 Monat
justfile 7b18e47ce5 Merge pull request #962 from thesimplekid/justfile_errors vor 2 Monaten
rust-toolchain.toml 06a3237977 chore: update stable rust to 1.86.0 vor 5 Monaten
rustfmt.toml d46d4c5bd8 chore: rust fmt vor 11 Monaten

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

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.