aac7726824
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. |
||
|---|---|---|
| bash_completion.d | ||
| docs | ||
| tools | ||
| trezorlib | ||
| vendor | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| COPYING | ||
| Makefile | ||
| MANIFEST.in | ||
| README.md | ||
| requirements-dev.txt | ||
| requirements-optional.txt | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| shell.nix | ||
| tox.ini | ||
| trezorctl | ||
| trigger-travis.sh | ||
python-trezor
Python library and commandline client for communicating with TREZOR Hardware Wallet
See https://trezor.io for more information
Install
Python-trezor requires Python 3.3 or higher, and libusb 1.0. The easiest
way to install it is with pip. The rest of this guide assumes you have
a working pip; if not, you can refer to this
guide.
Trezor T only
On a typical Linux / Mac / BSD system, you already have all you need.
Install trezor with:
pip3 install --upgrade setuptools
pip3 install trezor
On Windows, you also need to install libusb and the appropriate drivers. This is, unfortunately, a topic bigger than this README.
Trezor One support
In addition to the above, you need to install development headers for HIDAPI.
On a Debian or Ubuntu based system, you can install these:
sudo apt-get install python3-dev python3-pip cython3 libusb-1.0-0-dev libudev-dev
When installing the trezor library, you need to specify that you want
hidapi:
pip3 install --upgrade setuptools
pip3 install trezor[hidapi]
Ethereum support
Ethereum requires additional python packages. Instead of
pip3 install trezor, specify pip3 install trezor[ethereum].
You can combine it with the above, to get both HIDAPI and Ethereum support:
pip3 install trezor[ethereum,hidapi]
FreeBSD
On FreeBSD you can install the packages:
pkg install security/py-trezor
or build via ports:
cd /usr/ports/security/py-trezor
make install clean
Command line client (trezorctl)
The included trezorctl python script can perform various tasks such as
changing setting in the Trezor, signing transactions, retrieving account
info and addresses. See the docs/ sub folder for detailed
examples and options.
NOTE: An older version of the trezorctl command is available for
Debian Stretch
(and comes pre-installed on Tails OS).
Python Library
You can use this python library to interact with a Bitcoin Trezor and use its capabilities in your application. See examples here in the tools/ sub folder.
PIN Entering
When you are asked for PIN, you have to enter scrambled PIN. Follow the numbers shown on TREZOR display and enter the their positions using the numeric keyboard mapping:
| 7 | 8 | 9 |
| 4 | 5 | 6 |
| 1 | 2 | 3 |
Example: your PIN is 1234 and TREZOR is displaying the following:
| 2 | 8 | 3 |
| 5 | 4 | 6 |
| 7 | 9 | 1 |
You have to enter: 3795
Contributing
Python-trezor pulls coins info and protobuf messages from
trezor-common repository. If
you are developing new features for Trezor, you will want to start
there. Once your changes are accepted to trezor-common, you can make a
PR against this repository. Don't forget to update the submodule with:
git submodule update --init --remote
Then, rebuild the protobuf messages and get coins.json by running:
python3 setup.py prebuild
To get support for BTC-like coins, these steps are enough and no further changes to the library are necessary.