{"id":19525502,"url":"https://github.com/onekeyhq/docs","last_synced_at":"2026-02-18T08:32:03.951Z","repository":{"id":103044422,"uuid":"532933356","full_name":"OneKeyHQ/docs","owner":"OneKeyHQ","description":"Synced w/ gitbook","archived":false,"fork":false,"pushed_at":"2025-07-21T04:04:15.000Z","size":21559,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-19T01:55:14.081Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OneKeyHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-09-05T14:21:34.000Z","updated_at":"2025-09-30T23:31:56.000Z","dependencies_parsed_at":"2023-11-29T10:47:47.632Z","dependency_job_id":"44e88531-c902-4b64-86af-7be9fafc53ab","html_url":"https://github.com/OneKeyHQ/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OneKeyHQ/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OneKeyHQ","download_url":"https://codeload.github.com/OneKeyHQ/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29574019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:21:05.678Z","status":"ssl_error","status_checked_at":"2026-02-18T08:18:53.770Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T01:05:09.891Z","updated_at":"2026-02-18T08:32:03.923Z","avatar_url":"https://github.com/OneKeyHQ.png","language":null,"readme":"# Introduction\n\n{% hint style=\"info\" %}\n**Note**: This documentation is primarily for developers. If you are a regular user experiencing product usage issues, please visit our [Help Center](https://help.onekey.so/hc) or [Submit a Customer Service Ticket](https://help.onekey.so/hc/requests/new) for support.\n{% endhint %}\n\n### For users\n\nThis documentation is primarily for developers. If you encounter any issues while using our products, please consult our help documentation or submit a ticket for customer service assistance.\n\n#### For users Useful links\n\n* [OneKey Official Website](https://onekey.so/)\n* [Help Center](https://help.onekey.so/hc)\n* [Submit a ticket for customer service](https://help.onekey.so/hc/requests/new)\n* [Official Twitter - X](https://twitter.com/OneKeyHQ)\n\n***\n\n### Platform Overview\n\nOneKey is a leading hardware and software wallet solution that provides developers with comprehensive blockchain integration capabilities.\n\nOneKey offers complete wallet infrastructure supporting multi-chain ecosystem integration. Through our SDKs and APIs, developers can easily integrate hardware security with software convenience, providing users with secure and reliable digital asset management experiences. Supports 25+ blockchain protocols including Bitcoin, Ethereum, Solana, Cosmos, and other mainstream ecosystems.\n\n\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (6).png\" alt=\"\" width=\"563\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\n\n***\n\n### 🔄 OneKey Integration Workflow\n\n#### Workflow Details\n\n1. **🔌 Integration Access**: dApps establish connections through OneKey Provider or SDK\n2. **🔒 Secure Communication**: Use encrypted channels to communicate with hardware/software wallets\n3. **✍️ Signature Authorization**: Users confirm and sign transactions on the device\n4. **📡 Transaction Broadcast**: Send signed transactions to the blockchain network\n\n**Multi-Chain Support** • **Hardware Security** • **Software Convenience** • **Developer Friendly**\n\n***\n\n### Explore OneKey Features\n\n\u003ctable data-header-hidden\u003e\u003cthead\u003e\u003ctr\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003ctd\u003e\u003cimg src=\".gitbook/assets/image (11).png\" alt=\"\"\u003e\u003cbr\u003e\u003ca href=\"guide/web-app-integration-developer.md\"\u003e\u003cstrong\u003e🌐 DApp Integration\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eAdd wallet connection functionality to your decentralized applications\u003c/td\u003e\u003ctd\u003e\u003cp\u003e\u003ca href=\"guide/hardware-integration-developer.md\"\u003e\u003cbr\u003e\u003c/a\u003e\u003cimg src=\".gitbook/assets/image (15).png\" alt=\"\"\u003e\u003c/p\u003e\u003cp\u003e\u003ca href=\"guide/hardware-integration-developer.md\"\u003e\u003cstrong\u003e🔧 Hardware Integration\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eCommunicate and interact directly with OneKey hardware wallets\u003c/p\u003e\u003c/td\u003e\u003ctd\u003e\u003cimg src=\".gitbook/assets/image (14).png\" alt=\"\"\u003e\u003cbr\u003e\u003ca href=\"guide/external-contribution-guide.md\"\u003e\u003cstrong\u003e🤝 External Contribution\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eContribute code and functionality to the OneKey ecosystem\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003c/td\u003e\u003ctd\u003e\u003c/td\u003e\u003ctd\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\n### 🚀 OneKey Hardware SDK Playground\n\n{% hint style=\"info\" %}\nExperience OneKey Hardware SDK functionality directly in your browser! Test hardware wallet interactions and explore our comprehensive API without any setup.\n{% endhint %}\n\n[**🔧 Try SDK Playground**](https://hardware-example.onekeytest.com/expo-playground/) - Interactive SDK testing environment with live device simulation\n\n🎪**Features:**\n\n* Live hardware wallet simulation\n* Real-time API testing\n* Multi-chain protocol support\n* No hardware device required for testing ( You could use the emulator  device）\n\n### Detailed Feature List\n\n#### 🌐 DApp Integration Features\n\n\u003ctable data-header-hidden\u003e\u003cthead\u003e\u003ctr\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003cth width=\"250\"\u003e\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (26).png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-software/compatible-with-metamask/\"\u003e\u003cstrong\u003e🔗 MetaMask Compatible\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eEIP-1193 standard support\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (25).png\" alt=\"\" width=\"188\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-software/support-wallet-kit/\"\u003e\u003cstrong\u003e🛠️ Wallet Kit Support\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eRainbowKit, Web3Modal, etc.\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (28).png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-software/webapp-connect-onekey/\"\u003e\u003cstrong\u003e⚡ Multi-Chain Provider\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eETH, BTC, Solana, NEAR, etc.\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (29).png\" alt=\"\" width=\"188\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-software/using-walletconnect/\"\u003e\u003cstrong\u003e🔄 WalletConnect\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eCross-platform connection protocol\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\n#### 🔧 Hardware Integration Features\n\n\u003ctable data-header-hidden\u003e\u003cthead\u003e\u003ctr\u003e\u003cth width=\"400\"\u003e\u003c/th\u003e\u003cth width=\"400\"\u003e\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (17).png\" alt=\"\" width=\"188\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-hardware/page-1.md\"\u003e\u003cstrong\u003e📡 Hardware SDK\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eDirect device communication\u003cbr\u003eIncludes device management, multi-chain APIs and complete functionality\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003ctd\u003e\u003cdiv\u003e\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (20).png\" alt=\"\" width=\"188\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\u003c/div\u003e\u003cp\u003e\u003ca href=\"connect-to-hardware/air-gap-sdk/\"\u003e\u003cstrong\u003e📱 Air Gap SDK\u003c/strong\u003e\u003c/a\u003e\u003cbr\u003eQR code communication\u003cbr\u003eOffline signing secure interaction\u003cbr\u003e\u003c/p\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\n\n\n{% hint style=\"success\" %}\n[Start using OneKey now!](https://onekey.so/) Supports hardware and software wallets to protect your digital asset security.\n{% endhint %}\n\n{% hint style=\"warning\" %}\n**Important Note**: Before using OneKey APIs in production environment, please carefully read security best practices and integration guides.\n{% endhint %}\n\n### For Developer's Useful Links\n\n#### Developer Resources\n\n* [OneKey GitHub](https://github.com/OneKeyHQ)\n* [Logo Assets](https://help.onekey.so/en/articles/11461296-media-kit-press-kit)\n\n#### Something is Missing? Contact Us!\n\nIf you can't find what you need here:\n\n* [Ask an issue on GitHub](https://github.com/OneKeyHQ/OneKey-Hardware-JS-SDK/issues)\n* [Check our GitHub profile](https://github.com/OneKeyHQ)\n\n***\n\n\u003e **💡 Tip**: This is the OneKey developer documentation navigation page. Click on the feature modules above to jump to detailed integration guides and API reference documentation.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonekeyhq%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonekeyhq%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonekeyhq%2Fdocs/lists"}