Skip to content

Commit 68b6f79

Browse files
committed
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.
1 parent f917128 commit 68b6f79

3 files changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Additional options with the `liquid` feature:
7575
- `--parent-network <network>` - the parent network this chain is pegged to.
7676

7777
Additional options with the `electrum-discovery` feature:
78-
- `--electrum-hosts <json>` - 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).
78+
- `--electrum-hosts <json>` - 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).
7979
- `--electrum-announce` - announce the electrum server on the electrum p2p server discovery network.
8080

8181
See `$ cargo run --release --bin electrs -- --help` for the full list of options.

TODO.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Electrum
22

33
* Snapshot DB after successful indexing - and run queries on the latest snapshot
4-
* Update height to -1 for txns with any [unconfirmed input](https://electrumx.readthedocs.io/en/latest/protocol-basics.html#status)
54

65
# Rust
76

87
* Use [bytes](https://carllerche.github.io/bytes/bytes/index.html) instead of `Vec<u8>` when possible
9-
* Use generators instead of vectors
108
* Use proper HTTP parser for JSONRPC replies over persistent connection
119

1210
# Performance

src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ impl Config {
308308
let args = args.arg(
309309
Arg::with_name("electrum_public_hosts")
310310
.long("electrum-public-hosts")
311-
.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")
311+
.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")
312312
.takes_value(true)
313313
).arg(
314314
Arg::with_name("electrum_announce")

0 commit comments

Comments
 (0)