Cuprate/cuprate
Cuprate/cuprate
1
0
Fork 0
mirror of https://github.com/Cuprate/cuprate.git synced 2024-12-22 11:39:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add skeleton

Browse source
This commit is contained in:
hinto.janai 2024-06-16 14:41:06 -04:00
parent 1bc05366b0
commit 150ace0b98
No known key found for this signature in database
GPG key ID: D47CE05FA175A499
115 changed files with 233 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
books/user/README.md
View file

@ -1,5 +1,5 @@
## Cuprate's user book
This book is the end-user documentation for Cuprate, aka, "how to use `cuprated`".
This book is the end-user documentation for Cuprate.
See:
- <https://user.cuprate.org>

19
books/user/book.toml
View file

@ -3,17 +3,10 @@ authors = ["hinto-janai"]
language = "en"
multilingual = false
src = "src"
title = "Cuprate's user book"
git-repository-url = "https://github.com/Cuprate/user-book"
title = "Cuprate User Book"
git-repository-url = "https://github.com/Cuprate/cuprate/books/user"
# TODO: fix after importing real files.
#
# [preprocessor.last-changed]
# command = "mdbook-last-changed"
# renderer = ["html"]
#
# [output.html]
# default-theme = "ayu"
# preferred-dark-theme = "ayu"
# git-repository-url = "https://github.com/hinto-janai/cuprate-user"
# additional-css = ["last-changed.css"]
[output.html]
default-theme = "ayu"
preferred-dark-theme = "ayu"
no-section-label = true

105
books/user/src/SUMMARY.md
View file

