Quick Start

Ape Trezor is a plugin for Ape Framework which integrates Trezorlib ethereum.py to load and create accounts, sign messages, and sign transactions.

Dependencies

• Python 3 version 3.10 or greater.
• Supported Trezor device (x = tested):
  • Model T
  • Safe 3
  • Safe 5
  • Safe 7

Note: USB does not work in WSL2 environments natively and requires additional setup.

Installation

via pip

You can install the latest release via pip:

pip install ape-trezor

via source

You can clone the repository and install for development:

git clone https://github.com/ApeWorX/ape-trezor.git
cd ape-trezor
uv sync --group dev
uv run prek install

Quick Usage

Trezor accounts have the following capabilities in ape:

1. Can sign transactions (both static-fee and EIP-1559 compliant)
2. Can sign messages using the default EIP-191 specification

To use the Trezor plugin, you must have the Trezor USB device connected and unlocked.

WARNING: When the Trezor Suite is open, you may face additional connection issues. It is recommended to not have the Trezor Suite application open while using the plugin.

Add Accounts

Add accounts using the add command:

ape trezor add <alias>

You can also specify the HD Path:

ape trezor add <alias> --hd-path "m/44'/1'/0'/0"

WARNING: When using 3rd party wallets, such as this plugin, trezorlib discourages signing transactions from the default Ethereum HD Path m/44'/60'/0'/0. Changing the HD-Path in that circumstance will allow fewer warnings from both Ape and the device, as well as improved security. See https://github.com/trezor/trezor-firmware/issues/1336#issuecomment-720126545 for more information.

trezor:
  hd_path: "m/44'/1'/0'/0"

List Accounts

To list just your Trezor accounts in ape, do:

ape trezor list

Remove accounts

You can also remove accounts:

ape trezor delete <alias>
ape trezor delete-all

Sign Messages

You can sign messages with your accounts:

ape trezor sign-message <alias> "hello world"

Verify Messages

You can also verify a message with a signature:

ape trezor verify-message "hello world" <signature>

Using trezorctl

For conveinence, we've added trezorctl from the trezor library as a subcommand under this plugin's own ape trezor cli subcommand. To access it, simply use ape trezor ctl [CMD].

As an example, to connect to the new BLE-enabled Trezor 7 device, use:

$ ape trezor ctl ble connect

You can also use other commands for deeper management of the device such as:

# Setup a new device
$ ape trezor ctl device setup

# Manage firmware on device(s)
$ ape trezor ctl firmware

Development

Please see the contributing guide to learn more how to contribute to this project. Comments, questions, criticisms and pull requests are welcomed.