Differential D14964

[electrum] add more docstrings and typehint to network and interface code
ClosedPublic
Actions

Authored by PiRK on Dec 11 2023, 16:51.

Details

Reviewers

Fabien

Group Reviewers

Restricted Project

Commits

rABC0b511b224a0b: [electrum] add more docstrings and typehint to network and interface code

Summary

This is an attempt at documenting the current behavior the network's state machine.

The fixme comment points to the codepath that causes the reorg issue in the tests in D14944.

Test Plan

Mostly proof-reading.

Check also that we didn't accidentaly break anything:

python test_runner.py
pytest electrumabc/tests/regtest

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Dec 11 2023, 16:51

Herald added a reviewer: Restricted Project. · View Herald TranscriptDec 11 2023, 16:51

Harbormaster completed remote builds in B25916: Diff 43545.Dec 11 2023, 16:53

improve doc for Modes

PiRK published this revision for review.Dec 12 2023, 09:44

PiRK edited the test plan for this revision. (Show Details)

Harbormaster completed remote builds in B25926: Diff 43557.Dec 12 2023, 09:44

PiRK added a child revision: D14968: [electrum] resolve past single-block reorg.Dec 12 2023, 09:53

Fabien accepted this revision.Dec 12 2023, 14:14

Fabien added a subscriber: Fabien.

Fabien added inline comments.

electrum/electrumabc/interface.py
429 ↗	(On Diff #43557)

This revision is now accepted and ready to land.Dec 12 2023, 14:14

whitespace nit

This revision was landed with ongoing or failed builds.Dec 12 2023, 14:54

Closed by commit rABC0b511b224a0b: [electrum] add more docstrings and typehint to network and interface code (authored by PiRK). · Explain Why

This revision was automatically updated to reflect the committed changes.

PiRK added a commit: rABC0b511b224a0b: [electrum] add more docstrings and typehint to network and interface code.

Harbormaster completed remote builds in B25937: Diff 43569.Dec 12 2023, 15:52

Revision Contents
Changeset List

Path

Size

electrum/

electrumabc/

interface.py

73 lines

network.py

28 lines

Diff 43570

View Options

electrum/electrumabc/interface.py