| package | description |
|---|---|
| @trezor/blockchain-link | lib for connecting to blockchains |
| @trezor/components | frontend react components |
| @trezor/connect-common | static files and commons for trezor-connect |
| @trezor/connect-explorer | interactive demo for trezor-connect |
| @trezor/connect-iframe | connect-iframe build from monorepo |
| @trezor/integration-tests | cross-packages e2e tests |
| @trezor/news-api | medium proxy providing allow-origin headers |
| @trezor/rollout | firmware updated utilities |
| @trezor/suite-build | build utilities |
| @trezor/suite-data | suite static data |
| @trezor/suite-desktop-api | API for suite - suite-desktop communication |
| @trezor/suite-desktop | suite build target for Mac, Win, Linux |
| @trezor/suite-native | suite build target for react-native |
| @trezor/suite-storage | abstract database definition for suite |
| @trezor/suite-web-landing | https://suite.trezor.io/ |
| @trezor/suite-web | suite build target for web |
| @trezor/suite | trezor suite common code |
| @trezor/transport-native | communication lib for react-native |
| @trezor/transport | communication lib for javascript |
| @trezor/utils | shared utility functions |
| @trezor/utxo-lib | btc-like coins lib |
Before you start make sure you have downloaded and installed NVM, Yarn and git with git lfs.
git clone git@github.com:trezor/trezor-suite.gitgit lfs pullnvm installyarnyarn build:libs && yarn workspace @trezor/suite-data msg-system-sign-config
To set up your dev environment for a native platform (iOS/Android) follow these additional steps.
Run a dev build:
yarn suite:dev(web app)yarn suite:dev:desktop(electron app)yarn suite:dev:android(react-native Android)yarn suite:dev:ios(react-native iOS)
Trezor Connect is a platform for easy integration of Trezor into 3rd party services. At the moment, trezor-connect has its own repository but we expect it to be migrated into the trezor-suite monorepo in a very short time.
When adding new features to trezor-connect you need to work with both repositories. Please follow the readme in @trezor/transport package on how protobuf definitions are updated.
Inspired by GitLab Contributing Guide
Using Conventional Commits is strongly recommended and might be enforced in future.
Please report suspected security vulnerabilities in private to security@satoshilabs.com, also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.
Find specific settings for Integrated Development Environments (IDE) in IDE.md