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

Cashu Development Kit

Branch: nut-17-ws-subscription
Branches Tags
cdk
ZIP TAR.GZ
Cesar Rodas e8d301358c Merge remote-tracking branch 'origin/main' into nut-17-ws-subscription vor 2 Monaten
.config e2041d3928 chore: flakebox install vor 4 Monaten
.github 1fa10c6a02 chore: remove swagger msrv vor 2 Monaten
.helix 9d65b603bc feat: mintd use mint builder vor 2 Monaten
LICENSES 5f2fd0bbc5 chore: rename for CDK vor 9 Monaten
bindings 479b4e78e5 Merge pull request #398 from prusnak/mint-info-urls vor 2 Monaten
crates e8d301358c Merge remote-tracking branch 'origin/main' into nut-17-ws-subscription vor 2 Monaten
misc 187664439c refactor: mint into mods vor 3 Monaten
.envrc bf5ea01c1f improve: nix flakebox fmt vor 1 Jahr
.gitignore 6a315fc3b9 feat: mintd axum server vor 6 Monaten
.pre-commit-config.yaml 654e803bc4 chore: update flake vor 2 Monaten
.typos.toml 476ecd4eda fix typos check vor 4 Monaten
CHANGELOG.md aad50a251b chore: change log vor 2 Monaten
CODE_STYLE.md 4c2cb78327 chore: update CODE_STYLE vor 9 Monaten
Cargo.toml c25bf79e8c Cache `SwapResponse`, `MeltBolt11Response` and `MintBolt11Response` (#361) vor 3 Monaten
DEVELOPMENT.md 4c46d5c799 docs: add development doc vor 2 Monaten
LICENSE 5f2fd0bbc5 chore: rename for CDK vor 9 Monaten
README.md c62b0b7f11 docs: Update readme vor 2 Monaten
SECURITY.md f0579071c1 release: v0.1.0 vor 6 Monaten
flake.lock 3db25640dc feat: support custom unit vor 2 Monaten
flake.nix 5e26332a45 chore: define specfic rust version in flake vor 2 Monaten
justfile 4c46d5c799 docs: add development doc vor 2 Monaten
rust-toolchain.toml e95e95e3e2 build: add rust-toolchain.toml file vor 2 Monaten
rustfmt.toml 1eb14703a5 refactor: cdk MSRV vor 4 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.

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

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 bindings can be found in the bindings folder.

License

Code is under the MIT License

Contribution

All contributions 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.