1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-24 15:28:10 +00:00
trezor-firmware/trezorlib
matejcik aac7726824 trezorlib: transport/protocol reshuffle
This commit breaks session handling (which matters with Bridge) and
regresses Bridge to an older code state. Both of these issues will be
rectified in subsequent commits.

Explanation of this big API reshuffle follows:

* protocols are moved to trezorlib.transport, and to a single common file.
* there is a cleaner definition of Transport and Protocol API (see below)
* fully valid mypy type hinting
* session handle counters and open handle counters mostly went away. Transports
  and Protocols are meant to be "raw" APIs; TrezorClient will implement
  context-handler-based sessions, session tracking, etc.

I'm calling this a "reshuffle" because it involved very small number of
code changes. Most of it is moving things around where they sit better.

The API changes are as follows.

Transport is now a thing that can:
* open and close sessions
* read and write protobuf messages
* enumerate and find devices

Some transports (all except bridge) are technically bytes-based and need
a separate protocol implementation (because we have two existing protocols,
although only the first one is actually used). Hence a protocol superclass.

Protocol is a thing that *also* can:
* open and close sessions
* read and write protobuf messages
For that, it requires a `handle`.

Handle is a physical layer for a protocol. It can:
* open and close some sort of device connection
  (this is distinct from session! Connection is a channel over which you can
  send data. Session is a logical arrangement on top of that; you can have
  multiple sessions on a single connection.)
* read and write 64-byte chunks of data

With that, we introduce ProtocolBasedTransport, which simply delegates
the appropriate Transport functionality to respective Protocol methods.

hid and webusb transports are ProtocolBasedTransport-s that provide separate
device handles. HidHandle and WebUsbHandle existed before, but the distinction
of functionality between a Transport and its Handle was unclear. Some methods
were moved and now the handles implement the Handle API, while the transports
provide the enumeration parts of the Transport API, as well as glue between
the respective Protocols and Handles.

udp transport is also a ProtocolBasedTransport, but it acts as its own handle.
(That might be changed. For now, I went with the pre-existing structure.)

In addition, session_begin/end is renamed to begin/end_session to keep
consistent verb_noun naming.
2018-11-12 12:22:26 +01:00
..
messages build: remove prebuilt protobuf files 2018-07-09 13:46:18 +02:00
qt Fix Qt5/4 import strategy. 2018-10-04 17:42:59 +02:00
tests trezorlib: transport/protocol reshuffle 2018-11-12 12:22:26 +01:00
transport trezorlib: transport/protocol reshuffle 2018-11-12 12:22:26 +01:00
__init__.py build: do not import trezorlib in setup.py, parse out __version__ by hand 2018-07-09 13:46:18 +02:00
_ed25519.py cosi: replace slow djb implementation of ed25519 with an optimized one 2018-10-12 12:58:44 +02:00
btc.py style: fix imports 2018-11-06 13:36:25 +01:00
cardano.py trezorlib+tools: remove usage of binascii 2018-09-27 16:52:28 +02:00
ckd_public.py style: apply black/isort 2018-08-13 18:22:19 +02:00
client.py client: do not coerce self.features.vendor to string 2018-11-06 14:16:53 +01:00
coins.py tx_api: rework API, separate caching functionality to test support 2018-11-06 13:36:25 +01:00
cosi.py cosi: tests for new verify_m_of_n method 2018-10-12 12:58:49 +02:00
debuglink.py trezorlib: transport/protocol reshuffle 2018-11-12 12:22:26 +01:00
device.py style: isort & autopep 2018-10-10 13:15:28 +02:00
ethereum.py tests: fix eip155 test 2018-09-03 14:53:53 +02:00
exceptions.py exceptions: smarter, nicer exceptions from Failures 2018-10-12 15:49:17 +02:00
firmware.py firmware: fix byte order for VendorTrust field, reproduce reserved field 2018-11-06 13:36:25 +01:00
lisk.py style: uppercase hex constants to conform with black 18.9b0 style 2018-10-01 14:01:33 +02:00
log.py style: apply black/isort 2018-08-13 18:22:19 +02:00
mapping.py style: apply black/isort 2018-08-13 18:22:19 +02:00
misc.py style: apply black/isort 2018-08-13 18:22:19 +02:00
monero.py fix style 2018-11-04 16:06:21 +01:00
nem.py trezorlib+tools: remove usage of binascii 2018-09-27 16:52:28 +02:00
ontology.py add Ontology support (#301) 2018-09-06 15:36:44 +02:00
protobuf.py trezorlib: add some utility features 2018-11-06 13:36:25 +01:00
ripple.py tests: ripple fix 2018-09-05 10:42:32 +02:00
stellar.py style: uppercase hex constants to conform with black 18.9b0 style 2018-10-01 14:01:33 +02:00
tezos.py added Tezos support (#302) 2018-09-10 16:40:31 +02:00
tools.py trezorlib: transport/protocol reshuffle 2018-11-12 12:22:26 +01:00
tx_api.py style: fix imports 2018-11-06 13:36:25 +01:00
ui.py ui: switch ClickUI to use stderr 2018-10-25 12:47:14 +02:00