https://github.com/onekeyhq/firmware

https://github.com/onekeyhq/firmware

embedded-software

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/onekeyhq/firmware
• Owner: OneKeyHQ
• License: other
• Created: 2021-09-13T10:08:06.000Z (over 4 years ago)
• Default Branch: touch
• Last Pushed: 2025-03-10T08:28:09.000Z (about 1 year ago)
• Last Synced: 2025-03-28T17:09:48.146Z (about 1 year ago)
• Topics: embedded-software
• Language: C
• Homepage:
• Size: 117 MB
• Stars: 71
• Watchers: 13
• Forks: 52
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          






---

[![Github Stars](https://img.shields.io/github/stars/OneKeyHQ/firmware?t&logo=github&style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/stargazers)

[![Version](https://img.shields.io/github/release/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/releases)

[![](https://img.shields.io/github/contributors-anon/OneKeyHQ/firmware?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/graphs/contributors)

[![Last commit](https://img.shields.io/github/last-commit/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/commits/onekey)

[![Issues](https://img.shields.io/github/issues-raw/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/issues?q=is%3Aissue+is%3Aopen)

[![Pull Requests](https://img.shields.io/github/issues-pr-raw/OneKeyHQ/firmware.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/pulls?q=is%3Apr+is%3Aopen)

[![Discord](https://img.shields.io/discord/868309113942196295?style=for-the-badge&labelColor=000)](https://discord.gg/onekey)

[![Twitter Follow](https://img.shields.io/twitter/follow/OneKeyHQ?style=for-the-badge&labelColor=000)](https://twitter.com/OneKeyHQ)

## Community & Support

- [Community Forum](https://github.com/orgs/OneKeyHQ/discussions). Best for: help with building, discussion about best practices.

- [GitHub Issues](https://github.com/OneKeyHQ/firmware/issues). Best for: bugs and errors you encounter using OneKey.

- [Discord](https://discord.gg/onekey). Best for: sharing your ideas and hanging out with the community.

## 🚀 Getting Onboard

1. Install [nix](https://nixos.org/download.html)

2. Pulling the latest code via the git command line tool,  setting up the development environment

```

  git clone --recurse-submodules https://github.com/OneKeyHQ/onekey-firmware.git

  cd onekey-firmware

  nix-shell

  poetry install

```

3. Run the build with:

```

   cd core && poetry run make build_unix

```

4. Now you can start the emulator

```

   poetry run ./emu.py

```

5. You can now install the command line client utility to interact with the emulator

```

   cd python && poetry run python3 -m pip install .

```

## ✏ Contribute

- 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](docs/misc/contributing.md)

- Add new coin/token/network to the official onekey firmware

  See [COINS.md](docs/misc/COINS.md)

Also please have a look at the [docs](docs/SUMMARY.md) before contributing. The misc chapter should be read in particular because it contains some useful assorted knowledge.

## 🔒 Security

- Please read [Bug Bounty Rules](https://github.com/OneKeyHQ/app-monorepo/blob/onekey/docs/BUG_RULES.md), 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.

## ✨ Salute!

[![](https://img.shields.io/github/contributors-anon/OneKeyHQ/firmware?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/firmware/graphs/contributors)