SAFE21.io/bal-electrum-plugin
1
0
Fork 0
forked from bitcoinafterlife/bal-electrum-plugin
Code Pull Requests Activity

feat(bal): UI batch v0.3.9 + expired-will invalidate regression fix

Browse Source 
UI batch (TASK A/B/C/D):
- (A) Clearer 'Will expired' message: shortened will id (8+8 chars) and
  readable UTC date instead of raw UNIX timestamp; shown in WARNING colour
  (orange) instead of ERROR (red) in the wizard, as it is an expected step.
- (A2) Split the orange message onto two lines via <br> (rendered as HTML by
  msg_warning) to avoid an overly long single line.
- (B) History tab labels (text only): inheritance txs -> 'BAL Inheritance
  transaction'; invalidate tx -> 'BAL Invalidate transaction'. Colours left
  to Electrum defaults.
- (C) New 'No will-executor TX' checkbox in plugin settings, bound to the
  existing NO_WILLEXECUTOR config (default ON, kept in sync with the wizard),
  with help text, and included in the settings reset action.
- (D) Wizard button label 'Create your will' -> 'Build Your Will'.

Regression fix (A3):
- When an heir was added to an already-expired will via the wizard, the
  automatic invalidation no longer triggered. Root cause: the inner
  check_will() after build_will() raised WillExpiredException and the handler
  returned (False, None), which never invalidated.
- Auto-opening the invalidation tx window from the closing wizard proved
  unreliable (the window ended up behind the main wallet on some window
  managers; a re-check loop could ask to invalidate repeatedly before the tx
  reached the mempool). The robust fix: close the wizard and show a clear
  instruction popup guiding the user to run 'Tools -> Invalidate' and then
  press 'Check' to finish the will. Reasoning documented in the code.

Version bumped to 0.3.9 (manifest.json, __init__.py, plugin_base.py, VERSION).
CHANGELOG entry #15 updated. Verified: py_compile OK, ruff clean (no new
errors), full test suite 239 passed.
This commit is contained in:
donkey-ai
2026-06-28 23:02:11 -04:00
parent ce3a463a5e
commit 5b707e647b
10 changed files with 249 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
CHANGELOG.md
View File

@@ -784,3 +784,72 @@ the DATA mode and the RAW mode, while keeping the **CHECK ALIVE** title in bold.
**Outcome:** DONE (delivered as a test ZIP v0.3.8 for the user to try before
commit).
## 15. UI batch (v0.3.9): clearer "will expired" message, History labels, settings checkbox, wizard button
**Context:** A batch of four small UI improvements requested by the user
(internally tracked as TASK A/B/C/D).
**Changes:**
- **(A) "Will expired" message — clearer and not alarming.** Rewrote the message
raised by `Will.check_will_expired()` (`bal/core/will.py`): the will id is now
shortened (first 8 + last 8 chars, e.g. `9f1b0a75…fed9ae1b`) and the locktime
is shown as a readable UTC date (e.g. `2026-06-22 11:00 UTC`) instead of a raw
UNIX timestamp, with an explanation that the will will be invalidated and
re-signed. Two small helpers were added (`_short_will_id`, `_format_locktime`)
and `datetime`/`timezone` are now imported at module top. In the "Build your
will" wizard (`bal/gui/qt/dialogs.py`) an expired will is now shown in the
WARNING colour (orange) instead of the ERROR colour (red), because it is an
expected part of the flow, not an error.
- **(B) History tab labels (text only).** Renamed the labels written to
Electrum's History tab: inheritance transactions now read
`BAL Inheritance transaction` (was `BAL Transaction`, updated in both
`dialogs.py` and `window.py`) and the invalidate transaction now reads
`BAL Invalidate transaction` (was `BAL Invalidate`, in `window.py`). Colours
are left to Electrum's defaults (outgoing transactions are shown in red by
Electrum itself) to keep the change simple and robust.
- **(C) "No will-executor TX" checkbox in plugin settings.** Added a checkbox to
the settings dialog (`bal/gui/qt/plugin.py`) bound to the existing
`NO_WILLEXECUTOR` config (default ON), the same config used by the wizard's
will-executor download window, so the two stay in sync. Its help button reads:
"Create a will that does not require a Will-executor; it can be saved, for
example, on a USB stick, and a copy can be given to the heirs." It is also
included in the "Reset setting" action so a reset restores it to ON.
- **(D) Wizard button label.** The main wizard button now reads `Build Your Will`
(was `Create your will`, `bal/gui/qt/lists.py`), matching the tooltip and the
rest of the codebase which already call it the "Build your will" wizard.
- **(A2) Two-line expired message.** Following user feedback that the orange
message was too long on a single line, a `<br>` line break was added in
`Will.check_will_expired()` so the second sentence ("too late to anticipate,
the will will be invalidated and re-signed.") is shown on its own line. The
message is rendered as HTML by `msg_warning()`, so the `<br>` tag is honoured.
- **(A3) Auto-invalidate regression fix when adding an heir to an expired will.**
While verifying TASK A a regression was found: when an heir was added to an
already-expired will through the wizard, the automatic invalidation window no
longer opened (the user had to restart Electrum or press Check). Root cause:
in `dialogs.py::task_phase1`, adding an heir first raises
`HeirNotFoundException` (so the will is rebuilt by `build_will()`), and the
freshly rebuilt transactions are themselves expired, raising
`WillExpiredException` on the INNER `check_will()`. The original handler there
did `return False, None`, which never triggered invalidation. The fix makes
the wizard, in that case, behave exactly like the "Tools -> Invalidate" menu:
instead of trying to auto-open the invalidation transaction window (which
proved unreliable — depending on the OS window manager the transaction window
ended up BEHIND the main wallet window when the wizard closed, and an
automatic re-check loop could ask to invalidate repeatedly before the
invalidation tx reached the mempool), the wizard now closes and shows a clear
instruction popup telling the user to run `Tools -> Invalidate` themselves and
then press `Check`. That menu path is already known to work perfectly (its
transaction window stays in front and sets the `BAL Invalidate transaction`
history label) and it makes the user consciously aware of this deliberate,
important action. The reasoning behind this choice is documented in the code.
**Verification:**
- `py_compile` on all changed files: OK.
- `ruff check`: no new errors (only the pre-existing star-import noise and
pre-existing F841 warnings, none in the changed lines).
- Full test suite: `239 passed`.
**Outcome:** DONE (delivered as test ZIP v0.3.9, confirmed OK by the user before
commit).