Accueil Explorer Aide
Connexion
cesar
/
cdk
1
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki

Cashu Development Kit

Branche: minor-sqlite-improvement
Branches Tags
cdk
ZIP TAR.GZ
Cesar Rodas 919f4bade8 Minor improvement in the SQLite crate il y a 1 mois
.config e2041d3928 chore: flakebox install il y a 4 mois
.github c8f82b29d0 chore: remove bindings from cdk repo il y a 1 mois
.helix 9d65b603bc feat: mintd use mint builder il y a 2 mois
LICENSES 5f2fd0bbc5 chore: rename for CDK il y a 9 mois
crates 919f4bade8 Minor improvement in the SQLite crate il y a 1 mois
misc c8f82b29d0 chore: remove bindings from cdk repo il y a 1 mois
.envrc bf5ea01c1f improve: nix flakebox fmt il y a 1 an
.gitignore f3be8fe393 feat: remove precommit use in ci il y a 2 mois
.typos.toml 476ecd4eda fix typos check il y a 4 mois
CHANGELOG.md 357957d2ac chore: changelog il y a 2 mois
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE il y a 9 mois
Cargo.toml c8f82b29d0 chore: remove bindings from cdk repo il y a 1 mois
DEVELOPMENT.md 4c46d5c799 docs: add development doc il y a 2 mois
LICENSE 5f2fd0bbc5 chore: rename for CDK il y a 9 mois
README.md 39b2207ea6 docs: link dev in readme il y a 1 mois
SECURITY.md f0579071c1 release: v0.1.0 il y a 6 mois
flake.lock f3be8fe393 feat: remove precommit use in ci il y a 2 mois
flake.nix 4cefe875f1 feat: melt startup check into cdk il y a 2 mois
justfile 4c46d5c799 docs: add development doc il y a 2 mois
rust-toolchain.toml e95e95e3e2 build: add rust-toolchain.toml file il y a 2 mois
rustfmt.toml d46d4c5bd8 chore: rust fmt il y a 2 mois

README.md

Warning This project is in early development, it does however work with real sats! Always use amounts you don't mind losing.

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-phoenixd: Phoenixd Lightning backend for mint.
    • cdk-fake-wallet: Fake Lightning backend for mint. To be used only for testing, quotes are automatically filled.
  • 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 :construction:

Bindings

Experimental JS bindings can be found in the bindings repository.

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.