swapserver: cli: skip pending swaps in history commands
What the developer wrote
Authored by f321x
swapserver: cli: skip pending swaps in history commands
skip pending swaps in the swapserver history/summary cli commands.
They are not relevant and don't contain all required informations yet.
Fixes https://github.com/spesmilo/electrum/issues/10521
Fixes https://github.com/spesmilo/electrum/issues/10525
```
File "/home/electrum/electrum-fork/electrum/daemon.py", line 268, in handle
response['result'] = await f(*params)
^^^^^^^^^^^^^^^^
File "/home/electrum/electrum-fork/electrum/daemon.py", line 381, in run_cmdline
result = await func(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/electrum/electrum-fork/electrum/commands.py", line 207, in func_wrapper
File "/home/electrum/electrum-fork/electrum/commands.py", line 2349, in func_wrapper
group = parser.add_argument_group('network options')
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/electrum/electrum-fork/electrum/plugins/swapserver/__init__.py", line 79, in get_summary
swap_history = await get_history(self)
^^^^^^^^^^^^^^^^^^^^^^^
File "/home/electrum/electrum-fork/electrum/commands.py", line 207, in func_wrapper
File "/home/electrum/electrum-fork/electrum/commands.py", line 2349, in func_wrapper
group = parser.add_argument_group('network options')
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/electrum/electrum-fork/electrum/plugins/swapserver/__init__.py", line 60, in get_history
'date': swap['date'].strftime("%Y-%m-%d"),
^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'strftime'
```
What changed, and why it matters
This commit fixes a crash in Electrum's swapserver plugin command-line tools. When users ran commands to view swap history or summary, the tool tried to format a missing date for swaps that were still pending, causing an error. The fix now skips pending swaps and only shows confirmed ones.
No urgent security action required. Treat as a routine bug-fix release item. Users running swapserver CLI history/summary commands should update to the fixed version to avoid crashes.
Security signals we found
Denial-of-service via unhandled exception in CLI command (non-privileged, user-triggered)
Missing null/pending-state validation before formatting output
Fix is a robustness/correctness change rather than an authentication or authorization bypass
Evidence from the diff
The patch modifies electrum/plugins/swapserver/init.py to filter out pending submarine swaps before generating history/summary output. Previously, get_history() collected all swap group IDs from swap_manager.get_groups_for_onchain_history(), which could include swaps whose spending_txid was None or unconfirmed. The code then looked up entries in wallet.get_full_history() and attempted swap[‘date’].strftime(…), but pending swaps have a None date, raising AttributeError. The new code iterates sm._swaps directly, skips entries with missing group_id, skips entries with no spending_txid or with spending_txid height <= TX_HEIGHT_UNCONFIRMED, and only includes confirmed swaps. Docstrings are updated to say ‘confirmed swaps’.
Changed components
electrum/plugins/swapserver/__init__.pyget_history CLI commandget_summary CLI commandInspect captured patch +15 / −6
diff --git a/electrum/plugins/swapserver/__init__.py b/electrum/plugins/swapserver/__init__.py
index d8b1934..a670417 100644
--- a/electrum/plugins/swapserver/__init__.py
+++ b/electrum/plugins/swapserver/__init__.py
@@ -2,6 +2,7 @@ from typing import TYPE_CHECKING, List
from electrum.simple_config import ConfigVar, SimpleConfig
from electrum.commands import plugin_command
+from electrum.address_synchronizer import TX_HEIGHT_UNCONFIRMED
if TYPE_CHECKING:
from electrum.commands import Commands
@@ -19,7 +20,7 @@ SimpleConfig.SWAPSERVER_ANN_POW_NONCE = ConfigVar('plugins.swapserver.ann_pow_no
@plugin_command('wl', plugin_name)
async def get_history(self: 'Commands', wallet: 'Abstract_Wallet' = None, plugin = None) -> List[dict]:
"""
- Get a list of all swaps provided by this swapserver.
+ Get a list of all confirmed swaps provided by this swapserver.
Single elements can potentially cover multiple swaps if transactions have been batched.
Example result:
@@ -42,12 +43,20 @@ async def get_history(self: 'Commands', wallet: 'Abstract_Wallet' = None, plugin
assert wallet.lnworker, "lightning not available"
assert wallet.lnworker.swap_manager, "swap manager not available"
- full_history = wallet.get_full_history()
- swap_group_ids = set(
- x['group_id'] for x in wallet.lnworker.swap_manager.get_groups_for_onchain_history().values()
- )
+ sm = wallet.lnworker.swap_manager
+ swap_group_ids = set()
+ for swap in sm._swaps.values():
+ group_id = swap.spending_txid if swap.is_reverse else swap.funding_txid
+ if group_id is None:
+ continue
+ if swap.spending_txid is None \
+ or wallet.adb.get_tx_height(swap.spending_txid).height() <= TX_HEIGHT_UNCONFIRMED:
+ # get only final swaps so the history is stable and doesn't include pending swaps
+ continue
+ swap_group_ids.add(group_id)
swap_history_items = []
+ full_history = wallet.get_full_history()
for swap_group_id in swap_group_ids:
if swap_history_item := full_history.get('group:' + swap_group_id):
swap_history_items.append(swap_history_item)
@@ -66,7 +75,7 @@ async def get_history(self: 'Commands', wallet: 'Abstract_Wallet' = None, plugin
@plugin_command('wl', plugin_name)
async def get_summary(self: 'Commands', wallet: 'Abstract_Wallet' = None, plugin = None) -> dict:
- """Get a summary of all swaps provided by this swapserver.
+ """Get a summary of all confirmed swaps provided by this swapserver.
Can become incorrect if closed lightning channels have been deleted in this wallet.
Example result:
Why this scored 22/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.