Welcome to the Onekey Firmware repository. This repository is so called monorepo, it contains several different yet very related projects that together form the Onekey Firmware ecosystem.
ci: Gitlab CI configuration filescommon/defs: JSON coin definitions and support tablescommon/protob: Common protobuf definitions for the Onekey protocolcommon/tools: Tools for managing coin definitions and related datacore: Onekey Core, firmware implementation for Onekey Tcrypto: Stand-alone cryptography library used by both Onekey Core and the Onekey One firmwaredocs: Assorted documentationpython: Python client library and theonekeyctlcommandstorage: NORCOW storage implementation used by both Onekey Core and the Onekey One firmwaretests: Firmware unit test suitetools: Miscellaneous build and helper scriptsvendor: Submodules for external dependencies
- Adding a small feature or a fix If your change is somewhat subtle, feel free to file a PR in one of the appropriate repositories directly. See the PR requirements noted at CONTRIBUTING.md.
- Add new coin/token/network to the official onekey firmware See COINS.md
- Please read Bug Bunty Rules, we have detailed the exact plan in this article.
- Please report suspected security vulnerabilities in private to dev@onekey.so
- Please do NOT create publicly viewable issues for suspected security vulnerabilities.
- As an open source project, although we are not yet profitable, we try to give some rewards to white hat hackers who disclose vulnerabilities to us in a timely manner.
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.