open-index/open-npm huggingface dataset:
npm package: @onekeyfe/eslint-config-onekey
Description: onekey-eslint rules
Author: OneKey
Latest version: 1.0.13

# onekey-eslint
OneKey Customize ESLint Rule

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

Next, install `@onekeyfe/eslint-config-onekey`:

```
$ npm install @onekeyfe/eslint-config-onekey --save-dev
```

## Usage

Add `@onekeyfe/onekey` to the extends section of your `.eslintrc` configuration file. You can omit the `eslint-config-` prefix:

```json
{
    "extends": [
        "@onekeyfe/onekey"
    ]
}
```
npm package: @onekeyfe/hd-transport-lowlevel
Description: `@onekeyfe/hd-transport-http` is a library that implements transport communication using http.
Latest version: 1.1.25

# `@onekeyfe/hd-transport-lowlevel`

`@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](./protocol.md)
- 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.
1. `yarn update-submodules` to update firmware submodule
1. `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
yarn 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)
npm package: @onekeyfe/hd-transport-react-native
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).
Latest version: 1.1.25

# `@onekeyfe/hd-transport-react-native`

`@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).

## 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](./protocol.md)
- 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.
1. `yarn update-submodules` to update firmware submodule
1. `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](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)
npm package: @onekeyfe/hd-transport-web-device
Description: `@onekeyfe/hd-transport-webusb` is a library that implements transport communication by WebUSB.
Author: OneKey
Latest version: 1.1.25

# `@onekeyfe/hd-transport-webusb`

`@onekeyfe/hd-transport-webusb` is a library that implements transport communication by WebUSB.

## 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](./protocol.md)
- 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.
1. `yarn update-submodules` to update firmware submodule
1. `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](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)
npm package: @onekeyfe/hd-transport-webusb
Description: `@onekeyfe/hd-transport-webusb` is a library that implements transport communication by WebUSB.
Author: OneKey
Latest version: 1.0.39-alpha.3

# `@onekeyfe/hd-transport-webusb`

`@onekeyfe/hd-transport-webusb` is a library that implements transport communication by WebUSB.

## 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](./protocol.md)
- 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.
1. `yarn update-submodules` to update firmware submodule
1. `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](https://developer.onekey.so/connect-to-hardware/hardware-sdk/start)
npm package: @onekeyfe/kaspa-core-lib
Description: JavaScript Kaspa library.
Latest version: 1.0.2

JavaScript Data Primitives Library for Kaspa
=============================================

**PLEASE NOTE: This project is under heavy development and is not production ready**

Based on the popular [Bitcore library](https://github.com/bitpay/bitcore) developed by BitPay for the Bitcoin, Kaspacore library provides primitives for interfacing with the Kaspa network.

Get Started
-----------

```sh
git clone git@github.com:aspectron/kaspacore-lib
```

Adding Kaspacore to your app's `package.json`:

```json
"dependencies": {
    "aspectron/kaspacore-lib": "*"
}
```

Kaspa adaptation
----------------

Kaspacore library provides primitives such as Transaction and UTXO data structures customized for use with the next-generation high-performance Kaspa network.

Documentation
-------------

The complete docs are hosted here: [bitcore documentation](https://github.com/bitpay/bitcore). There's also a [bitcore API reference](https://github.com/bitpay/bitcore/blob/master/packages/bitcore-node/docs/api-documentation.md) available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.


Building the Browser Bundle
---------------------------

To build a kaspacore-lib full bundle for the browser:

```sh
gulp browser
```

This will generate files named `kaspacore-lib.js` and `kaspacore-lib.min.js`.

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout the [releases](https://github.com/bitpay/bitcore/blob/master/packages/bitcore-lib/CHANGELOG.md).


Contributing
------------

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/Contributing.md) on the main bitcore repo for information about how to contribute.

License
-------

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Bitcore - Copyright 2013-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.  
Kaspacore - Copyright 2020 ASPECTRON Inc.
npm package: @onekeyfe/kaspacore-lib
Description: JavaScript Kaspa library.
Latest version: 1.0.0-alpha.6

JavaScript Data Primitives Library for Kaspa
=============================================

**PLEASE NOTE: This project is under heavy development and is not production ready**

Based on the popular [Bitcore library](https://github.com/bitpay/bitcore) developed by BitPay for the Bitcoin, Kaspacore library provides primitives for interfacing with the Kaspa network.

Get Started
-----------

```sh
git clone git@github.com:aspectron/kaspacore-lib
```

Adding Kaspacore to your app's `package.json`:

```json
"dependencies": {
    "aspectron/kaspacore-lib": "*"
}
```

Kaspa adaptation
----------------

Kaspacore library provides primitives such as Transaction and UTXO data structures customized for use with the next-generation high-performance Kaspa network.

Documentation
-------------

The complete docs are hosted here: [bitcore documentation](https://github.com/bitpay/bitcore). There's also a [bitcore API reference](https://github.com/bitpay/bitcore/blob/master/packages/bitcore-node/docs/api-documentation.md) available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.


Building the Browser Bundle
---------------------------

To build a kaspacore-lib full bundle for the browser:

```sh
gulp browser
```

This will generate files named `kaspacore-lib.js` and `kaspacore-lib.min.js`.

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout the [releases](https://github.com/bitpay/bitcore/blob/master/packages/bitcore-lib/CHANGELOG.md).


Contributing
------------

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/Contributing.md) on the main bitcore repo for information about how to contribute.

License
-------

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Bitcore - Copyright 2013-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.  
Kaspacore - Copyright 2020 ASPECTRON Inc.