@onekeyfe/hd-transport-http
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-alpha.13 • Public • Published

@onekeyfe/hd-transport-http

@onekeyfe/hd-transport-http is a library that implements transport communication using http.

What is the purpose

  • translate JSON payloads to binary messages using protobuf definitions comprehensible to OneKey devices
  • chunking and reading chunked messages according to the OneKey protocol
  • exposing single API for various transport methods:
    • Http Transport
    • React Native Transport
    • WebUSB
  • Create and expose typescript definitions based on protobuf definitions.

The short version

In order to be able to use new features of onekey-firmware you need to update protobuf definitions.

  1. git submodule update --init --recursive to initialize git submodules.
  2. yarn update-submodules to update firmware submodule
  3. yarn update:protobuf to generate new ./messages.json and ./src/types/messages.ts

git submodule update --init --recursive to initialize firmware submodule yarn update-submodules to update firmware submodule yar update:protobuf to generate new ./messages.json and ./src/types/messages.ts

Docs

Documentation is available hardware-js-sdk

Dependencies (3)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @onekeyfe/hd-transport-http

    Weekly Downloads

    429

    Version

    1.0.0-alpha.13

    License

    ISC

    Unpacked Size

    22.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • 1keyfe
    • loatheb