docs: refresh Electrum protocol links and prune stale TODOs#228
Open
EddieHouston wants to merge 1 commit into
Open
docs: refresh Electrum protocol links and prune stale TODOs#228EddieHouston wants to merge 1 commit into
EddieHouston wants to merge 1 commit into
Conversation
EddieHouston
changed the title
EddieHouston
force-pushed
the
chore/update-electrum-protocol-doc-links
branch
from
2a33ec2 to
68b6f79
Compare
DeviaVir
approved these changes
Jun 17, 2026
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.
EddieHouston
force-pushed
the
chore/update-electrum-protocol-doc-links
branch
from
68b6f79 to
7a0f158
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The ElectrumX docs at
electrumx.readthedocs.ioare effectively frozen around protocol 1.4.2. The maintained, canonical Electrum protocol spec now lives at spesmilo/electrum-protocol (rendered at electrum-protocol.readthedocs.io).Doc-link refresh
Point the remaining references at the maintained docs:
README.md—--electrum-hosts/server.featuresformat linksrc/config.rs—--electrum-public-hostsCLI help textThe
#server-featuresanchor was verified to resolve on the new docs.Prune stale TODO.md items
get_electrum_height(src/electrum/mod.rs), wired intoget_history/get_mempool/status viahas_unconfirmed_parents.Remaining TODO items (DB snapshot for queries,
bytesvsVec<u8>, proper HTTP parser for JSONRPC replies, RocksDB tuning) are left as-is — they're still open.Docs/help-text only; no behavior change.
Thanks to @SomberNight for pointing out that the up-to-date docs live at spesmilo/electrum-protocol.