Trezor Firmware documentation
This documentation can also be found at docs.trezor.io where it is available in a HTML-built version compiled using mdBook.
Welcome to the Trezor Firmware repository. This repository is so called monorepo, it contains several different yet very related projects that together form the Trezor Firmware ecosystem.
ci: Gitlab CI configuration files
common/defs: JSON coin definitions and support tables
common/protob: Common protobuf definitions for the Trezor protocol
common/tools: Tools for managing coin definitions and related data
core: Trezor Core, firmware implementation for Trezor T
crypto: Stand-alone cryptography library used by both Trezor Core and the Trezor One firmware
docs: Assorted documentation
legacy: Trezor One firmware implementation
python: Python client library and the
storage: NORCOW storage implementation used by both Trezor Core and the Trezor One firmware
tests: Firmware unit test suite
tools: Miscellaneous build and helper scripts
vendor: Submodules for external dependencies
Also please have a look at the docs, either in the
docs folder or at docs.trezor.io before contributing. The misc chapter should be read in particular because it contains some useful assorted knowledge.
Security vulnerability disclosure
Please report suspected security vulnerabilities in private to [email protected], also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.
Note on terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.