@ledgerhq/types-devices

Ledger types for devices and transport.

Usage no npm install needed!

<script type="module">
  import ledgerhqTypesDevices from 'https://cdn.skypack.dev/@ledgerhq/types-devices';
</script>

README

@ledgerhq/types-devices

Ledger types for devices and transport.

API

Table of Contents

DeviceModelId

DeviceModelId is a unique identifier to identify the model of a Ledger hardware wallet.

DeviceModel

a DeviceModel contains all the information of a specific Ledger hardware wallet model.

BluetoothInfos

Subscription

represent an ongoing job that can be stopped with .unsubscribe()

Type: {unsubscribe: function (): void}

Properties

  • unsubscribe function (): void

Device

data about the device. not yet typed

Type: any

Observer

Type: Readonly<{next: function (event: Ev): any, error: function (e: any): any, complete: function (): any}>

send

wrapper on top of exchange to simplify work of the implementation.

Type: function (cla: number, ins: number, p1: number, p2: number, data: Buffer, statusList: Array<number>): Promise<Buffer>

Parameters

  • cla
  • ins
  • p1
  • p2
  • data
  • statusList is a list of accepted status code (shorts). [0x9000] by default

Returns any a Promise of response buffer

on

Listen to an event on an instance of transport. Transport implementation can have specific events. Here is the common events:

  • "disconnect" : triggered if Transport is disconnected

Type: function (eventName: string, cb: function (...args: Array<any>): any): void

off

Stop listening to an event on an instance of transport.

Type: function (eventName: string, cb: function (...args: Array<any>): any): void

setExchangeTimeout

Set a timeout (in milliseconds) for the exchange call. Only some transport might implement it. (e.g. U2F)

Type: function (exchangeTimeout: number): void

setExchangeUnresponsiveTimeout

Define the delay before emitting "unresponsive" on an exchange that does not respond

Type: function (unresponsiveTimeout: number): void