* add workflow * fix errors * fix workflow * install dependencies * fix more errors * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: hinto-janai <hinto.janai@protonmail.com> * fix hack + enable it for cuprate-database * move hack to main CI * fix docs * fix ci formatting * fix txpool tests * fix CONTRIBUTING.md formatting * service -> tower::Service * review fixes * review fixes * fix CI --------- Co-authored-by: hinto-janai <hinto.janai@protonmail.com>
Contents
About
Cuprate is an effort to create an alternative Monero node implementation in Rust.
It will be able to independently validate Monero consensus rules, providing a layer of security and redundancy for the Monero network.
Documentation
Cuprate is currently a work-in-progress; documentation will be changing/unfinished.
Cuprate maintains various documentation books:
| Book | Description |
|---|---|
| Cuprate's architecture book | Documents Cuprate's internal architecture & implementation |
| Monero's protocol book | Documents the Monero protocol |
| Cuprate's user book | Practical user-guide for using cuprated |
For crate (library) documentation, see: https://doc.cuprate.org. This site holds documentation for Cuprate's crates and all dependencies. All Cuprate crates start with cuprate_, for example: cuprate_database.
Contributing
See CONTRIBUTING.md.
Security
Cuprate has a responsible vulnerability disclosure policy, see SECURITY.md.
License
The binaries/ directory is licensed under AGPL-3.0, everything else is licensed under MIT.
See LICENSE for more details.