qt: paytoedit: complete contacts to their key, not 'name <key>'
What changed, and why it matters
This commit fixes a bug in Electrum's Qt 'Send' tab where selecting a contact from the autocomplete dropdown could briefly leave the wrong recipient active. Previously, the payment field was set to a display name like 'Alice <alice@example.com>' for up to about one second, and during that window the 'Pay' button could still use the previous recipient. The patch makes the field immediately switch to the actual payment identifier (e.g. alice@example.com), pauses lookups while the dropdown is open, and disables Pay/Save/Max while the recipient text is being edited. It also fixes a related UI spinner that could keep spinning forever.
Treat this as a security-relevant bug fix and include it in the next release. Users should upgrade to a version containing this commit to avoid the risk of sending to a stale recipient after changing the pay-to field. No immediate incident response is required beyond normal patch deployment.
Security signals we found
UI state desynchronization between displayed recipient and active PaymentIdentifier
Stale PaymentIdentifier usable for ~1 second after recipient text changes
Pay/Save/Max buttons enabled while recipient is being edited
Contact completer inserting non-identifier display text into payment field
Race condition between edit timer and contact key resolution
Progress spinner not hidden on stale resolve / clear
Evidence from the diff
PayToEdit’s contact completer used to insert the display string ‘name
Changed components
electrum/gui/qt/paytoedit.pyelectrum/gui/qt/send_tab.pyQt Send tab recipient input / contact completerPaymentIdentifier resolution flowPay/Save/Max button enablement logicInspect captured patch +47 / −13
### electrum/gui/qt/paytoedit.py
@@ -26,14 +26,15 @@
from functools import partial
from typing import Optional, TYPE_CHECKING, Union
-from PyQt6.QtCore import Qt, QTimer, QSize, QStringListModel
+from PyQt6.QtCore import Qt, QTimer, QSize, QModelIndex
from PyQt6.QtCore import pyqtSignal
-from PyQt6.QtGui import QFontMetrics, QFont, QContextMenuEvent
+from PyQt6.QtGui import QFontMetrics, QFont, QContextMenuEvent, QStandardItem, QStandardItemModel
from PyQt6.QtWidgets import QTextEdit, QWidget, QLineEdit, QStackedLayout, QCompleter
from electrum.payment_identifier import PaymentIdentifier
from electrum.logging import Logger
-from electrum.util import EventListener, event_listener
+
+from electrum.gui.common_qt.util import QtEventListener, qt_event_listener
from . import util
from .util import MONOSPACE_FONT, GenericInputHandler, ColorScheme, add_input_actions_to_context_menu
@@ -95,7 +96,16 @@ def sizeHint(self) -> QSize:
return QSize(0, self.minimumHeight())
-class PayToEdit(QWidget, Logger, GenericInputHandler, EventListener):
+class ContactCompleter(QCompleter):
+ """Shows contacts as 'name <key>', but completes to the key, which is the payment identifier."""
+
+ ROLE_CONTACT_KEY = Qt.ItemDataRole.UserRole + 100
+
+ def pathFromIndex(self, index: QModelIndex) -> str:
+ return index.data(self.ROLE_CONTACT_KEY) # returns 'alice@example.com'
+
+
+class PayToEdit(QWidget, Logger, GenericInputHandler, QtEventListener):
paymentIdentifierChanged = pyqtSignal()
textChanged = pyqtSignal()
@@ -136,12 +146,11 @@ def line_edit_changed():
self.text_edit.textReallyChanged.connect(text_edit_changed)
self.text_edit.resized.connect(text_edit_resized)
- def on_completed(item: str):
- text = self._completer_contacts[1][self._completer_contacts[0].index(item)]
- self.try_payment_identifier(text)
+ def on_completed(key: str):
+ self.try_payment_identifier(key)
self.completer.popup().hide()
- self.completer = QCompleter()
+ self.completer = ContactCompleter()
self.completer.setCompletionMode(QCompleter.CompletionMode.PopupCompletion)
self.completer.setCaseSensitivity(Qt.CaseSensitivity.CaseInsensitive)
self.completer.setFilterMode(Qt.MatchFlag.MatchContains)
@@ -212,17 +221,18 @@ def custom_context_menu_event(self, e: 'QContextMenuEvent', *, tl_edit: Union[QT
add_input_actions_to_context_menu(self, m)
m.exec(e.globalPos())
- @event_listener
+ @qt_event_listener
def on_event_contacts_updated(self):
self.update_completer()
def update_completer(self):
- self._completer_contacts = [], []
+ model = QStandardItemModel()
for k, v in self.send_tab.wallet.contacts.items():
- self._completer_contacts[0].append(f'{v[1]} <{k}>')
- self._completer_contacts[1].append(k)
+ item = QStandardItem(f'{v[1]} <{k}>') # 'Alice <alice@example.com>'
+ item.setData(k, ContactCompleter.ROLE_CONTACT_KEY) # 'alice@example.com'
+ model.appendRow(item)
- self.completer.setModel(QStringListModel(self._completer_contacts[0]))
+ self.completer.setModel(model)
@property
def multiline(self):
@@ -326,6 +336,16 @@ def _handle_text_change(self) -> None:
# but a user friendly representation.
return
+ if self.payment_identifier and self.payment_identifier.text != self._text.strip():
+ # reset previous payment identifier so we don't pay a stale PI
+ self.payment_identifier = None
+ self.paymentIdentifierChanged.emit()
+
+ if self.completer.popup().isVisible():
+ # don't resolve/set pi while user is still picking the contact in the completer
+ self.edit_timer.start()
+ return
+
# pushback timer if timer active or PI needs resolving
pi = PaymentIdentifier(self.send_tab.wallet, self._text)
if not pi.is_valid() or pi.need_resolve() or self.edit_timer.isActive():
@@ -334,5 +354,9 @@ def _handle_text_change(self) -> None:
self.set_payment_identifier(self._text)
def _on_edit_timer(self) -> None:
+ if self.completer.popup().isVisible():
+ # user is still picking a contact in the completer
+ self.edit_timer.start() # loop so the PI gets taken once the completer closes
+ return
if not self.isFrozen():
self.set_payment_identifier(self._text)
### electrum/gui/qt/send_tab.py
@@ -365,6 +365,7 @@ def do_clear(self):
self.lock_fields(lock_recipient=False, lock_amount=False, lock_max=True, lock_description=False)
self.max_button.setChecked(False)
self.payto_e.do_clear()
+ self.spinner.setVisible(False)
for w in [self.comment_e, self.comment_label]:
w.setVisible(False)
for w in [self.message_e, self.amount_e, self.fiat_send_e, self.comment_e]:
@@ -412,6 +413,12 @@ def update_fields(self):
self.clear_button.setEnabled(True)
+ if pi is None: # the recipient is being edited, PayToEdit sets the payment identifier later
+ self.save_button.setEnabled(False)
+ self.send_button.setEnabled(False)
+ self.max_button.setEnabled(False)
+ return
+
if pi.is_multiline():
self.lock_fields(lock_recipient=False, lock_amount=True, lock_max=True, lock_description=False)
self.set_field_validated(self.payto_e, validated=pi.is_valid()) # TODO: validated used differently here than openalias
@@ -481,8 +488,11 @@ def _is_pi_usable(self, pi: 'PaymentIdentifier') -> bool:
return pi.is_valid() and not pi.is_error() and (self.wallet.has_lightning() or pi.is_onchain())
def _handle_payment_identifier(self):
+ self.spinner.setVisible(False) # resolve for previous PI is stale now
self.update_fields()
+ if self.payto_e.payment_identifier is None:
+ return
if not self.payto_e.payment_identifier.is_valid():
self.logger.debug(f'PI error: {self.payto_e.payment_identifier.error}')
returnWhy this scored 59/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.