AaronFiore/electrum
1
0
Fork 0
Code Activity

wallet_db version 52: break non-homogeneous multisig wallets

Browse Source 
- case 1: in version 4.4.1, 4.4.2, the qml GUI wizard allowed creating multisig wallets with an old_mpk as cosigner.
- case 2: in version 4.4.0, 4.4.1, 4.4.2, the qml GUI wizard allowed creating multisig wallets with mixed xpub/Ypub/Zpub.

The corresponding missing input validation was a bug in the wizard, it was unintended behaviour. Validation was added in d2cf21fc2b. Note however that there might be users who created such wallet files.

Re case 1 wallet files: there is no version of Electrum that allows spending from such a wallet. Coins received at addresses are not burned, however it is technically challenging to spend them. (unless the multisig can spend without needing the old_mpk cosigner in the quorum).

Re case 2 wallet files: it is possible to create a corresponding spending wallet for such a multisig, however it is a bit tricky. The script type for the addresses in such a heterogeneous xpub wallet is based on the xpub_type of the first keystore. So e.g. given a wallet file [Yprv1, Zpub2] it will have sh(wsh()) scripts, and the cosigner should create a wallet file [Ypub1, Zprv2] (same order).

Technically case 2 wallet files could be "fixed" automatically by converting the xpub types as part of a wallet_db upgrade. However if the wallet files also contain seeds, those cannot be converted ("standard" vs "segwit" electrum seed).
Case 1 wallet files are not possible to "fix" automatically as the cosigner using the old_mpk is not bip32 based.

It is unclear if there are *any* users out there affected by this. I suspect for case 1 it is very likely there are none (not many people have pre-2.0 electrum seeds which were never supported as part of a multisig who would also now try to create a multisig using them); for case 2 however there might be.

This commit breaks both case 1 and case 2 wallets: these wallet files can no longer be opened in new Electrum, an error message is shown and the crash reporter opens. If any potential users opt to send crash reports, at least we will know they exist and can help them recover.
This commit is contained in:
SomberNight
2023-05-11 13:48:54 +00:00
parent d2cf21fc2b
commit 68fb996d20
7 changed files with 111 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
electrum/wallet_db.py
View File

@@ -57,7 +57,7 @@ if TYPE_CHECKING:
OLD_SEED_VERSION = 4 # electrum versions < 2.0
NEW_SEED_VERSION = 11 # electrum versions >= 2.0
FINAL_SEED_VERSION = 51 # electrum >= 2.7 will set this to prevent
FINAL_SEED_VERSION = 52 # electrum >= 2.7 will set this to prevent
# old versions from overwriting new format
@@ -81,6 +81,12 @@ class DBMetadata(StoredObject):
return f"using {ver}, on {date_str}"
# note: subclassing WalletFileException for some specific cases
# allows the crash reporter to distinguish them and open
# separate tracking issues
class WalletFileExceptionVersion51(WalletFileException): pass
class WalletDB(JsonDB):
def __init__(self, raw, *, manual_upgrades: bool):
@@ -220,6 +226,7 @@ class WalletDB(JsonDB):
self._convert_version_49()
self._convert_version_50()
self._convert_version_51()
self._convert_version_52()
self.put('seed_version', FINAL_SEED_VERSION) # just to be sure
self._after_upgrade_tasks()
@@ -1016,6 +1023,38 @@ class WalletDB(JsonDB):
item['payment_hash'] = payment_hash
self.data['seed_version'] = 51
def _detect_insane_version_51(self) -> int:
"""Returns 0 if file okay,
error code 1: multisig wallet has old_mpk
error code 2: multisig wallet has mixed Ypub/Zpub
"""
assert self.get('seed_version') == 51
xpub_type = None
for ks_name in ['x{}/'.format(i) for i in range(1, 16)]: # having any such field <=> multisig wallet
ks = self.data.get(ks_name, None)
if ks is None: continue
ks_type = ks.get('type')
if ks_type == "old":
return 1 # error
assert ks_type in ("bip32", "hardware"), f"unexpected {ks_type=}"
xpub = ks.get('xpub') or None
assert xpub is not None
assert isinstance(xpub, str)
if xpub_type is None: # first iter
xpub_type = xpub[0:4]
if xpub[0:4] != xpub_type:
return 2 # error
# looks okay
return 0
def _convert_version_52(self):
if not self._is_upgrade_method_needed(51, 51):
return
if (error_code := self._detect_insane_version_51()) != 0:
# should not get here; get_seed_version should have caught this
raise Exception(f'unsupported wallet file: version_51 with error {error_code}')
self.data['seed_version'] = 52
def _convert_imported(self):
if not self._is_upgrade_method_needed(0, 13):
return
@@ -1071,9 +1110,11 @@ class WalletDB(JsonDB):
raise WalletFileException('This version of Electrum is too old to open this wallet.\n'
'(highest supported storage version: {}, version of this file: {})'
.format(FINAL_SEED_VERSION, seed_version))
if seed_version==14 and self.get('seed_type') == 'segwit':
if seed_version == 14 and self.get('seed_type') == 'segwit':
self._raise_unsupported_version(seed_version)
if seed_version >=12:
if seed_version == 51 and self._detect_insane_version_51():
self._raise_unsupported_version(seed_version)
if seed_version >= 12:
return seed_version
if seed_version not in [OLD_SEED_VERSION, NEW_SEED_VERSION]:
self._raise_unsupported_version(seed_version)
@@ -1092,6 +1133,23 @@ class WalletDB(JsonDB):
else:
# creation was complete if electrum was run from source
msg += "\nPlease open this file with Electrum 1.9.8, and move your coins to a new wallet."
if seed_version == 51:
error_code = self._detect_insane_version_51()
assert error_code != 0
msg += f" ({error_code=})"
if error_code == 1:
msg += "\nThis is a multisig wallet containing an old_mpk (pre-bip32 master public key)."
msg += "\nPlease contact us to help recover it by opening an issue on GitHub."
elif error_code == 2:
msg += ("\nThis is a multisig wallet containing mixed xpub/Ypub/Zpub."
"\nThe script type is determined by the type of the first keystore."
"\nTo recover, you should re-create the wallet with matching type "
"(converted if needed) master keys."
"\nOr you can contact us to help recover it by opening an issue on GitHub.")
else:
raise Exception(f"unexpected {error_code=}")
raise WalletFileExceptionVersion51(msg, should_report_crash=True)
# generic exception
raise WalletFileException(msg)
def _add_db_creation_metadata(self):