thesimplekid
9f0df32348
chore: readme
|
3 luni în urmă | |
|---|---|---|
| .config | 6 luni în urmă | |
| .github | 3 luni în urmă | |
| .helix | 4 luni în urmă | |
| LICENSES | 11 luni în urmă | |
| crates | 3 luni în urmă | |
| misc | 3 luni în urmă | |
| .envrc | 1 an în urmă | |
| .gitignore | 3 luni în urmă | |
| .typos.toml | 6 luni în urmă | |
| CHANGELOG.md | 3 luni în urmă | |
| CODE_STYLE.md | 11 luni în urmă | |
| Cargo.lock | 3 luni în urmă | |
| Cargo.toml | 3 luni în urmă | |
| DEVELOPMENT.md | 4 luni în urmă | |
| Dockerfile | 3 luni în urmă | |
| LICENSE | 11 luni în urmă | |
| README.md | 3 luni în urmă | |
| SECURITY.md | 8 luni în urmă | |
| docker-compose.yaml | 3 luni în urmă | |
| flake.lock | 3 luni în urmă | |
| flake.nix | 3 luni în urmă | |
| justfile | 4 luni în urmă | |
| rust-toolchain.toml | 4 luni în urmă | |
| rustfmt.toml | 4 luni în urmă |
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 | :heavy_check_mark: |
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.