Утилита trezorctl

trezorctl представляет собой мощный инструмент командной строки для управления устройствами Trezor. В данном руководстве будут описаны основные команды trezorctl.

Установка trezorctl

Для установки trezorctl и настройки системы для работы с устройством выполните шаги из инструкции: Подключение аппаратных кошельков по USB.

Если вы хотите установить другую версию trezorctl, сначала получите список версий:

python3 -m pip install trezor==

Установите нужную версию:

python3 -m pip install trezor==0.13.9

Если вы хотите собрать свежую версию из исходного кода, выполните:

python3 -m pip uninstall trezor
git clone --recurse-submodules https://github.com/trezor/trezor-firmware ~/trezor-firmware
cd ~/trezor-firmware/python/
python3 -m pip install -r requirements.txt
python3 setup.py build
python3 setup.py install --user

crypto — Криптографические функции

get-entropy

Получить случайные байты от устройства.

Использование:

trezorctl crypto get-entropy РАЗМЕР

device — Команды управления устройством

backup

Создать резервную копию сид-фразы. Устройство должно находится в состоянии “Needs Backup”. Дополнительные опции предназначены для резервного копирования типа Advanced или Shamir в кошельках Trezor T/Safe.

Использование:

trezorctl device backup

Пример для резервного копирования типа Advanced:

trezorctl device backup -t 2 -g 2 3 -g 2 3 -g 3 5
ОпцияОписание
-t, --group-threshold ЧИСЛОМинимальное число групп для восстановления кошелька
-g, --group ПОРОГ КОЛИЧЕСТВО_ЧАСТЕЙУказывается порог и количество частей для каждой группы

Таким образом, в нашем примере количество групп — 3 (-g указано трижды), любые 2 группы из 3 могут восстановить кошелек (-t 2). У каждой группы есть общее количество частей (3 у первых двух и 5 у третьей) и число частей, которые могут быть использованы для восстановления (2-из-3, 2-из-3 и 3-из-5 соответственно).

Пример для резервного копирования типа Shamir:

trezorctl device backup -t 1 -g 3 5

Стандартное резервное копирование с разделением секрета Шамира подразумевает одну группу (-t 1) с указанием количества частей и числа частей, необходимого для восстановления кошелька (3-из-5).

Для резервного копирования типа Advanced или Shamir устройство должно быть инициализировано с опцией --backup-type single, shamir или advanced.

load

Загрузить временную (до перезагрузки устройства) сид-фразу и пользовательскую конфигурацию в устройство. Функция работает только с эмулятором или прошивкой, собранной с параметрами DEBUG_LINK=1 PRODUCTION=0. Для работы команды устройство должно быть не инициализировано. SLIP-0039 поддерживается только в Trezor T/Safe.

Использование:

trezorctl device load [ОПЦИИ]
ОпцияОписание
-m, --mnemonic SEED_ФРАЗА
-p, --pin PIN_КОД
-r, --passphrase-protectionВключить функцию кодовой фразы
-l, --label ИМЯ_КОШЕЛЬКА
-i, --ignore-checksumИгнорировать контрольную сумму сид-фразы
-s, --slip0014Загрузить тестовую сид-фразу формата BIP-0039 “all all all all all all all all all all all all” согласно SLIP-0014
-a, --academicТолько для Trezor T/Safe. Загрузить тестовую сид-фразу формата SLIP-0039 “academic again academic academic academic academic academic academic academic academic academic academic academic academic academic academic academic pecan provide remember”
-b, --needs-backupВключить функцию создания резервной копии
-n, --no-backupВыключить функцию создания резервной копии (по умолчанию)

reboot-to-bootloader

Перезагрузка устройства в режим загрузчика. Поддерживается только на Trezor One.

Использование:

trezorctl device reboot-to-bootloader

setup

Настройка устройства и генерация сид-фразы. Для работы команды устройство должно быть не инициализировано. SLIP-0039 поддерживается только в Trezor T/Safe.

Использование:

trezorctl device setup [ОПЦИИ]
ОпцияОписание
-t, --strength [128|192|256]Количество бит энтропии для создания сид-фразы. 128 — фраза BIP-0039 из 12 слов или фраза SLIP-0039 из 20 слов. 192 — фраза BIP-0039 из 18 слов. 256 — фраза BIP-0039 из 24 слов или фраза SLIP-0039 из 33 слов
-r, --passphrase-protectionВключить функцию кодовой фразы
-p, --pin-protectionВключить функцию защиты PIN-кодом
-l, --label ИМЯ_КОШЕЛЬКА
-u, --u2f-counter ЧИСЛОЗадать счетчик U2F
-s, --skip-backupПропустить резервное копирование
-n, --no-backupСоздать Seedless-кошелек без возможности резервного копирования
-b, --backup-type ЗНАЧЕНИЕТолько для Trezor T/Safe. Тип резервного копирования. bip39 — фраза BIP-0039. single — фраза SLIP-0039. shamir — разделение секрета Шамира с указанием на устройстве количества частей и порога. advanced — разделение секрета Шамира с указанием на устройстве количества групп и количества частей/порога для каждой группы
-e, --entropy-check-count ЧИСЛОТолько для Trezor T/Safe. Количество проверок энтропии перед созданием кошелька (см. статью)
-e, --show-entropyУстаревшая опция. Показать внутреннюю энтропию устройства при генерации сид-фразы. Функция не поддерживается в новых версиях прошивок (см. руководство)

