https://github.com/onekeyhq/docs
Synced w/ gitbook
https://github.com/onekeyhq/docs
Last synced: about 2 months ago
JSON representation
Synced w/ gitbook
- Host: GitHub
- URL: https://github.com/onekeyhq/docs
- Owner: OneKeyHQ
- License: other
- Created: 2022-09-05T14:21:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-21T04:04:15.000Z (9 months ago)
- Last Synced: 2025-10-19T01:55:14.081Z (6 months ago)
- Size: 20.6 MB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Introduction
{% hint style="info" %}
**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.
{% endhint %}
### For users
This 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.
#### For users Useful links
* [OneKey Official Website](https://onekey.so/)
* [Help Center](https://help.onekey.so/hc)
* [Submit a ticket for customer service](https://help.onekey.so/hc/requests/new)
* [Official Twitter - X](https://twitter.com/OneKeyHQ)
***
### Platform Overview
OneKey is a leading hardware and software wallet solution that provides developers with comprehensive blockchain integration capabilities.
OneKey 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.
.png)
***
### π OneKey Integration Workflow
#### Workflow Details
1. **π Integration Access**: dApps establish connections through OneKey Provider or SDK
2. **π Secure Communication**: Use encrypted channels to communicate with hardware/software wallets
3. **βοΈ Signature Authorization**: Users confirm and sign transactions on the device
4. **π‘ Transaction Broadcast**: Send signed transactions to the blockchain network
**Multi-Chain Support** β’ **Hardware Security** β’ **Software Convenience** β’ **Developer Friendly**
***
### Explore OneKey Features
.png)
π DApp Integration
Add wallet connection functionality to your decentralized applications
π§ Hardware Integration
Communicate and interact directly with OneKey hardware wallets
.png)
π€ External Contribution
Contribute code and functionality to the OneKey ecosystem
### π OneKey Hardware SDK Playground
{% hint style="info" %}
Experience OneKey Hardware SDK functionality directly in your browser! Test hardware wallet interactions and explore our comprehensive API without any setup.
{% endhint %}
[**π§ Try SDK Playground**](https://hardware-example.onekeytest.com/expo-playground/) - Interactive SDK testing environment with live device simulation
πͺ**Features:**
* Live hardware wallet simulation
* Real-time API testing
* Multi-chain protocol support
* No hardware device required for testing ( You could use the emulator deviceοΌ
### Detailed Feature List
#### π DApp Integration Features
.png)
π MetaMask Compatible
EIP-1193 standard support
.png)
π οΈ Wallet Kit Support
RainbowKit, Web3Modal, etc.
.png)
β‘ Multi-Chain Provider
ETH, BTC, Solana, NEAR, etc.
.png)
π WalletConnect
Cross-platform connection protocol
#### π§ Hardware Integration Features
.png)
π‘ Hardware SDK
Direct device communication
Includes device management, multi-chain APIs and complete functionality
.png)
π± Air Gap SDK
QR code communication
Offline signing secure interaction
{% hint style="success" %}
[Start using OneKey now!](https://onekey.so/) Supports hardware and software wallets to protect your digital asset security.
{% endhint %}
{% hint style="warning" %}
**Important Note**: Before using OneKey APIs in production environment, please carefully read security best practices and integration guides.
{% endhint %}
### For Developer's Useful Links
#### Developer Resources
* [OneKey GitHub](https://github.com/OneKeyHQ)
* [Logo Assets](https://help.onekey.so/en/articles/11461296-media-kit-press-kit)
#### Something is Missing? Contact Us!
If you can't find what you need here:
* [Ask an issue on GitHub](https://github.com/OneKeyHQ/OneKey-Hardware-JS-SDK/issues)
* [Check our GitHub profile](https://github.com/OneKeyHQ)
***
> **π‘ 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.
.png)