@ledgerhq/hw-transport-web-ble

GitHub, Ledger Devs Discord, Developer Portal

@ledgerhq/hw-transport-web-ble

Allows to communicate with Ledger Hardware Wallets.

[Web] (Bluetooth) – check browser support.

Are you adding Ledger support to your software wallet?

You may be using this package to open a Bluetooth connection between your web 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

• BluetoothTransport
  • Parameters
  • Examples
  • exchange
    • Parameters
  • observeAvailability
    • Parameters
  • listen
    • Parameters
  • open
    • Parameters
  • disconnect
    • Parameters

BluetoothTransport

Extends Transport

react-native bluetooth BLE implementation

Parameters

• device Device
• writeCharacteristic Characteristic
• notifyObservable Observable<any>
• deviceModel DeviceModel

Examples

import BluetoothTransport from "@ledgerhq/hw-transport-web-ble";

exchange

Exchange with the device using APDU protocol.

Parameters

• apdu Buffer

Returns Promise<Buffer> a promise of apdu response

observeAvailability

observe event with { available: bool, type: string } (available is generic, type is specific) an event is emit once and then each time it changes

Parameters

• observer any

listen

Scan for Ledger Bluetooth devices. On this web implementation, it only emits ONE device, the one that was selected in the UI (if any).

Parameters

• observer any

open

open a bluetooth device.

Parameters

• deviceOrId (Device | string)

disconnect

globally disconnect a bluetooth device by its id.

Parameters

• id any