Hardware Wallet Interface
latest
Contents:
Usage
Supported Devices
Development
Example Usage
Hardware Wallet Interface
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
X
Symbols
--account
hwi-getdescriptors command line option
hwi-getkeypool command line option
hwi-getmasterxpub command line option
--addr-type
hwi-displayaddress command line option
hwi-getkeypool command line option
hwi-getmasterxpub command line option
--all
hwi-getkeypool command line option
--backup_passphrase
hwi-backup command line option
hwi-setup command line option
--chain
hwi command line option
--debug
hwi command line option
--desc
hwi-displayaddress command line option
--device-path
hwi command line option
--device-type
hwi command line option
--expert
hwi command line option
--fingerprint
hwi command line option
--help
hwi command line option
hwi-backup command line option
hwi-displayaddress command line option
hwi-enumerate command line option
hwi-getdescriptors command line option
hwi-getkeypool command line option
hwi-getmasterxpub command line option
hwi-getxpub command line option
hwi-installudevrules command line option
hwi-promptpin command line option
hwi-restore command line option
hwi-sendpin command line option
hwi-setup command line option
hwi-signmessage command line option
hwi-signtx command line option
hwi-togglepassphrase command line option
hwi-wipe command line option
--interactive
hwi command line option
--internal
hwi-getkeypool command line option
--keypool
hwi-getkeypool command line option
--label
hwi-backup command line option
hwi-restore command line option
hwi-setup command line option
--location
hwi-installudevrules command line option
--nokeypool
hwi-getkeypool command line option
--password
hwi command line option
--path
hwi-displayaddress command line option
hwi-getkeypool command line option
--stdin
hwi command line option
--stdinpass
hwi command line option
--version
hwi command line option
--word_count
hwi-restore command line option
-b
hwi-backup command line option
hwi-setup command line option
-d
hwi command line option
-f
hwi command line option
-h
hwi command line option
hwi-backup command line option
hwi-displayaddress command line option
hwi-enumerate command line option
hwi-getdescriptors command line option
hwi-getkeypool command line option
hwi-getmasterxpub command line option
hwi-getxpub command line option
hwi-installudevrules command line option
hwi-promptpin command line option
hwi-restore command line option
hwi-sendpin command line option
hwi-setup command line option
hwi-signmessage command line option
hwi-signtx command line option
hwi-togglepassphrase command line option
hwi-wipe command line option
-i
hwi command line option
-l
hwi-backup command line option
hwi-restore command line option
hwi-setup command line option
-p
hwi command line option
-t
hwi command line option
-w
hwi-restore command line option
A
ACTION_CANCELED (in module hwilib.errors)
ActionCanceledError
add_user_plugdev_group() (hwilib.udevinstaller.UDevInstaller method)
AddChecksum() (in module hwilib.descriptor)
AddressType (class in hwilib.common)
B
backup_device() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
BAD_ARGUMENT (in module hwilib.errors)
BadArgumentError
bech32_create_checksum() (in module hwilib._bech32)
bech32_decode() (in module hwilib._bech32)
bech32_encode() (in module hwilib._bech32)
bech32_hrp_expand() (in module hwilib._bech32)
bech32_polymod() (in module hwilib._bech32)
bech32_verify_checksum() (in module hwilib._bech32)
C
cache_unsigned_tx_pieces() (hwilib.psbt.PSBT method)
can_sign_taproot() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
Chain (class in hwilib.common)
close() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
ColdcardClient (class in hwilib.devices.coldcard)
compute_lock_time() (hwilib.psbt.PSBT method)
convert_to_v0() (hwilib.psbt.PSBT method)
convert_to_v2() (hwilib.psbt.PSBT method)
convertbits() (in module hwilib._bech32)
copy_udev_rule_files() (hwilib.udevinstaller.UDevInstaller method)
count() (hwilib.descriptor.ExpandedScripts method)
D
DBBError
decode() (in module hwilib._base58)
(in module hwilib._bech32)
decode_check() (in module hwilib._base58)
derive_pub() (hwilib.key.ExtendedKey method)
derive_pub_path() (hwilib.key.ExtendedKey method)
Descriptor (class in hwilib.descriptor)
DescriptorChecksum() (in module hwilib.descriptor)
deser_compact_size() (in module hwilib._serialize)
deser_string() (in module hwilib._serialize)
deser_string_vector() (in module hwilib._serialize)
deser_uint256() (in module hwilib._serialize)
deser_vector() (in module hwilib._serialize)
Deserializable (class in hwilib._serialize)
deserialize() (hwilib.key.ExtendedKey class method)
(hwilib.key.KeyOriginInfo class method)
(hwilib.psbt.PartiallySignedInput method)
(hwilib.psbt.PartiallySignedOutput method)
(hwilib.psbt.PSBT method)
DEVICE_ALREADY_INIT (in module hwilib.errors)
DEVICE_ALREADY_UNLOCKED (in module hwilib.errors)
DEVICE_BUSY (in module hwilib.errors)
DEVICE_CONN_ERROR (in module hwilib.errors)
DEVICE_NOT_INITIALIZED (in module hwilib.errors)
DEVICE_NOT_READY (in module hwilib.errors)
DeviceAlreadyInitError
DeviceAlreadyUnlockedError
DeviceBusyError
DeviceConnectionError
DeviceFailureError
DeviceNotReadyError
DigitalbitboxClient (class in hwilib.devices.digitalbitbox)
display_multisig_address() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
display_singlesig_address() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
displayaddress() (in module hwilib.commands)
E
encode() (in module hwilib._base58)
(in module hwilib._bech32)
Encoding (class in hwilib._bech32)
end
hwi-getkeypool command line option
enumerate() (in module hwilib.commands)
expand() (hwilib.descriptor.Descriptor method)
(hwilib.descriptor.MultisigDescriptor method)
(hwilib.descriptor.PKDescriptor method)
(hwilib.descriptor.PKHDescriptor method)
(hwilib.descriptor.SHDescriptor method)
(hwilib.descriptor.TRDescriptor method)
(hwilib.descriptor.WPKHDescriptor method)
(hwilib.descriptor.WSHDescriptor method)
ExpandedScripts (class in hwilib.descriptor)
ExtendedKey (class in hwilib.key)
F
find_device() (in module hwilib.commands)
from_bytes() (hwilib.key.ExtendedKey class method)
from_string() (hwilib.key.KeyOriginInfo class method)
G
get_bip44_chain() (in module hwilib.key)
get_bip44_purpose() (in module hwilib.key)
get_client() (in module hwilib.commands)
get_code() (hwilib.errors.ActionCanceledError method)
(hwilib.errors.BadArgumentError method)
(hwilib.errors.DeviceAlreadyInitError method)
(hwilib.errors.DeviceAlreadyUnlockedError method)
(hwilib.errors.DeviceBusyError method)
(hwilib.errors.DeviceConnectionError method)
(hwilib.errors.DeviceFailureError method)
(hwilib.errors.DeviceNotReadyError method)
(hwilib.errors.HWWError method)
(hwilib.errors.NeedsRootError method)
(hwilib.errors.NoPasswordError method)
(hwilib.errors.NotImplementedError method)
(hwilib.errors.PSBTSerializationError method)
(hwilib.errors.UnavailableActionError method)
(hwilib.errors.UnknownDeviceError method)
get_derivation_path() (hwilib.key.KeyOriginInfo method)
get_full_derivation_int_list() (hwilib.descriptor.PubkeyProvider method)
get_full_derivation_path() (hwilib.descriptor.PubkeyProvider method)
get_full_int_list() (hwilib.key.KeyOriginInfo method)
get_master_fingerprint() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
get_master_xpub() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
get_msg() (hwilib.errors.ActionCanceledError method)
(hwilib.errors.BadArgumentError method)
(hwilib.errors.DeviceAlreadyInitError method)
(hwilib.errors.DeviceAlreadyUnlockedError method)
(hwilib.errors.DeviceBusyError method)
(hwilib.errors.DeviceConnectionError method)
(hwilib.errors.DeviceFailureError method)
(hwilib.errors.DeviceNotReadyError method)
(hwilib.errors.HWWError method)
(hwilib.errors.NeedsRootError method)
(hwilib.errors.NoPasswordError method)
(hwilib.errors.NotImplementedError method)
(hwilib.errors.PSBTSerializationError method)
(hwilib.errors.UnavailableActionError method)
(hwilib.errors.UnknownDeviceError method)
get_printable_dict() (hwilib.key.ExtendedKey method)
get_pubkey_at_path() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
get_txout() (hwilib.psbt.PartiallySignedOutput method)
get_unsigned_tx() (hwilib.psbt.PSBT method)
get_xpub_fingerprint() (in module hwilib._base58)
get_xpub_fingerprint_hex() (in module hwilib._base58)
getdescriptor() (in module hwilib.commands)
getdescriptors() (in module hwilib.commands)
getkeypool() (in module hwilib.commands)
getmasterxpub() (in module hwilib.commands)
getxpub() (in module hwilib.commands)
H
H_() (in module hwilib.key)
handle_errors() (in module hwilib.errors)
HardwareWalletClient (class in hwilib.hwwclient)
hash160() (in module hwilib.common)
hash256() (in module hwilib.common)
HELP_TEXT (in module hwilib.errors)
hwi command line option
--chain
--debug
--device-path
--device-type
--expert
--fingerprint
--help
--interactive
--password
--stdin
--stdinpass
--version
-d
-f
-h
-i
-p
-t
hwi-backup command line option
--backup_passphrase
--help
--label
-b
-h
-l
hwi-displayaddress command line option
--addr-type
--desc
--help
--path
-h
hwi-enumerate command line option
--help
-h
hwi-getdescriptors command line option
--account
--help
-h
hwi-getkeypool command line option
--account
--addr-type
--all
--help
--internal
--keypool
--nokeypool
--path
-h
end
start
hwi-getmasterxpub command line option
--account
--addr-type
--help
-h
hwi-getxpub command line option
--help
-h
path
hwi-installudevrules command line option
--help
--location
-h
hwi-promptpin command line option
--help
-h
hwi-restore command line option
--help
--label
--word_count
-h
-l
-w
hwi-sendpin command line option
--help
-h
pin
hwi-setup command line option
--backup_passphrase
--help
--label
-b
-h
-l
hwi-signmessage command line option
--help
-h
message
path
hwi-signtx command line option
--help
-h
psbt
hwi-togglepassphrase command line option
--help
-h
hwi-wipe command line option
--help
-h
hwilib._base58
module
hwilib._bech32
module
hwilib._script
module
hwilib._serialize
module
hwilib.commands
module
hwilib.common
module
hwilib.descriptor
module
hwilib.devices.coldcard
module
hwilib.devices.digitalbitbox
module
hwilib.devices.keepkey
module
hwilib.devices.ledger
module
hwilib.devices.trezor
module
hwilib.errors
module
hwilib.hwwclient
module
hwilib.key
module
hwilib.psbt
module
hwilib.udevinstaller
module
HWWError
I
index() (hwilib.descriptor.ExpandedScripts method)
install() (hwilib.udevinstaller.UDevInstaller static method)
install_udev_rules() (in module hwilib.commands)
INVALID_TX (in module hwilib.errors)
is_hardened() (in module hwilib.key)
is_opreturn() (in module hwilib._script)
is_p2pk() (in module hwilib._script)
is_p2pkh() (in module hwilib._script)
is_p2sh() (in module hwilib._script)
is_p2tr() (in module hwilib._script)
is_p2wpkh() (in module hwilib._script)
is_p2wsh() (in module hwilib._script)
is_witness() (in module hwilib._script)
K
KeepkeyClient (class in hwilib.devices.keepkey)
KeyOriginInfo (class in hwilib.key)
L
LedgerClient (class in hwilib.devices.ledger)
LEGACY (hwilib.common.AddressType attribute)
M
MAIN (hwilib.common.Chain attribute)
message
hwi-signmessage command line option
MISSING_ARGUMENTS (in module hwilib.errors)
module
hwilib._base58
hwilib._bech32
hwilib._script
hwilib._serialize
hwilib.commands
hwilib.common
hwilib.descriptor
hwilib.devices.coldcard
hwilib.devices.digitalbitbox
hwilib.devices.keepkey
hwilib.devices.ledger
hwilib.devices.trezor
hwilib.errors
hwilib.hwwclient
hwilib.key
hwilib.psbt
hwilib.udevinstaller
MultisigDescriptor (class in hwilib.descriptor)
N
NEED_TO_BE_ROOT (in module hwilib.errors)
NeedsRootError
NO_DEVICE_TYPE (in module hwilib.errors)
NO_PASSWORD (in module hwilib.errors)
NoPasswordError
NOT_IMPLEMENTED (in module hwilib.errors)
NotImplementedError
O
output_script (hwilib.descriptor.ExpandedScripts property)
P
parse() (hwilib.descriptor.PubkeyProvider class method)
parse_descriptor() (in module hwilib.descriptor)
parse_multisig() (in module hwilib._script)
parse_path() (in module hwilib.key)
parse_pubkey() (in module hwilib.descriptor)
PartiallySignedInput (class in hwilib.psbt)
PartiallySignedOutput (class in hwilib.psbt)
path
hwi-getxpub command line option
hwi-signmessage command line option
pin
hwi-sendpin command line option
PKDescriptor (class in hwilib.descriptor)
PKHDescriptor (class in hwilib.descriptor)
prompt_pin() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
psbt
hwi-signtx command line option
PSBT (class in hwilib.psbt)
PSBTSerializationError
PubkeyProvider (class in hwilib.descriptor)
R
Readable (class in hwilib._serialize)
redeem_script (hwilib.descriptor.ExpandedScripts property)
REGTEST (hwilib.common.Chain attribute)
reload_rules() (hwilib.udevinstaller.UDevInstaller method)
restore_device() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
ripemd160() (in module hwilib.common)
S
send_pin() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
ser_compact_size() (in module hwilib._serialize)
ser_sig_compact() (in module hwilib._serialize)
ser_sig_der() (in module hwilib._serialize)
ser_string() (in module hwilib._serialize)
ser_string_vector() (in module hwilib._serialize)
ser_uint256() (in module hwilib._serialize)
ser_vector() (in module hwilib._serialize)
Serializable (class in hwilib._serialize)
serialize() (hwilib.key.ExtendedKey method)
(hwilib.key.KeyOriginInfo method)
(hwilib.psbt.PartiallySignedInput method)
(hwilib.psbt.PartiallySignedOutput method)
(hwilib.psbt.PSBT method)
set_null() (hwilib.psbt.PartiallySignedInput method)
(hwilib.psbt.PartiallySignedOutput method)
setup_device() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
setup_from_tx() (hwilib.psbt.PSBT method)
SH_WIT (hwilib.common.AddressType attribute)
sha256() (in module hwilib.common)
SHDescriptor (class in hwilib.descriptor)
sign_message() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
sign_tx() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
SIGNET (hwilib.common.Chain attribute)
signmessage() (in module hwilib.commands)
signtx() (in module hwilib.commands)
start
hwi-getkeypool command line option
T
TAP (hwilib.common.AddressType attribute)
TEST (hwilib.common.Chain attribute)
to_address() (in module hwilib._base58)
to_string() (hwilib.descriptor.Descriptor method)
(hwilib.descriptor.MultisigDescriptor method)
(hwilib.descriptor.PKDescriptor method)
(hwilib.descriptor.PKHDescriptor method)
(hwilib.descriptor.PubkeyProvider method)
(hwilib.descriptor.SHDescriptor method)
(hwilib.descriptor.TRDescriptor method)
(hwilib.descriptor.WPKHDescriptor method)
(hwilib.descriptor.WSHDescriptor method)
(hwilib.key.ExtendedKey method)
(hwilib.key.KeyOriginInfo method)
to_string_no_checksum() (hwilib.descriptor.Descriptor method)
(hwilib.descriptor.MultisigDescriptor method)
(hwilib.descriptor.PKDescriptor method)
(hwilib.descriptor.PKHDescriptor method)
(hwilib.descriptor.SHDescriptor method)
(hwilib.descriptor.TRDescriptor method)
(hwilib.descriptor.WPKHDescriptor method)
(hwilib.descriptor.WSHDescriptor method)
toggle_passphrase() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
TRDescriptor (class in hwilib.descriptor)
TrezorClient (class in hwilib.devices.trezor)
trigger() (hwilib.udevinstaller.UDevInstaller method)
U
UDevInstaller (class in hwilib.udevinstaller)
uint256_from_str() (in module hwilib._serialize)
UNAVAILABLE_ACTION (in module hwilib.errors)
UnavailableActionError
UNKNOWN_ERROR (in module hwilib.errors)
UnknownDeviceError
UNKNWON_DEVICE_TYPE (in module hwilib.errors)
W
wipe_device() (hwilib.devices.coldcard.ColdcardClient method)
(hwilib.devices.digitalbitbox.DigitalbitboxClient method)
(hwilib.devices.keepkey.KeepkeyClient method)
(hwilib.devices.ledger.LedgerClient method)
(hwilib.devices.trezor.TrezorClient method)
(hwilib.hwwclient.HardwareWalletClient method)
(in module hwilib.commands)
WIT (hwilib.common.AddressType attribute)
with_traceback() (hwilib.devices.digitalbitbox.DBBError method)
(hwilib.errors.ActionCanceledError method)
(hwilib.errors.BadArgumentError method)
(hwilib.errors.DeviceAlreadyInitError method)
(hwilib.errors.DeviceAlreadyUnlockedError method)
(hwilib.errors.DeviceBusyError method)
(hwilib.errors.DeviceConnectionError method)
(hwilib.errors.DeviceFailureError method)
(hwilib.errors.DeviceNotReadyError method)
(hwilib.errors.HWWError method)
(hwilib.errors.NeedsRootError method)
(hwilib.errors.NoPasswordError method)
(hwilib.errors.NotImplementedError method)
(hwilib.errors.PSBTSerializationError method)
(hwilib.errors.UnavailableActionError method)
(hwilib.errors.UnknownDeviceError method)
witness_script (hwilib.descriptor.ExpandedScripts property)
WPKHDescriptor (class in hwilib.descriptor)
WSHDescriptor (class in hwilib.descriptor)
X
xpub_main_2_test() (in module hwilib._base58)
xpub_to_pub_hex() (in module hwilib._base58)
xpub_to_xonly_pub_hex() (in module hwilib._base58)
Read the Docs
v: latest
Versions
latest
stable
2.3.1
2.3.0
2.2.1
2.2.0
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
Downloads
On Read the Docs
Project Home
Builds