@ledgerhq/hw-transport-webhid

v6.30.0

Ledger Hardware Wallet WebHID implementation of the communication layer For more information about how to use this package see README

Latest version published 19 days ago

License: MIT

NPM

GitHub

Package Health Score

90 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
6.30.0	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.29.4	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.27.1	\|	04/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.51.1	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.78.0	\|	11/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (90,602)

GitHub Stars: 456
Forks: 350
Contributors: 290

Direct Usage Popularity

The npm package @ledgerhq/hw-transport-webhid receives a total of 90,602 downloads a week. As such, we scored @ledgerhq/hw-transport-webhid popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @ledgerhq/hw-transport-webhid, we found that it has been starred 456 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 290
Funding: No

A good and healthy external contribution signal for @ledgerhq/hw-transport-webhid project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like @ledgerhq/hw-transport-webhid is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 16
Open PR: 46
Last Release: 19 days ago
Last Commit: 7 days ago

Further analysis of the maintenance status of @ledgerhq/hw-transport-webhid based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @ledgerhq/hw-transport-webhid demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 4 Direct
Versions: 246
Install Size: 78.2 kB
Dist-tags: 29
# of Files: 17
Maintainers: 8
TS Typings: No

@ledgerhq/hw-transport-webhid has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @ledgerhq/hw-transport-webhid?

To help you get started, we've collected the most common ways that @ledgerhq/hw-transport-webhid is being used within popular public projects.

LedgerHQ / ledger-live-common / tools / src / live-common-setup.js View on Github

open: (id: string): ?Promise&lt;*&gt; =&gt; {
    if (id.startsWith("webhid")) {
      return TransportWebHID.create();
    }
    return null;
  },

View more ways to use @ledgerhq/hw-transport-webhid

GitHub, Ledger Devs Discord, Developer Portal

@ledgerhq/hw-transport-webhid

Allows to communicate with Ledger Hardware Wallets.

[Web] (WebHID) – WebHID check browser support.

Are you adding Ledger support to your software wallet?

You may be using this package to open a USB 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.

FAQ: "DOM Exception" is triggered when creating the transport

The transport functions create() and listen() must be called in the context of a user interaction (like a "click" event), otherwise it fails with DOM Exception. This is by WebUSB design. You also must run on HTTPS.

How to use this transport?

Please check @ledgerhq/hw-transport-webusb documentation because it is very similar paradigm.

Support status

WebUSB is currently only supported on Google Chrome / Chromium DEV version and by explicitly enabling chrome://flags/#enable-experimental-web-platform-features

API

TransportWebHID
- Parameters
- Examples
- close
- exchange
  - Parameters
- isSupported
- list
- listen
  - Parameters
- request
- openConnected
- open
  - Parameters

TransportWebHID

Extends Transport

WebHID Transport implementation

Parameters

device HIDDevice

Examples

import TransportWebHID from "@ledgerhq/hw-transport-webhid";
...
TransportWebHID.create().then(transport =&gt; ...)

close

Release the transport device

Returns *Promise*

exchange

Exchange with the device using APDU protocol.

Parameters

apdu Buffer

Returns Promise<Buffer> a promise of apdu response

isSupported

Check if WebUSB transport is supported.

list

List the WebUSB devices that was previously authorized by the user.

listen

Actively listen to WebUSB devices and emit ONE device that was either accepted before, if not it will trigger the native permission UI.

Important: it must be called in the context of a UI click!

Parameters

observer Observer>

Returns Subscription

request

Similar to create() except it will always display the device permission (even if some devices are already accepted).

openConnected

Similar to create() except it will never display the device permission (it returns a Promise, null if it fails to find a device).

open

Create a Ledger transport with a HIDDevice

Parameters

device HIDDevice

@ledgerhq/hw-transport-webhid dependencies

@ledgerhq/devices @ledgerhq/errors @ledgerhq/hw-transport @ledgerhq/logs

@ledgerhq/hw-transport-webhid development dependencies

@types/jest @types/node @types/w3c-web-hid documentation jest rimraf source-map-support ts-jest ts-node

FAQs

What is @ledgerhq/hw-transport-webhid?

Ledger Hardware Wallet WebHID implementation of the communication layer. Visit Snyk Advisor to see a full health score report for @ledgerhq/hw-transport-webhid, including popularity, security, maintenance & community analysis.

Is @ledgerhq/hw-transport-webhid popular?

The npm package @ledgerhq/hw-transport-webhid receives a total of 90,602 weekly downloads. As such, @ledgerhq/hw-transport-webhid popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @ledgerhq/hw-transport-webhid well maintained?

We found that @ledgerhq/hw-transport-webhid demonstrated a healthy version release cadence and project activity. It has a community of 290 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @ledgerhq/hw-transport-webhid safe to use?

The npm package @ledgerhq/hw-transport-webhid was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 30 December-2024, at 07:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (90,602)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @ledgerhq/hw-transport-webhid?

@ledgerhq/hw-transport-webhid

Are you adding Ledger support to your software wallet?

FAQ: "DOM Exception" is triggered when creating the transport

How to use this transport?

Support status

API

Table of Contents

TransportWebHID

Parameters

Examples

close

exchange

Parameters

isSupported

list

listen

Parameters

request

openConnected

open

Parameters

@ledgerhq/hw-transport-webhid dependencies

@ledgerhq/hw-transport-webhid development dependencies

FAQs

What is @ledgerhq/hw-transport-webhid?

Is @ledgerhq/hw-transport-webhid popular?

Is @ledgerhq/hw-transport-webhid well maintained?

Is @ledgerhq/hw-transport-webhid safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues