TREZOR SUITE MONOREPO

Packages

package	description
@trezor/analytics	generic analytics implementation
@trezor/blockchain-link	lib for connecting to blockchains
@trezor/components	frontend react components
@trezor/connect	3rd party interface entrypoint for nodejs
@trezor/connect-examples	example implementations of @trezor/connect
@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/connect-plugin-ethereum	plugin for 3rd party ethereum wallets
@trezor/connect-popup	UI for 3rd party implementations
@trezor/connect-web	3rd party interface entrypoint for browser
@trezor/integration-tests	cross-packages e2e tests
@trezor/news-api	medium proxy providing allow-origin headers
@trezor/suite	trezor suite common code
@trezor/suite-analytics	analytics data for suite app
@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/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

@trezor/suite development

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.git
• git lfs pull
• nvm install
• yarn
• yarn 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 development

Trezor Connect is a platform for easy integration of Trezor hardware wallets into 3rd party applications. Historically, trezor-connect had its own repository. This repository is still active and accepts hotfixes for trezor-connect version 8.

@trezor/connect version 9 is developed in this repository only.

Contribute

Inspired by GitLab Contributing Guide

Using Conventional Commits is strongly recommended and might be enforced in future.

Security vulnerability disclosure

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.

IDE specific settings

Find specific settings for Integrated Development Environments (IDE) in IDE.md