@emurgo/react-native-hid
Version:
Ledger Hardware Wallet Web implementation of the communication layer, using U2F api
93 lines (55 loc) • 2.12 kB
Markdown
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
## @ledgerhq/hw-transport-u2f
Allows to communicate with Ledger Hardware Wallets.
**[React Native]** **(HID)** _Android_ – Ledger's native implementation.
## API
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
#### Table of Contents
- [HIDTransport](#hidtransport)
- [Parameters](#parameters)
- [Examples](#examples)
- [exchange](#exchange)
- [Parameters](#parameters-1)
- [close](#close)
- [isSupported](#issupported)
- [list](#list)
- [listen](#listen)
- [Parameters](#parameters-2)
- [open](#open)
- [Parameters](#parameters-3)
### HIDTransport
**Extends Transport**
Ledger's React Native HID Transport implementation
#### Parameters
- `nativeId` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
- `productId` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
#### Examples
```javascript
import TransportHID from "@ledgerhq/react-native-hid";
...
TransportHID.create().then(transport => ...)
```
#### exchange
##### Parameters
- `apdu` **any** input value
Returns **any** Promise of apdu response
#### close
Close the transport
Returns **any** Promise
#### isSupported
Check if the transport is supported (basically true on Android)
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>**
#### list
List currently connected devices.
Returns **any** Promise of devices
#### listen
Listen to ledger devices events
##### Parameters
- `observer` **any**
Returns **any**
#### open
Open a the transport with a Ledger device
##### Parameters
- `deviceObj` **DeviceObj**