Transport Device Kit Web HID

[!CAUTION] This is still under development and we are free to make new interfaces which may lead to breaking changes.

• Transport Device Kit Web HID Documentation
  • Description
  • Installation
  • Usage
    • Compatibility
    • Pre-requisites
    • Main Features
    • How To

Description

This transport is used to interact with a Ledger device through the Web HID (usb) implementation by the Device Management Kit.

Installation

To install the core package, run the following command:

npm install @ledgerhq/device-transport-kit-web-hid

Usage

Compatibility

This library works in any browser supporting the WebHID API.

Pre-requisites

To use this transport, ensure you have the Device Management Kit installed in your project.

Main Features

• Exposing a transport factory to be injected into the DeviceManagementKit
• Exposing the transport directly for a custom configuration

How To

To use the transport, you need to inject it in the DeviceManagementKitBuilder before the build. This will allow the Devivce Management Kit to find and interact with devices on the Web HID protocol.

import { DeviceManagementKitBuilder } from "@ledgerhq/device-management-kit"
import { webHidTransportFactory, WebHidTransport } from "@ledgerhq/device-transport-kit-web-hid"

// Easy setup with the factory
const dmk = new DeviceManagementKitBuilder()
  .addTransport(webHidTransportFactory)
  .build();


// With custom config
const dmk = new DeviceManagementKitBuilder()
  .addTransport(({
    deviceModelDataSource: DeviceModelDataSource;
    loggerServiceFactory: (tag: string) => LoggerPublisherService;
    config: DmkConfig;
    apduSenderServiceFactory: ApduSenderServiceFactory;
    apduReceiverServiceFactory: ApduReceiverServiceFactory;
  }) => {
    // custom code
    return new WebHidTransport(
      deviceModelDataSource,
      loggerServiceFactory,
      config,
      apduSenderServiceFactory,
      apduReceiverServiceFactory,
    );
  })
  .build();

  // You can then make use of the Device Management Kit