LBRY-Vault/electrum/plugins/bitbox02/qt.py
TheCharlatan a4fe14bb82
BitBox02 Electrum plugin support
This commit adds support for the BitBox02 hardware wallet.
It supports both single and multisig for the electrum gui wallet.

To use the plugin a local installation of the BitBox02 python library is
required. It can be found on PiPy under the name 'bitbox02' and can be
installed from the bitbox02-firmware repository in the py/bitbox02
directory.

All communication to and from the BitBox02 is noise encrypted, the keys
required for this are stored in the wallet config file under the
bitbox02 key.

The BitBox02 registers a multisig configuration before allowing
transaction signing. This multisig configuration includes the threshold,
cosigner xpubs, keypath, a variable to indicate for mainnet and testnet,
and a name that the user can choose during configuration registration.
The user is asked to register the multisig configuration either during
address verification or during transaction signing.

The check the xpub of the BitBox02 for other hardware wallets, a button
is added in the wallet info dialog.

The wallet encryption key is fetched in a separate api call, requiring a
slightly tweaked override version of the wallet encryption password.
2020-04-12 15:34:37 +02:00

174 lines
5.5 KiB
Python

import time, os
from functools import partial
import copy
from PyQt5.QtCore import Qt, pyqtSignal
from PyQt5.QtWidgets import (
QPushButton,
QLabel,
QVBoxLayout,
QWidget,
QGridLayout,
QLineEdit,
QHBoxLayout,
)
from PyQt5.QtCore import Qt, QMetaObject, Q_RETURN_ARG, pyqtSignal, pyqtSlot
from electrum.gui.qt.util import (
WindowModalDialog,
Buttons,
OkButton,
CancelButton,
get_parent_main_window,
)
from electrum.gui.qt.transaction_dialog import TxDialog
from electrum.i18n import _
from electrum.plugin import hook
from electrum.wallet import Multisig_Wallet
from electrum.transaction import PartialTransaction
from electrum import keystore
from .bitbox02 import BitBox02Plugin
from ..hw_wallet.qt import QtHandlerBase, QtPluginBase
from ..hw_wallet.plugin import only_hook_if_libraries_available, LibraryFoundButUnusable
class Plugin(BitBox02Plugin, QtPluginBase):
icon_unpaired = "bitbox02_unpaired.png"
icon_paired = "bitbox02.png"
def create_handler(self, window):
return BitBox02_Handler(window)
@only_hook_if_libraries_available
@hook
def receive_menu(self, menu, addrs, wallet):
# Context menu on each address in the Addresses Tab, right click...
if len(addrs) != 1:
return
for keystore in wallet.get_keystores():
if type(keystore) == self.keystore_class:
def show_address(keystore=keystore):
keystore.thread.add(
partial(self.show_address, wallet, addrs[0], keystore=keystore)
)
device_name = "{} ({})".format(self.device, keystore.label)
menu.addAction(_("Show on {}").format(device_name), show_address)
@only_hook_if_libraries_available
@hook
def show_xpub_button(self, main_window, dialog, labels_clayout):
# user is about to see the "Wallet Information" dialog
# - add a button to show the xpub on the BitBox02 device
wallet = main_window.wallet
if not any(type(ks) == self.keystore_class for ks in wallet.get_keystores()):
# doesn't involve a BitBox02 wallet, hide feature
return
btn = QPushButton(_("Show on BitBox02"))
def on_button_click():
selected_keystore_index = 0
if labels_clayout is not None:
selected_keystore_index = labels_clayout.selected_index()
keystores = wallet.get_keystores()
selected_keystore = keystores[selected_keystore_index]
derivation = selected_keystore.get_derivation_prefix()
if type(selected_keystore) != self.keystore_class:
main_window.show_error("Select a BitBox02 xpub")
selected_keystore.get_client().get_xpub(
derivation, keystore.xtype_from_derivation(derivation), True
)
btn.clicked.connect(lambda unused: on_button_click())
return btn
class BitBox02_Handler(QtHandlerBase):
setup_signal = pyqtSignal()
def __init__(self, win):
super(BitBox02_Handler, self).__init__(win, "BitBox02")
self.setup_signal.connect(self.setup_dialog)
def message_dialog(self, msg):
self.clear_dialog()
self.dialog = dialog = WindowModalDialog(
self.top_level_window(), _("BitBox02 Status")
)
l = QLabel(msg)
vbox = QVBoxLayout(dialog)
vbox.addWidget(l)
dialog.show()
def attestation_failed_warning(self, msg):
self.clear_dialog()
self.dialog = dialog = WindowModalDialog(None, "BitBox02 Attestation Failed")
l = QLabel(msg)
vbox = QVBoxLayout(dialog)
vbox.addWidget(l)
okButton = OkButton(dialog)
vbox.addWidget(okButton)
dialog.setLayout(vbox)
dialog.exec_()
return
def pairing_code_dialog(self, code):
self.clear_dialog()
self.dialog = dialog = WindowModalDialog(None, "BitBox02 Pairing Code")
l = QLabel(code)
vbox = QVBoxLayout(dialog)
vbox.addWidget(l)
vbox.addLayout(Buttons(CancelButton(dialog), OkButton(dialog)))
dialog.setLayout(vbox)
dialog.exec_()
return
def get_setup(self):
self.done.clear()
self.setup_signal.emit()
self.done.wait()
return
def name_multisig_account(self):
return QMetaObject.invokeMethod(
self,
"_name_multisig_account",
Qt.BlockingQueuedConnection,
Q_RETURN_ARG(str),
)
@pyqtSlot(result=str)
def _name_multisig_account(self):
dialog = WindowModalDialog(None, "Create Multisig Account")
vbox = QVBoxLayout()
label = QLabel(
_(
"Enter a descriptive name for your multisig account.\nYou should later be able to use the name to uniquely identify this multisig account"
)
)
hl = QHBoxLayout()
hl.addWidget(label)
name = QLineEdit()
name.setMaxLength(30)
name.resize(200, 40)
he = QHBoxLayout()
he.addWidget(name)
okButton = OkButton(dialog)
hlb = QHBoxLayout()
hlb.addWidget(okButton)
hlb.addStretch(2)
vbox.addLayout(hl)
vbox.addLayout(he)
vbox.addLayout(hlb)
dialog.setLayout(vbox)
dialog.exec_()
return name.text().strip()
def setup_dialog(self):
self.show_error(_("Please initialize your BitBox02 while connected."))
return