Introduction

# Web / desktop WebUSB (recommended)
npm i @onekeyfe/hd-common-connect-sdk
 
# React Native BLE
npm i @onekeyfe/hd-ble-sdk
 
# Native host with low-level plugin (Android/iOS/Flutter bridge)
npm i @onekeyfe/hd-common-connect-sdk
 
# Plugin iframe host only (plugin-only)
npm i @onekeyfe/hd-web-sdk

import HardwareSDK from '@onekeyfe/hd-common-connect-sdk';
 
await HardwareSDK.init({
  env: 'webusb',
  debug: process.env.NODE_ENV !== 'production',
  fetchConfig: true,
});

import HardwareSDK from '@onekeyfe/hd-ble-sdk';
 
await HardwareSDK.init({
  debug: __DEV__,
});

import HardwareSDK from '@onekeyfe/hd-common-connect-sdk';
 
await HardwareSDK.init({
  env: 'lowlevel',
  debug: process.env.NODE_ENV !== 'production',
  fetchConfig: true,
});

import { HardwareSDK } from '@onekeyfe/hd-web-sdk';
 
await HardwareSDK.init({
  debug: process.env.NODE_ENV !== 'production',
  connectSrc: 'https://jssdk.onekey.so/1.1.19/', // iframe host
});

import { UI_EVENT, UI_REQUEST, DEVICE } from '@onekeyfe/hd-core';
 
HardwareSDK.on(UI_EVENT, async (message) => {
  switch (message.type) {
    case UI_REQUEST.REQUEST_PIN:
      // Handle PIN entry (see below)
      break;
    case UI_REQUEST.REQUEST_PASSPHRASE:
      // Handle passphrase entry (see below)
      break;
  }
});
 
HardwareSDK.on(DEVICE.CONNECT, (payload) => console.log('Connected:', payload));
HardwareSDK.on(DEVICE.DISCONNECT, (payload) => console.log('Disconnected:', payload));

import { ONEKEY_WEBUSB_FILTER } from '@onekeyfe/hd-shared';
 
// Trigger browser's device chooser
await navigator.usb.requestDevice({ filters: ONEKEY_WEBUSB_FILTER });

const result = await HardwareSDK.searchDevices();
if (!result.success) throw new Error(result.payload.error);
 
const devices = result.payload;
// [{ connectId, deviceId?, name, deviceType, ... }]

const features = await HardwareSDK.getFeatures(connectId);
if (!features.success) throw new Error(features.payload.error);
 
const deviceId = features.payload.device_id;

import { UI_RESPONSE } from '@onekeyfe/hd-core';
 
// Option 1: Enter on device (recommended)
await HardwareSDK.uiResponse({
  type: UI_RESPONSE.RECEIVE_PIN,
  payload: '@@ONEKEY_INPUT_PIN_IN_DEVICE'
});
 
// Option 2: Software blind PIN (not supported on Pro/Touch)
await HardwareSDK.uiResponse({
  type: UI_RESPONSE.RECEIVE_PIN,
  payload: userInputPin  // e.g., '1234'
});

// Option 1: Enter on device (most secure)
await HardwareSDK.uiResponse({
  type: UI_RESPONSE.RECEIVE_PASSPHRASE,
  payload: { passphraseOnDevice: true, value: '' }
});
 
// Option 2: Software input with optional session cache
await HardwareSDK.uiResponse({
  type: UI_RESPONSE.RECEIVE_PASSPHRASE,
  payload: { value: userPassphrase, passphraseOnDevice: false, save: true }
});

const message = 'Hello OneKey';
const messageHex = Buffer.from(message).toString('hex');
 
const res = await HardwareSDK.evmSignMessage(connectId, deviceId, {
  path: "m/44'/60'/0'",
  messageHex,
  chainId: 1,
});
 
if (!res.success) throw new Error(res.payload.error);
 
console.log('Address:', res.payload.address);
console.log('Signature:', res.payload.signature);