このページの内容
統合方法を選択
まず、アプリケーションの接続先を決めます。ウォレットの Provider API、Hardware SDK、QR SDK は、それぞれ異なる統合方法に対応します。
| やりたいこと | 使用するもの | ここから始める |
|---|---|---|
| Web サイトや dApp にユーザーの OneKey ウォレットを接続 | チェーン別のウォレットプロバイダーまたはウォレット UI ライブラリ | dApp クイックスタート |
| 独自のウォレットやアプリを OneKey デバイスに直接接続 | 実行環境に対応したトランスポート付きの Hardware SDK | Hardware SDK クイックスタート |
| QR 対応デバイスと署名リクエストをやり取り | Air-Gap SDK | QR 署名の概要 |
dApp の統合では、OneKey ウォレットにユーザーアカウントと署名フローの管理を任せます。ハードウェアと直接統合する場合、アプリケーションがデバイス検出、接続状態、UI イベント、トランザクションの準備を担当します。
dApp を接続
- 開発環境に OneKey をインストールします。
- dApp クイックスタートに従って、プロバイダーを検出し、ユーザー操作からアカウントを要求します。
- Provider API リファレンスでチェーンを選択します。メソッドと戻り値はチェーンによって異なります。
- ウォレットがない場合、アカウント一覧が空の場合、リクエストの拒否、アカウントやネットワークの変更を処理してください。
アプリケーションですでにウォレット UI ライブラリを使用している場合は、その OneKey 統合から始めてください。モバイルへの引き継ぎについてはモバイルとディープリンクを参照してください。
ハードウェアに直接接続
SDK のインストール前に実行環境を選択します:
| 実行環境 | ガイド |
|---|---|
| WebUSB 対応ブラウザー | WebUSB |
| Bluetooth を使用する React Native | React Native BLE |
| ネイティブ Android、iOS、Flutter | ネイティブモバイル統合 |
続いてクイックスタートに従います。SDK を初期化し、UI リクエストを処理し、デバイスを選択してアドレスを取得してから署名へ進みます。デバイスとチェーンの対応状況で、使用予定のメソッドとデバイスを正確に確認してください。
この ハードウェアプレイグラウンド は API を試すのに便利です。エミュレーターやビルドの成功は、想定するデバイス、ファームウェア、実行環境での統合テストの代わりにはなりません。
QR 署名を使用
まず Air-Gap の概要を読み、続いて Ethereum と EVM などのチェーン別ガイドを参照します。アプリがリクエストをエンコードして QR データで表示し、デバイスのレスポンスを読み取って結果を検証した後、独自のネットワーク接続でブロードキャストします。
リリース前に
- 成功時だけでなく、拒否、キャンセル、切断、再接続もテストしてください。
- 使用中のアカウントとネットワークを表示し、ユーザーが署名リクエストを確認する機会を確保してください。
- リカバリーフレーズや秘密鍵を収集してはいけません。PIN、パスフレーズ、トークン、ウォレットセッションのデータをログや不具合報告に含めないでください。
- 統合で使用するバージョンを固定して記録してください。SDK、ファームウェア、ウォレットの更新後には再テストしてください。
- リクエストが失敗または停止したときは、トラブルシューティングガイドを参照してください。
最終更新日