@ledgerhq/hw-transport-node-hid-singleton

GitHub, Ledger Devs Discord, Developer Portal

@ledgerhq/hw-transport-node-hid-singleton

Allows to communicate with Ledger Hardware Wallets.

[Node]/Electron (HID) – uses node-hid and node-usb. Keep transport opened and re-use it as a singleton, one device at a time on a computer but more robust implementation.

---

Are you adding Ledger support to your software wallet?

You may be using this package to open a USB connection between your desktop application and the device.

For a smooth and quick integration:

• See the developers’ documentation on the Developer Portal and
• Go on Discord to chat with developer support and the developer community.

---

API

Table of Contents

• TransportNodeHidSingleton
  • Examples
  • exchange
    • Parameters
  • isSupported
  • list
  • listen
    • Parameters
  • autoDisconnect
  • disconnect
  • open

TransportNodeHidSingleton

Extends TransportNodeHidNoEvents

node-hid Transport implementation

Examples

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

exchange

Exchange with the device using APDU protocol.

Parameters

• apdu Buffer

Returns Promise<Buffer> a promise of apdu response

isSupported

list

listen

Parameters

• observer Observer<ListenDescriptorEvent>

Returns Subscription

autoDisconnect

convenience wrapper for auto-disconnect logic

Returns Promise<void>

disconnect

globally disconnect the transport singleton

open

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

Returns Promise<TransportNodeHidSingleton>