be9fcf7525
1. make it work on macOS hosts 2. add quoting to paths to prevent failures if user was foolish enough to put the repo on a path with spaces 3. use -o pipefail for robustness 4. use wget --no-config to prevent surprises from ~/.wgetrc 5. add --init to docker run for better signals 6. detect effective USER:GROUP like a grown up 7. break fs download url into multiple configurable parts 8. make the script independent on launch location 9. build: generate nix-shell scripts with HEREDOC 9.1. this is easier on eyes, one could review generated script in ./build 9.2. we don't have to escape quotes and chain commands with && 9.4. added some extra quoting for user-specified values |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| ci | ||
| common | ||
| core | ||
| crypto | ||
| docs | ||
| legacy | ||
| python | ||
| storage | ||
| tests | ||
| tools | ||
| vendor | ||
| .clang-format | ||
| .editorconfig | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .travis.yml | ||
| .yamllint.yml | ||
| build-docker.sh | ||
| CODEOWNERS | ||
| COMMITS.md | ||
| CONTRIBUTING.md | ||
| create_monorepo.py | ||
| Makefile | ||
| poetry.lock | ||
| poetry.toml | ||
| pyproject.toml | ||
| README.md | ||
| SECURITY.md | ||
| setup.cfg | ||
| shell.nix | ||
Trezor Firmware
Repository Structure
ci: Gitlab CI configuration filescommon/defs: JSON coin definitions and support tablescommon/protob: Common protobuf definitions for the Trezor protocolcommon/tools: Tools for managing coin definitions and related datacore: Trezor Core, firmware implementation for Trezor Tcrypto: Stand-alone cryptography library used by both Trezor Core and the Trezor One firmwaredocs: Assorted documentationlegacy: Trezor One firmware implementationpython: Python client library and thetrezorctlcommandstorage: NORCOW storage implementation used by both Trezor Core and the Trezor One firmwaretests: Firmware unit test suitetools: Miscellaneous build and helper scriptsvendor: Submodules for external dependencies
Contribute
See CONTRIBUTING.md.
Using Conventional Commits is strongly recommended and might be enforced in future.
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.