1
0
Files
electrum/electrum/gui/qt/wizard/wallet.py
2025-05-26 10:35:41 +02:00

1525 lines
61 KiB
Python

from abc import ABC
import os
import sys
import threading
from typing import TYPE_CHECKING, Optional, List, Tuple
from PyQt6.QtCore import Qt, QTimer, QRect, pyqtSignal
from PyQt6.QtGui import QPen, QPainter, QPalette, QPixmap
from PyQt6.QtWidgets import (QVBoxLayout, QHBoxLayout, QLabel, QLineEdit, QPushButton, QWidget,
QFileDialog, QSlider, QGridLayout, QDialog, QApplication)
from electrum.bip32 import is_bip32_derivation, BIP32Node, normalize_bip32_derivation, xpub_type
from electrum.daemon import Daemon
from electrum.i18n import _
from electrum.keystore import bip44_derivation, bip39_to_seed, purpose48_derivation, ScriptTypeNotSupported
from electrum.plugin import run_hook, HardwarePluginLibraryUnavailable
from electrum.storage import StorageReadWriteError
from electrum.util import WalletFileException, get_new_wallet_name, UserFacingException, InvalidPassword
from electrum.util import is_subpath, ChoiceItem, multisig_type
from electrum.wallet import wallet_types
from .wizard import QEAbstractWizard, WizardComponent
from electrum.logging import get_logger, Logger
from electrum import WalletStorage, mnemonic, keystore
from electrum.wallet_db import WalletDB
from electrum.wizard import NewWalletWizard, KeystoreWizard
from electrum.gui.qt.bip39_recovery_dialog import Bip39RecoveryDialog
from electrum.gui.qt.password_dialog import PasswordLayout, PW_NEW, MSG_ENTER_PASSWORD, PasswordLayoutForHW
from electrum.gui.qt.seed_dialog import SeedWidget, MSG_PASSPHRASE_WARN_ISSUE4566, KeysWidget
from electrum.gui.qt.util import (PasswordLineEdit, char_width_in_lineedit, WWLabel, InfoButton, font_height,
ChoiceWidget, MessageBoxMixin, icon_path, IconLabel, read_QIcon)
from electrum.gui.qt.plugins_dialog import PluginsDialog
if TYPE_CHECKING:
from electrum.simple_config import SimpleConfig
from electrum.plugin import Plugins, DeviceInfo
from electrum.gui.qt import QElectrumApplication
WIF_HELP_TEXT = (_('WIF keys are typed in Electrum, based on script type.') + '\n\n' +
_('A few examples') + ':\n' +
'p2pkh:KxZcY47uGp9a... \t-> 1DckmggQM...\n' +
'p2wpkh-p2sh:KxZcY47uGp9a... \t-> 3NhNeZQXF...\n' +
'p2wpkh:KxZcY47uGp9a... \t-> bc1q3fjfk...')
MSG_HW_STORAGE_ENCRYPTION = _("Set wallet file encryption.") + '\n'\
+ _("Your wallet file does not contain secrets, mostly just metadata. ") \
+ _("It also contains your master public key that allows watching your addresses.")
class QEKeystoreWizard(KeystoreWizard, QEAbstractWizard, MessageBoxMixin):
_logger = get_logger(__name__)
def __init__(self, config: 'SimpleConfig', wallet_type: str, app: 'QElectrumApplication', plugins: 'Plugins', *, start_viewstate=None):
KeystoreWizard.__init__(self, plugins)
QEAbstractWizard.__init__(self, config, app, start_viewstate=start_viewstate)
self._wallet_type = wallet_type
self.window_title = _('Extend wallet keystore')
# attach gui classes to views
self.navmap_merge({
'keystore_type': {'gui': WCExtendKeystore},
'enter_seed': {'gui': WCHaveSeed},
'enter_ext': {'gui': WCEnterExt},
'choose_hardware_device': {'gui': WCChooseHWDevice},
'script_and_derivation': {'gui': WCScriptAndDerivation},
'wallet_password': {'gui': WCWalletPassword},
'wallet_password_hardware': {'gui': WCWalletPasswordHardware},
})
def is_single_password(self):
return True
def run(self):
if self.exec() == QDialog.DialogCode.Rejected:
return
return self._result
class QENewWalletWizard(NewWalletWizard, QEAbstractWizard, MessageBoxMixin):
_logger = get_logger(__name__)
def __init__(self, config: 'SimpleConfig', app: 'QElectrumApplication', plugins: 'Plugins', daemon: Daemon, path, *, start_viewstate=None):
NewWalletWizard.__init__(self, daemon, plugins)
QEAbstractWizard.__init__(self, config, app, start_viewstate=start_viewstate)
self.window_title = _('Create/Restore wallet')
self._path = path
self._password = None
# attach gui classes to views
self.navmap_merge({
'wallet_name': {'gui': WCWalletName},
'wallet_type': {'gui': WCWalletType},
'keystore_type': {'gui': WCKeystoreType},
'create_seed': {'gui': WCCreateSeed},
'confirm_seed': {'gui': WCConfirmSeed},
'have_seed': {'gui': WCHaveSeed},
'choose_hardware_device': {'gui': WCChooseHWDevice},
'script_and_derivation': {'gui': WCScriptAndDerivation},
'have_master_key': {'gui': WCHaveMasterKey},
'multisig': {'gui': WCMultisig},
'multisig_cosigner_keystore': {'gui': WCCosignerKeystore},
'multisig_cosigner_key': {'gui': WCHaveMasterKey},
'multisig_cosigner_seed': {'gui': WCHaveSeed},
'multisig_cosigner_hardware': {'gui': WCChooseHWDevice},
'multisig_cosigner_script_and_derivation': {'gui': WCScriptAndDerivation},
'imported': {'gui': WCImport},
'wallet_password': {'gui': WCWalletPassword},
'wallet_password_hardware': {'gui': WCWalletPasswordHardware}
})
# add open existing wallet from wizard, incl hw unlock
self.navmap_merge({
'wallet_name': {
'next': lambda d: 'hw_unlock' if d['wallet_needs_hw_unlock'] else 'wallet_type',
'last': lambda d: d['wallet_exists'] and not d['wallet_needs_hw_unlock']
},
'hw_unlock': {
'gui': WCChooseHWDevice,
'next': lambda d: self.on_hardware_device(d, new_wallet=False)
}
})
# insert seed extension entry/confirm as separate views
self.navmap_merge({
'create_seed': {
'next': lambda d: 'create_ext' if self.wants_ext(d) else 'confirm_seed'
},
'create_ext': {
'next': 'confirm_seed',
'gui': WCEnterExt
},
'confirm_seed': {
'next': lambda d: 'confirm_ext' if self.wants_ext(d) else self.on_have_or_confirm_seed(d),
'accept': lambda d: None if self.wants_ext(d) else self.maybe_master_pubkey(d)
},
'confirm_ext': {
'next': self.on_have_or_confirm_seed,
'accept': self.maybe_master_pubkey,
'gui': WCConfirmExt
},
'have_seed': {
'next': lambda d: 'have_ext' if self.wants_ext(d) else self.on_have_or_confirm_seed(d),
'accept': lambda d: None if self.wants_ext(d) else self.maybe_master_pubkey(d),
'last': lambda d: self.is_single_password() and not
(self.needs_derivation_path(d) or self.is_multisig(d) or self.wants_ext(d))
},
'have_ext': {
'next': self.on_have_or_confirm_seed,
'accept': self.maybe_master_pubkey,
'gui': WCEnterExt
},
'multisig_cosigner_seed': {
'next': lambda d: 'multisig_cosigner_have_ext' if self.wants_ext(d) else self.on_have_cosigner_seed(d),
'last': lambda d: self.is_single_password() and self.last_cosigner(d) and not
(self.needs_derivation_path(d) or self.wants_ext(d))
},
'multisig_cosigner_have_ext': {
'next': self.on_have_cosigner_seed,
'last': lambda d: self.is_single_password() and self.last_cosigner(d) and not self.needs_derivation_path(d),
'gui': WCEnterExt
},
})
run_hook('init_wallet_wizard', self)
@property
def path(self):
return self._path
@path.setter
def path(self, path):
self._path = path
def is_single_password(self):
# not supported on desktop
return False
def create_storage(self, single_password: str = None):
self._logger.info('Creating wallet from wizard data')
data = self.get_wizard_data()
path = os.path.join(os.path.dirname(self._daemon.config.get_wallet_path()), data['wallet_name'])
super().create_storage(path, data)
# minimally populate self after create
self._password = data['password']
self.path = path
def run_split(self, wallet_path, split_data) -> None:
msg = _(
"The wallet '{}' contains multiple accounts, which are no longer supported since Electrum 2.7.\n\n"
"Do you want to split your wallet into multiple files?").format(wallet_path)
if self.question(msg):
file_list = WalletDB.split_accounts(wallet_path, split_data)
msg = _('Your accounts have been moved to') + ':\n' + '\n'.join(file_list) + '\n\n' + _(
'Do you want to delete the old file') + ':\n' + wallet_path
if self.question(msg):
os.remove(wallet_path)
self.show_warning(_('The file was removed'))
def is_finalized(self, wizard_data: dict) -> bool:
# check decryption of existing wallet and keep wizard open if incorrect.
if not wizard_data['wallet_exists'] or wizard_data['wallet_is_open']:
return True
wallet_file = wizard_data['wallet_name']
storage = WalletStorage(wallet_file)
assert storage.file_exists(), f"file {wallet_file!r} does not exist"
if not storage.is_encrypted_with_user_pw() and not storage.is_encrypted_with_hw_device():
return True
try:
storage.decrypt(wizard_data['password'])
except InvalidPassword:
if storage.is_encrypted_with_hw_device():
self.show_message('This hardware device could not decrypt this wallet. Is it the correct one?')
else:
self.show_message('Invalid password')
return False
return True
def waiting_dialog(self, task, msg, on_finished=None):
dialog = QDialog()
label = WWLabel(msg)
vbox = QVBoxLayout()
vbox.addSpacing(100)
label.setMinimumWidth(300)
label.setAlignment(Qt.AlignmentFlag.AlignCenter)
vbox.addWidget(label)
vbox.addSpacing(100)
dialog.setLayout(vbox)
dialog.setModal(True)
exc = None
def task_wrap(_task):
nonlocal exc
try:
_task()
except Exception as e:
exc = e
t = threading.Thread(target=task_wrap, args=(task,))
t.start()
dialog.show()
while True:
QApplication.processEvents()
t.join(1.0/60)
if not t.is_alive():
break
dialog.close()
if exc:
raise exc
if on_finished:
on_finished()
class WalletWizardComponent(WizardComponent, ABC):
# ^ this class only exists to help with typing
wizard: QENewWalletWizard
def __init__(self, parent: QWidget, wizard: QENewWalletWizard, **kwargs):
WizardComponent.__init__(self, parent, wizard, **kwargs)
class WCWalletName(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Electrum wallet'))
Logger.__init__(self)
path = wizard._path
if os.path.isdir(path):
raise Exception("wallet path cannot point to a directory")
self.wallet_exists = False
self.wallet_is_open = False
self.wallet_needs_hw_unlock = False
hbox = QHBoxLayout()
hbox.addWidget(QLabel(_('Wallet') + ':'))
self.name_e = QLineEdit()
hbox.addWidget(self.name_e)
button = QPushButton(_('Choose...'))
button_create_new = QPushButton(_('New'))
hbox.addWidget(button)
hbox.addWidget(button_create_new)
self.layout().addLayout(hbox)
outside_label = WWLabel('')
self.layout().addWidget(outside_label)
self.layout().addSpacing(50)
msg_label = WWLabel('')
self.layout().addWidget(msg_label)
hbox2 = QHBoxLayout()
self.pw_e = PasswordLineEdit('', self)
self.pw_e.setFixedWidth(17 * char_width_in_lineedit())
pw_label = QLabel(_('Password') + ':')
hbox2.addWidget(pw_label)
hbox2.addWidget(self.pw_e)
hbox2.addStretch()
self.layout().addLayout(hbox2)
self.layout().addStretch(1)
temp_storage = None # type: Optional[WalletStorage]
datadir_wallet_folder = self.wizard.config.get_datadir_wallet_path()
def relative_path(path):
new_path = path
try:
if is_subpath(path, datadir_wallet_folder):
# below datadir_wallet_path, make relative
commonpath = os.path.commonpath([path, datadir_wallet_folder])
new_path = os.path.relpath(path, commonpath)
except ValueError:
pass
return new_path
def on_choose():
_path, __ = QFileDialog.getOpenFileName(self, "Select your wallet file", datadir_wallet_folder)
if _path:
self.name_e.setText(relative_path(_path))
def on_filename(filename):
# FIXME? "filename" might contain ".." (etc) and hence sketchy path traversals are possible
nonlocal temp_storage
temp_storage = None
msg = None
self.wallet_exists = False
self.wallet_is_open = False
self.wallet_needs_hw_unlock = False
if filename:
_path = os.path.join(datadir_wallet_folder, filename)
wallet_from_memory = self.wizard._daemon.get_wallet(_path)
try:
if wallet_from_memory:
temp_storage = wallet_from_memory.storage # type: Optional[WalletStorage]
self.wallet_is_open = True
else:
temp_storage = WalletStorage(_path)
self.wallet_exists = temp_storage.file_exists()
except (StorageReadWriteError, WalletFileException) as e:
msg = _('Cannot read file') + f'\n{repr(e)}'
except Exception as e:
self.logger.exception('')
msg = _('Cannot read file') + f'\n{repr(e)}'
else:
msg = ""
self.valid = temp_storage is not None
user_needs_to_enter_password = False
if temp_storage:
if not temp_storage.file_exists():
msg = _("This file does not exist.") + '\n' \
+ _("Press 'Next' to create this wallet, or choose another file.")
elif not wallet_from_memory:
if temp_storage.is_encrypted_with_user_pw():
msg = _("This file is encrypted with a password.")
user_needs_to_enter_password = True
elif temp_storage.is_encrypted_with_hw_device():
msg = _("This file is encrypted using a hardware device.") + '\n' \
+ _("Press 'Next' to choose device to decrypt.")
self.wallet_needs_hw_unlock = True
else:
msg = _("Press 'Finish' to open this wallet.")
else:
msg = _("This file is already open in memory.") + "\n" \
+ _("Press 'Finish' to create/focus window.")
if msg is None:
msg = _('Cannot read file')
if filename and os.path.isabs(relative_path(_path)):
outside_text = _('Note: this wallet file is outside the default wallets folder.')
else:
outside_text = ''
outside_label.setText(outside_text)
msg_label.setText(msg)
if user_needs_to_enter_password:
pw_label.show()
self.pw_e.show()
if not self.name_e.hasFocus():
self.pw_e.setFocus()
else:
pw_label.hide()
self.pw_e.hide()
self.on_updated()
button.clicked.connect(on_choose)
button_create_new.clicked.connect(
lambda: self.name_e.setText(get_new_wallet_name(datadir_wallet_folder))) # FIXME get_new_wallet_name might raise
self.name_e.textChanged.connect(on_filename)
self.name_e.setText(relative_path(path))
def initialFocus(self) -> Optional[QWidget]:
return self.pw_e
def apply(self):
if self.wallet_exists:
# use full path
wallet_folder = self.wizard.config.get_datadir_wallet_path()
self.wizard_data['wallet_name'] = os.path.join(wallet_folder, self.name_e.text())
else:
# FIXME: wizard_data['wallet_name'] is sometimes a full path, sometimes a basename
self.wizard_data['wallet_name'] = self.name_e.text()
self.wizard_data['wallet_exists'] = self.wallet_exists
self.wizard_data['wallet_is_open'] = self.wallet_is_open
self.wizard_data['password'] = self.pw_e.text()
self.wizard_data['wallet_needs_hw_unlock'] = self.wallet_needs_hw_unlock
class WCWalletType(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Create new wallet'))
message = _('What kind of wallet do you want to create?')
wallet_kinds = [
ChoiceItem(key='standard', label=_('Standard wallet')),
ChoiceItem(key='2fa', label=_('Wallet with two-factor authentication')),
ChoiceItem(key='multisig', label=_('Multi-signature wallet')),
ChoiceItem(key='imported', label=_('Import Bitcoin addresses or private keys')),
]
choices = [c for c in wallet_kinds if c.key in wallet_types]
self.choice_w = ChoiceWidget(message=message, choices=choices, default_key='standard')
self.layout().addWidget(self.choice_w)
self.layout().addStretch(1)
self._valid = True
def apply(self):
self.wizard_data['wallet_type'] = self.choice_w.selected_key
class WCKeystoreType(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Keystore'))
message = _('Do you want to create a new seed, or to restore a wallet using an existing seed?')
choices = [
ChoiceItem(key='createseed', label=_('Create a new seed')),
ChoiceItem(key='haveseed', label=_('I already have a seed')),
ChoiceItem(key='masterkey', label=_('Use a master key')),
ChoiceItem(key='hardware', label=_('Use a hardware device')),
]
self.choice_w = ChoiceWidget(message=message, choices=choices)
self.layout().addWidget(self.choice_w)
self.layout().addStretch(1)
self._valid = True
def apply(self):
self.wizard_data['keystore_type'] = self.choice_w.selected_key
class WCExtendKeystore(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Keystore'))
message = _('What type of signing method do you want to add?')
choices = [
ChoiceItem(key='haveseed', label=_('Enter seed')),
ChoiceItem(key='hardware', label=_('Use a hardware device')),
]
self.choice_w = ChoiceWidget(message=message, choices=choices)
self.layout().addWidget(self.choice_w)
self.layout().addStretch(1)
self._valid = True
self.wizard_data['wallet_type'] = self._wallet_type = wizard._wallet_type
def apply(self):
self.wizard_data['wallet_type'] = self._wallet_type
self.wizard_data['keystore_type'] = self.choice_w.selected_key
if multisig_type(self._wallet_type):
self.wizard_data['wallet_type'] = self._wallet_type = 'multisig'
self.wizard_data['multisig_participants'] = 2
self.wizard_data['multisig_signatures'] = 2
self.wizard_data['multisig_cosigner_data'] = {}
class WCCreateSeed(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Wallet Seed'))
self._busy = True
self.seed_type = 'standard' if self.wizard.config.WIZARD_DONT_CREATE_SEGWIT else 'segwit'
self.seed_widget = None
self.seed = None
def on_ready(self):
if self.wizard_data['wallet_type'] == '2fa':
self.seed_type = '2fa_segwit'
QTimer.singleShot(1, self.create_seed)
def apply(self):
if self.seed_widget:
self.wizard_data['seed'] = self.seed
self.wizard_data['seed_type'] = self.seed_type
self.wizard_data['seed_extend'] = self.seed_widget.is_ext
self.wizard_data['seed_variant'] = 'electrum'
def create_seed(self):
self.busy = True
self.seed = mnemonic.Mnemonic('en').make_seed(seed_type=self.seed_type)
self.seed_widget = SeedWidget(
title=_('Your wallet generation seed is:'),
seed=self.seed,
options=['ext', 'electrum'],
msg=True,
parent=self,
config=self.wizard.config,
)
self.layout().addWidget(self.seed_widget)
self.layout().addStretch(1)
self.busy = False
self.valid = True
class WCConfirmSeed(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Confirm Seed'))
message = ' '.join([
_('Your seed is important!'),
_('If you lose your seed, your money will be permanently lost.'),
_('To make sure that you have properly saved your seed, please retype it here.')
])
self.layout().addWidget(WWLabel(message))
self.seed_widget = SeedWidget(
is_seed=lambda x: x == self.wizard_data['seed'],
config=self.wizard.config,
)
def seed_valid_changed(valid):
self.valid = valid
self.seed_widget.validChanged.connect(seed_valid_changed)
self.layout().addWidget(self.seed_widget)
wizard.app.clipboard().clear()
def apply(self):
pass
class WCEnterExt(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Seed Extension'))
Logger.__init__(self)
message = '\n'.join([
_('You may extend your seed with custom words.'),
_('Your seed extension must be saved together with your seed.'),
])
warning = '\n'.join([
_('Note that this is NOT your encryption password.'),
_('If you do not know what this is, leave this field empty.'),
])
self.ext_edit = SeedExtensionEdit(self, message=message, warning=warning)
self.ext_edit.textEdited.connect(self.on_text_edited)
self.layout().addWidget(self.ext_edit)
self.layout().addStretch(1)
self.warn_label = IconLabel(reverse=True, hide_if_empty=True)
self.warn_label.setIcon(read_QIcon('warning.png'))
self.layout().addWidget(self.warn_label)
def on_ready(self):
self.validate()
def on_text_edited(self, text):
# TODO also for cosigners?
self.ext_edit.warn_issue4566 = self.wizard_data['keystore_type'] == 'haveseed' and \
self.wizard_data['seed_type'] == 'bip39'
self.validate()
def validate(self):
self.apply()
musig_valid, errortext = self.wizard.check_multisig_constraints(self.wizard_data)
self.valid = musig_valid
self.warn_label.setText(errortext)
def apply(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
cosigner_data['seed_extra_words'] = self.ext_edit.text()
class WCConfirmExt(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Confirm Seed Extension'))
message = '\n'.join([
_('Your seed extension must be saved together with your seed.'),
_('Please type it here.'),
])
self.ext_edit = SeedExtensionEdit(self, message=message)
self.ext_edit.textEdited.connect(self.on_text_edited)
self.layout().addWidget(self.ext_edit)
self.layout().addStretch(1)
def on_ready(self):
self.validate()
def on_text_edited(self, *args):
self.validate()
def validate(self):
self.valid = self.ext_edit.text() == self.wizard_data['seed_extra_words']
def apply(self):
pass
class WCHaveSeed(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Enter Seed'))
Logger.__init__(self)
self.layout().addWidget(WWLabel(_('Please enter your seed phrase in order to restore your wallet.')))
self.warn_label = IconLabel(reverse=True, hide_if_empty=True)
self.warn_label.setIcon(read_QIcon('warning.png'))
self.seed_widget = None
self.can_passphrase = True
def on_ready(self):
options = ['ext', 'electrum', 'bip39', 'slip39']
if self.wizard_data['wallet_type'] == '2fa':
options = ['ext', 'electrum']
else:
if self.params and 'seed_options' in self.params:
options = self.params['seed_options']
self.seed_widget = SeedWidget(
is_seed=self.is_seed,
options=options,
config=self.wizard.config,
)
def seed_valid_changed(valid):
if not valid:
self.valid = valid
else:
self.validate()
self.seed_widget.validChanged.connect(seed_valid_changed)
self.seed_widget.updated.connect(self.validate)
self.layout().addWidget(self.seed_widget)
self.layout().addStretch(1)
self.layout().addWidget(self.warn_label)
def is_seed(self, x):
# really only used for electrum seeds. bip39 and slip39 are validated in SeedWidget
t = mnemonic.calc_seed_type(x)
if self.wizard_data['wallet_type'] == 'standard':
return mnemonic.is_seed(x) and not mnemonic.is_any_2fa_seed_type(t)
elif self.wizard_data['wallet_type'] == '2fa':
return mnemonic.is_any_2fa_seed_type(t)
else:
# multisig? by default, only accept modern non-2fa electrum seeds
return t in ['standard', 'segwit']
def validate(self):
# precond: only call when SeedWidget deems seed a valid seed
seed = self.seed_widget.get_seed()
seed_variant = self.seed_widget.seed_type
wallet_type = self.wizard_data['wallet_type']
seed_valid, seed_type, validation_message, self.can_passphrase = self.wizard.validate_seed(seed, seed_variant, wallet_type)
is_cosigner = self.wizard_data['wallet_type'] == 'multisig' and 'multisig_current_cosigner' in self.wizard_data
if not is_cosigner or not seed_valid:
self.valid = seed_valid
return
self.apply()
musig_valid, errortext = self.wizard.check_multisig_constraints(self.wizard_data)
if not musig_valid:
seed_valid = False
self.warn_label.setText(errortext)
self.valid = seed_valid
def apply(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
cosigner_data['seed'] = self.seed_widget.get_seed()
cosigner_data['seed_variant'] = self.seed_widget.seed_type
if self.seed_widget.seed_type == 'electrum':
cosigner_data['seed_type'] = mnemonic.calc_seed_type(self.seed_widget.get_seed())
else:
cosigner_data['seed_type'] = self.seed_widget.seed_type
cosigner_data['seed_extend'] = self.seed_widget.is_ext if self.can_passphrase else False
class WCScriptAndDerivation(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Script type and Derivation path'))
Logger.__init__(self)
self.choice_w = None # type: ChoiceWidget
self.derivation_path_edit = None
self.warn_label = IconLabel(reverse=True, hide_if_empty=True)
self.warn_label.setIcon(read_QIcon('warning.png'))
def on_ready(self):
message1 = _('Choose the type of addresses in your wallet.')
message2 = ' '.join([
_('You can override the suggested derivation path.'),
_('If you are not sure what this is, leave this field unchanged.')
])
hide_choices = False
if self.wizard_data['wallet_type'] == 'multisig':
choices = [
# TODO: nicer to refactor 'standard' to 'p2sh', but backend wallet still uses 'standard'
ChoiceItem(key='standard', label='legacy multisig (p2sh)',
extra_data=normalize_bip32_derivation("m/45'/0")),
ChoiceItem(key='p2wsh-p2sh', label='p2sh-segwit multisig (p2wsh-p2sh)',
extra_data=purpose48_derivation(0, xtype='p2wsh-p2sh')),
ChoiceItem(key='p2wsh', label='native segwit multisig (p2wsh)',
extra_data=purpose48_derivation(0, xtype='p2wsh')),
]
if 'multisig_current_cosigner' in self.wizard_data:
# get script type of first cosigner
ks = self.wizard.keystore_from_data(self.wizard_data['wallet_type'], self.wizard_data)
default_choice = xpub_type(ks.get_master_public_key())
hide_choices = True
else:
default_choice = 'p2wsh'
else:
default_choice = 'p2wpkh'
choices = [
# TODO: nicer to refactor 'standard' to 'p2pkh', but backend wallet still uses 'standard'
ChoiceItem(key='standard', label='legacy (p2pkh)',
extra_data=bip44_derivation(0, bip43_purpose=44)),
ChoiceItem(key='p2wpkh-p2sh', label='p2sh-segwit (p2wpkh-p2sh)',
extra_data=bip44_derivation(0, bip43_purpose=49)),
ChoiceItem(key='p2wpkh', label='native segwit (p2wpkh)',
extra_data=bip44_derivation(0, bip43_purpose=84)),
]
if self.wizard_data['wallet_type'] == 'standard' and not self.wizard_data['keystore_type'] == 'hardware':
button = QPushButton(_("Detect Existing Accounts"))
passphrase = self.wizard_data['seed_extra_words'] if self.wizard_data['seed_extend'] else ''
if self.wizard_data['seed_variant'] == 'bip39':
root_seed = bip39_to_seed(self.wizard_data['seed'], passphrase=passphrase)
elif self.wizard_data['seed_variant'] == 'slip39':
root_seed = self.wizard_data['seed'].decrypt(passphrase)
def get_account_xpub(account_path):
root_node = BIP32Node.from_rootseed(root_seed, xtype="standard")
account_node = root_node.subkey_at_private_derivation(account_path)
account_xpub = account_node.to_xpub()
return account_xpub
def on_account_select(account):
script_type = account["script_type"]
if script_type == "p2pkh":
script_type = "standard"
self.choice_w.select(script_type)
self.derivation_path_edit.setText(account["derivation_path"])
button.clicked.connect(lambda: Bip39RecoveryDialog(self, get_account_xpub, on_account_select))
self.layout().addWidget(button, alignment=Qt.AlignmentFlag.AlignLeft)
self.layout().addWidget(QLabel(_("Or")))
def on_choice_click(index):
self.derivation_path_edit.setText(self.choice_w.selected_item.extra_data)
self.choice_w = ChoiceWidget(message=message1, choices=choices, default_key=default_choice)
self.choice_w.itemSelected.connect(on_choice_click)
if not hide_choices:
self.layout().addWidget(self.choice_w)
self.layout().addWidget(WWLabel(message2))
self.derivation_path_edit = QLineEdit()
self.derivation_path_edit.textChanged.connect(self.validate)
self.layout().addWidget(self.derivation_path_edit)
on_choice_click(self.choice_w.selected_index) # set default value for derivation path
self.layout().addStretch(1)
self.layout().addWidget(self.warn_label)
def validate(self):
self.apply()
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
valid = is_bip32_derivation(cosigner_data['derivation_path'])
if valid:
valid, errortext = self.wizard.check_multisig_constraints(self.wizard_data)
if not valid:
self.logger.error(errortext)
self.warn_label.setText(errortext)
else:
self.warn_label.setText(_('Invalid derivation path'))
self.valid = valid
def apply(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
cosigner_data['script_type'] = self.choice_w.selected_key
cosigner_data['derivation_path'] = str(self.derivation_path_edit.text())
class WCCosignerKeystore(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard)
message = _('Add a cosigner to your multi-sig wallet')
choices = [
ChoiceItem(key='masterkey', label=_('Enter cosigner key')),
ChoiceItem(key='haveseed', label=_('Enter cosigner seed')),
ChoiceItem(key='hardware', label=_('Cosign with hardware device')),
]
self.choice_w = ChoiceWidget(message=message, choices=choices)
self.layout().addWidget(self.choice_w)
self.cosigner = 0
self.participants = 0
self._valid = True
def on_ready(self):
self.participants = self.wizard_data['multisig_participants']
# cosigner index is determined here and put on the wizard_data dict in apply()
# as this page is the start for each additional cosigner
self.cosigner = 2 + len(self.wizard_data['multisig_cosigner_data'])
self.wizard_data['multisig_current_cosigner'] = self.cosigner
self.title = _("Add Cosigner {}").format(self.wizard_data['multisig_current_cosigner'])
# different from old wizard: master public key for sharing is now shown on this page
self.layout().addSpacing(20)
self.layout().addWidget(WWLabel(_('Below is your master public key. Please share it with your cosigners')))
seed_widget = SeedWidget(
self.wizard_data['multisig_master_pubkey'],
icon=False,
for_seed_words=False,
config=self.wizard.config,
)
self.layout().addWidget(seed_widget)
self.layout().addStretch(1)
def apply(self):
self.wizard_data['cosigner_keystore_type'] = self.choice_w.selected_key
self.wizard_data['multisig_current_cosigner'] = self.cosigner
self.wizard_data['multisig_cosigner_data'][str(self.cosigner)] = {
'keystore_type': self.choice_w.selected_key
}
class WCHaveMasterKey(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Create keystore from a master key'))
self.keys_widget = None
self.message_create = ' '.join([
_("To create a watching-only wallet, please enter your master public key (xpub/ypub/zpub)."),
_("To create a spending wallet, please enter a master private key (xprv/yprv/zprv).")
])
self.message_multisig = ' '.join([
_('Please enter your master private key (xprv).'),
_('You can also enter a public key (xpub) here, but be aware you will then create a watch-only wallet if all cosigners are added using public keys'),
])
self.message_cosign = ' '.join([
_('Please enter the master public key (xpub) of your cosigner.'),
_('Enter their master private key (xprv) if you want to be able to sign for them.')
])
self.header_layout = QHBoxLayout()
self.label = WWLabel()
self.label.setMinimumWidth(400)
self.header_layout.addWidget(self.label)
self.warn_label = IconLabel(reverse=True, hide_if_empty=True)
self.warn_label.setIcon(read_QIcon('warning.png'))
def on_ready(self):
if self.wizard_data['wallet_type'] == 'standard':
self.label.setText(self.message_create)
def is_valid(x) -> bool:
self.apply()
key_valid, message = self.wizard.validate_master_key(x, self.wizard_data['wallet_type'])
self.warn_label.setText(message)
return key_valid
elif self.wizard_data['wallet_type'] == 'multisig':
if 'multisig_current_cosigner' in self.wizard_data:
self.title = _("Add Cosigner {}").format(self.wizard_data['multisig_current_cosigner'])
self.label.setText(self.message_cosign)
else:
self.label.setText(self.message_multisig)
def is_valid(x) -> bool:
self.apply()
key_valid, message = self.wizard.validate_master_key(x, self.wizard_data['wallet_type'])
if not key_valid:
self.warn_label.setText(message)
return False
musig_valid, errortext = self.wizard.check_multisig_constraints(self.wizard_data)
self.warn_label.setText(errortext)
if not musig_valid:
return False
return True
else:
raise Exception(f"unexpected wallet type: {self.wizard_data['wallet_type']}")
self.keys_widget = KeysWidget(parent=self, header_layout=self.header_layout, is_valid=is_valid,
allow_multi=False, config=self.wizard.config)
def key_valid_changed(valid):
self.valid = valid
self.keys_widget.validChanged.connect(key_valid_changed)
self.layout().addWidget(self.keys_widget)
self.layout().addStretch()
self.layout().addWidget(self.warn_label)
def apply(self):
text = self.keys_widget.get_text()
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
cosigner_data['master_key'] = text
class WCMultisig(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Multi-Signature Wallet'))
def on_m(m):
m_label.setText(_('Require {0} signatures').format(m))
cw.set_m(m)
backup_warning_label.setVisible(cw.m != cw.n)
def on_n(n):
n_label.setText(_('From {0} cosigners').format(n))
cw.set_n(n)
m_edit.setMaximum(n)
backup_warning_label.setVisible(cw.m != cw.n)
backup_warning_label = WWLabel(_('Warning: to be able to restore a multisig wallet, '
'you should include the master public key for each cosigner '
'in all of your backups.'))
cw = CosignWidget(2, 2)
m_label = QLabel()
n_label = QLabel()
m_edit = QSlider(Qt.Orientation.Horizontal, self)
m_edit.setMinimum(1)
m_edit.setMaximum(2)
m_edit.setValue(2)
m_edit.valueChanged.connect(on_m)
on_m(m_edit.value())
n_edit = QSlider(Qt.Orientation.Horizontal, self)
n_edit.setMinimum(2)
n_edit.setMaximum(15)
n_edit.setValue(2)
n_edit.valueChanged.connect(on_n)
on_n(n_edit.value())
grid = QGridLayout()
grid.addWidget(n_label, 0, 0)
grid.addWidget(n_edit, 0, 1)
grid.addWidget(m_label, 1, 0)
grid.addWidget(m_edit, 1, 1)
self.layout().addWidget(cw)
self.layout().addWidget(WWLabel(_('Choose the number of signatures needed to unlock funds in your wallet:')))
self.layout().addLayout(grid)
self.layout().addSpacing(2 * char_width_in_lineedit())
self.layout().addWidget(backup_warning_label)
self.layout().addStretch(1)
self.n_edit = n_edit
self.m_edit = m_edit
self._valid = True
def apply(self):
self.wizard_data['multisig_participants'] = int(self.n_edit.value())
self.wizard_data['multisig_signatures'] = int(self.m_edit.value())
self.wizard_data['multisig_cosigner_data'] = {}
class WCImport(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Import Bitcoin Addresses or Private Keys'))
message = _(
'Enter a list of Bitcoin addresses (this will create a watching-only wallet), or a list of private keys.')
header_layout = QHBoxLayout()
label = WWLabel(message)
label.setMinimumWidth(400)
header_layout.addWidget(label)
header_layout.addWidget(InfoButton(WIF_HELP_TEXT), alignment=Qt.AlignmentFlag.AlignRight)
def is_valid(x) -> bool:
return keystore.is_address_list(x) or keystore.is_private_key_list(x, raise_on_error=True)
self.keys_widget = KeysWidget(header_layout=header_layout, is_valid=is_valid,
allow_multi=True, config=self.wizard.config)
def key_valid_changed(valid):
self.valid = valid
self.keys_widget.validChanged.connect(key_valid_changed)
self.layout().addWidget(self.keys_widget)
def apply(self):
text = self.keys_widget.get_text()
if keystore.is_address_list(text):
self.wizard_data['address_list'] = text
elif keystore.is_private_key_list(text):
self.wizard_data['private_key_list'] = text
class WCWalletPassword(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Wallet Password'))
# TODO: PasswordLayout assumes a button, refactor PasswordLayout
# for now, fake next_button.setEnabled
class Hack:
def setEnabled(self2, b):
self.valid = b
self.next_button = Hack()
self.pw_layout = PasswordLayout(
msg=MSG_ENTER_PASSWORD,
kind=PW_NEW,
OK_button=self.next_button,
)
self.layout().addLayout(self.pw_layout.layout())
self.layout().addStretch(1)
def initialFocus(self) -> Optional[QWidget]:
return self.pw_layout.new_pw
def apply(self):
self.wizard_data['password'] = self.pw_layout.new_password()
self.wizard_data['encrypt'] = True
class SeedExtensionEdit(QWidget):
def __init__(self, parent, *, message: str = None, warning: str = None, warn_issue4566: bool = False):
super().__init__(parent)
self.warn_issue4566 = warn_issue4566
layout = QVBoxLayout()
self.setLayout(layout)
if message:
layout.addWidget(WWLabel(message))
self.line = QLineEdit()
layout.addWidget(self.line)
def f(text):
if self.warn_issue4566:
text_whitespace_normalised = ' '.join(text.split())
warn_issue4566_label.setVisible(text != text_whitespace_normalised)
self.line.textEdited.connect(f)
if warning:
layout.addWidget(WWLabel(warning))
warn_issue4566_label = WWLabel(MSG_PASSPHRASE_WARN_ISSUE4566)
warn_issue4566_label.setVisible(False)
layout.addWidget(warn_issue4566_label)
# expose textEdited signal and text() func to widget
self.textEdited = self.line.textEdited
self.text = self.line.text
class CosignWidget(QWidget):
def __init__(self, m, n):
QWidget.__init__(self)
self.size = max(120, 9 * font_height())
self.R = QRect(0, 0, self.size, self.size)
self.setGeometry(self.R)
self.setMinimumHeight(self.size)
self.setMaximumHeight(self.size)
self.m = m
self.n = n
def set_n(self, n):
self.n = n
self.update()
def set_m(self, m):
self.m = m
self.update()
def paintEvent(self, event):
bgcolor = self.palette().color(QPalette.ColorRole.Window)
pen = QPen(bgcolor, 7, Qt.PenStyle.SolidLine)
qp = QPainter()
qp.begin(self)
qp.setPen(pen)
qp.setRenderHint(QPainter.RenderHint.Antialiasing)
qp.setBrush(Qt.GlobalColor.gray)
for i in range(self.n):
alpha = int(16 * 360 * i/self.n)
alpha2 = int(16 * 360 * 1/self.n)
qp.setBrush(Qt.GlobalColor.green if i < self.m else Qt.GlobalColor.gray)
qp.drawPie(self.R, alpha, alpha2)
qp.end()
class WCChooseHWDevice(WalletWizardComponent, Logger):
scanFailed = pyqtSignal([str, str], arguments=['code', 'message'])
scanComplete = pyqtSignal()
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Choose Hardware Device'))
Logger.__init__(self)
self.scanFailed.connect(self.on_scan_failed)
self.scanComplete.connect(self.on_scan_complete)
self.plugins = wizard.plugins
self.config = wizard.config
self.error_l = WWLabel()
self.error_l.setVisible(False)
self.device_list = QWidget()
self.device_list_layout = QVBoxLayout()
self.device_list.setLayout(self.device_list_layout)
self.choice_w = None # type: ChoiceWidget
self.rescan_button = QPushButton(_('Rescan devices'))
self.rescan_button.clicked.connect(self.on_rescan)
self.add_plugin_button = QPushButton(_('Add plugin'))
self.add_plugin_button.clicked.connect(self.on_add_plugin)
hbox = QHBoxLayout()
hbox.addStretch(1)
hbox.addWidget(self.rescan_button)
hbox.addWidget(self.add_plugin_button)
hbox.addStretch(1)
self.layout().addWidget(self.error_l)
self.layout().addWidget(self.device_list)
self.layout().addStretch(1)
self.layout().addLayout(hbox)
self.layout().addStretch(1)
def on_ready(self):
self.scan_devices()
def on_rescan(self):
self.scan_devices()
def on_add_plugin(self):
d = PluginsDialog(self.config, self.plugins)
d.exec()
self.scan_devices()
def on_scan_failed(self, code, message):
self.error_l.setText(message)
self.error_l.setVisible(True)
self.device_list.setVisible(False)
self.valid = False
def on_scan_complete(self):
self.error_l.setVisible(False)
self.device_list.setVisible(True)
choices = [] # type: List[ChoiceItem]
for name, info in self.devices:
state = _("initialized") if info.initialized else _("wiped")
label = info.label or _("An unnamed {}").format(name)
try:
transport_str = info.device.transport_ui_string[:20]
except Exception:
transport_str = 'unknown transport'
descr = f"{label} [{info.model_name or name}, {state}, {transport_str}]"
choices.append(ChoiceItem(key=(name, info), label=descr))
msg = _('Select a device') + ':'
if self.choice_w:
self.device_list_layout.removeWidget(self.choice_w)
self.choice_w = ChoiceWidget(message=msg, choices=choices)
self.device_list_layout.addWidget(self.choice_w)
self.valid = True
if self.valid:
self.wizard.next_button.setFocus()
else:
self.rescan_button.setFocus()
def scan_devices(self):
self.valid = False
self.busy_msg = _('Scanning devices...')
self.busy = True
def scan_task():
# check available plugins
supported_plugins = self.plugins.get_hardware_support()
devices = [] # type: List[Tuple[str, DeviceInfo]]
devmgr = self.plugins.device_manager
debug_msg = ''
def failed_getting_device_infos(name, e):
nonlocal debug_msg
err_str_oneline = ' // '.join(str(e).splitlines())
self.logger.warning(f'error getting device infos for {name}: {err_str_oneline}')
_indented_error_msg = ' '.join([''] + str(e).splitlines(keepends=True))
debug_msg += f' {name}: (error getting device infos)\n{_indented_error_msg}\n'
# scan devices
try:
# scanned_devices = self.run_task_without_blocking_gui(task=devmgr.scan_devices,
# msg=_("Scanning devices..."))
scanned_devices = devmgr.scan_devices()
except BaseException as e:
self.logger.info('error scanning devices: {}'.format(repr(e)))
debug_msg = ' {}:\n {}'.format(_('Error scanning devices'), e)
else:
for splugin in supported_plugins:
name, plugin = splugin.name, splugin.plugin
# plugin init errored?
if not plugin:
e = splugin.exception
indented_error_msg = ' '.join([''] + str(e).splitlines(keepends=True))
debug_msg += f' {name}: (error during plugin init)\n'
debug_msg += ' {}\n'.format(_('You might have an incompatible library.'))
debug_msg += f'{indented_error_msg}\n'
continue
# see if plugin recognizes 'scanned_devices'
try:
# FIXME: side-effect: this sets client.handler
device_infos = devmgr.list_pairable_device_infos(
handler=None, plugin=plugin, devices=scanned_devices, include_failing_clients=True)
except HardwarePluginLibraryUnavailable as e:
failed_getting_device_infos(name, e)
continue
except BaseException as e:
self.logger.exception('')
failed_getting_device_infos(name, e)
continue
device_infos_failing = list(filter(lambda di: di.exception is not None, device_infos))
for di in device_infos_failing:
failed_getting_device_infos(name, di.exception)
device_infos_working = list(filter(lambda di: di.exception is None, device_infos))
devices += list(map(lambda x: (name, x), device_infos_working))
if not debug_msg:
debug_msg = ' {}'.format(_('No exceptions encountered.'))
if not devices:
msg = (_('No hardware device detected.') + '\n\n')
if sys.platform == 'win32':
msg += _('If your device is not detected on Windows, go to "Settings", "Devices", "Connected devices", '
'and do "Remove device". Then, plug your device again.') + '\n'
msg += _('While this is less than ideal, it might help if you run Electrum as Administrator.') + '\n'
else:
msg += _('On Linux, you might have to add a new permission to your udev rules.') + '\n'
msg += '\n\n'
msg += _('Debug message') + '\n' + debug_msg
self.scanFailed.emit('no_devices', msg)
self.busy = False
return
# select device
self.devices = devices
self.scanComplete.emit()
self.busy = False
t = threading.Thread(target=scan_task, daemon=True)
t.start()
def apply(self):
if self.choice_w:
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
cosigner_data['hardware_device'] = self.choice_w.selected_key
class WCWalletPasswordHardware(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Encrypt using hardware'))
self.plugins = wizard.plugins
# TODO: PasswordLayout assumes a button, refactor PasswordLayout
# for now, fake next_button.setEnabled
class Hack:
def setEnabled(self2, b):
self.valid = b
self.next_button = Hack()
self.playout = PasswordLayoutForHW(
MSG_HW_STORAGE_ENCRYPTION,
kind=PW_NEW,
OK_button=self.next_button,
)
self.layout().addLayout(self.playout.layout())
self.layout().addStretch(1)
self._valid = True
def apply(self):
self.wizard_data['encrypt'] = True
if self.playout.should_encrypt_storage_with_xpub():
self.wizard_data['xpub_encrypt'] = True
_name, _info = self.wizard_data['hardware_device']
device_id = _info.device.id_
client = self.plugins.device_manager.client_by_id(device_id, scan_now=False)
# client.handler = self.plugin.create_handler(self.wizard)
# FIXME client can be None if it was recently disconnected.
# also, even if not None, this might raise (e.g. if it disconnected *just now*):
self.wizard_data['password'] = client.get_password_for_storage_encryption()
else:
self.wizard_data['xpub_encrypt'] = False
self.wizard_data['password'] = self.playout.new_password()
class WCHWUnlock(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Unlocking hardware'))
Logger.__init__(self)
self.plugins = wizard.plugins
self.plugin = None
self._busy = True
self.password = None
ok_icon = QLabel()
ok_icon.setPixmap(QPixmap(icon_path('confirmed.png')).scaledToWidth(48, mode=Qt.TransformationMode.SmoothTransformation))
ok_icon.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.ok_l = WWLabel(_('Hardware successfully unlocked'))
self.ok_l.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.layout().addStretch(1)
self.layout().addWidget(ok_icon)
self.layout().addWidget(self.ok_l)
self.layout().addStretch(1)
def on_ready(self):
_name, _info = self.wizard_data['hardware_device']
self.plugin = self.plugins.get_plugin(_info.plugin_name)
self.title = _('Unlocking {} ({})').format(_info.model_name, _info.label)
device_id = _info.device.id_
client = self.plugins.device_manager.client_by_id(device_id, scan_now=False)
if client is None:
self.error = _("Client for hardware device was unpaired.")
self.busy = False
self.validate()
return
client.handler = self.plugin.create_handler(self.wizard)
def unlock_task(client):
try:
self.password = client.get_password_for_storage_encryption()
except Exception as e:
self.error = repr(e) # TODO: handle user interaction exceptions (e.g. invalid pin) more gracefully
self.logger.exception(repr(e))
self.busy = False
self.validate()
t = threading.Thread(target=unlock_task, args=(client,), daemon=True)
t.start()
def validate(self):
self.valid = False
if self.password and not self.error:
if not self.check_hw_decrypt():
self.error = _('This hardware device could not decrypt this wallet. Is it the correct one?')
else:
self.apply()
self.valid = True
if self.valid:
self.wizard.requestNext.emit() # via signal, so it triggers Next/Finish on GUI thread after on_updated()
def check_hw_decrypt(self):
wallet_file = self.wizard_data['wallet_name']
storage = WalletStorage(wallet_file)
if not storage.is_encrypted_with_hw_device():
return True
try:
storage.decrypt(self.password)
except InvalidPassword:
return False
return True
def apply(self):
if self.valid:
self.wizard_data['password'] = self.password
class WCHWXPub(WalletWizardComponent, Logger):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Retrieving extended public key from hardware'))
Logger.__init__(self)
self.plugins = wizard.plugins
self.plugin = None
self._busy = True
self.xpub = None
self.root_fingerprint = None
self.label = None
self.soft_device_id = None
ok_icon = QLabel()
ok_icon.setPixmap(QPixmap(icon_path('confirmed.png')).scaledToWidth(48, mode=Qt.TransformationMode.SmoothTransformation))
ok_icon.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.ok_l = WWLabel(_('Hardware keystore added to wallet'))
self.ok_l.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.layout().addStretch(1)
self.layout().addWidget(ok_icon)
self.layout().addWidget(self.ok_l)
self.layout().addStretch(1)
def on_ready(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
_name, _info = cosigner_data['hardware_device']
self.plugin = self.plugins.get_plugin(_info.plugin_name)
self.title = _('Retrieving extended public key from {} ({})').format(_info.model_name, _info.label)
device_id = _info.device.id_
client = self.plugins.device_manager.client_by_id(device_id, scan_now=False)
if client is None:
self.error = _("Client for hardware device was unpaired.")
self.busy = False
self.validate()
return
if not client.handler:
client.handler = self.plugin.create_handler(self.wizard)
xtype = cosigner_data['script_type']
derivation = cosigner_data['derivation_path']
def get_xpub_task(_client, _derivation, _xtype):
try:
self.xpub = self.get_xpub_from_client(_client, _derivation, _xtype)
self.root_fingerprint = _client.request_root_fingerprint_from_device()
self.label = _client.label()
self.soft_device_id = _client.get_soft_device_id()
except UserFacingException as e:
self.error = str(e)
self.logger.error(repr(e))
except Exception as e:
self.error = repr(e) # TODO: handle user interaction exceptions (e.g. invalid pin) more gracefully
self.logger.exception(repr(e))
self.logger.debug(f'Done retrieve xpub: {self.xpub}')
self.busy = False
self.validate()
t = threading.Thread(target=get_xpub_task, args=(client, derivation, xtype), daemon=True)
t.start()
def get_xpub_from_client(self, client, derivation, xtype): # override for HWW specific client if needed
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
_name, _info = cosigner_data['hardware_device']
if xtype not in self.plugin.SUPPORTED_XTYPES:
raise ScriptTypeNotSupported(_('This type of script is not supported with {}').format(_info.model_name))
return client.get_xpub(derivation, xtype)
def validate(self):
if self.xpub and not self.error:
self.apply()
valid, error = self.wizard.check_multisig_constraints(self.wizard_data)
if not valid:
self.error = '\n'.join([
_('Could not add hardware keystore to wallet'),
error
])
self.valid = valid
else:
self.valid = False
if self.valid:
self.wizard.requestNext.emit() # via signal, so it triggers Next/Finish on GUI thread after on_updated()
def apply(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
_name, _info = cosigner_data['hardware_device']
cosigner_data['hw_type'] = _info.plugin_name
cosigner_data['master_key'] = self.xpub
cosigner_data['root_fingerprint'] = self.root_fingerprint
cosigner_data['label'] = self.label
cosigner_data['soft_device_id'] = self.soft_device_id
class WCHWUninitialized(WalletWizardComponent):
def __init__(self, parent, wizard):
WalletWizardComponent.__init__(self, parent, wizard, title=_('Hardware not initialized'))
def on_ready(self):
cosigner_data = self.wizard.current_cosigner(self.wizard_data)
_name, _info = cosigner_data['hardware_device']
w_icon = QLabel()
w_icon.setPixmap(QPixmap(icon_path('warning.png')).scaledToWidth(48, mode=Qt.TransformationMode.SmoothTransformation))
w_icon.setAlignment(Qt.AlignmentFlag.AlignCenter)
label = WWLabel(_('This {} is not initialized. Use manufacturer tooling to initialize the device.').format(_info.model_name))
label.setAlignment(Qt.AlignmentFlag.AlignCenter)
self.layout().addStretch(1)
self.layout().addWidget(w_icon)
self.layout().addWidget(label)
self.layout().addStretch(1)
def apply(self):
pass