@ledgerhq/hw-transport-webusb

Github, API Doc, Ledger Devs Slack

@ledgerhq/hw-transport-webusb

Allows to communicate with Ledger Hardware Wallets.

[Web] (WebUSB) – WebUSB check browser support.

Important: The transport functions create() and listen() must be in the context of an user interaction (like a "click" event), otherwise it will fails with DOM Exception.

API

Table of Contents

• TransportWebUSB
  • Parameters
  • Examples
  • close
  • exchange
    • Parameters
  • isSupported
  • list
  • listen
    • Parameters
  • open
    • Parameters

TransportWebUSB

Extends Transport

WebUSB Transport implementation

Parameters

• device USBDevice

Examples

import TransportWebUSB from "@ledgerhq/hw-transport-webusb";
...
TransportWebUSB.create().then(transport => ...)

close

Release the transport device

Returns Promise<void>

exchange

Exchange with the device using APDU protocol.

Parameters

• apdu Buffer

Returns Promise<Buffer> a promise of apdu response

isSupported

Check if WebUSB transport is supported.

list

List the WebUSB devices that was previously authorized.

listen

Actively listen to WebUSB devices and emit ONE device that was selected by the native permission UI.

Important: it must be called in the context of a UI click!

Parameters

• observer Observer<DescriptorEvent<USBDevice>>

Returns Subscription

open

Create a Ledger transport with a USBDevice

Parameters

• device USBDevice