From 7a0f1584007d66b41af497ed0d39faadf26a8073 Mon Sep 17 00:00:00 2001 From: Edward Houston Date: Wed, 17 Jun 2026 16:39:28 +0200 Subject: [PATCH] docs: refresh electrum protocol links and prune stale TODOs The ElectrumX docs (electrumx.readthedocs.io) are frozen ~1.4.2; the maintained spec now lives at electrum-protocol.readthedocs.io. Update the server.features references in README and the --electrum-hosts help text. Also prune two stale TODO.md items: - "height -1 for txns with unconfirmed inputs" -- already implemented by get_electrum_height. - "use generators instead of vectors" -- obsolete; iterators are used throughout. --- README.md | 2 +- TODO.md | 2 -- src/config.rs | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8fc410b97..2e0b6941d 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Additional options with the `liquid` feature: - `--parent-network ` - the parent network this chain is pegged to. Additional options with the `electrum-discovery` feature: -- `--electrum-hosts ` - a json map of the public hosts where the electrum server is reachable, in the [`server.features` format](https://electrumx.readthedocs.io/en/latest/protocol-methods.html#server.features). +- `--electrum-hosts ` - a json map of the public hosts where the electrum server is reachable, in the [`server.features` format](https://electrum-protocol.readthedocs.io/en/latest/protocol-methods.html#server-features). - `--electrum-announce` - announce the electrum server on the electrum p2p server discovery network. See `$ cargo run --release --bin electrs -- --help` for the full list of options. diff --git a/TODO.md b/TODO.md index 9736158b4..de44f6517 100644 --- a/TODO.md +++ b/TODO.md @@ -1,12 +1,10 @@ # Electrum * Snapshot DB after successful indexing - and run queries on the latest snapshot -* Update height to -1 for txns with any [unconfirmed input](https://electrumx.readthedocs.io/en/latest/protocol-basics.html#status) # Rust * Use [bytes](https://carllerche.github.io/bytes/bytes/index.html) instead of `Vec` when possible -* Use generators instead of vectors * Use proper HTTP parser for JSONRPC replies over persistent connection # Performance diff --git a/src/config.rs b/src/config.rs index 7f542f9b2..d1408f610 100644 --- a/src/config.rs +++ b/src/config.rs @@ -308,7 +308,7 @@ impl Config { let args = args.arg( Arg::with_name("electrum_public_hosts") .long("electrum-public-hosts") - .help("A dictionary of hosts where the Electrum server can be reached at. Required to enable server discovery. See https://electrumx.readthedocs.io/en/latest/protocol-methods.html#server-features") + .help("A dictionary of hosts where the Electrum server can be reached at. Required to enable server discovery. See https://electrum-protocol.readthedocs.io/en/latest/protocol-methods.html#server-features") .takes_value(true) ).arg( Arg::with_name("electrum_announce")