@ledgerhq/hw-transport
    TypeScript icon, indicating that this package has built-in type declarations

    6.7.0 • Public • Published

    Github, Ledger Devs Slack

    @ledgerhq/hw-transport

    @ledgerhq/hw-transport implements the generic interface of a Ledger Hardware Wallet transport.

    API

    Table of Contents

    Subscription

    Type: {unsubscribe: function (): void}

    Properties

    • unsubscribe function (): void

    Device

    Type: any

    DescriptorEvent

    type: add or remove event descriptor: a parameter that can be passed to open(descriptor) deviceModel: device info on the model (is it a nano s, nano x, ...) device: transport specific device info

    Observer

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

    Transport

    Transport defines the generic interface to share between node/u2f impl A Descriptor is a parametric type that is up to be determined for the implementation. it can be for instance an ID, an file path, a URL,...

    exchange

    low level api to communicate with the device This method is for implementations to implement but should not be directly called. Instead, the recommanded way is to use send() method

    Parameters
    • _apdu Buffer
    • apdu the data to send

    Returns Promise<Buffer> a Promise of response data

    setScrambleKey

    set the "scramble key" for the next exchanges with the device. Each App can have a different scramble key and they internally will set it at instanciation.

    Parameters
    • _key string
    • key the scramble key

    close

    close the exchange with the device.

    Returns Promise<void> a Promise that ends when the transport is closed.

    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
    Parameters
    • eventName string
    • cb function (...args: Array<any>): any

    Returns void

    off

    Stop listening to an event on an instance of transport.

    Parameters
    • eventName string
    • cb function (...args: Array<any>): any

    Returns void

    setDebugMode

    Enable or not logs of the binary exchange

    setExchangeTimeout

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

    Parameters

    Returns void

    setExchangeUnresponsiveTimeout

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

    Parameters

    Returns void

    send

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

    Parameters
    • cla number
    • ins number
    • p1 number
    • p2 number
    • data Buffer (optional, default Buffer.alloc(0))
    • statusList Array<number> is a list of accepted status code (shorts). [0x9000] by default (optional, default [StatusCodes.OK])

    Returns Promise<Buffer> a Promise of response buffer

    isSupported

    Statically check if a transport is supported on the user's platform/browser.

    Type: function (): Promise<boolean>

    list

    List once all available descriptors. For a better granularity, checkout listen().

    Type: function (): Promise<Array<any>>

    Examples
    TransportFoo.list().then(descriptors => ...)

    Returns any a promise of descriptors

    listen

    Listen all device events for a given Transport. The method takes an Obverver of DescriptorEvent and returns a Subscription (according to Observable paradigm https://github.com/tc39/proposal-observable ) a DescriptorEvent is a { descriptor, type } object. type can be "add" or "remove" and descriptor is a value you can pass to open(descriptor). each listen() call will first emit all potential device already connected and then will emit events can come over times, for instance if you plug a USB device after listen() or a bluetooth device become discoverable.

    Type: function (observer: Observer<DescriptorEvent<any>>): Subscription

    Parameters
    • observer is an object with a next, error and complete function (compatible with observer pattern)
    Examples
    const sub = TransportFoo.listen({
    next: e => {
    if (e.type==="add") {
    sub.unsubscribe();
    const transport = await TransportFoo.open(e.descriptor);
    ...
    }
    },
    error: error => {},
    complete: () => {}
    })

    Returns any a Subscription object on which you can .unsubscribe() to stop listening descriptors.

    open

    attempt to create a Transport instance with potentially a descriptor.

    Type: function (descriptor: any, timeout: number): Promise<Transport>

    Parameters
    • descriptor : the descriptor to open the transport with.
    • timeout : an optional timeout
    Examples
    TransportFoo.open(descriptor).then(transport => ...)

    Returns any a Promise of Transport instance

    create

    create() allows to open the first descriptor available or throw if there is none or if timeout is reached. This is a light helper, alternative to using listen() and open() (that you may need for any more advanced usecase)

    Parameters
    • openTimeout (optional, default 3000)
    • listenTimeout number?
    Examples
    TransportFoo.create().then(transport => ...)

    Returns Promise<Transport>

    Install

    npm i @ledgerhq/hw-transport

    DownloadsWeekly Downloads

    86,044

    Version

    6.7.0

    License

    Apache-2.0

    Unpacked Size

    90.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • haammar-ledger
    • achabrolin-ledger
    • mortalkastor
    • gre
    • btchip
    • meriadec
    • flocks
    • amougel
    • juan-cortes
    • val_pinkman
    • iammorrow
    • phenry-ledger
    • jdecussy-ledger
    • lfbarreto
    • junsugiura
    • hzheng_ledger
    • machard-ledger
    • glethuillier_ledger