# OneKey: Secure Crypto Wallet Anti-scam, open-source crypto wallet for every chain. Supports Bitcoin, Ethereum, Solana, Tron, BNB Smart Chain, and more. [![Github Stars](https://img.shields.io/github/stars/OneKeyHQ/app-monorepo?t&logo=github&style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/stargazers) [![Version](https://img.shields.io/github/release/OneKeyHQ/app-monorepo.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/releases) [![Contributors](https://img.shields.io/github/contributors-anon/OneKeyHQ/app-monorepo?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/graphs/contributors) [![Last commit](https://img.shields.io/github/last-commit/OneKeyHQ/app-monorepo.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/commits/onekey) [![Issues](https://img.shields.io/github/issues-raw/OneKeyHQ/app-monorepo.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/issues?q=is%3Aissue+is%3Aopen) [![Pull Requests](https://img.shields.io/github/issues-pr-raw/OneKeyHQ/app-monorepo.svg?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/pulls?q=is%3Apr+is%3Aopen) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/OneKeyHQ/app-monorepo) [![Twitter Follow](https://img.shields.io/twitter/follow/OneKeyHQ?style=for-the-badge&labelColor=000)](https://twitter.com/OneKeyHQ)
## ๐Ÿ“ฅ Download | Platform | Link | |----------|------| | iOS | [App Store](https://apps.apple.com/us/app/onekey-open-source-wallet/id1609559473) | | Android | [Google Play](https://play.google.com/store/apps/details?id=so.onekey.app.wallet) | | Desktop | [macOS / Windows / Linux](https://onekey.so/download?client=desktop) | | Browser Extension | [Chrome Web Store](https://onekey.so/download?client=browserExtension) | | Bridge | [Download](https://onekey.so/download?client=bridge) | ## ๐Ÿ“‹ Table of Contents - [๐Ÿ“ฅ Download](#-download) - [๐Ÿ“– Documentation](#-documentation) - [๐Ÿ—‚ Project Structure](#-project-structure) - [๐Ÿš€ Getting Onboard](#-getting-onboard) - [๐Ÿง‘โ€๐Ÿ’ป Development](#-development) - [๐Ÿก Community & Enterprise Edition](#-community--enterprise-edition) - [๐Ÿ’ก Support](#-support) - [๐Ÿ”ฐ Security](#-security) - [๐Ÿ’ฌ Docs in Your Languages](#-docs-in-your-languages) - [๐Ÿช„ Repo Activity](#-repo-activity) - [๐Ÿ™‹โ€โ™‚๏ธ We're Hiring!](#%EF%B8%8F-were-hiring) - [โœจ Contributors](#-contributors) - [๐Ÿ“„ License](#-license) ## ๐Ÿ“– Documentation - [DeepWiki โ€” Full Codebase Documentation](https://deepwiki.com/OneKeyHQ/app-monorepo) - [Bug Bounty Rules](docs/BUG_RULES.md) - [Security Policy](SECURITY.md) ## ๐Ÿ—‚ Project Structure This is a monorepo managed with Yarn workspaces. ``` app-monorepo/ โ”œโ”€โ”€ apps/ โ”‚ โ”œโ”€โ”€ desktop/ # Electron desktop app (macOS, Windows, Linux) โ”‚ โ”œโ”€โ”€ ext/ # Browser extension (Chrome) โ”‚ โ”œโ”€โ”€ mobile/ # React Native mobile app (iOS, Android) โ”‚ โ”œโ”€โ”€ web/ # Web application โ”‚ โ””โ”€โ”€ web-embed/ # Embeddable web component โ”œโ”€โ”€ packages/ โ”‚ โ”œโ”€โ”€ components/ # Shared UI component library โ”‚ โ”œโ”€โ”€ core/ # Core business logic & crypto utilities โ”‚ โ”œโ”€โ”€ kit/ # Main UI kit โ”‚ โ”œโ”€โ”€ kit-bg/ # Background service kit โ”‚ โ”œโ”€โ”€ qr-wallet-sdk/ # QR-code hardware wallet SDK โ”‚ โ””โ”€โ”€ shared/ # Shared utilities, constants, and types โ”œโ”€โ”€ development/ # Dev tooling & scripts โ”œโ”€โ”€ patches/ # Dependency patches โ””โ”€โ”€ docs/ # Documentation & i18n ``` ## ๐Ÿš€ Getting Onboard > **Prerequisites:** Node.js >= 22, Yarn 4.x (bundled via Corepack), [Git LFS](https://git-lfs.github.com/) ```bash git clone https://github.com/OneKeyHQ/app-monorepo.git cd app-monorepo yarn yarn app:web # starts dev server at http://localhost:3000 ```
๐Ÿ“ฑ Platform-specific requirements - **iOS:** Xcode >= 13.3 - **Android:** JDK >= 11
## ๐Ÿง‘โ€๐Ÿ’ป Development Run these commands from the root directory: | Command | Description | |---------|-------------| | `yarn app:web` | Start web dev server (port 3000) | | `yarn app:ios` | Run iOS app via USB-connected device | | `yarn app:android` | Run Android app | | `yarn app:desktop` | Run desktop (Electron) app | | `yarn app:ext` | Run browser extension | ## ๐Ÿก Community & Enterprise Edition - ๐Ÿก ๐Ÿง”๐Ÿปโ€โ™‚๏ธ **Community Edition** โ€” Free forever for individuals and open-source communities. - ๐Ÿฆ ๐Ÿ’ผ **Enterprise Edition** โ€” Coming soon. Star this repo to get notified when it's ready. ## ๐Ÿ’ก Support - [Community Forum](https://github.com/orgs/OneKeyHQ/discussions) โ€” Help with building, best practices discussion. - [GitHub Issues](https://github.com/OneKeyHQ/app-monorepo/issues) โ€” Bug reports and errors. ## ๐Ÿ”ฐ Security - Please read the [Bug Bounty Rules](docs/BUG_RULES.md), we have detailed the exact plan in this article. - Report suspected vulnerabilities privately to **dev@onekey.so** or via [BugRap](https://bugrap.io/bounties/OneKey). - 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. - See [SECURITY.md](SECURITY.md) for full details. ## ๐Ÿ’ฌ Docs in Your Languages | Available Languages | |---------------------| | [๐Ÿ‡จ๐Ÿ‡ณ ็ฎ€ไฝ“ไธญๆ–‡](docs/i18n/README.zh-cn.md) | | [๐Ÿ‡ฉ๐Ÿ‡ช Deutsch](docs/i18n/README.de.md) | | [๐Ÿ‡ฏ๐Ÿ‡ต ๆ—ฅๆœฌ่ชž](docs/i18n/README.jp.md) | | [๐Ÿ‡ซ๐Ÿ‡ท Franรงais](docs/i18n/README.fr.md) | | [๐Ÿ‡ฎ๐Ÿ‡น Italiano](docs/i18n/README.it.md) | ## ๐Ÿช„ Repo Activity ![Repo Activity](https://repobeats.axiom.co/api/embed/5f8b83656094956b2d6274929f6eaa2e068a6cfb.svg "Repobeats analytics image") ## ๐Ÿ™‹โ€โ™‚๏ธ We're Hiring! We're hiring for remote roles worldwide โ€” global pay, ESOP for everyone, open-source culture. [**๐Ÿ‘‰ View all open positions**](https://onekeyhq.atlassian.net/wiki/spaces/OC/overview)
Why join OneKey? | English | ไธญๆ–‡ | |---------|------| | ๐ŸŒ Remote (Live anywhere) | ๐ŸŒ ่ฟœ็จ‹ (็”Ÿๆดปๅœจๅ“ชไธชๅŸŽๅธ‚้ƒฝๅฏไปฅ) | | ๐Ÿ’ฐ Global Pay (Literally) | ๐Ÿ’ฐ ๅ…จ็ƒไธ€่‡ด็š„่–ช้…ฌ (็œŸ็š„) | | ๐Ÿ“ˆ ESOP (For everybody) | ๐Ÿ“ˆ ESOP ่ฎกๅˆ’ | | ๐Ÿ”“ Open Source (As you see) | ๐Ÿ”“ ๅผ€ๆบ (ๅฆ‚ไฝ ๆ‰€่ง) | | ๐Ÿค Awesome Colleagues (Hell Yeah!) | ๐Ÿค ่ถ…็บงๆฃ’็š„ๅŒไบ‹ (็ˆฝๅ‘†!) |
## โœจ Contributors [![Contributors](https://img.shields.io/github/contributors-anon/OneKeyHQ/app-monorepo?style=for-the-badge&labelColor=000)](https://github.com/OneKeyHQ/app-monorepo/graphs/contributors) ## ๐Ÿ“„ License This project is licensed under the [OneKey Standard Source License (O-SSL)](LICENSE.md).