new wizard Qt desktop client #8560

accumulator · 2023-08-01T12:41:26Z

Refactor of wizard to new wizard framework (as in qml).

Notes:

For multisig Qt client shows master pubkey on cosigner keystore select page, not on separate page.
inserts extra separate pages for passphrase/ext entry in the base wizard flow, to mimic old wizard.
script and derivation path entry shown after HWW select but before device access/unlock

Todo:

SomberNight · 2023-08-01T13:38:05Z

electrum/gui/qt/wizard/wizard.py

+
+
+class QEAbstractWizard(QDialog):
+    _logger = get_logger(__name__)


I think it is nicer to inherit Logger, e.g. QEAbstractWizard(QDialog, Logger), and then

def __init__(self, config: 'SimpleConfig', app: QApplication, daemon): Logger.__init__(self)

Especially as QEAbstractWizard is not a singleton, it could be useful for debugging to have separate instances of it each their own logger. E.g. look at wallet.py/Abstract_Wallet: note it is overriding Logger.diagnostic_name. -- Though if you don't override diagnostic_name, the choice of having a per-class/per-instance logger becomes less important.

I guess this remark also applies to a lot of existing code in the qml GUI.
Anyway, it's more of a nit.

Thanks. I guess this stems from my past experience with C++ and Java, where inheritance is more rigid. Pythonic multiple inheritance and mixins still feels a bit 'loose' to me, and although you could maintain the is a relationship, I'm used to loggers being a composition into a class. I guess the difference in interpretation is that a class using a logger should not imply the class being a full fledged logger within a logging framework.

BTW, diagnostic_name might not be unique unless I use the id() of the wizard instance.

I'm used to loggers being a composition into a class

You are right that inheritance should not be overused.
Hmm, I guess it is mostly more consistent usage of the Logger across the codebase that I wanted, not necessarily inheritance.
We could change the Logger class to be used with composition instead. diagnostic_name and LOGGING_SHORTCUT could be passed as parameters to Logging.__init__,
and then do e.g. self.logger = Logger(name=self.diagnostic_name(), shortcut=LOGGING_SHORTCUT) in init.

diagnostic_name might not be unique unless I use the id() of the wizard instance

Yes, indeed. See lnpeer.Peer for an example where we explicitly use id() (through the transport) -- it was added during/after debugging an issue where multiple Peer objects did have the same colliding diagnostic names which was causing confusion.

Anyway, it's just a small remark; not too important re this PR.

accumulator · 2023-08-23T10:45:35Z

@ecdsa, @SomberNight I've started adding HWW support for devices I can't test.
I've added test todos in the top post. Can you please check these devices for

proper handling when HWW uninitialized
can use to create standard wallet
can use for wallet encrypt by hardware

accumulator · 2023-08-23T10:48:42Z

For my information, which HWW allow for initialization within Electrum? For trezor I'm sure (and is implemented), safe_t looks like it supports it?

accumulator · 2023-08-29T13:27:48Z

Removing draft status. Not all HWW that currently support initial device setup are ported, but it's ready to test.

electrum/gui/qt/__init__.py

ecdsa · 2023-08-30T16:56:00Z

Can we rename qt_common to something else? I am a heavy user of tab-completions, and this new directory is slowing me down significantly; I now need to type "q + t + shift + slash" in order to have a non-ambiguous prefix, where "q + t" used to be sufficient. (before the introduction of the qml directory, the sole letter "q" was enough).

accumulator · 2023-08-31T06:56:35Z

Can we rename qt_common to something else? I am a heavy user of tab-completions, and this new directory is slowing me down significantly; I now need to type "q + t + shift + slash" in order to have a non-ambiguous prefix, where "q + t" used to be sufficient. (before the introduction of the qml directory, the sole letter "q" was enough).

Done

electrum/gui/qt/__init__.py

qt: call is_finalized before closing the wizard dialog and add a check if wallet can be decrypted with the supplied secret (user pw, hw device)

…nd picked wallets, add abstract method decl HW_PluginBase.wizard_entry_for_device

… report error when exception

…-add rescan button in choose hw device, clear clipboard before confirming seed.

… unexpected keystore type msg

also, consistent single quoting of strings

add auto-proceed to next page after init to trezor, safe_t, keepkey

- always store 'keystore_type' in cosigner data and use same types as main - dont share 'hardware_device' in root of dict, but store for each cosigner - properly return hardware keystore for hardware cosigners

SomberNight

Added some more comments. Also tested on safe-t, looks ok.

electrum/wizard.py

electrum/gui/qt/wizard/wallet.py

electrum/wizard.py

electrum/plugins/keepkey/qt.py

electrum/plugins/trezor/qt.py

… standard wallets, check hw wallet file decrypt in WCHWUnlock, fix assumption 'wallet_type' exists in wallet open scenario.

ecdsa · 2023-09-22T12:07:13Z

not directly related, but the split_account function does not work on qml. For example, if I try ./run_electrum -w electrum/tests/test_storage_upgrade/client_2_5_4_trezor_multiacc -g qml -v, a popup is shown, but no split happens.

Since that is not needed on Android, I think this should be removed from qml

follow-up 8be3c4d related: #8560 (comment)

follow-up #8560

Include new wizard Qt desktop client spesmilo#8560 WIP TODO: build binaries, adapt qrcodewidget

accumulator force-pushed the qtwizard branch 2 times, most recently from 23febe5 to eda2d7b Compare August 1, 2023 13:11

SomberNight reviewed Aug 1, 2023

View reviewed changes

accumulator force-pushed the qtwizard branch 2 times, most recently from 17af9dd to c48fc00 Compare August 3, 2023 18:55