@ -1,3 +1,106 @@
# Summary
- [TODO](todo.md)
[Introduction](introduction.md)
- [Getting started](getting-started/intro.md)
- [System requirements](getting-started/sys-req.md)
- [Pre-built binaries](getting-started/pre-build.md)
- [Building from source](getting-started/source.md)
- [Verifying](getting-started/verify.md)
- [Running](getting-started/run.md)
- [Configuration](config.md)
- [File structure](file-structure.md)
- [Ports](ports/intro.md)
- [P2P](ports/p2p.md)
- [ZMQ](ports/zmq.md)
- [RPC](ports/rpc.md)
- [Command line](cli/intro.md)
- [Runtime input](cli/runtime.md)
- [CLI arguments](cli/args.md)
- [Deployment](deploy/intro.md)
- [Docker](deploy/docker.md)
- [systemd](deploy/systemd.md)
- [Anonymity networks](anon-net/intro.md)
- [SOCKS proxy](anon-net/socks.md)
- [Tor](anon-net/tor.md)
- [Instrumentation](instrumentation/intro.md)
- [Console logs](instrumentation/console-logs.md)
- [File logs](instrumentation/file-logs.md)
- [RPC](rpc/intro.md)
- [`monerod` & `cuprated`](rpc/comparison.md)
- [JSON objects](rpc/objects/intro.md)
- [Block](rpc/objects/block.md)
- [BlockHeader](rpc/objects/block_header.md)
- [Histogram](rpc/objects/histogram.md)
- [Chain](rpc/objects/chain.md)
- [Connection](rpc/objects/connection.md)
- [JSON-RPC 2.0](rpc/json-rpc/intro.md)
- [get_block_count](rpc/json-rpc/get_block_count.md)
- [on_get_block_hash](rpc/json-rpc/on_get_block_hash.md)
- [get_block_template](rpc/json-rpc/get_block_template.md)
- [submit_block](rpc/json-rpc/submit_block.md)
- [generateblocks](rpc/json-rpc/generateblocks.md)
- [get_last_block_header](rpc/json-rpc/get_last_block_header.md)
- [get_block_header_by_hash](rpc/json-rpc/get_block_header_by_hash.md)
- [get_block_header_by_height](rpc/json-rpc/get_block_header_by_height.md)
- [get_block_headers_range](rpc/json-rpc/get_block_headers_range.md)
- [get_block](rpc/json-rpc/get_block.md)
- [get_connections](rpc/json-rpc/get_connections.md)
- [get_info](rpc/json-rpc/get_info.md)
- [hard_fork_info](rpc/json-rpc/hard_fork_info.md)
- [set_bans](rpc/json-rpc/set_bans.md)
- [get_bans](rpc/json-rpc/get_bans.md)
- [banned](rpc/json-rpc/banned.md)
- [flush_txpool](rpc/json-rpc/flush_txpool.md)
- [get_output_histogram](rpc/json-rpc/get_output_histogram.md)
- [get_version](rpc/json-rpc/get_version.md)
- [get_coinbase_tx_sum](rpc/json-rpc/get_coinbase_tx_sum.md)
- [get_fee_estimate](rpc/json-rpc/get_fee_estimate.md)
- [get_alternate_chains](rpc/json-rpc/get_alternate_chains.md)
- [relay_tx](rpc/json-rpc/relay_tx.md)
- [sync_info](rpc/json-rpc/sync_info.md)
- [get_txpool_backlog](rpc/json-rpc/get_txpool_backlog.md)
- [get_output_distribution](rpc/json-rpc/get_output_distribution.md)
- [get_miner_data](rpc/json-rpc/get_miner_data.md)
- [prune_blockchain](rpc/json-rpc/prune_blockchain.md)
- [calc_pow](rpc/json-rpc/calc_pow.md)
- [flush_cache](rpc/json-rpc/flush_cache.md)
- [add_aux_pow](rpc/json-rpc/add_aux_pow.md)
- [Binary endpoints](rpc/bin/intro.md)
- [/get_blocks.bin](rpc/bin/get_blocks.md)
- [/get_blocks_by_height.bin](rpc/bin/get_blocks_by_height.md)
- [/get_hashes.bin](rpc/bin/get_hashes.md)
- [/get_o_indexes.bin](rpc/bin/get_o_indexes.md)
- [/get_outs.bin](rpc/bin/get_outs.md)
- [/get_transaction_pool_hashes.bin](rpc/bin/get_transaction_pool_hashes.md)
- [JSON endpoints](rpc/json/intro.md)
- [/get_height](rpc/json/get_height.md)
- [/get_transactions](rpc/json/get_transactions.md)
- [/get_alt_blocks_hashes](rpc/json/get_alt_blocks_hashes.md)
- [/is_key_image_spent](rpc/json/is_key_image_spent.md)
- [/send_raw_transaction](rpc/json/send_raw_transaction.md)
- [/save_bc](rpc/json/save_bc.md)
- [/get_peer_list](rpc/json/get_peer_list.md)
- [/set_log_level](rpc/json/set_log_level.md)
- [/set_log_categories](rpc/json/set_log_categories.md)
- [/set_bootstrap_daemon](rpc/json/set_bootstrap_daemon.md)
- [/get_transaction_pool](rpc/json/get_transaction_pool.md)
- [/get_transaction_pool_stats](rpc/json/get_transaction_pool_stats.md)
- [/stop_daemon](rpc/json/stop_daemon.md)
- [/get_limit](rpc/json/get_limit.md)
- [/set_limit](rpc/json/set_limit.md)
- [/out_peers](rpc/json/out_peers.md)
- [/in_peers](rpc/json/in_peers.md)
- [/get_net_stats](rpc/json/get_net_stats.md)
- [/get_outs](rpc/json/get_outs.md)
- [/update](rpc/json/update.md)
- [/pop_blocks](rpc/json/pop_blocks.md)
- [Unsupported](rpc/unsupported/intro.md)
- [/start_mining](rpc/unsupported/start_mining.md)
- [/stop_mining](rpc/unsupported/stop_mining.md)
- [/mining_status](rpc/unsupported/mining_status.md)
- [/set_log_hash_rate](rpc/unsupported/set_log_hash_rate.md)
- [/get_info](rpc/unsupported/get_info.md)
- [/start_save_graph](rpc/unsupported/start_save_graph.md)
- [/stop_save_graph](rpc/unsupported/stop_save_graph.md)
- [Appendix](appendix/intro.md)

1
books/user/src/anon-net/intro.md Normal file
View file

@ -0,0 +1 @@
# Anonymity networks

1
books/user/src/anon-net/socks.md Normal file
View file

@ -0,0 +1 @@
# SOCKS proxy

1
books/user/src/anon-net/tor.md Normal file
View file

@ -0,0 +1 @@
# Tor

1
books/user/src/appendix/devs.md Normal file
View file