wipe

Сброс устройства до заводских настроек и удаление всех секретныx данных, включая сид-фразу.

Использование:

trezorctl device wipe [ОПЦИИ]
ОпцияОписание
-b, --bootloaderСброс устройства в режиме загрузчика с удалением установленной прошивки

firmware — Команды управления прошивкой

download

Скачать и верифицировать файл прошивки.

Использование:

trezorctl firmware download [ОПЦИИ]
ОпцияОписание
-v, --version ВЕРСИЯВерсия прошивки для загрузки
-m, --model МОДЕЛЬМодель устройства: T1B1 (или 1, one), T2T1 (или t), T2B1 (или r, safe3, s3), T3B1, T3T1 (или safe5, s5)
-s, --skip-checkНе проверять целостность прошивки
--bitcoin-onlyСкачать версию Bitcoin Only

get-hash

Получить хэш-сумму установленной прошивки в сочетании с криптографическим вызовом. За подробностями использования команды обратитесь к руководству Проверка подлинности Trezor One.

Использование:

trezorctl firmware get-hash ВЫЗОВ

update

Установка прошивки на устройство.

Использование:

trezorctl firmware update [ОПЦИИ]
ОпцияОписание
-f, --filename ФАЙЛУказать путь к файлу прошивки
-u, --url URLУказать ссылку на файл прошивки
-v, --version ВЕРСИЯВерсия прошивки для загрузки и установки
-s, --skip-checkНе проверять целостность прошивки
-n, --dry-runВыполнить все шаги, но не устанавливать прошивку на устройство
--bitcoin-onlyСкачать и установить версию Bitcoin Only

verify

Проверка целостности файла прошивки.

Использование:

trezorctl firmware verify [ОПЦИИ] ФАЙЛ
ОпцияОписание
-c, --check-deviceПроверка совместимости устройства с прошивкой

set — Настройки устройства

auto-lock-delay

Установка времени автоматической блокировки устройства (в секундах, минимум — 60). Для работы функции должен быть установлен PIN-код.

Использование:

trezorctl set auto-lock-delay СЕКУНДЫ

brightness

Задать яркость экрана Trezor T.

Использование:

trezorctl set brightness

display-rotation

Ориентация дисплея Trezor T.

Использование:

trezorctl set display-rotation {north|east|south|west}

homescreen

Установить изображение на главный экран. Преобразование цвета и размера производится автоматически. Размер изображения для Trezor One — 128x64, для Trezor T — 240x240. Поддерживаемые форматы — JPG, PNG, WEBP.

Использование:

trezorctl set homescreen [ОПЦИИ] ФАЙЛ
ОпцияОписание
-q, –quality [0-100]Качество JPEG

Для установки изображения по умолчанию:

trezorctl set homescreen default

label

Задать имя устройства на главном экране.

Использование:

trezorctl set label "ИМЯ КОШЕЛЬКА"

passphrase

Управление функцией кодовой фразы.

Использование:

trezorctl set passphrase КОМАНДА [ОПЦИИ]
КомандаОписание
onВключить функцию кодовой фразы
-f, --force-on-deviceТолько для Trezor T/Safe. Дополнительная опция к команде on. Разрешить ввод кодовой фразы только на устройстве
-F, --no-force-on-deviceТолько для Trezor T/Safe. Дополнительная опция к команде on. Разрешить ввод кодовой фразы на ПК
offВыключить функцию кодовой фразы
hide [on|off]Показывать/не показывать кодовую фразу на устройстве

pin

Управление PIN-кодом.

Использование:

trezorctl set pin КОМАНДА
КомандаОписание
onВключить защиту PIN-кодом / Изменить PIN-код
offОтключить защиту PIN-кодом

safety-checks

Установка уровня проверки безопасности. Значение strict установлено по умолчанию, кошелек при этом не позволяет подписывать некоторые типы транзакций. При значении prompt выводится предупреждение на экран, но устройство позволяет подписать транзакцию в потенциально небезопасных условиях, таких как несовпадающие пути деривации или экстремальные комиссии.

Использование:

trezorctl set safety-checks [ОПЦИИ] {strict|prompt}
ОпцияОписание
--alwaysСохранять значение prompt после перезагрузки устройства

wipe-code

Управление кодом стирания.

Использование:

trezorctl set wipe-code КОМАНДА
КомандаОписание
onВключить защиту кодом стирания / Изменить код стирания
offОтключить защиту кодом стирания

version — Отображение версии trezorctl/trezorlib

Использование:

trezorctl version