From 310f3d1e14417271a3201478ec6decdd51bec5d9 Mon Sep 17 00:00:00 2001 From: Randall Naar Date: Fri, 10 Jul 2026 13:51:58 -0400 Subject: [PATCH] docs: move mining REST endpoint notes after CLI options --- README.md | 14 +++++++------- TODO.md | 12 ------------ 2 files changed, 7 insertions(+), 19 deletions(-) delete mode 100644 TODO.md diff --git a/README.md b/README.md index 1a88899d0..a0514fa81 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,6 @@ In addition to electrs's original configuration options, a few new options are a - `--electrum-txs-limit ` - maximum number of txs to return per address in the electrum server (does not apply for the http api). - `--electrum-banner ` - welcome banner text for electrum server. -### Mining-related HTTP endpoints - -`GET /block-template` is available only with `--enable-mining-rest`. It proxies -the daemon's `getblocktemplate` template-mode response and caches successful -responses for 15 seconds, invalidating early when electrs indexes a new tip. -Callers that require fresher templates should account for this cache behavior. - Additional options with the `liquid` feature: - `--parent-network ` - the parent network this chain is pegged to. @@ -88,6 +81,13 @@ Additional options with the `electrum-discovery` feature: See `$ cargo run --release --bin electrs -- --help` for the full list of options. +### Mining-related HTTP endpoints + +`GET /block-template` is available only with `--enable-mining-rest`. It proxies +the daemon's `getblocktemplate` template-mode response and caches successful +responses for 15 seconds, invalidating early when electrs indexes a new tip. +Callers that require fresher templates should account for this cache behavior. + ## License MIT diff --git a/TODO.md b/TODO.md deleted file mode 100644 index de44f6517..000000000 --- a/TODO.md +++ /dev/null @@ -1,12 +0,0 @@ -# Electrum - -* Snapshot DB after successful indexing - and run queries on the latest snapshot - -# Rust - -* Use [bytes](https://carllerche.github.io/bytes/bytes/index.html) instead of `Vec` when possible -* Use proper HTTP parser for JSONRPC replies over persistent connection - -# Performance - -* Consider https://github.com/facebook/rocksdb/wiki/RocksDB-Tuning-Guide#difference-of-spinning-disk