@ -0,0 +1 @@
# Developers

1
books/user/src/appendix/intro.md Normal file
View file

@ -0,0 +1 @@
# Appendix

1
books/user/src/cli/args.md Normal file
View file

@ -0,0 +1 @@
# CLI arguments

1
books/user/src/cli/intro.md Normal file
View file

@ -0,0 +1 @@
# Command line

1
books/user/src/cli/runtime.md Normal file
View file

@ -0,0 +1 @@
# Runtime input

1
books/user/src/config.md Normal file
View file

@ -0,0 +1 @@
# Configuration

1
books/user/src/deploy/docker.md Normal file
View file

@ -0,0 +1 @@
# Docker

1
books/user/src/deploy/intro.md Normal file
View file

@ -0,0 +1 @@
# Deployment

1
books/user/src/deploy/systemd.md Normal file
View file

@ -0,0 +1 @@
# systemd

1
books/user/src/file-structure.md Normal file
View file

@ -0,0 +1 @@
# File structure

1
books/user/src/getting-started/intro.md Normal file
View file

@ -0,0 +1 @@
# Getting started

1
books/user/src/getting-started/pre-build.md Normal file
View file

@ -0,0 +1 @@
# Pre-built binaries

1
books/user/src/getting-started/run.md Normal file
View file

@ -0,0 +1 @@
# Running

1
books/user/src/getting-started/source.md Normal file
View file

@ -0,0 +1 @@
# Building from source

1
books/user/src/getting-started/sys-req.md Normal file
View file

@ -0,0 +1 @@
# System requirements

1
books/user/src/getting-started/verify.md Normal file
View file

@ -0,0 +1 @@
# Verifying

1
books/user/src/gs/intro.md Normal file
View file

@ -0,0 +1 @@
# Getting started

1
books/user/src/gs/pre-build.md Normal file
View file

@ -0,0 +1 @@
# Pre-built binaries}

1
books/user/src/gs/run.md Normal file
View file

@ -0,0 +1 @@
# Running

1
books/user/src/gs/source.md Normal file
View file

@ -0,0 +1 @@
# Building from source

1
books/user/src/gs/sys-req.md Normal file
View file

@ -0,0 +1 @@
# System requirements

1
books/user/src/gs/verify.md Normal file
View file

@ -0,0 +1 @@
# Verifying

1
books/user/src/images/CuprateLogo.svg Symbolic link
View file

@ -0,0 +1 @@
../../../../misc/logo/CuprateLogo.svg

1
books/user/src/instrumentation/console-logs.md Normal file
View file

@ -0,0 +1 @@
# Console logs

1
books/user/src/instrumentation/file-logs.md Normal file
View file

@ -0,0 +1 @@
# File logs

1
books/user/src/instrumentation/intro.md Normal file
View file

@ -0,0 +1 @@
# Instrumentation

12
books/user/src/introduction.md Normal file
View file

