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 git@github.com:OneKeyHQ/hardware-js-sdk.gitgit submodule update --init --recursiveyarnyarn 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)
yarn bootstrap && yarn buildyarn example:desktop
yarn bootstrap && yarn buildyarn exampleselect ios or android in menu.
- Build web sdk
- Edit connect src in
packages/connect-examples/expo-example/src/constants/connect.ts, changeCONNECT_SRCtohttps://localhost:8087/ yarn dev:web- Open chrome browser, enter
https://localhost:8087/, simply type "thisisunsafe" directly on your keyboard (no need to press Enter) - Run example app
yarn bootstrap && yarn buildyarn exampleselect web in menu.
- Build all packages
yarn bootstrap && yarn build- Edit .env file, APP_MONOREPO_LOCAL_PATH=/path/to/v5-app-monorepo
yarn debug:watcher
Open v5-app-monorepo, run yarn && yarn app:xxxx to start the app.