Go to file

ChiragMaliwal f359e36273 add .DS_Store to .gitignore (#900 )		4 years ago
.github/ISSUE_TEMPLATE	github: update issue templates	4 years ago
ci	ci: check if commit message contains fixup on travis	4 years ago
common	common/protob: update special fields usage in comments	4 years ago
core	Merge pull request #886 from trezor/onvej-sl/monero-optimizations-squashed	4 years ago
crypto	crypto: fix last commit	4 years ago
docs	docs/core: add info about exceptions usage	4 years ago
legacy	core+legacy: update changelogs	4 years ago
python	python: fix encoding errors in Stellar	4 years ago
storage	ci: add junit for a nice tests overview	4 years ago
tests	tests: remove explicit timeouts from test suite	4 years ago
tools	ci: upload ui tests fixtures	4 years ago
vendor	vendor: update nanopb to 0.4.1	4 years ago
.clang-format	style: fix weirdness in modtrezorio-fatfs.h	5 years ago
.gitignore	add .DS_Store to .gitignore (#900 )	4 years ago
.gitlab-ci.yml	ci: add a generic timeout to GitLab pytest runs	4 years ago
.gitmodules	vendor: change fido2-tests to our fork	5 years ago
.travis.yml	ci: check if commit message contains fixup on travis	4 years ago
CONTRIBUTING.md	docs: move docs to root	4 years ago
Makefile	build: make sure resources are built for 'make mypy'	4 years ago
Pipfile	pipfile: add nanopb to Pipfile	4 years ago
Pipfile.lock	pipfile: add nanopb to Pipfile	4 years ago
README.md	docs: move docs to root	4 years ago
SECURITY.md	docs: use monospace for fingerprints	5 years ago
build-docker.sh	build: in build-docker.sh, remove containers after we are done	4 years ago
create_monorepo.py	all: replace /bin/bash with /usr/bin/env bash	5 years ago
setup.cfg	tests: remove explicit timeouts from test suite	4 years ago
shell.nix	shell.nix: do not enforce purity	4 years ago

README.md

Trezor Firmware

Repository Structure

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 trezorctl command
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

Contribute

See CONTRIBUTING.md.

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 security@satoshilabs.com, also see the disclosure section on the Trezor.io website. Please do NOT create publicly viewable issues for suspected security vulnerabilities.

Issue Labels

Priority

Label	Meaning (SLA)
P1 Urgent	The current release + potentially immediate hotfix (30 days)
P2 High	The next release (60 days)
P3 Medium	Within the next 3 releases (90 days)
P4 Low	Anything outside the next 3 releases (120 days)

Severity

Label	Impact
S1 Blocker	Outage, broken feature with no workaround
S2 Critical	Broken feature, workaround too complex & unacceptable
S3 Major	Broken feature, workaround acceptable
S4 Low	Functionality inconvenience or cosmetic issue

CI

The complete test suite is running on a public GitLab CI. If you are an external contributor, we also have a Travis instance where a small subset of tests is running as well - mostly style and easy fast checks, which are quite common to fail for new contributors.

Documentation

See the docs folder or visit docs.trezor.io.