TREZOR SUITE MONOREPO

July 29, 2022 ยท View on GitHub

img

Packages

packagedescription
@trezor/analyticsgeneric analytics implementation
@trezor/atomsfront-end React Native components
@trezor/auth-serverNodeJS server for secure Google OAuth
@trezor/blockchain-linklib for connecting to blockchains
@trezor/componentsfront-end React components for web + desktop
@trezor/connect3rd party interface entrypoint for nodejs
@trezor/connect-commonstatic files and commons for @trezor/connect
@trezor/connect-examplesexample implementations of @trezor/connect
@trezor/connect-explorerinteractive demo for @trezor/connect
@trezor/connect-iframeconnect-iframe build from monorepo
@trezor/connect-plugin-ethereumplugin for 3rd party Ethereum wallets
@trezor/connect-plugin-stellarplugin for 3rd party Stellar wallets
@trezor/connect-popupUI for 3rd party implementations
@trezor/connect-web3rd party interface entrypoint for browser
@trezor/integration-testscross-packages e2e tests
@trezor/news-apimedium proxy providing allow-origin headers
@trezor/request-managerimproved communication with Tor
@trezor/stylescustom styling library for native app
@trezor/suite-analyticsanalytics for Suite
@trezor/suite-buildbuild utilities
@trezor/suite-datasuite static data
@trezor/suite-desktop-apiAPI for suite - suite-desktop communication
@trezor/suite-desktopsuite build target for Mac, Win, Linux
@trezor/suite-nativesuite build target for react-native
@trezor/suite-storageabstract database definition for suite
@trezor/suite-web-landinghttps://suite.trezor.io/
@trezor/suite-websuite build target for web
@trezor/suiteTrezor Suite common code
@trezor/transport-nativecommunication lib for React Native
@trezor/transportcommunication lib for JavaScript
@trezor/urlsshared urls plus health checking
@trezor/utilsshared utility functions
@trezor/utxo-libbtc-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 submodule update --init --recursive
  • 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