https://github.com/onekeyhq/firmware-pro
https://github.com/onekeyhq/firmware-pro
embedded-software
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/onekeyhq/firmware-pro
- Owner: OneKeyHQ
- License: other
- Created: 2023-10-24T06:26:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-20T08:14:36.000Z (about 2 months ago)
- Last Synced: 2026-04-20T10:24:52.875Z (about 2 months ago)
- Topics: embedded-software
- Language: C
- Homepage:
- Size: 209 MB
- Stars: 24
- Watchers: 4
- Forks: 18
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
OneKey Pro Firmware
Open-source firmware for the OneKey Pro hardware wallet.
Security-first ยท Fully verifiable ยท Community-driven
---
## About
This repository contains the firmware source code for the **OneKey Pro** hardware wallet. Every release is built via GitHub CI, multi-signed by the OneKey team, and can be independently verified against this open-source codebase โ ensuring full supply chain transparency from code to device.
> **Verify your device's firmware:** see [Open Source Code Verification](https://help.onekey.so/en/articles/12025839-verifying-onekey-pro-firmware-with-open-source-code) for step-by-step instructions.
## Documentation
๐ ย **[Deep Wiki โ Full Architecture & Codebase Guide](https://deepwiki.com/OneKeyHQ/firmware-pro/1-overview)**
[](https://deepwiki.com/OneKeyHQ/firmware-pro/1-overview)
## Getting Started
### Prerequisites
- [Nix](https://nixos.org/download.html) (package manager)
- Git
### Build & Run
```bash
# 1. Clone the repo (with submodules)
git clone --recurse-submodules https://github.com/OneKeyHQ/firmware-pro.git
cd firmware-pro
# 2. Enter the Nix development shell & install dependencies
nix-shell
poetry install
# 3. Build the Unix emulator
cd core && poetry run make build_unix
# 4. Start the emulator
poetry run ./emu.py
# 5. (Optional) Install the CLI client to interact with the emulator
cd ../python && poetry run python3 -m pip install .
```
## Contributing
We welcome contributions of all sizes. Before you start, please read the [contributing docs](docs/SUMMARY.md) โ especially the [misc chapter](docs/misc/) for useful background knowledge.
- **Bug fixes & small features** โ File a PR directly. See [CONTRIBUTING.md](docs/misc/contributing.md) for PR requirements.
- **New coin / token / network** โ Follow the guide in [COINS.md](docs/misc/COINS.md).
## Security
> **If you discover a vulnerability, please report it responsibly.**
- ๐ฌ ย Email **[security@onekey.so](mailto:security@onekey.so)** โ do **not** open a public issue.
- ๐ฐ ย We run a [Bug Bounty Program](https://github.com/OneKeyHQ/app-monorepo/blob/onekey/docs/BUG_RULES.md) to reward responsible disclosure.
## Community & Support
- ๐ฌ ย [Community Forum](https://github.com/orgs/OneKeyHQ/discussions) โ Questions, ideas, and best practices.
- ๐ ย [GitHub Issues](https://github.com/OneKeyHQ/firmware-pro/issues) โ Bug reports and feature requests.
- ๐ฆ ย [Twitter / X](https://twitter.com/OneKeyHQ) โ News and announcements.