You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
matejcik a6410693b3 Revert "feat(core): implement firmware dumping" 2 weeks ago
..
.changelog.d Revert "feat(python): implement firmware dumping" 2 weeks ago
bash_completion.d MONOREPO MERGE python-trezor 3 years ago
docs docs(python): freshen up READMEs, generate changelog 2 months ago
helper-scripts chore(python): regenerate GNU copyright headers 8 months ago
src/trezorlib Revert "feat(core): implement firmware dumping" 2 weeks ago
tests test(python): better dependency checking in tox 2 months ago
tools feat(python): ScriptUI for trezorctl, reference client implementation 7 months ago
.gitignore feat(python): add full type information 9 months ago
.towncrier.template.md docs(python): use towncrier for generating CHANGELOG.md 1 year ago
AUTHORS feat(python/trezorctl): improving and refactoring firmware CLI commands 1 year ago
CHANGELOG.md docs(python): regenerate changelog 1 month ago
CHANGELOG.unreleased docs(core): use towncrier for generating CHANGELOG.md 1 year ago
COPYING MONOREPO MERGE python-trezor 3 years ago
MANIFEST.in chore(python): exclude mako template from distributed packages 8 months ago
Makefile feat(tools): make pyright_tool more user-friendly 5 months ago
README.md docs(python): freshen up READMEs, generate changelog 2 months ago
default.nix Drop pyargs 3 years ago
pyrightconfig.json feat(tools): make pyright_tool more user-friendly 5 months ago
requirements-optional.txt chore(python): limit click version to be below 8.1 5 months ago
requirements.txt build(python): bump click to 8.1 2 months ago
setup.cfg chore(python): loosen ethereum dependencies 6 months ago
setup.py build(python): load requirements from requirements.txt 2 months ago
towncrier.toml fix(changelog): explicitly include title in rendered template 2 months ago
tox.ini build(python): widen tox test matrix to include multiple Click versions 1 month ago

README.md

trezorlib

repology image

Python library and command-line client for communicating with Trezor Hardware Wallet.

See https://trezor.io for more information.

Install

Python Trezor tools require Python 3.6 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.

On a typical system, you already have all you need. Install trezor with:

pip3 install trezor

On Windows, you also need to either install Trezor Bridge, or libusb and the appropriate drivers.

Firmware version requirements

Current trezorlib version supports Trezor One version 1.8.0 and up, and Trezor T version 2.1.0 and up.

For firmware versions below 1.8.0 and 2.1.0 respectively, the only supported operation is "upgrade firmware".

Trezor One with firmware older than 1.7.0 and bootloader older than 1.6.0 (including pre-2021 fresh-out-of-the-box units) will not be recognized, unless you install HIDAPI support (see below).

Installation options

  • Ethereum: To support Ethereum signing from command line, additional packages are needed. Install with:

    pip3 install trezor[ethereum]
    
  • Stellar: To support Stellar signing from command line, additional packages are needed. Install with:

    pip3 install trezor[stellar]
    
  • Firmware-less Trezor One: If you are setting up a brand new Trezor One manufactured before 2021 (with pre-installed bootloader older than 1.6.0), you will need HIDAPI support. On Linux, you will need the following packages (or their equivalents) as prerequisites: python3-dev, cython3, libusb-1.0-0-dev, libudev-dev.

    Install with:

    pip3 install trezor[hidapi]
    

To install all three, use pip3 install trezor[hidapi,ethereum,stellar].

Distro packages

Check out Repology to see if your operating system has an up-to-date python-trezor package.

Installing latest version from GitHub

pip3 install "git+https://github.com/trezor/trezor-firmware#egg=trezor&subdirectory=python"

Running from source

Install the Poetry tool, checkout trezor-firmware from git, and enter the poetry shell:

pip3 install poetry
git clone https://github.com/trezor/trezor-firmware
cd trezor-firmware
poetry install
poetry shell

In this environment, trezorlib and the trezorctl tool is running from the live sources, so your changes are immediately effective.

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 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

If you want to change protobuf or coin definitions, you will need to regenerate definitions in the python/ subdirectory.

First, make sure your submodules are up-to-date with:

git submodule update --init --recursive

Then, rebuild the protobuf messages by running, from the trezor-firmware top-level directory:

make gen

To get support for BTC-like coins, these steps are enough and no further changes to the library are necessary.