From 150ace0b98a42e835beb47f056c97ee4c6a11c18 Mon Sep 17 00:00:00 2001 From: "hinto.janai" Date: Sun, 16 Jun 2024 14:41:06 -0400 Subject: [PATCH] add skeleton --- books/user/README.md | 2 +- books/user/book.toml | 19 +--- books/user/src/SUMMARY.md | 105 +++++++++++++++++- books/user/src/anon-net/intro.md | 1 + books/user/src/anon-net/socks.md | 1 + books/user/src/anon-net/tor.md | 1 + books/user/src/appendix/devs.md | 1 + books/user/src/appendix/intro.md | 1 + books/user/src/cli/args.md | 1 + books/user/src/cli/intro.md | 1 + books/user/src/cli/runtime.md | 1 + books/user/src/config.md | 1 + books/user/src/deploy/docker.md | 1 + books/user/src/deploy/intro.md | 1 + books/user/src/deploy/systemd.md | 1 + books/user/src/file-structure.md | 1 + books/user/src/getting-started/intro.md | 1 + books/user/src/getting-started/pre-build.md | 1 + books/user/src/getting-started/run.md | 1 + books/user/src/getting-started/source.md | 1 + books/user/src/getting-started/sys-req.md | 1 + books/user/src/getting-started/verify.md | 1 + books/user/src/gs/intro.md | 1 + books/user/src/gs/pre-build.md | 1 + books/user/src/gs/run.md | 1 + books/user/src/gs/source.md | 1 + books/user/src/gs/sys-req.md | 1 + books/user/src/gs/verify.md | 1 + books/user/src/images/CuprateLogo.svg | 1 + .../user/src/instrumentation/console-logs.md | 1 + books/user/src/instrumentation/file-logs.md | 1 + books/user/src/instrumentation/intro.md | 1 + books/user/src/introduction.md | 12 ++ books/user/src/ports/intro.md | 1 + books/user/src/ports/p2p.md | 1 + books/user/src/ports/rpc.md | 1 + books/user/src/ports/zmq.md | 1 + books/user/src/rpc/bin/get_blocks.md | 1 + .../user/src/rpc/bin/get_blocks_by_height.md | 1 + books/user/src/rpc/bin/get_hashes.md | 1 + books/user/src/rpc/bin/get_o_indexes.md | 1 + books/user/src/rpc/bin/get_outs.md | 1 + .../rpc/bin/get_transaction_pool_hashes.md | 1 + books/user/src/rpc/bin/intro.md | 1 + books/user/src/rpc/comparison.md | 1 + books/user/src/rpc/intro.md | 1 + books/user/src/rpc/json-rpc/add_aux_pow.md | 1 + books/user/src/rpc/json-rpc/banned.md | 1 + books/user/src/rpc/json-rpc/calc_pow.md | 1 + books/user/src/rpc/json-rpc/flush_cache.md | 1 + books/user/src/rpc/json-rpc/flush_txpool.md | 1 + books/user/src/rpc/json-rpc/generateblocks.md | 1 + .../src/rpc/json-rpc/get_alternate_chains.md | 1 + books/user/src/rpc/json-rpc/get_bans.md | 1 + books/user/src/rpc/json-rpc/get_block.md | 1 + .../user/src/rpc/json-rpc/get_block_count.md | 1 + .../rpc/json-rpc/get_block_header_by_hash.md | 1 + .../json-rpc/get_block_header_by_height.md | 1 + .../rpc/json-rpc/get_block_headers_range.md | 1 + .../src/rpc/json-rpc/get_block_template.md | 1 + .../src/rpc/json-rpc/get_coinbase_tx_sum.md | 1 + .../user/src/rpc/json-rpc/get_connections.md | 1 + .../user/src/rpc/json-rpc/get_fee_estimate.md | 1 + books/user/src/rpc/json-rpc/get_info.md | 1 + .../src/rpc/json-rpc/get_last_block_header.md | 1 + books/user/src/rpc/json-rpc/get_miner_data.md | 1 + .../rpc/json-rpc/get_output_distribution.md | 1 + .../src/rpc/json-rpc/get_output_histogram.md | 1 + .../src/rpc/json-rpc/get_txpool_backlog.md | 1 + books/user/src/rpc/json-rpc/get_version.md | 1 + books/user/src/rpc/json-rpc/hard_fork_info.md | 1 + books/user/src/rpc/json-rpc/intro.md | 1 + .../src/rpc/json-rpc/on_get_block_hash.md | 1 + .../user/src/rpc/json-rpc/prune_blockchain.md | 1 + books/user/src/rpc/json-rpc/relay_tx.md | 1 + books/user/src/rpc/json-rpc/set_bans.md | 1 + books/user/src/rpc/json-rpc/submit_block.md | 1 + books/user/src/rpc/json-rpc/sync_info.md | 1 + .../src/rpc/json/get_alt_blocks_hashes.md | 1 + books/user/src/rpc/json/get_height.md | 1 + books/user/src/rpc/json/get_limit.md | 1 + books/user/src/rpc/json/get_net_stats.md | 1 + books/user/src/rpc/json/get_outs.md | 1 + books/user/src/rpc/json/get_peer_list.md | 1 + .../user/src/rpc/json/get_transaction_pool.md | 1 + .../rpc/json/get_transaction_pool_stats.md | 1 + books/user/src/rpc/json/get_transactions.md | 1 + books/user/src/rpc/json/in_peers.md | 1 + books/user/src/rpc/json/intro.md | 1 + books/user/src/rpc/json/is_key_image_spent.md | 1 + books/user/src/rpc/json/out_peers.md | 1 + books/user/src/rpc/json/pop_blocks.md | 1 + books/user/src/rpc/json/save_bc.md | 1 + .../user/src/rpc/json/send_raw_transaction.md | 1 + .../user/src/rpc/json/set_bootstrap_daemon.md | 1 + books/user/src/rpc/json/set_limit.md | 1 + books/user/src/rpc/json/set_log_categories.md | 1 + books/user/src/rpc/json/set_log_level.md | 1 + books/user/src/rpc/json/stop_daemon.md | 1 + books/user/src/rpc/json/update.md | 1 + books/user/src/rpc/objects/block.md | 1 + books/user/src/rpc/objects/block_header.md | 1 + books/user/src/rpc/objects/chain.md | 1 + books/user/src/rpc/objects/connection.md | 1 + books/user/src/rpc/objects/histogram.md | 1 + books/user/src/rpc/objects/intro.md | 1 + books/user/src/rpc/unsupported/get_info.md | 1 + books/user/src/rpc/unsupported/intro.md | 1 + .../user/src/rpc/unsupported/mining_status.md | 1 + .../src/rpc/unsupported/set_log_hash_rate.md | 1 + .../user/src/rpc/unsupported/start_mining.md | 1 + .../src/rpc/unsupported/start_save_graph.md | 1 + books/user/src/rpc/unsupported/stop_mining.md | 1 + .../src/rpc/unsupported/stop_save_graph.md | 1 + books/user/src/todo.md | 1 - 115 files changed, 233 insertions(+), 16 deletions(-) create mode 100644 books/user/src/anon-net/intro.md create mode 100644 books/user/src/anon-net/socks.md create mode 100644 books/user/src/anon-net/tor.md create mode 100644 books/user/src/appendix/devs.md create mode 100644 books/user/src/appendix/intro.md create mode 100644 books/user/src/cli/args.md create mode 100644 books/user/src/cli/intro.md create mode 100644 books/user/src/cli/runtime.md create mode 100644 books/user/src/config.md create mode 100644 books/user/src/deploy/docker.md create mode 100644 books/user/src/deploy/intro.md create mode 100644 books/user/src/deploy/systemd.md create mode 100644 books/user/src/file-structure.md create mode 100644 books/user/src/getting-started/intro.md create mode 100644 books/user/src/getting-started/pre-build.md create mode 100644 books/user/src/getting-started/run.md create mode 100644 books/user/src/getting-started/source.md create mode 100644 books/user/src/getting-started/sys-req.md create mode 100644 books/user/src/getting-started/verify.md create mode 100644 books/user/src/gs/intro.md create mode 100644 books/user/src/gs/pre-build.md create mode 100644 books/user/src/gs/run.md create mode 100644 books/user/src/gs/source.md create mode 100644 books/user/src/gs/sys-req.md create mode 100644 books/user/src/gs/verify.md create mode 120000 books/user/src/images/CuprateLogo.svg create mode 100644 books/user/src/instrumentation/console-logs.md create mode 100644 books/user/src/instrumentation/file-logs.md create mode 100644 books/user/src/instrumentation/intro.md create mode 100644 books/user/src/introduction.md create mode 100644 books/user/src/ports/intro.md create mode 100644 books/user/src/ports/p2p.md create mode 100644 books/user/src/ports/rpc.md create mode 100644 books/user/src/ports/zmq.md create mode 100644 books/user/src/rpc/bin/get_blocks.md create mode 100644 books/user/src/rpc/bin/get_blocks_by_height.md create mode 100644 books/user/src/rpc/bin/get_hashes.md create mode 100644 books/user/src/rpc/bin/get_o_indexes.md create mode 100644 books/user/src/rpc/bin/get_outs.md create mode 100644 books/user/src/rpc/bin/get_transaction_pool_hashes.md create mode 100644 books/user/src/rpc/bin/intro.md create mode 100644 books/user/src/rpc/comparison.md create mode 100644 books/user/src/rpc/intro.md create mode 100644 books/user/src/rpc/json-rpc/add_aux_pow.md create mode 100644 books/user/src/rpc/json-rpc/banned.md create mode 100644 books/user/src/rpc/json-rpc/calc_pow.md create mode 100644 books/user/src/rpc/json-rpc/flush_cache.md create mode 100644 books/user/src/rpc/json-rpc/flush_txpool.md create mode 100644 books/user/src/rpc/json-rpc/generateblocks.md create mode 100644 books/user/src/rpc/json-rpc/get_alternate_chains.md create mode 100644 books/user/src/rpc/json-rpc/get_bans.md create mode 100644 books/user/src/rpc/json-rpc/get_block.md create mode 100644 books/user/src/rpc/json-rpc/get_block_count.md create mode 100644 books/user/src/rpc/json-rpc/get_block_header_by_hash.md create mode 100644 books/user/src/rpc/json-rpc/get_block_header_by_height.md create mode 100644 books/user/src/rpc/json-rpc/get_block_headers_range.md create mode 100644 books/user/src/rpc/json-rpc/get_block_template.md create mode 100644 books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md create mode 100644 books/user/src/rpc/json-rpc/get_connections.md create mode 100644 books/user/src/rpc/json-rpc/get_fee_estimate.md create mode 100644 books/user/src/rpc/json-rpc/get_info.md create mode 100644 books/user/src/rpc/json-rpc/get_last_block_header.md create mode 100644 books/user/src/rpc/json-rpc/get_miner_data.md create mode 100644 books/user/src/rpc/json-rpc/get_output_distribution.md create mode 100644 books/user/src/rpc/json-rpc/get_output_histogram.md create mode 100644 books/user/src/rpc/json-rpc/get_txpool_backlog.md create mode 100644 books/user/src/rpc/json-rpc/get_version.md create mode 100644 books/user/src/rpc/json-rpc/hard_fork_info.md create mode 100644 books/user/src/rpc/json-rpc/intro.md create mode 100644 books/user/src/rpc/json-rpc/on_get_block_hash.md create mode 100644 books/user/src/rpc/json-rpc/prune_blockchain.md create mode 100644 books/user/src/rpc/json-rpc/relay_tx.md create mode 100644 books/user/src/rpc/json-rpc/set_bans.md create mode 100644 books/user/src/rpc/json-rpc/submit_block.md create mode 100644 books/user/src/rpc/json-rpc/sync_info.md create mode 100644 books/user/src/rpc/json/get_alt_blocks_hashes.md create mode 100644 books/user/src/rpc/json/get_height.md create mode 100644 books/user/src/rpc/json/get_limit.md create mode 100644 books/user/src/rpc/json/get_net_stats.md create mode 100644 books/user/src/rpc/json/get_outs.md create mode 100644 books/user/src/rpc/json/get_peer_list.md create mode 100644 books/user/src/rpc/json/get_transaction_pool.md create mode 100644 books/user/src/rpc/json/get_transaction_pool_stats.md create mode 100644 books/user/src/rpc/json/get_transactions.md create mode 100644 books/user/src/rpc/json/in_peers.md create mode 100644 books/user/src/rpc/json/intro.md create mode 100644 books/user/src/rpc/json/is_key_image_spent.md create mode 100644 books/user/src/rpc/json/out_peers.md create mode 100644 books/user/src/rpc/json/pop_blocks.md create mode 100644 books/user/src/rpc/json/save_bc.md create mode 100644 books/user/src/rpc/json/send_raw_transaction.md create mode 100644 books/user/src/rpc/json/set_bootstrap_daemon.md create mode 100644 books/user/src/rpc/json/set_limit.md create mode 100644 books/user/src/rpc/json/set_log_categories.md create mode 100644 books/user/src/rpc/json/set_log_level.md create mode 100644 books/user/src/rpc/json/stop_daemon.md create mode 100644 books/user/src/rpc/json/update.md create mode 100644 books/user/src/rpc/objects/block.md create mode 100644 books/user/src/rpc/objects/block_header.md create mode 100644 books/user/src/rpc/objects/chain.md create mode 100644 books/user/src/rpc/objects/connection.md create mode 100644 books/user/src/rpc/objects/histogram.md create mode 100644 books/user/src/rpc/objects/intro.md create mode 100644 books/user/src/rpc/unsupported/get_info.md create mode 100644 books/user/src/rpc/unsupported/intro.md create mode 100644 books/user/src/rpc/unsupported/mining_status.md create mode 100644 books/user/src/rpc/unsupported/set_log_hash_rate.md create mode 100644 books/user/src/rpc/unsupported/start_mining.md create mode 100644 books/user/src/rpc/unsupported/start_save_graph.md create mode 100644 books/user/src/rpc/unsupported/stop_mining.md create mode 100644 books/user/src/rpc/unsupported/stop_save_graph.md delete mode 100644 books/user/src/todo.md diff --git a/books/user/README.md b/books/user/README.md index ee2ccaef..281aeba4 100644 --- a/books/user/README.md +++ b/books/user/README.md @@ -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: - diff --git a/books/user/book.toml b/books/user/book.toml index f26e736a..3bb423a7 100644 --- a/books/user/book.toml +++ b/books/user/book.toml @@ -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 diff --git a/books/user/src/SUMMARY.md b/books/user/src/SUMMARY.md index 2b8615c9..82e739de 100644 --- a/books/user/src/SUMMARY.md +++ b/books/user/src/SUMMARY.md @@ -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) \ No newline at end of file diff --git a/books/user/src/anon-net/intro.md b/books/user/src/anon-net/intro.md new file mode 100644 index 00000000..29cfeac1 --- /dev/null +++ b/books/user/src/anon-net/intro.md @@ -0,0 +1 @@ +# Anonymity networks diff --git a/books/user/src/anon-net/socks.md b/books/user/src/anon-net/socks.md new file mode 100644 index 00000000..afe9ed0e --- /dev/null +++ b/books/user/src/anon-net/socks.md @@ -0,0 +1 @@ +# SOCKS proxy diff --git a/books/user/src/anon-net/tor.md b/books/user/src/anon-net/tor.md new file mode 100644 index 00000000..ee87db4c --- /dev/null +++ b/books/user/src/anon-net/tor.md @@ -0,0 +1 @@ +# Tor diff --git a/books/user/src/appendix/devs.md b/books/user/src/appendix/devs.md new file mode 100644 index 00000000..73437b84 --- /dev/null +++ b/books/user/src/appendix/devs.md @@ -0,0 +1 @@ +# Developers diff --git a/books/user/src/appendix/intro.md b/books/user/src/appendix/intro.md new file mode 100644 index 00000000..fad5ae45 --- /dev/null +++ b/books/user/src/appendix/intro.md @@ -0,0 +1 @@ +# Appendix diff --git a/books/user/src/cli/args.md b/books/user/src/cli/args.md new file mode 100644 index 00000000..ceb2da1c --- /dev/null +++ b/books/user/src/cli/args.md @@ -0,0 +1 @@ +# CLI arguments diff --git a/books/user/src/cli/intro.md b/books/user/src/cli/intro.md new file mode 100644 index 00000000..9d573bfa --- /dev/null +++ b/books/user/src/cli/intro.md @@ -0,0 +1 @@ +# Command line diff --git a/books/user/src/cli/runtime.md b/books/user/src/cli/runtime.md new file mode 100644 index 00000000..2e43bf7b --- /dev/null +++ b/books/user/src/cli/runtime.md @@ -0,0 +1 @@ +# Runtime input diff --git a/books/user/src/config.md b/books/user/src/config.md new file mode 100644 index 00000000..a025a48b --- /dev/null +++ b/books/user/src/config.md @@ -0,0 +1 @@ +# Configuration diff --git a/books/user/src/deploy/docker.md b/books/user/src/deploy/docker.md new file mode 100644 index 00000000..c597eaa5 --- /dev/null +++ b/books/user/src/deploy/docker.md @@ -0,0 +1 @@ +# Docker diff --git a/books/user/src/deploy/intro.md b/books/user/src/deploy/intro.md new file mode 100644 index 00000000..d36c65e5 --- /dev/null +++ b/books/user/src/deploy/intro.md @@ -0,0 +1 @@ +# Deployment diff --git a/books/user/src/deploy/systemd.md b/books/user/src/deploy/systemd.md new file mode 100644 index 00000000..418a110c --- /dev/null +++ b/books/user/src/deploy/systemd.md @@ -0,0 +1 @@ +# systemd diff --git a/books/user/src/file-structure.md b/books/user/src/file-structure.md new file mode 100644 index 00000000..c06a53f9 --- /dev/null +++ b/books/user/src/file-structure.md @@ -0,0 +1 @@ +# File structure diff --git a/books/user/src/getting-started/intro.md b/books/user/src/getting-started/intro.md new file mode 100644 index 00000000..69a5d543 --- /dev/null +++ b/books/user/src/getting-started/intro.md @@ -0,0 +1 @@ +# Getting started diff --git a/books/user/src/getting-started/pre-build.md b/books/user/src/getting-started/pre-build.md new file mode 100644 index 00000000..20465af5 --- /dev/null +++ b/books/user/src/getting-started/pre-build.md @@ -0,0 +1 @@ +# Pre-built binaries diff --git a/books/user/src/getting-started/run.md b/books/user/src/getting-started/run.md new file mode 100644 index 00000000..9936b1a5 --- /dev/null +++ b/books/user/src/getting-started/run.md @@ -0,0 +1 @@ +# Running diff --git a/books/user/src/getting-started/source.md b/books/user/src/getting-started/source.md new file mode 100644 index 00000000..6a5b9dc1 --- /dev/null +++ b/books/user/src/getting-started/source.md @@ -0,0 +1 @@ +# Building from source diff --git a/books/user/src/getting-started/sys-req.md b/books/user/src/getting-started/sys-req.md new file mode 100644 index 00000000..0658719e --- /dev/null +++ b/books/user/src/getting-started/sys-req.md @@ -0,0 +1 @@ +# System requirements diff --git a/books/user/src/getting-started/verify.md b/books/user/src/getting-started/verify.md new file mode 100644 index 00000000..f53d6989 --- /dev/null +++ b/books/user/src/getting-started/verify.md @@ -0,0 +1 @@ +# Verifying diff --git a/books/user/src/gs/intro.md b/books/user/src/gs/intro.md new file mode 100644 index 00000000..69a5d543 --- /dev/null +++ b/books/user/src/gs/intro.md @@ -0,0 +1 @@ +# Getting started diff --git a/books/user/src/gs/pre-build.md b/books/user/src/gs/pre-build.md new file mode 100644 index 00000000..8354ed9d --- /dev/null +++ b/books/user/src/gs/pre-build.md @@ -0,0 +1 @@ +# Pre-built binaries} diff --git a/books/user/src/gs/run.md b/books/user/src/gs/run.md new file mode 100644 index 00000000..9936b1a5 --- /dev/null +++ b/books/user/src/gs/run.md @@ -0,0 +1 @@ +# Running diff --git a/books/user/src/gs/source.md b/books/user/src/gs/source.md new file mode 100644 index 00000000..6a5b9dc1 --- /dev/null +++ b/books/user/src/gs/source.md @@ -0,0 +1 @@ +# Building from source diff --git a/books/user/src/gs/sys-req.md b/books/user/src/gs/sys-req.md new file mode 100644 index 00000000..0658719e --- /dev/null +++ b/books/user/src/gs/sys-req.md @@ -0,0 +1 @@ +# System requirements diff --git a/books/user/src/gs/verify.md b/books/user/src/gs/verify.md new file mode 100644 index 00000000..f53d6989 --- /dev/null +++ b/books/user/src/gs/verify.md @@ -0,0 +1 @@ +# Verifying diff --git a/books/user/src/images/CuprateLogo.svg b/books/user/src/images/CuprateLogo.svg new file mode 120000 index 00000000..248d4158 --- /dev/null +++ b/books/user/src/images/CuprateLogo.svg @@ -0,0 +1 @@ +../../../../misc/logo/CuprateLogo.svg \ No newline at end of file diff --git a/books/user/src/instrumentation/console-logs.md b/books/user/src/instrumentation/console-logs.md new file mode 100644 index 00000000..94891225 --- /dev/null +++ b/books/user/src/instrumentation/console-logs.md @@ -0,0 +1 @@ +# Console logs diff --git a/books/user/src/instrumentation/file-logs.md b/books/user/src/instrumentation/file-logs.md new file mode 100644 index 00000000..50401f98 --- /dev/null +++ b/books/user/src/instrumentation/file-logs.md @@ -0,0 +1 @@ +# File logs diff --git a/books/user/src/instrumentation/intro.md b/books/user/src/instrumentation/intro.md new file mode 100644 index 00000000..ab7111ba --- /dev/null +++ b/books/user/src/instrumentation/intro.md @@ -0,0 +1 @@ +# Instrumentation diff --git a/books/user/src/introduction.md b/books/user/src/introduction.md new file mode 100644 index 00000000..e85fed85 --- /dev/null +++ b/books/user/src/introduction.md @@ -0,0 +1,12 @@ +
+ + +[![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. + +
diff --git a/books/user/src/ports/intro.md b/books/user/src/ports/intro.md new file mode 100644 index 00000000..e0b058d8 --- /dev/null +++ b/books/user/src/ports/intro.md @@ -0,0 +1 @@ +# Ports diff --git a/books/user/src/ports/p2p.md b/books/user/src/ports/p2p.md new file mode 100644 index 00000000..4dc51b64 --- /dev/null +++ b/books/user/src/ports/p2p.md @@ -0,0 +1 @@ +# P2P diff --git a/books/user/src/ports/rpc.md b/books/user/src/ports/rpc.md new file mode 100644 index 00000000..e8774683 --- /dev/null +++ b/books/user/src/ports/rpc.md @@ -0,0 +1 @@ +# RPC diff --git a/books/user/src/ports/zmq.md b/books/user/src/ports/zmq.md new file mode 100644 index 00000000..b1210e9d --- /dev/null +++ b/books/user/src/ports/zmq.md @@ -0,0 +1 @@ +# ZMQ diff --git a/books/user/src/rpc/bin/get_blocks.md b/books/user/src/rpc/bin/get_blocks.md new file mode 100644 index 00000000..45f8c0c6 --- /dev/null +++ b/books/user/src/rpc/bin/get_blocks.md @@ -0,0 +1 @@ +# /get_blocks.bin diff --git a/books/user/src/rpc/bin/get_blocks_by_height.md b/books/user/src/rpc/bin/get_blocks_by_height.md new file mode 100644 index 00000000..bb24e88f --- /dev/null +++ b/books/user/src/rpc/bin/get_blocks_by_height.md @@ -0,0 +1 @@ +# /get_blocks_by_height.bin diff --git a/books/user/src/rpc/bin/get_hashes.md b/books/user/src/rpc/bin/get_hashes.md new file mode 100644 index 00000000..d3fe27eb --- /dev/null +++ b/books/user/src/rpc/bin/get_hashes.md @@ -0,0 +1 @@ +# /get_hashes.bin diff --git a/books/user/src/rpc/bin/get_o_indexes.md b/books/user/src/rpc/bin/get_o_indexes.md new file mode 100644 index 00000000..8030fb4d --- /dev/null +++ b/books/user/src/rpc/bin/get_o_indexes.md @@ -0,0 +1 @@ +# /get_o_indexes.bin diff --git a/books/user/src/rpc/bin/get_outs.md b/books/user/src/rpc/bin/get_outs.md new file mode 100644 index 00000000..1d48f438 --- /dev/null +++ b/books/user/src/rpc/bin/get_outs.md @@ -0,0 +1 @@ +# /get_outs.bin diff --git a/books/user/src/rpc/bin/get_transaction_pool_hashes.md b/books/user/src/rpc/bin/get_transaction_pool_hashes.md new file mode 100644 index 00000000..2adbf62e --- /dev/null +++ b/books/user/src/rpc/bin/get_transaction_pool_hashes.md @@ -0,0 +1 @@ +# /get_transaction_pool_hashes.bin diff --git a/books/user/src/rpc/bin/intro.md b/books/user/src/rpc/bin/intro.md new file mode 100644 index 00000000..1089a073 --- /dev/null +++ b/books/user/src/rpc/bin/intro.md @@ -0,0 +1 @@ +# Binary endpoints diff --git a/books/user/src/rpc/comparison.md b/books/user/src/rpc/comparison.md new file mode 100644 index 00000000..9da351c0 --- /dev/null +++ b/books/user/src/rpc/comparison.md @@ -0,0 +1 @@ +# monerod & cuprated diff --git a/books/user/src/rpc/intro.md b/books/user/src/rpc/intro.md new file mode 100644 index 00000000..e8774683 --- /dev/null +++ b/books/user/src/rpc/intro.md @@ -0,0 +1 @@ +# RPC diff --git a/books/user/src/rpc/json-rpc/add_aux_pow.md b/books/user/src/rpc/json-rpc/add_aux_pow.md new file mode 100644 index 00000000..e476bc7d --- /dev/null +++ b/books/user/src/rpc/json-rpc/add_aux_pow.md @@ -0,0 +1 @@ +# add_aux_pow diff --git a/books/user/src/rpc/json-rpc/banned.md b/books/user/src/rpc/json-rpc/banned.md new file mode 100644 index 00000000..e574e24b --- /dev/null +++ b/books/user/src/rpc/json-rpc/banned.md @@ -0,0 +1 @@ +# banned diff --git a/books/user/src/rpc/json-rpc/calc_pow.md b/books/user/src/rpc/json-rpc/calc_pow.md new file mode 100644 index 00000000..e6440717 --- /dev/null +++ b/books/user/src/rpc/json-rpc/calc_pow.md @@ -0,0 +1 @@ +# calc_pow diff --git a/books/user/src/rpc/json-rpc/flush_cache.md b/books/user/src/rpc/json-rpc/flush_cache.md new file mode 100644 index 00000000..a3c2d3ae --- /dev/null +++ b/books/user/src/rpc/json-rpc/flush_cache.md @@ -0,0 +1 @@ +# flush_cache diff --git a/books/user/src/rpc/json-rpc/flush_txpool.md b/books/user/src/rpc/json-rpc/flush_txpool.md new file mode 100644 index 00000000..3c481a6f --- /dev/null +++ b/books/user/src/rpc/json-rpc/flush_txpool.md @@ -0,0 +1 @@ +# flush_txpool diff --git a/books/user/src/rpc/json-rpc/generateblocks.md b/books/user/src/rpc/json-rpc/generateblocks.md new file mode 100644 index 00000000..3376c996 --- /dev/null +++ b/books/user/src/rpc/json-rpc/generateblocks.md @@ -0,0 +1 @@ +# generateblocks diff --git a/books/user/src/rpc/json-rpc/get_alternate_chains.md b/books/user/src/rpc/json-rpc/get_alternate_chains.md new file mode 100644 index 00000000..39706990 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_alternate_chains.md @@ -0,0 +1 @@ +# get_alternate_chains diff --git a/books/user/src/rpc/json-rpc/get_bans.md b/books/user/src/rpc/json-rpc/get_bans.md new file mode 100644 index 00000000..60659ff8 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_bans.md @@ -0,0 +1 @@ +# get_bans diff --git a/books/user/src/rpc/json-rpc/get_block.md b/books/user/src/rpc/json-rpc/get_block.md new file mode 100644 index 00000000..c0ec77a3 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block.md @@ -0,0 +1 @@ +# get_block diff --git a/books/user/src/rpc/json-rpc/get_block_count.md b/books/user/src/rpc/json-rpc/get_block_count.md new file mode 100644 index 00000000..cacfd7c1 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block_count.md @@ -0,0 +1 @@ +# get_block_count diff --git a/books/user/src/rpc/json-rpc/get_block_header_by_hash.md b/books/user/src/rpc/json-rpc/get_block_header_by_hash.md new file mode 100644 index 00000000..a0bdbab9 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block_header_by_hash.md @@ -0,0 +1 @@ +# get_block_header_by_hash diff --git a/books/user/src/rpc/json-rpc/get_block_header_by_height.md b/books/user/src/rpc/json-rpc/get_block_header_by_height.md new file mode 100644 index 00000000..725a9965 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block_header_by_height.md @@ -0,0 +1 @@ +# get_block_header_by_height diff --git a/books/user/src/rpc/json-rpc/get_block_headers_range.md b/books/user/src/rpc/json-rpc/get_block_headers_range.md new file mode 100644 index 00000000..04108057 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block_headers_range.md @@ -0,0 +1 @@ +# get_block_headers_range diff --git a/books/user/src/rpc/json-rpc/get_block_template.md b/books/user/src/rpc/json-rpc/get_block_template.md new file mode 100644 index 00000000..355cc325 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_block_template.md @@ -0,0 +1 @@ +# get_block_template diff --git a/books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md b/books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md new file mode 100644 index 00000000..c942bd4d --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md @@ -0,0 +1 @@ +# get_coinbase_tx_sum diff --git a/books/user/src/rpc/json-rpc/get_connections.md b/books/user/src/rpc/json-rpc/get_connections.md new file mode 100644 index 00000000..6d31b849 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_connections.md @@ -0,0 +1 @@ +# get_connections diff --git a/books/user/src/rpc/json-rpc/get_fee_estimate.md b/books/user/src/rpc/json-rpc/get_fee_estimate.md new file mode 100644 index 00000000..67ebeeba --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_fee_estimate.md @@ -0,0 +1 @@ +# get_fee_estimate diff --git a/books/user/src/rpc/json-rpc/get_info.md b/books/user/src/rpc/json-rpc/get_info.md new file mode 100644 index 00000000..55ee8881 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_info.md @@ -0,0 +1 @@ +# get_info diff --git a/books/user/src/rpc/json-rpc/get_last_block_header.md b/books/user/src/rpc/json-rpc/get_last_block_header.md new file mode 100644 index 00000000..09efbfb0 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_last_block_header.md @@ -0,0 +1 @@ +# get_last_block_header diff --git a/books/user/src/rpc/json-rpc/get_miner_data.md b/books/user/src/rpc/json-rpc/get_miner_data.md new file mode 100644 index 00000000..ccdfb58e --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_miner_data.md @@ -0,0 +1 @@ +# get_miner_data diff --git a/books/user/src/rpc/json-rpc/get_output_distribution.md b/books/user/src/rpc/json-rpc/get_output_distribution.md new file mode 100644 index 00000000..10320c80 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_output_distribution.md @@ -0,0 +1 @@ +# get_output_distribution diff --git a/books/user/src/rpc/json-rpc/get_output_histogram.md b/books/user/src/rpc/json-rpc/get_output_histogram.md new file mode 100644 index 00000000..135d607a --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_output_histogram.md @@ -0,0 +1 @@ +# get_output_histogram diff --git a/books/user/src/rpc/json-rpc/get_txpool_backlog.md b/books/user/src/rpc/json-rpc/get_txpool_backlog.md new file mode 100644 index 00000000..8579b422 --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_txpool_backlog.md @@ -0,0 +1 @@ +# get_txpool_backlog diff --git a/books/user/src/rpc/json-rpc/get_version.md b/books/user/src/rpc/json-rpc/get_version.md new file mode 100644 index 00000000..3b1376ec --- /dev/null +++ b/books/user/src/rpc/json-rpc/get_version.md @@ -0,0 +1 @@ +# get_version diff --git a/books/user/src/rpc/json-rpc/hard_fork_info.md b/books/user/src/rpc/json-rpc/hard_fork_info.md new file mode 100644 index 00000000..8bb251c5 --- /dev/null +++ b/books/user/src/rpc/json-rpc/hard_fork_info.md @@ -0,0 +1 @@ +# hard_fork_info diff --git a/books/user/src/rpc/json-rpc/intro.md b/books/user/src/rpc/json-rpc/intro.md new file mode 100644 index 00000000..cffdf46b --- /dev/null +++ b/books/user/src/rpc/json-rpc/intro.md @@ -0,0 +1 @@ +# JSON-RPC 2.0 diff --git a/books/user/src/rpc/json-rpc/on_get_block_hash.md b/books/user/src/rpc/json-rpc/on_get_block_hash.md new file mode 100644 index 00000000..99756c88 --- /dev/null +++ b/books/user/src/rpc/json-rpc/on_get_block_hash.md @@ -0,0 +1 @@ +# on_get_block_hash diff --git a/books/user/src/rpc/json-rpc/prune_blockchain.md b/books/user/src/rpc/json-rpc/prune_blockchain.md new file mode 100644 index 00000000..978979a8 --- /dev/null +++ b/books/user/src/rpc/json-rpc/prune_blockchain.md @@ -0,0 +1 @@ +# prune_blockchain diff --git a/books/user/src/rpc/json-rpc/relay_tx.md b/books/user/src/rpc/json-rpc/relay_tx.md new file mode 100644 index 00000000..d410e781 --- /dev/null +++ b/books/user/src/rpc/json-rpc/relay_tx.md @@ -0,0 +1 @@ +# relay_tx diff --git a/books/user/src/rpc/json-rpc/set_bans.md b/books/user/src/rpc/json-rpc/set_bans.md new file mode 100644 index 00000000..d5fbc204 --- /dev/null +++ b/books/user/src/rpc/json-rpc/set_bans.md @@ -0,0 +1 @@ +# set_bans diff --git a/books/user/src/rpc/json-rpc/submit_block.md b/books/user/src/rpc/json-rpc/submit_block.md new file mode 100644 index 00000000..b84db00c --- /dev/null +++ b/books/user/src/rpc/json-rpc/submit_block.md @@ -0,0 +1 @@ +# submit_block diff --git a/books/user/src/rpc/json-rpc/sync_info.md b/books/user/src/rpc/json-rpc/sync_info.md new file mode 100644 index 00000000..40866b25 --- /dev/null +++ b/books/user/src/rpc/json-rpc/sync_info.md @@ -0,0 +1 @@ +# sync_info diff --git a/books/user/src/rpc/json/get_alt_blocks_hashes.md b/books/user/src/rpc/json/get_alt_blocks_hashes.md new file mode 100644 index 00000000..d73e4eed --- /dev/null +++ b/books/user/src/rpc/json/get_alt_blocks_hashes.md @@ -0,0 +1 @@ +# /get_alt_blocks_hashes diff --git a/books/user/src/rpc/json/get_height.md b/books/user/src/rpc/json/get_height.md new file mode 100644 index 00000000..eaf56b30 --- /dev/null +++ b/books/user/src/rpc/json/get_height.md @@ -0,0 +1 @@ +# /get_height diff --git a/books/user/src/rpc/json/get_limit.md b/books/user/src/rpc/json/get_limit.md new file mode 100644 index 00000000..60013ac3 --- /dev/null +++ b/books/user/src/rpc/json/get_limit.md @@ -0,0 +1 @@ +# /get_limit diff --git a/books/user/src/rpc/json/get_net_stats.md b/books/user/src/rpc/json/get_net_stats.md new file mode 100644 index 00000000..a759cab3 --- /dev/null +++ b/books/user/src/rpc/json/get_net_stats.md @@ -0,0 +1 @@ +# /get_net_stats diff --git a/books/user/src/rpc/json/get_outs.md b/books/user/src/rpc/json/get_outs.md new file mode 100644 index 00000000..edda61ae --- /dev/null +++ b/books/user/src/rpc/json/get_outs.md @@ -0,0 +1 @@ +# /get_outs diff --git a/books/user/src/rpc/json/get_peer_list.md b/books/user/src/rpc/json/get_peer_list.md new file mode 100644 index 00000000..6729fdcb --- /dev/null +++ b/books/user/src/rpc/json/get_peer_list.md @@ -0,0 +1 @@ +# /get_peer_list diff --git a/books/user/src/rpc/json/get_transaction_pool.md b/books/user/src/rpc/json/get_transaction_pool.md new file mode 100644 index 00000000..d48399ec --- /dev/null +++ b/books/user/src/rpc/json/get_transaction_pool.md @@ -0,0 +1 @@ +# /get_transaction_pool diff --git a/books/user/src/rpc/json/get_transaction_pool_stats.md b/books/user/src/rpc/json/get_transaction_pool_stats.md new file mode 100644 index 00000000..e23d45da --- /dev/null +++ b/books/user/src/rpc/json/get_transaction_pool_stats.md @@ -0,0 +1 @@ +# /get_transaction_pool_stats diff --git a/books/user/src/rpc/json/get_transactions.md b/books/user/src/rpc/json/get_transactions.md new file mode 100644 index 00000000..4a9066db --- /dev/null +++ b/books/user/src/rpc/json/get_transactions.md @@ -0,0 +1 @@ +# /get_transactions diff --git a/books/user/src/rpc/json/in_peers.md b/books/user/src/rpc/json/in_peers.md new file mode 100644 index 00000000..4527729e --- /dev/null +++ b/books/user/src/rpc/json/in_peers.md @@ -0,0 +1 @@ +# /in_peers diff --git a/books/user/src/rpc/json/intro.md b/books/user/src/rpc/json/intro.md new file mode 100644 index 00000000..29f0713f --- /dev/null +++ b/books/user/src/rpc/json/intro.md @@ -0,0 +1 @@ +# JSON endpoints diff --git a/books/user/src/rpc/json/is_key_image_spent.md b/books/user/src/rpc/json/is_key_image_spent.md new file mode 100644 index 00000000..ce9909b7 --- /dev/null +++ b/books/user/src/rpc/json/is_key_image_spent.md @@ -0,0 +1 @@ +# /is_key_image_spent diff --git a/books/user/src/rpc/json/out_peers.md b/books/user/src/rpc/json/out_peers.md new file mode 100644 index 00000000..dceaa75b --- /dev/null +++ b/books/user/src/rpc/json/out_peers.md @@ -0,0 +1 @@ +# /out_peers diff --git a/books/user/src/rpc/json/pop_blocks.md b/books/user/src/rpc/json/pop_blocks.md new file mode 100644 index 00000000..fa0d872d --- /dev/null +++ b/books/user/src/rpc/json/pop_blocks.md @@ -0,0 +1 @@ +# /pop_blocks diff --git a/books/user/src/rpc/json/save_bc.md b/books/user/src/rpc/json/save_bc.md new file mode 100644 index 00000000..25218a8f --- /dev/null +++ b/books/user/src/rpc/json/save_bc.md @@ -0,0 +1 @@ +# /save_bc diff --git a/books/user/src/rpc/json/send_raw_transaction.md b/books/user/src/rpc/json/send_raw_transaction.md new file mode 100644 index 00000000..3d4a584d --- /dev/null +++ b/books/user/src/rpc/json/send_raw_transaction.md @@ -0,0 +1 @@ +# /send_raw_transaction diff --git a/books/user/src/rpc/json/set_bootstrap_daemon.md b/books/user/src/rpc/json/set_bootstrap_daemon.md new file mode 100644 index 00000000..dff2ca71 --- /dev/null +++ b/books/user/src/rpc/json/set_bootstrap_daemon.md @@ -0,0 +1 @@ +# /set_bootstrap_daemon diff --git a/books/user/src/rpc/json/set_limit.md b/books/user/src/rpc/json/set_limit.md new file mode 100644 index 00000000..63b0820f --- /dev/null +++ b/books/user/src/rpc/json/set_limit.md @@ -0,0 +1 @@ +# /set_limit diff --git a/books/user/src/rpc/json/set_log_categories.md b/books/user/src/rpc/json/set_log_categories.md new file mode 100644 index 00000000..00e2b9bf --- /dev/null +++ b/books/user/src/rpc/json/set_log_categories.md @@ -0,0 +1 @@ +# /set_log_categories diff --git a/books/user/src/rpc/json/set_log_level.md b/books/user/src/rpc/json/set_log_level.md new file mode 100644 index 00000000..cabb3c9c --- /dev/null +++ b/books/user/src/rpc/json/set_log_level.md @@ -0,0 +1 @@ +# /set_log_level diff --git a/books/user/src/rpc/json/stop_daemon.md b/books/user/src/rpc/json/stop_daemon.md new file mode 100644 index 00000000..d205f122 --- /dev/null +++ b/books/user/src/rpc/json/stop_daemon.md @@ -0,0 +1 @@ +# /stop_daemon diff --git a/books/user/src/rpc/json/update.md b/books/user/src/rpc/json/update.md new file mode 100644 index 00000000..78b9e8f6 --- /dev/null +++ b/books/user/src/rpc/json/update.md @@ -0,0 +1 @@ +# /update diff --git a/books/user/src/rpc/objects/block.md b/books/user/src/rpc/objects/block.md new file mode 100644 index 00000000..2d45d232 --- /dev/null +++ b/books/user/src/rpc/objects/block.md @@ -0,0 +1 @@ +# Block diff --git a/books/user/src/rpc/objects/block_header.md b/books/user/src/rpc/objects/block_header.md new file mode 100644 index 00000000..ff187329 --- /dev/null +++ b/books/user/src/rpc/objects/block_header.md @@ -0,0 +1 @@ +# BlockHeader diff --git a/books/user/src/rpc/objects/chain.md b/books/user/src/rpc/objects/chain.md new file mode 100644 index 00000000..867836c1 --- /dev/null +++ b/books/user/src/rpc/objects/chain.md @@ -0,0 +1 @@ +# Chain diff --git a/books/user/src/rpc/objects/connection.md b/books/user/src/rpc/objects/connection.md new file mode 100644 index 00000000..42d070c7 --- /dev/null +++ b/books/user/src/rpc/objects/connection.md @@ -0,0 +1 @@ +# Connection diff --git a/books/user/src/rpc/objects/histogram.md b/books/user/src/rpc/objects/histogram.md new file mode 100644 index 00000000..ff9cfd03 --- /dev/null +++ b/books/user/src/rpc/objects/histogram.md @@ -0,0 +1 @@ +# Histogram diff --git a/books/user/src/rpc/objects/intro.md b/books/user/src/rpc/objects/intro.md new file mode 100644 index 00000000..65e1bfb6 --- /dev/null +++ b/books/user/src/rpc/objects/intro.md @@ -0,0 +1 @@ +# JSON objects diff --git a/books/user/src/rpc/unsupported/get_info.md b/books/user/src/rpc/unsupported/get_info.md new file mode 100644 index 00000000..76dee567 --- /dev/null +++ b/books/user/src/rpc/unsupported/get_info.md @@ -0,0 +1 @@ +# /get_info diff --git a/books/user/src/rpc/unsupported/intro.md b/books/user/src/rpc/unsupported/intro.md new file mode 100644 index 00000000..703fa579 --- /dev/null +++ b/books/user/src/rpc/unsupported/intro.md @@ -0,0 +1 @@ +# Unsupported diff --git a/books/user/src/rpc/unsupported/mining_status.md b/books/user/src/rpc/unsupported/mining_status.md new file mode 100644 index 00000000..b392f9a3 --- /dev/null +++ b/books/user/src/rpc/unsupported/mining_status.md @@ -0,0 +1 @@ +# /mining_status diff --git a/books/user/src/rpc/unsupported/set_log_hash_rate.md b/books/user/src/rpc/unsupported/set_log_hash_rate.md new file mode 100644 index 00000000..7128e6e2 --- /dev/null +++ b/books/user/src/rpc/unsupported/set_log_hash_rate.md @@ -0,0 +1 @@ +# /set_log_hash_rate diff --git a/books/user/src/rpc/unsupported/start_mining.md b/books/user/src/rpc/unsupported/start_mining.md new file mode 100644 index 00000000..f209b8b9 --- /dev/null +++ b/books/user/src/rpc/unsupported/start_mining.md @@ -0,0 +1 @@ +# /start_mining diff --git a/books/user/src/rpc/unsupported/start_save_graph.md b/books/user/src/rpc/unsupported/start_save_graph.md new file mode 100644 index 00000000..37f783d4 --- /dev/null +++ b/books/user/src/rpc/unsupported/start_save_graph.md @@ -0,0 +1 @@ +# /start_save_graph diff --git a/books/user/src/rpc/unsupported/stop_mining.md b/books/user/src/rpc/unsupported/stop_mining.md new file mode 100644 index 00000000..3a5d7065 --- /dev/null +++ b/books/user/src/rpc/unsupported/stop_mining.md @@ -0,0 +1 @@ +# /stop_mining diff --git a/books/user/src/rpc/unsupported/stop_save_graph.md b/books/user/src/rpc/unsupported/stop_save_graph.md new file mode 100644 index 00000000..4ad353a1 --- /dev/null +++ b/books/user/src/rpc/unsupported/stop_save_graph.md @@ -0,0 +1 @@ +# /stop_save_graph diff --git a/books/user/src/todo.md b/books/user/src/todo.md deleted file mode 100644 index 46409041..00000000 --- a/books/user/src/todo.md +++ /dev/null @@ -1 +0,0 @@ -# TODO