{"id":19525580,"url":"https://github.com/onekeyhq/hardware-js-sdk","last_synced_at":"2025-04-09T07:10:03.686Z","repository":{"id":65539747,"uuid":"492670028","full_name":"OneKeyHQ/hardware-js-sdk","owner":"OneKeyHQ","description":"Javascript SDK for easily connect OneKey hardware device.","archived":false,"fork":false,"pushed_at":"2024-10-14T03:46:10.000Z","size":39505,"stargazers_count":17,"open_issues_count":16,"forks_count":10,"subscribers_count":9,"default_branch":"onekey","last_synced_at":"2024-10-14T04:31:57.937Z","etag":null,"topics":["developer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OneKeyHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-16T03:22:59.000Z","updated_at":"2024-10-12T18:20:38.000Z","dependencies_parsed_at":"2023-11-13T10:24:25.161Z","dependency_job_id":"8a3ddd17-6e86-41f2-ba82-45994bbb5a96","html_url":"https://github.com/OneKeyHQ/hardware-js-sdk","commit_stats":{"total_commits":351,"total_committers":13,"mean_commits":27.0,"dds":"0.46153846153846156","last_synced_commit":"90781b7a1316ab56d412324b721da91023d8f80f"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fhardware-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fhardware-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fhardware-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OneKeyHQ%2Fhardware-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OneKeyHQ","download_url":"https://codeload.github.com/OneKeyHQ/hardware-js-sdk/tar.gz/refs/heads/onekey","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247994122,"owners_count":21030050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer"],"created_at":"2024-11-11T01:05:39.354Z","updated_at":"2025-04-09T07:10:03.657Z","avatar_url":"https://github.com/OneKeyHQ.png","language":"TypeScript","readme":"# Hardware-js-sdk\n\nHardware-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.\n\n## Packages\n\n| package                                                                     | description                                                           |\n| --------------------------------------------------------------------------- | --------------------------------------------------------------------- |\n| [@onekeyfe/core](./packages/core)                                           | The core process of hardware wallet connection.                       |\n| [@onekeyfe/hd-web-sdk](./packages/hd-web-sdk)                               | Using the sdk in the web platform.                                    |\n| [@onekeyfe/hd-ble-sdk](./packages/hd-ble-sdk)                               | Using the SDK in BLE communication environment. e.g: iOS / Android    |\n| [@onekeyfe/hd-common-sdk](./packages/hd-common-connect-sdk)                 | Using the SDK in a node or web-usb environment                        |\n| [@onekeyfe/hd-transport](./packages/hd-transport)                           | Data serialization and deserialization of hardware communication data |\n| [@onekeyfe/hd-transport-http](./packages/hd-transport-http)                 | communication lib for http                                            |\n| [@onekeyfe/hd-transport-react-native](./packages/hd-transport-react-native) | communication lib for React Native                                    |\n| [@onekeyfe/hd-transport-webusb](./packages/hd-transport-webusb)             | communication lib for WebUSB                                          |\n| [@onekeyfe/hd-shared](./packages/shared)                                    | Tools, error definitions, constants                                   |\n\n## Documentation\n\nSee the full documentation on [developer.onekey.so](https://developer.onekey.so/connect-to-hardware/hardware-sdk).\n\n## hardware-js-sdk development\n\nBefore you start make sure you have downloaded and installed NVM, Yarn and git with git lfs.\n\n- `git clone git@github.com:OneKeyHQ/hardware-js-sdk.git`\n- `git submodule update --init --recursive`\n- `yarn`\n- `yarn bootstrap`\n\nRun a dev build:\n\n- `yarn dev:web` (web sdk)\n- `yarn dev:ble` (react-native sdk)\n- `yarn dev:core` (core package)\n- `yarn dev:transport-http` (transport-http package)\n- `yarn dev:shared` (shared package)\n\n### Development with example desktop app (Recommend)\n- `yarn bootstrap \u0026\u0026 yarn build`\n- `yarn example:desktop`\n\n### Development with example mobile app\n- `yarn bootstrap \u0026\u0026 yarn build`\n- `yarn example` select ios or android in menu.\n\n### Development with example web app\n- Build web sdk\n- Edit connect src in `packages/connect-examples/expo-example/src/constants/connect.ts`, change `CONNECT_SRC` to `https://localhost:8087/`\n- `yarn dev:web`\n- Open chrome browser, enter `https://localhost:8087/`, simply type \"thisisunsafe\" directly on your keyboard (no need to press Enter)\n- Run example app\n- `yarn bootstrap \u0026\u0026 yarn build`\n- `yarn example` select web in menu.\n\n### Development onekey-app monorepo\n\n- Build all packages\n- `yarn bootstrap \u0026\u0026 yarn build`\n- Edit .env file, APP_MONOREPO_LOCAL_PATH=/path/to/v5-app-monorepo\n- `yarn debug:watcher`\n\nOpen v5-app-monorepo, run `yarn \u0026\u0026 yarn app:xxxx` to start the app.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonekeyhq%2Fhardware-js-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonekeyhq%2Fhardware-js-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonekeyhq%2Fhardware-js-sdk/lists"}