caa08d5eaa
Some checks failed
Architecture mdBook / build (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
Deny / audit (push) Has been cancelled
Doc / build (push) Has been cancelled
Doc / deploy (push) Has been cancelled
* add readme * readme, basic examples * name changes, bin impl * example, docs * book * add `cuprate-criterion-example` * docs, tracing * fix clippy * docs * lib readme * json-rpc benchmarks * add to crates.md * add `fixme` * fix `cargo b` failing this `cfg()` existing makes a regular workspace `cargo b` fail * fix cargo.toml |
||
|---|---|---|
| .github | ||
| benches | ||
| binaries | ||
| books | ||
| consensus | ||
| constants | ||
| cryptonight | ||
| helper | ||
| misc | ||
| net | ||
| p2p | ||
| pruning | ||
| rpc | ||
| storage | ||
| test-utils | ||
| types | ||
| zmq | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| clippy.toml | ||
| CONTRIBUTING.md | ||
| deny.toml | ||
| LICENSE | ||
| LICENSE-AGPL | ||
| LICENSE-MIT | ||
| README.md | ||
| SECURITY.md | ||
| typos.toml | ||
An alternative Monero node implementation.
(work-in-progress)
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.