accumulator force-pushed the qtwizard branch 4 times, most recently from 2ae343a to 538b91a Compare August 15, 2023 10:20

spesmilo deleted a comment from Erkansukgen Aug 15, 2023

accumulator force-pushed the qtwizard branch 5 times, most recently from cb5758d to 9dc9a55 Compare August 23, 2023 09:43

accumulator force-pushed the qtwizard branch 3 times, most recently from 320ef47 to cc841c9 Compare August 29, 2023 11:07

accumulator marked this pull request as ready for review August 29, 2023 13:27

ecdsa reviewed Aug 30, 2023

View reviewed changes

electrum/gui/qt/__init__.py Outdated Show resolved Hide resolved

SomberNight mentioned this pull request Aug 30, 2023

remove the kivy gui #8591

Merged

ecdsa reviewed Aug 31, 2023

View reviewed changes

electrum/gui/qt/__init__.py Show resolved Hide resolved

ecdsa reviewed Aug 31, 2023

View reviewed changes

electrum/gui/qt/__init__.py Show resolved Hide resolved

accumulator force-pushed the qtwizard branch 2 times, most recently from 7d006a2 to c30740a Compare August 31, 2023 12:23

accumulator and others added 16 commits September 20, 2023 14:34

wizard: add bitbox02 new wallet init and checks to new wizard

dd64b5c

wizard: remove finished call, it's unused

7fd3b6c

qt: call is_finalized before closing the wizard dialog and add a check if wallet can be decrypted with the supplied secret (user pw, hw device)

wizard: add missing keepkey porting, fix password focus for default a…

60d1d1e

…nd picked wallets, add abstract method decl HW_PluginBase.wizard_entry_for_device

wizard: keepkey and safe_t set valid on init, handle xprv validation,…

7313259

… report error when exception

wizard: add non-hardened derivation path check for digital bitbox, re…

4101946

…-add rescan button in choose hw device, clear clipboard before confirming seed.

trustedcoin: remove old wizard code

f69316d

wizard: remove base_wizard.py

551a0e9

plugins: make HW_PluginBase an abstract baseclass

a1dea83

wizard: fix hww scan debug_msg not working correctly

d2c7df3

coldcard: factor out manipulate_keystore_dict_during_wizard_setup

1a91da6

wizard: fix assumption 'keystore_type' is present in wizard_data, fix…

ec0dbc7

… unexpected keystore type msg

qt: fix device list after rescan

5080c22

wizard: allow slip39 for multisig

808f187

also, consistent single quoting of strings

wizard: fix trezor initialisation/recover not setting page valid to True

22d3a5e

add auto-proceed to next page after init to trezor, safe_t, keepkey

wizard: keepkey scope pin lineedit to instance

81089a1

wizard: make wizard.keystore_from_data more robust;

2caa8f1

- always store 'keystore_type' in cosigner data and use same types as main - dont share 'hardware_device' in root of dict, but store for each cosigner - properly return hardware keystore for hardware cosigners

accumulator force-pushed the qtwizard branch from 84e5e60 to 2caa8f1 Compare September 20, 2023 12:34

SomberNight mentioned this pull request Sep 20, 2023

Qt desktop GUI: upgrade to Qt6 (gui/qt/, QtWidgets) #8007

Closed

SomberNight reviewed Sep 20, 2023

View reviewed changes

accumulator mentioned this pull request Sep 21, 2023

Add support for Satochip hardware wallet #8453

Closed

wizard: don't use hww encryption of wallet files for anything besides…

44a1595

… standard wallets, check hw wallet file decrypt in WCHWUnlock, fix assumption 'wallet_type' exists in wallet open scenario.

accumulator force-pushed the qtwizard branch from 6d054d7 to 44a1595 Compare September 21, 2023 12:20

ecdsa merged commit 8be3c4d into spesmilo:master Sep 22, 2023

This was referenced Sep 22, 2023

Unresponsive buttons in multiple instances of wallet creation wizard (modal dialogs not updating/refreshing if there is more than one) #3286

Closed

Remember state of selection upon clicking Next #3805

Closed

SomberNight added a commit that referenced this pull request Sep 22, 2023

keepkey: fix TIM_RECOVER restore method

0a3dd8e

follow-up 8be3c4d related: #8560 (comment)

SomberNight added a commit that referenced this pull request Sep 24, 2023

qt gui __init__: restore import order - raise pyqt5 missing early

4978d40

follow-up #8560

SomberNight mentioned this pull request Feb 21, 2024

close unused client connections #7701

Closed

Toporin added a commit to Toporin/electrum-satochip that referenced this pull request Mar 20, 2024

Add Satochip hardware wallet support to Electrum v4.5.4

fa82f82

Include new wizard Qt desktop client spesmilo#8560 WIP TODO: build binaries, adapt qrcodewidget



		class QEAbstractWizard(QDialog):
		_logger = get_logger(__name__)

new wizard Qt desktop client #8560

new wizard Qt desktop client #8560

Uh oh!

Conversation

accumulator commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SomberNight Aug 1, 2023

Choose a reason for hiding this comment

Uh oh!

accumulator Aug 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

accumulator Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

SomberNight Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

accumulator commented Aug 23, 2023

Uh oh!

accumulator commented Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

accumulator commented Aug 29, 2023

Uh oh!

Uh oh!

ecdsa commented Aug 30, 2023

Uh oh!

accumulator commented Aug 31, 2023

Uh oh!

Uh oh!

Uh oh!

SomberNight left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ecdsa commented Sep 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

accumulator commented Aug 1, 2023 •

edited

Loading

accumulator Aug 3, 2023 •

edited

Loading

accumulator commented Aug 23, 2023 •

edited

Loading