feat(bal): Group A (timestamps + statuses + anticipate docs) and Group B (auto-sign) v0.3.4

Bump plugin version to 0.3.4 (manifest, __init__, plugin_base, VERSION). GROUP A - A1: remove block-height locktimes; the plugin now uses UNIX timestamps only. The NLOCKTIME_BLOCKHEIGHT_MAX guard is kept on purpose (it forces every locktime to be a timestamp). chk_locktime is now 2-arg; int_locktime and anticipate_locktime no longer accept blocks; RAW input only accepts d/y. Two now-dormant configs (LOCKTIME_BLOCKS, LOCKTIMEDELTA_BLOCKS) are kept with comments to avoid touching persisted keys. - A2: rename PENDING -> MEMPOOL everywhere (label 'Mempool', yellow #ffce30); add new UPDATED status; ANTICIPATED & UPDATED keep VALID; documented set_status rules; backward-compat migration (old PENDING -> MEMPOOL). - A3: clarify that anticipating to a future date only rebuilds (never invalidates), while only a past locktime invalidates (WillExpired). Code was already correct; only the comment and docs were fixed. Colour follow-up: UPDATED lightened from #800080 to #b266b2 (more readable), updated in theme.py, docs and the theme test. GROUP B - B1: verified the 'Create your will' button already opens the guided wizard (no code change needed). - B2: new persisted AUTO_SIGN setting (default ON) with an 'Auto-sign on Check' checkbox in the settings dialog. When enabled, Check signs and broadcasts automatically; the wallet password is requested only for encrypted wallets. B2 follow-up (fixes reported after testing): - Remove the duplicate sign/broadcast cycle in lists.check(); build_will_task() already signs and broadcasts. - Suppress the manual 'press Sign/Broadcast' hint and its popup when AUTO_SIGN is ON (kept when OFF). - Make broadcast one-shot: removed the retry flag and the Exception('retry'); failed will-executors stay PUSH_FAIL and are skipped (no endless retry). PUSHED transactions are already excluded from re-collection. Docs: inheritance-options.md/.html and inheritance-flow.svg updated to v0.3.4. Tests: 206 passing (new test_anticipate_manual_locktime, test_anticipate_past_locktime, test_group_b_auto_sign; updated core/util, core/will_extra, gui/theme, gui/widgets). CHANGELOG.md added with one numbered entry per task.
2026-06-28 23:00:23 -04:00
parent 10d0b85779
commit dc166d04ff
23 changed files with 1374 additions and 205 deletions
--- a/tests/test_group_b_auto_sign.py
+++ b/tests/test_group_b_auto_sign.py
@@ -0,0 +1,155 @@
+"""
+Tests for Group B / B2 and its follow-up fixes.
+
+Covered behaviour:
+
+  * the persisted ``AUTO_SIGN`` configuration key exists and defaults to ON,
+    and can be turned off and read back;
+  * the manual "next step (Sign/Broadcast)" hint is suppressed when AUTO_SIGN
+    is ON (the Building Will dialog already signs and broadcasts), and shown
+    when AUTO_SIGN is OFF (Fix A - no duplicate "press Broadcast" popup);
+  * the broadcast is "one-shot": transactions already marked PUSHED are not
+    collected again for re-sending, so a will-executor that failed before does
+    not cause the successful ones to be re-broadcast (Fix B).
+
+The Qt classes are not imported (they require PyQt6 + an Electrum window).
+Instead we reproduce the small decision logic with light-weight fakes, which
+keeps the tests fast and headless while still verifying the real contract.
+
+Run:
+    PYTHONPATH=electrum-src python3 -m pytest tests/test_group_b_auto_sign.py -q
+"""
+
+import os
+import sys
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), os.pardir))
+
+from bal.core.plugin_base import BalConfig
+from bal.core.willexecutors import Willexecutors
+
+
+# ------------------------------------------------------------------ #
+# Mocks
+# ------------------------------------------------------------------ #
+
+class FakeConfig:
+    """Minimal mock for Electrum's config object (key/value store)."""
+
+    def __init__(self):
+        self._store = {}
+
+    def get(self, key, default=None):
+        return self._store.get(key, default)
+
+    def set_key(self, key, value, save=True):
+        self._store[key] = value
+
+
+class FakeWillItem:
+    """Minimal will item exposing the status flags and will-executor used by
+    ``Willexecutors.get_willexecutor_transactions``.
+
+    ``statuses`` is a set of active status names; ``we`` is the assigned
+    will-executor dict (or ``None``); ``tx`` is any stringifiable stand-in for
+    the transaction.
+    """
+
+    def __init__(self, statuses, we, tx="rawtx"):
+        self._statuses = set(statuses)
+        self.we = we
+        self.tx = tx
+
+    def get_status(self, name):
+        return name in self._statuses
+
+
+# ------------------------------------------------------------------ #
+# AUTO_SIGN config default
+# ------------------------------------------------------------------ #
+
+def test_auto_sign_config_defaults_on():
+    """AUTO_SIGN must default to ON (True) when not yet stored."""
+    cfg = FakeConfig()
+    auto_sign = BalConfig(cfg, "bal_auto_sign", True)
+    assert auto_sign.get() is True
+
+
+def test_auto_sign_config_can_be_disabled():
+    """Once turned off and persisted, AUTO_SIGN reads back as False."""
+    cfg = FakeConfig()
+    auto_sign = BalConfig(cfg, "bal_auto_sign", True)
+    auto_sign.set(False)
+    assert auto_sign.get() is False
+    # A fresh wrapper over the same config still sees the stored value.
+    assert BalConfig(cfg, "bal_auto_sign", True).get() is False
+
+
+# ------------------------------------------------------------------ #
+# Fix A - manual "next step" hint suppressed when AUTO_SIGN is ON
+# ------------------------------------------------------------------ #
+
+def _should_show_manual_hint(auto_sign_on):
+    """Reproduce the guard added at the top of _show_next_steps_hint().
+
+    Returns True when the manual Sign/Broadcast hint (and follow-up popup)
+    should be shown. With AUTO_SIGN ON the dialog has already signed and
+    broadcast, so the hint must be suppressed.
+    """
+    if auto_sign_on:
+        return False
+    return True
+
+
+def test_hint_suppressed_when_auto_sign_on():
+    assert _should_show_manual_hint(auto_sign_on=True) is False
+
+
+def test_hint_shown_when_auto_sign_off():
+    assert _should_show_manual_hint(auto_sign_on=False) is True
+
+
+# ------------------------------------------------------------------ #
+# Fix B - PUSHED transactions are not collected again (one-shot broadcast)
+# ------------------------------------------------------------------ #
+
+def test_pushed_tx_not_recollected():
+    """A VALID+COMPLETE+PUSHED will must NOT be collected for re-broadcast."""
+    we = {"url": "https://we.example", "selected": True}
+    will = {
+        "tx_done": FakeWillItem(
+            {"VALID", "COMPLETE", "PUSHED"}, dict(we)
+        ),
+    }
+    collected = Willexecutors.get_willexecutor_transactions(will)
+    # Nothing to send: the only will is already PUSHED.
+    assert collected == {}
+
+
+def test_unpushed_tx_is_collected():
+    """A VALID+COMPLETE but NOT-yet-PUSHED will IS collected for broadcast."""
+    we = {"url": "https://we.example", "selected": True}
+    will = {
+        "tx_new": FakeWillItem({"VALID", "COMPLETE"}, dict(we)),
+    }
+    collected = Willexecutors.get_willexecutor_transactions(will)
+    assert "https://we.example" in collected
+    assert "tx_new" in collected["https://we.example"]["txsids"]
+
+
+def test_mixed_only_unpushed_collected():
+    """With one PUSHED and one not-pushed will on different servers, only the
+    not-pushed one is collected (the successful one is never re-sent)."""
+    will = {
+        "tx_done": FakeWillItem(
+            {"VALID", "COMPLETE", "PUSHED"},
+            {"url": "https://ok.example", "selected": True},
+        ),
+        "tx_todo": FakeWillItem(
+            {"VALID", "COMPLETE"},
+            {"url": "https://todo.example", "selected": True},
+        ),
+    }
+    collected = Willexecutors.get_willexecutor_transactions(will)
+    assert "https://ok.example" not in collected
+    assert "https://todo.example" in collected