Trezor User Env

This environment is meant to support Trezor development - both Firmware and Suite and other related projects. Its main goals are:

• Provide an easy websocket server that is capable of:
  • Launching/stopping different versions of the firmware emulator.
  • Launching/stopping trezord-go (Bridge).
  • Send simple debug commands to the emulator.
• Enable full integration testing of Suite, firmware emulator and Bridge using the websocket server.
• Provide a HTML page that communicates with the server. This allows the developers to perform the actions above.
• To be Nix-native but also offer Docker image to allow non-NixOS developers to use it.

How to run

You can also run trezor-user-env "natively" if you are on NixOS but we mainly support the Docker way as described here.

In case you have installed Trezor Bridge previously there will be a port conflict, please make sure it is not running. Either uninstall it completely or stop the service.

Supported platforms are Linux and macOS (both Intel and Silicon).

Prerequisites

• Docker (on Linux, you need to be able to run it as non-root user, follow those steps)

Steps

1. Clone this repo and enter the directory
2. Run ./run.sh - it will determine your platform and launch trezor-user-env. See ./run.sh --help for some additional arguments.
3. Open http://localhost:9002. The emulator display is available via the browser-based VNC viewer embedded in the dashboard, or via a VNC client at localhost:15900.

git clone https://github.com/trezor/trezor-user-env.git
cd trezor-user-env
./run.sh

Connecting to Trezor Suite

Trezor Suite normally relies on it's own bundled Bridge. To use the Bridge from trezor-user-env instead, you need to disable the bundled Bridge in Suite's debug settings.

1. To enable debug settings, open Trezor Suite -> Settings and 5x click on the "Settings" title at the top of the page.
2. Go to the "Debug" tab, scroll down to "Transport backends" and disable "Bridge server".
3. Also disable "Run on startup" if you want to remember this setting for next launches of Suite.
4. If you want to use a real device again, make sure to re-enable the "Bridge server" option.

Basic terminology

• Controller
  • Websocket server running on localhost:9001
  • Has the functionality to control trezor components (run emulators, bridges, etc.)
  • Used by Dashboard (below) or by automated end-to-end tests in Trezor Suite
• Dashboard
  • HTML page being accessible on localhost:9002
  • Instructs the websocket server what to do by predefined functionality
  • Used by developers testing their firmware/suite applications manually
• Bridge
  • Service running on localhost:21325
  • Connection between the trezor device (or running emulator) and the host
  • Used by applications needing to communicate with trezor device (for example Suite)
• Bitcoin regtest
  • Bitcoind with blockbook running in regtest mode
  • Default credentials for bitcoin backend
    • user and password: rpc/rpc and that you can run
  • You can test the connection with bitcoin-cli -rpcport=18021 -rpcuser=rpc -rpcpassword=rpc -getinfo

Development

See docs/development.md.

Troubleshooting

• On Apple Silicon Macs, trezor-user-env-regtest runs in an emulation layer as there is no arm native image. You may experience some slowness or issues when using it on arm Macs.

Features

Running node bridge from local Suite build

• instead of running the develop version of the node bridge, downloadable from https://dev.suite.sldev.cz/transport-bridge/develop/dist/bin.js, it is possible to run the bin.js server from the local Suite build
• it is necessary to create a symbolic link to the ./trezor-suite dir with the local Suite repository - e.g. ln -s ~/trezor-suite trezor-suite in the root of the trezor-user-env repo