@ -0,0 +1,12 @@
<div align="center">
<img src="images/CuprateLogo.svg" width="50%"/>
[![Matrix](https://img.shields.io/badge/Matrix-Cuprate-white?logo=matrix&labelColor=grey&logoColor=white)](https://matrix.to/#/#cuprate:monero.social)
Cuprate is an alternative [Monero](https://getmonero.org) node implementation that independently validates consensus rules, providing a layer of security and redundancy for the network. It is focused on being fast, user-friendly, and backwards compatible with [`monerod`](https://github.com/monero-project/monero).
This project is currently a work-in-progress; documentation will be changing/unfinished and the `cuprated` node itself is not yet production ready.
Feel free to join our Matrix channel or read our [documentation](https://github.com/Cuprate/cuprate?tab=readme-ov-file#documentation) to learn more.
</div>

1
books/user/src/ports/intro.md Normal file
View file

@ -0,0 +1 @@
# Ports

1
books/user/src/ports/p2p.md Normal file
View file

@ -0,0 +1 @@
# P2P

1
books/user/src/ports/rpc.md Normal file
View file

@ -0,0 +1 @@
# RPC

1
books/user/src/ports/zmq.md Normal file
View file

@ -0,0 +1 @@
# ZMQ

1
books/user/src/rpc/bin/get_blocks.md Normal file
View file

@ -0,0 +1 @@
# /get_blocks.bin

1
books/user/src/rpc/bin/get_blocks_by_height.md Normal file
View file

@ -0,0 +1 @@
# /get_blocks_by_height.bin

1
books/user/src/rpc/bin/get_hashes.md Normal file
View file

@ -0,0 +1 @@
# /get_hashes.bin

1
books/user/src/rpc/bin/get_o_indexes.md Normal file
View file

@ -0,0 +1 @@
# /get_o_indexes.bin

1
books/user/src/rpc/bin/get_outs.md Normal file
View file

@ -0,0 +1 @@
# /get_outs.bin

1
books/user/src/rpc/bin/get_transaction_pool_hashes.md Normal file
View file

@ -0,0 +1 @@
# /get_transaction_pool_hashes.bin

1
books/user/src/rpc/bin/intro.md Normal file
View file

@ -0,0 +1 @@
# Binary endpoints

1
books/user/src/rpc/comparison.md Normal file
View file

@ -0,0 +1 @@
# monerod & cuprated

1
books/user/src/rpc/intro.md Normal file
View file

@ -0,0 +1 @@
# RPC

1
books/user/src/rpc/json-rpc/add_aux_pow.md Normal file
View file

@ -0,0 +1 @@
# add_aux_pow

1
books/user/src/rpc/json-rpc/banned.md Normal file
View file

@ -0,0 +1 @@
# banned

1
books/user/src/rpc/json-rpc/calc_pow.md Normal file
View file

@ -0,0 +1 @@
# calc_pow

1
books/user/src/rpc/json-rpc/flush_cache.md Normal file
View file

@ -0,0 +1 @@
# flush_cache

1
books/user/src/rpc/json-rpc/flush_txpool.md Normal file
View file

@ -0,0 +1 @@
# flush_txpool

1
books/user/src/rpc/json-rpc/generateblocks.md Normal file
View file

@ -0,0 +1 @@
# generateblocks

1
books/user/src/rpc/json-rpc/get_alternate_chains.md Normal file
View file

@ -0,0 +1 @@
# get_alternate_chains

1
books/user/src/rpc/json-rpc/get_bans.md Normal file
View file

@ -0,0 +1 @@
# get_bans

1
books/user/src/rpc/json-rpc/get_block.md Normal file
View file

@ -0,0 +1 @@
# get_block

1
books/user/src/rpc/json-rpc/get_block_count.md Normal file
View file

@ -0,0 +1 @@
# get_block_count

1
books/user/src/rpc/json-rpc/get_block_header_by_hash.md Normal file
View file

@ -0,0 +1 @@
# get_block_header_by_hash

1
books/user/src/rpc/json-rpc/get_block_header_by_height.md Normal file
View file

@ -0,0 +1 @@
# get_block_header_by_height

1
books/user/src/rpc/json-rpc/get_block_headers_range.md Normal file
View file

@ -0,0 +1 @@
# get_block_headers_range

1
books/user/src/rpc/json-rpc/get_block_template.md Normal file
View file

@ -0,0 +1 @@
# get_block_template

1
books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md Normal file
View file

@ -0,0 +1 @@
# get_coinbase_tx_sum

1
books/user/src/rpc/json-rpc/get_connections.md Normal file
View file

@ -0,0 +1 @@
# get_connections

1
books/user/src/rpc/json-rpc/get_fee_estimate.md Normal file
View file

@ -0,0 +1 @@
# get_fee_estimate

1
books/user/src/rpc/json-rpc/get_info.md Normal file
View file

@ -0,0 +1 @@
# get_info

1
books/user/src/rpc/json-rpc/get_last_block_header.md Normal file
View file

@ -0,0 +1 @@
# get_last_block_header

1
books/user/src/rpc/json-rpc/get_miner_data.md Normal file
View file

@ -0,0 +1 @@
# get_miner_data

1
books/user/src/rpc/json-rpc/get_output_distribution.md Normal file
View file

@ -0,0 +1 @@
# get_output_distribution

1
books/user/src/rpc/json-rpc/get_output_histogram.md Normal file
View file

@ -0,0 +1 @@
# get_output_histogram

1
books/user/src/rpc/json-rpc/get_txpool_backlog.md Normal file
View file

@ -0,0 +1 @@
# get_txpool_backlog

1
books/user/src/rpc/json-rpc/get_version.md Normal file
View file

@ -0,0 +1 @@
# get_version

1
books/user/src/rpc/json-rpc/hard_fork_info.md Normal file
View file

@ -0,0 +1 @@
# hard_fork_info

1
books/user/src/rpc/json-rpc/intro.md Normal file
View file

@ -0,0 +1 @@
# JSON-RPC 2.0

1
books/user/src/rpc/json-rpc/on_get_block_hash.md Normal file
View file

@ -0,0 +1 @@
# on_get_block_hash

1
books/user/src/rpc/json-rpc/prune_blockchain.md Normal file
View file

@ -0,0 +1 @@
# prune_blockchain

1
books/user/src/rpc/json-rpc/relay_tx.md Normal file
View file

@ -0,0 +1 @@
# relay_tx

1
books/user/src/rpc/json-rpc/set_bans.md Normal file
View file

@ -0,0 +1 @@
# set_bans

1
books/user/src/rpc/json-rpc/submit_block.md Normal file
View file

@ -0,0 +1 @@
# submit_block

1
books/user/src/rpc/json-rpc/sync_info.md Normal file
View file

@ -0,0 +1 @@
# sync_info

1
books/user/src/rpc/json/get_alt_blocks_hashes.md Normal file
View file

@ -0,0 +1 @@
# /get_alt_blocks_hashes

1
books/user/src/rpc/json/get_height.md Normal file
View file

@ -0,0 +1 @@
# /get_height

1
books/user/src/rpc/json/get_limit.md Normal file
View file

@ -0,0 +1 @@
# /get_limit

1
books/user/src/rpc/json/get_net_stats.md Normal file
View file

@ -0,0 +1 @@
# /get_net_stats

1
books/user/src/rpc/json/get_outs.md Normal file
View file

@ -0,0 +1 @@
# /get_outs

1
books/user/src/rpc/json/get_peer_list.md Normal file
View file

@ -0,0 +1 @@
# /get_peer_list

1
books/user/src/rpc/json/get_transaction_pool.md Normal file
View file

@ -0,0 +1 @@
# /get_transaction_pool

1
books/user/src/rpc/json/get_transaction_pool_stats.md Normal file
View file

@ -0,0 +1 @@
# /get_transaction_pool_stats

1
books/user/src/rpc/json/get_transactions.md Normal file
View file

@ -0,0 +1 @@
# /get_transactions

1
books/user/src/rpc/json/in_peers.md Normal file
View file

@ -0,0 +1 @@
# /in_peers

1
books/user/src/rpc/json/intro.md Normal file
View file

@ -0,0 +1 @@
# JSON endpoints

1
books/user/src/rpc/json/is_key_image_spent.md Normal file
View file

@ -0,0 +1 @@
# /is_key_image_spent

1
books/user/src/rpc/json/out_peers.md Normal file
View file

@ -0,0 +1 @@
# /out_peers

1
books/user/src/rpc/json/pop_blocks.md Normal file
View file

@ -0,0 +1 @@
# /pop_blocks

1
books/user/src/rpc/json/save_bc.md Normal file
View file

@ -0,0 +1 @@
# /save_bc

1
books/user/src/rpc/json/send_raw_transaction.md Normal file
View file

@ -0,0 +1 @@
# /send_raw_transaction

1
books/user/src/rpc/json/set_bootstrap_daemon.md Normal file
View file

@ -0,0 +1 @@
# /set_bootstrap_daemon

1
books/user/src/rpc/json/set_limit.md Normal file
View file

@ -0,0 +1 @@
# /set_limit

1
books/user/src/rpc/json/set_log_categories.md Normal file
View file

@ -0,0 +1 @@
# /set_log_categories

1
books/user/src/rpc/json/set_log_level.md Normal file
View file

@ -0,0 +1 @@
# /set_log_level

1
books/user/src/rpc/json/stop_daemon.md Normal file
View file

@ -0,0 +1 @@
# /stop_daemon

1
books/user/src/rpc/json/update.md Normal file
View file

@ -0,0 +1 @@
# /update

Some files were not shown because too many files have changed in this diff Show more