Strona główna Odkrywaj Pomoc
Zaloguj się
cesar
/
cdk
1
0
Forkuj 0
Pliki Problemy 0 Oczekujące zmiany 0 Wiki

Cashu Development Kit

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

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.