Suite Desktop
Main differences between suite-web and suite-desktop builds
- @trezor/connect API
- suite-web
@trezor/connectis part of the JavaScript bundle as a regular module.@trezor/connectimports from@trezor/suiteare replaced to@trezor/connect-websee webpack config
- suite-desktop
@trezor/connectis installed as regular node_module and works in nodejs context (electron main process).@trezor/connectfiles are not hosted on the electron renderer context.- On the renderer context all
@trezor/connectmethods from are replaced by@trezor/ipc-proxymethods. see index
- suite-web
- Firmware binaries
- suite-web
- newest firmware binaries are hosted at
[url]/build/static/connect/data/firmwareand they are downloaded using regularfetchAPI.
- newest firmware binaries are hosted at
- suite-desktop
- firmware binaries are bundled as application resources in
bindirectory, full path depends on OS but it could be found on the as level asapp.asarfile, and they are downloaded usingfs.readFileAPI. see @trezor/connect/src/utils/assets
- firmware binaries are bundled as application resources in
- suite-web
- Trezor Bridge (trezord)
- Tor
- Bluetooth transport
App ID and name by environment
| Environment | App ID | App name | User data dir name |
|---|---|---|---|
| production (codesign) | com.trezor.suite | Trezor Suite | @trezor/suite-desktop |
| development (sldev) | com.trezor.suite.dev | Trezor Suite Dev | @trezor/suite-desktop-dev |
| local dev server | com.github.Electron | Trezor Suite Local | @trezor/suite-desktop-local |
Suite app name and ID are set by the environment so that Suite uses different user data dir and it's not mixed between environments. The main benefit is that you can switch back and forth between Suite dev versions without losing your remembered production wallets. One disadvantage of this solution is checking of other instance running is not so straightforward between environments.
Same concept (user data separated by environment) works on web out of the box (storage per domain name).
Note that locally built Suite is "development (sldev)", while "local dev server" is for yarn suite:dev:desktop.
If you want to run built Suite app with fresh data on every start (similarly to running Suite Web in an anonymous browser window), follow these instructions.
Debugging
See separate documentation for debugging with debugging instructions.
Logging
Logging can be enabled by running Suite with the command line flag --log-level=LEVEL (replace LEVEL with error, warn, info or debug based on the logging you wish to display). Additional command line flags can be found here.
More technical information can be found on the Desktop Logger page.
Shortcuts
Available shortcuts as provided by Electron:
| name | commands |
|---|---|
| Reload app | F5, Ctrl+R, Cmd+R |
| Hard Reload app | Shift+F5, Shift+Ctrl+R, Shift+Cmd+R |
| Restart app | Alt+F5, Option+F5, Alt+Shift+R, Option+Shift+R |
| Open DevTools | F12, Cmd+Shift+I,Ctrl+Shift+I, Cmd+Alt+I, Ctrl+Alt+I |
Runtime flags
See separate documentation for runtime-flags with runtime flags.
Extract application
MacOS
npx @electron/asar extract ./Trezor\ Suite.app/Contents/Resources/app.asar ./decompiled
NixOS
Run application to get mount-id like:
Trezor-Suite.AppImage installed in ~/.cache/appimage-run/e4f67ae8624c4079527c669d8a3c4bbc1dd00b83b2e1d15807a5863b11bd4f38
npx @electron/asar extract ~/.cache/appimage-run/[mount-id]/resources/app.asar ./decompiled