SUMMARY.md

Table of contents

👋 GUIDE

• Introduction
• Web App Integration Developer
• Hardware Integration Developer
• External Contribution Guide
• Common Terms

🔮 Connect To Software

• Compatible with Metamask
  • detectEthereumProvider
• Support Wallet Kit
  • Web3 Onboard
  • Rainbowkit
  • Aptos Wallet Adapter
  • Web3Modal
• WebApp Connect OneKey
  • ETH
    • Provider API
    • RPC API
    • Accessing Accounts
    • Sending Transactions
    • Signing Data
  • BTC
    • Guide
    • API Reference
      • requestAccounts
      • getAccounts
      • getNetwork
      • switchNetwork
      • getPublicKey
      • getBalance
      • getInscriptions
      • sendBitcoin
      • sendInscription
      • signMessage
      • pushTx
      • signPsbt
      • signPsbts
      • pushPsbt
      • inscribeTransfer (Deprecated)
    • Event
  • Nostr
    • Guide
    • API Reference
      • getPublicKey
      • signEvent
      • signSchnorr
      • getRelays
      • nip04.encrypt
      • nip04.decrypt
    • Event
  • WebLN
    • Guide
    • API Reference
      • enable
      • getInfo
      • makeInvoice
      • sendPayment
      • signMessage
      • verifyMessage
      • lnurl
      • getBalance
    • Event
  • NEAR
    • Introduction
    • Integrating
      • Install the Provider SDK
      • Detecting the Provider
      • Establishing a Connection
      • Accessing Accounts
      • Detecting Provider Network
      • Watch Accounts & Network Status
      • Sending Transactions
        • Create Transaction
        • Sign and Send Transaction
        • Signing Transaction
      • Signing Messages
      • RPC API Calling
      • Debug Logging
      • Migrate from Near Web Wallet
    • Reference
      • API Reference
      • Trouble Shooting
    • Resources
      • Example & Demo
      • FAQ
  • SOLANA
    • Detecting the Provider
    • Establishing a Connection
    • Sending a Transaction
    • Signing a Message
• Using WalletConnect
  • ETH
  • APTOS
    • Wallet Connect API

📟 Connect to Hardware

• Hardware SDK
  • Started
  • Install SDK
  • Config Event
  • Common Params
  • Path Params
  • Error Code
  • API Reference
    • Basic API
      • Init SDK
      • Search Devices
      • Get Features
      • Get Passphrase State
      • Cancel Request
      • Response UI Event
    • Device API
      • deviceSupportFeatures
      • checkBridgeStatus
      • checkTransportRelease
      • checkFirmwareRelease
      • checkBLEFirmwareRelease
      • deviceChangePin
      • deviceReset
      • deviceSettings
      • deviceUpdateReboot
      • deviceVerify
      • deviceWipe
      • firmwareUpdate
    • Bitcoin & Bitcoin forks
      • btcGetAddress
      • btcGetPublicKey
      • btcSignMessage
      • btcSignTransaction
      • btcVerifyMessage
    • Ethereum & EVM
      • evmGetPublicKey
      • evmGetAddress
      • evmSignTransaction
      • evmSignTypedData
      • evmSignMessage
      • evmVerifyMessage
    • Algorand
      • algoGetAddress
      • algoSignTransaction
    • Aptos
      • aptosGetAddress
      • aptosGetPublicKey
      • aptosSignMessage
      • aptosSignTransaction
    • Alephium
      • alephiumGetAddress
      • alephiumSignMessage
      • alephiumSignTransaction
    • Cardano
      • cardanoGetAddress
      • cardanoGetPublicKey
      • cardanoSignMessage
      • cardanoSignTransaction
    • Conflux
      • confluxGetAddress
      • confluxSignMessage
      • confluxSignMessageCIP23
      • confluxSignTransaction
    • Cosmos
      • cosmosGetAddress
      • cosmosGetPublicKey
      • cosmosSignTransaction
    • Dynex
      • dnxGetAddress
      • dnxSignTransaction
    • FileCoin
      • filecoinGetAddress
      • filecoinSignTransaction
    • Kaspa
      • kaspaGetAddress
      • kaspaSignTransaction
    • Near
      • nearGetAddress
      • nearSignTransaction
    • Nervos
      • nervosGetAddress
      • nervosSignTransaction
    • Nostr
      • nostrGetPublicKey
      • nostrSignEvent
      • nostrSignSchnorr
      • nostrEncryptMessage
      • nostrDecryptMessage
    • NEM
      • nemGetAddress
      • nemSignTransaction
    • Nexa
      • nexaGetAddress
      • nexaSignTransaction
    • Polkadot
      • polkadotGetAddress
      • polkadotSignTransaction
    • Ripple
      • xrpGetAddress
      • xrpSignTransaction
    • Scdo
      • scdoGetAddress
      • scdoSignMessage
      • scdoSignTransaction
    • Solana
      • solGetAddress
      • solSignTransaction
    • Starcoin
      • startcoinGetAddress
      • starcoinGetPublicKey
      • starcoinSignMessage
      • starcoinSignTransaction
      • starcoinVerifyMessage
    • Stellar
      • stellarGetAddress
      • stellarSignTransaction
    • Sui
      • suiGetAddress
      • suiGetPublicKey
      • suiSignMessage
      • suiSignTransaction
    • Tron
      • tronGetAddress
      • tronSignMessage
      • tronSignTransaction
    • Ton
      • tonGetAddress
      • tonSignMessage
      • tonSignProof
  • Advanced
    • Passphrase
    • Common SDK Guide
    • Low-level transport plugin
    • OneKey Message Protocol
  • Tutorial: Get started with OneKey
• Air Gap SDK
  • Started
  • Tutorial: Wallet Integration
  • API Reference
    • Basic API
      • CryptoHDkey
      • CryptoCoinInfo
      • CryptoKeypath
    • Ethereum & EVM
      • EthSignRequest
      • EthSignature

⛳ Best Practice

• Registering Your Contract's Method Names
• Registering Tokens with Users
• Defining Your App's Icon
• Migration from MetaMask

---

• 🎨 Logo Assets
• 👾 Join Discord
• 🧙 Support
• 🕹️ Trouble Shooting
• ❤️ Contribute