Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ledgerhq/hw-transport-web-ble

LedgerHQ418.5kApache-2.06.29.6TypeScript support: included

Ledger Hardware Wallet Web Bluetooth implementation of the communication layer

Ledger, LedgerWallet, bluetooth, ble, NanoS, Blue, Hardware Wallet

readme

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

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

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

changelog

@ledgerhq/hw-transport-web-ble

6.29.6

Patch Changes

6.29.6-next.1

Patch Changes

6.29.6-next.0

Patch Changes

6.29.5

Patch Changes

6.29.5-next.0

Patch Changes

6.29.4

Patch Changes

6.29.4-next.0

Patch Changes

6.29.3

Patch Changes

6.29.3-next.0

Patch Changes

6.29.2

Patch Changes

6.29.2-hotfix.0

Patch Changes

6.29.1

Patch Changes

6.29.1-next.0

Patch Changes

6.29.0

Minor Changes

Patch Changes

6.29.0-next.0

Minor Changes

Patch Changes

6.28.6

Patch Changes

6.28.6-next.0

Patch Changes

6.28.5

Patch Changes

6.28.5-next.0

Patch Changes

6.28.4

Patch Changes

6.28.4-next.0

Patch Changes

6.28.3

Patch Changes

6.28.3-next.0

Patch Changes

6.28.2

Patch Changes

6.28.2-next.0

Patch Changes

6.28.1

Patch Changes

6.28.1-next.0

Patch Changes

6.28.0

Minor Changes

Patch Changes

6.28.0-next.0

Minor Changes

Patch Changes

6.27.20

Patch Changes

6.27.20-next.0

Patch Changes

6.27.19

Patch Changes

6.27.19-next.0

Patch Changes

6.27.18

Patch Changes

6.27.18-next.0

Patch Changes

6.27.17

Patch Changes

6.27.17-next.0

Patch Changes

6.27.16

Patch Changes

6.27.16-next.0

Patch Changes

6.27.15

Patch Changes

6.27.15-next.0

Patch Changes

6.27.14

Patch Changes

6.27.14-next.0

Patch Changes

6.27.13

Patch Changes

6.27.13-next.0

Patch Changes

6.27.12

Patch Changes

6.27.12-next.0

Patch Changes

6.27.11

Patch Changes

6.27.11-next.0

Patch Changes

6.27.10

Patch Changes

6.27.10-next.0

Patch Changes

6.27.9

Patch Changes

6.27.9-next.0

Patch Changes

6.27.8

Patch Changes

6.27.8-next.0

Patch Changes

6.27.7

Patch Changes

6.27.7-next.0

Patch Changes

6.27.6

Patch Changes

6.27.6-next.0

Patch Changes

6.27.5

Patch Changes

6.27.5-next.0

Patch Changes

6.27.4

Patch Changes

6.27.4-next.0

Patch Changes

6.27.3

Patch Changes

6.27.3-next.0

Patch Changes

6.27.2

Patch Changes

  • #364 f538d2974 Thanks @elbywan! - #### Replace webpack with vite.js to speed up the ledger live desktop development process.

    To fully embrace the "bundleless" vite.js approach, it is necessary to transpile our packages contained in the monorepository to the ESM format, and subpath exports have been added to silently map to commonjs or esm depending on the need.

    🔥 BREAKING CHANGES for @ledgerhq/live-common, @ledgerhq/devices and @ledgerhq/hw-app-btc consumers.

    As highlighted here, it is not possible to target folders directly when using subpath exports.

    The workaround is to suffix the call with /index (or /).

    For instance…

    import * as currencies from "@ledgerhq/live-common/currencies";

    …must be rewritten to…

    import * as currencies from "@ledgerhq/live-common/currencies/index;";

    …or:

    import * as currencies from "@ledgerhq/live-common/currencies/;";

  • Updated dependencies [203b927b4, f538d2974]:

6.27.2-next.0

Patch Changes

  • #364 f538d2974 Thanks @elbywan! - #### Replace webpack with vite.js to speed up the ledger live desktop development process.

    To fully embrace the "bundleless" vite.js approach, it is necessary to transpile our packages contained in the monorepository to the ESM format, and subpath exports have been added to silently map to commonjs or esm depending on the need.

    🔥 BREAKING CHANGES for @ledgerhq/live-common, @ledgerhq/devices and @ledgerhq/hw-app-btc consumers.

    As highlighted here, it is not possible to target folders directly when using subpath exports.

    The workaround is to suffix the call with /index (or /).

    For instance…

    import * as currencies from "@ledgerhq/live-common/currencies";

    …must be rewritten to…

    import * as currencies from "@ledgerhq/live-common/currencies/index;";

    …or:

    import * as currencies from "@ledgerhq/live-common/currencies/;";

  • Updated dependencies [203b927b4, f538d2974]: