Skip to content

OneKeyHQ/firmware

touch
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
ci
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 


Github Stars Version Last commit Issues Pull Requests Discord Twitter Follow

Community & Support

  • Community Forum. Best for: help with building, discussion about best practices.
  • GitHub Issues. Best for: bugs and errors you encounter using OneKey.
  • Discord. Best for: sharing your ideas and hanging out with the community.

πŸš€ Getting Onboard

  1. Install nix
  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
  1. Run the build with:
   cd core && poetry run make build_unix
  1. Now you can start the emulator
   poetry run ./emu.py
  1. 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

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

    See COINS.md

Also please have a look at the docs before contributing. The misc chapter should be read in particular because it contains some useful assorted knowledge.

πŸ”’ Security

  • 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.

✨ Salute!