@onekeyfe/hd-transport-react-native - npm Package Compare versions

Comparing version 0.1.50 to 0.1.51

package.json

 {
   "name": "@onekeyfe/hd-transport-react-native",
-  "version": "0.1.50",
+  "version": "0.1.51",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -22,8 +22,8 @@ "license": "MIT",
   "dependencies": {
-    "@onekeyfe/hd-shared": "^0.1.50",
-    "@onekeyfe/hd-transport": "^0.1.50",
+    "@onekeyfe/hd-shared": "^0.1.51",
+    "@onekeyfe/hd-transport": "^0.1.51",
     "react-native-ble-manager": "^8.1.0",
     "react-native-ble-plx": "^2.0.3"
   },
-  "gitHead": "e3e2a8aa77a1bf72d1b26dc9841463a660a2f902"
+  "gitHead": "0bc84671cf1fabb0f50339407dd43ad82ff096b8"
 }

README.md

@@ -1,11 +0,29 @@
-# `hd-transport-react-native`
+# `@onekeyfe/hd-transport-react-native`
 
-> TODO: description
+`@onekeyfe/hd-transport-react-native` is a library that implements transport communication by [react-native-ble-plx](https://github.com/dotintent/react-native-ble-plx).
 
-## Usage
+## What is the purpose
 
-```
-const hdTransportReactNative = require('hd-transport-react-native');
+- translate JSON payloads to binary messages using protobuf definitions comprehensible to OneKey devices
+- chunking and reading chunked messages according to the [OneKey protocol](./protocol.md)
+- exposing single API for various transport methods:
+  - Http Transport
+  - React Native Transport
+  - WebUSB
+- Create and expose typescript definitions based on protobuf definitions.
 
-// TODO: DEMONSTRATE API
-```
+### 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.
+1. `yarn update-submodules` to update trezor-common submodule
+1. `yarn workspace @onekeyfe/transport update:protobuf` to generate new `./messages.json` and `./src/types/messages.ts`
+
+git submodule update --init --recursive to initialize trezor-common submodule
+yarn update-submodules to update trezor-common submodule
+yarn workspace @trezor/transport update:protobuf to generate new ./messages.json and ./src/types/messages.ts
+
+## Docs
+
+Documentation is available [hardware-js-sdk](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

57909

increased by2.11%

Number of lines in readme file

30

increased by150%

Dependency changes

• Updated@onekeyfe/hd-shared@^0.1.51

• Updated@onekeyfe/hd-transport@^0.1.51