Hardware-js-sdk is designed to allow third-party developers to quickly access the OneKey hardware wallet. The repository structure uses the monorepo to make each module more manageable.
package | description |
---|---|
@onekeyfe/core | The core process of hardware wallet connection. |
@onekeyfe/hd-web-sdk | Using the sdk in the web platform. |
@onekeyfe/hd-ble-sdk | Using the SDK in BLE communication environment. e.g: iOS / Android |
@onekeyfe/hd-common-sdk | Using the SDK in a node or web-usb environment |
@onekeyfe/hd-transport | Data serialization and deserialization of hardware communication data |
@onekeyfe/hd-transport-http | communication lib for http |
@onekeyfe/hd-transport-react-native | communication lib for React Native |
@onekeyfe/hd-transport-webusb | communication lib for WebUSB |
@onekeyfe/hd-shared | Tools, error definitions, constants |
See the full documentation on developer.onekey.so.
Before you start make sure you have downloaded and installed NVM, Yarn and git with git lfs.
git clone [email protected]:OneKeyHQ/hardware-js-sdk.git
git submodule update --init --recursive
yarn
yarn bootstrap
Run a dev build:
yarn dev:web
(web sdk)yarn dev:ble
(react-native sdk)yarn dev:core
(core package)yarn dev:transport-http
(transport-http package)yarn dev:shared
(shared package)