aa718e224f
Some checks failed
Audit / audit (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
* test-utils: add `crate::rpc::types` module * test-utils: conditional json doc-tests * json: add test data, fix macro doc tests * json: add all data * other: add all data * bin: add skeleton * docs * move type to correct file * rpc: `client/{client,constants}.rs` -> `client.rs` * lib.rs: remove `clippy::module_inception` |
||
---|---|---|
.github | ||
benches | ||
binaries | ||
books | ||
consensus | ||
cryptonight | ||
helper | ||
misc | ||
net | ||
p2p | ||
pruning | ||
rpc | ||
storage | ||
test-utils | ||
types | ||
zmq | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
CONTRIBUTING.md | ||
deny.toml | ||
LICENSE | ||
LICENSE-AGPL | ||
LICENSE-MIT | ||
README.md | ||
SECURITY.md | ||
typos.toml |
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.