thesimplekid
9beb0b4256
chore: update readmes (#773)
|
3 viikkoa sitten | |
|---|---|---|
| .config | 10 kuukautta sitten | |
| .github | 4 viikkoa sitten | |
| .helix | 4 kuukautta sitten | |
| LICENSES | 1 vuosi sitten | |
| crates | 3 viikkoa sitten | |
| misc | 4 viikkoa sitten | |
| .envrc | 1 vuosi sitten | |
| .gitignore | 3 kuukautta sitten | |
| .typos.toml | 3 kuukautta sitten | |
| CHANGELOG.md | 4 viikkoa sitten | |
| CODE_STYLE.md | 1 vuosi sitten | |
| Cargo.toml | 4 viikkoa sitten | |
| DEVELOPMENT.md | 2 kuukautta sitten | |
| Dockerfile | 6 kuukautta sitten | |
| Dockerfile.arm | 4 viikkoa sitten | |
| LICENSE | 1 vuosi sitten | |
| README.md | 3 viikkoa sitten | |
| SECURITY.md | 1 vuosi sitten | |
| docker-compose.yaml | 6 kuukautta sitten | |
| flake.lock | 4 viikkoa sitten | |
| flake.nix | 4 viikkoa sitten | |
| justfile | 4 viikkoa sitten | |
| rust-toolchain.toml | 2 kuukautta sitten | |
| rustfmt.toml | 7 kuukautta sitten |
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-lnbits: LNbits Lightning backend for mint.
- 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:
- cdk-cli: Cashu wallet CLI.
- cdk-mintd: Cashu Mint Binary.
- cdk-mint-cli: Cashu Mint management gRPC client cli.
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: |
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.