AaronFiore/electrum
1
0
Fork 0
Code Activity

wallet: set_frozen_state_of_coins to handle freeze=None

Browse Source 
Internally whether a coin is frozen is tri-state:
- forced-True, set by the user
- forced-False, set by the user
- unset/default: is_frozen_coin() can decide whether the coin should be frozen

This patch lets set_frozen_state_of_coins() undo a previous explicit setting of True/False,
by calling it with a value of None.
Note: there is still no way in the GUI to undo an explicit setting of True/False.
This commit is contained in:
SomberNight
2025-03-13 18:30:53 +00:00
parent 9351183876
commit 8ccd31fe49
2 changed files with 43 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
electrum/wallet.py
View File

@@ -2024,16 +2024,24 @@ class Abstract_Wallet(ABC, Logger, EventListener):
def set_frozen_state_of_coins( def set_frozen_state_of_coins(
self, self,
utxos: Iterable[str], utxos: Iterable[str],
freeze: bool, freeze: Optional[bool], # tri-state
*, *,
write_to_disk: bool = True, write_to_disk: bool = True,
) -> None: ) -> None:
"""Set frozen state of the utxos to FREEZE, True or False""" """Set frozen state of the utxos to `freeze`, True or False (or None).
A value of True/False means the user explicitly set if the coin should be frozen.
In contrast, None is the default "unset" state. If unset, is_frozen_coin()
can decide whether a coin should be frozen.
"""
# basic sanity check that input is not garbage: (see if raises) # basic sanity check that input is not garbage: (see if raises)
[TxOutpoint.from_str(utxo) for utxo in utxos] [TxOutpoint.from_str(utxo) for utxo in utxos]
assert freeze in (None, False, True), f"{freeze=!r}"
with self._freeze_lock: with self._freeze_lock:
for utxo in utxos: for utxo in utxos:
self._frozen_coins[utxo] = bool(freeze) if freeze is None:
self._frozen_coins.pop(utxo, None)
else:
self._frozen_coins[utxo] = bool(freeze)
util.trigger_callback('status') util.trigger_callback('status')
if write_to_disk: if write_to_disk:
self.save_db() self.save_db()

41
tests/test_wallet_vertical.py
View File

@@ -2895,16 +2895,39 @@ class TestWalletSending(ElectrumTestCase):
self.assertEqual( self.assertEqual(
{'52e669a20a26c8b3df5b41e5e6309b18bcde8e1ad7ea17a18f63b6dc6c8becc0:1'}, {'52e669a20a26c8b3df5b41e5e6309b18bcde8e1ad7ea17a18f63b6dc6c8becc0:1'},
{txi.prevout.to_str() for txi in wallet.get_spendable_coins(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"])}) {txi.prevout.to_str() for txi in wallet.get_spendable_coins(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"])})
utxo1 = "c36a6e1cd54df108e69574f70bc9b88dc13beddc70cfad9feb7f8f6593255d4a:1"
utxo2 = "52e669a20a26c8b3df5b41e5e6309b18bcde8e1ad7ea17a18f63b6dc6c8becc0:1"
# test freezing an address # test freezing an address
wallet.set_frozen_state_of_addresses(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"], freeze=True) with self.subTest(msg="freeze_address"):
self.assertEqual( wallet.set_frozen_state_of_addresses(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"], freeze=True)
{'c36a6e1cd54df108e69574f70bc9b88dc13beddc70cfad9feb7f8f6593255d4a:1'}, self.assertEqual(
{txi.prevout.to_str() for txi in wallet.get_spendable_coins()}) {utxo1},
wallet.set_frozen_state_of_addresses(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"], freeze=False) {txi.prevout.to_str() for txi in wallet.get_spendable_coins()})
self.assertEqual( wallet.set_frozen_state_of_addresses(["tb1q6n99dl96mx8mfh90m3tn5awk5mllkzdh25dw7z"], freeze=False)
{'c36a6e1cd54df108e69574f70bc9b88dc13beddc70cfad9feb7f8f6593255d4a:1', self.assertEqual(
'52e669a20a26c8b3df5b41e5e6309b18bcde8e1ad7ea17a18f63b6dc6c8becc0:1'}, {utxo1, utxo2},
{txi.prevout.to_str() for txi in wallet.get_spendable_coins()}) {txi.prevout.to_str() for txi in wallet.get_spendable_coins()})
# test freezing a utxo
with self.subTest(msg="freeze_coin"):
self.assertTrue(utxo1 not in wallet._frozen_coins)
wallet.set_frozen_state_of_coins([utxo1], freeze=True)
self.assertEqual(wallet._frozen_coins.get(utxo1), True)
self.assertEqual(
{utxo2},
{txi.prevout.to_str() for txi in wallet.get_spendable_coins()})
wallet.set_frozen_state_of_coins([utxo1], freeze=False)
self.assertEqual(wallet._frozen_coins.get(utxo1), False)
self.assertEqual(
{utxo1, utxo2},
{txi.prevout.to_str() for txi in wallet.get_spendable_coins()})
wallet.set_frozen_state_of_coins([utxo1], freeze=None)
self.assertTrue(utxo1 not in wallet._frozen_coins)
@mock.patch.object(wallet.Abstract_Wallet, 'save_db') @mock.patch.object(wallet.Abstract_Wallet, 'save_db')
async def test_export_psbt_with_xpubs__multisig(self, mock_save_db): async def test_export_psbt_with_xpubs__multisig(self, mock_save_db):