arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-18 12:28:09 +00:00
Code Issues Releases Wiki Activity

feat(python): Optionally init_device in TrezorClient

Browse Source
This commit is contained in:
Andrew Chow 2021-02-03 18:55:37 -05:00 committed by matejcik
parent be6d01729d
commit dbf57d745a
1 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
python/src/trezorlib/client.py
View File

@ -77,18 +77,6 @@ class TrezorClient:
This class allows you to manage connection state, send and receive protobuf This class allows you to manage connection state, send and receive protobuf
messages, handle user interactions, and perform some generic tasks messages, handle user interactions, and perform some generic tasks
(send a cancel message, initialize or clear a session, ping the device). (send a cancel message, initialize or clear a session, ping the device).
You have to provide a transport, i.e., a raw connection to the device. You can use
`trezorlib.transport.get_transport` to find one.
You have to provide an UI implementation for the three kinds of interaction:
- button request (notify the user that their interaction is needed)
- PIN request (on T1, ask the user to input numbers for a PIN matrix)
- passphrase request (ask the user to enter a passphrase)
See `trezorlib.ui` for details.
You can supply a `session_id` you might have saved in the previous session.
If you do, the user might not need to enter their passphrase again.
""" """
def __init__( def __init__(
@ -97,12 +85,36 @@ class TrezorClient:
ui: "TrezorClientUI", ui: "TrezorClientUI",
session_id: Optional[bytes] = None, session_id: Optional[bytes] = None,
derive_cardano: Optional[bool] = None, derive_cardano: Optional[bool] = None,
_init_device: bool = True,
) -> None: ) -> None:
"""Create a TrezorClient instance.
You have to provide a `transport`, i.e., a raw connection to the device. You can
use `trezorlib.transport.get_transport` to find one.
You have to provide an UI implementation for the three kinds of interaction:
- button request (notify the user that their interaction is needed)
- PIN request (on T1, ask the user to input numbers for a PIN matrix)
- passphrase request (ask the user to enter a passphrase) See `trezorlib.ui` for
details.
You can supply a `session_id` you might have saved in the previous session. If
you do, the user might not need to enter their passphrase again.
By default, the instance will open a connection to the Trezor device, send an
`Initialize` message, set up the `features` field from the response, and connect
to a session. By specifying `_init_device=False`, this step is skipped. Notably,
this means that `client.features` is unset. Use `client.init_device()` or
`client.refresh_features()` to fix that, otherwise A LOT OF THINGS will break.
Only use this if you are _sure_ that you know what you are doing. This feature
might be removed at any time.
"""
LOG.info(f"creating client instance for device: {transport.get_path()}") LOG.info(f"creating client instance for device: {transport.get_path()}")
self.transport = transport self.transport = transport
self.ui = ui self.ui = ui
self.session_counter = 0 self.session_counter = 0
self.session_id = session_id self.session_id = session_id
if _init_device:
self.init_device(session_id=session_id, derive_cardano=derive_cardano) self.init_device(session_id=session_id, derive_cardano=derive_cardano)
def open(self) -> None: def open(self) -> None: