README.md

Github, Ledger Devs Slack

@ledgerhq/hw-transport-node-hid

Allows to communicate with Ledger Hardware Wallets.

[Node]/Electron (HID) – uses node-hid and usb.

API

Table of Contents

• TransportNodeHid
  • Parameters
  • Examples
  • exchange
    • Parameters
  • close
  • isSupported
  • list
  • setListenDevicesDebounce
    • Parameters
  • setListenDevicesPollingSkip
    • Parameters
  • setListenDevicesDebug
  • listen
    • Parameters
  • open
    • Parameters

TransportNodeHid

Extends Transport

node-hid Transport implementation

Parameters

• device HID.HID

Examples

import TransportNodeHid from "@ledgerhq/hw-transport-node-hid";
...
TransportNodeHid.create().then(transport => ...)

exchange

Exchange with the device using APDU protocol.

Parameters

• apdu Buffer

Returns Promise<Buffer> a promise of apdu response

close

release the USB device.

Returns Promise<void>

isSupported

Returns Promise<boolean>

list

Returns Promise<Array<string>>

setListenDevicesDebounce

Parameters

• delay number

setListenDevicesPollingSkip

Parameters

• conditionToSkip function (): boolean

setListenDevicesDebug

listen

Parameters

• observer Observer<DescriptorEvent<string>>

Returns Subscription

open

if path="" is not provided, the library will take the first device

Parameters

• path string