@ledgerhq/hw-transport-webhid
Advanced tools
Ledger Hardware Wallet WebHID implementation of the communication layer
@ledgerhq/hw-transport-webhid is an npm package that provides a transport layer for communicating with Ledger hardware wallets using the WebHID API. It allows developers to interact with Ledger devices directly from web applications, enabling functionalities such as sending commands to the device and receiving responses.
Open Connection
This feature allows you to establish a connection with a Ledger device using the WebHID API. The code sample demonstrates how to create a transport instance and open a connection to the device.
const TransportWebHID = require('@ledgerhq/hw-transport-webhid');
async function openConnection() {
const transport = await TransportWebHID.create();
console.log('Connection opened:', transport);
}
openConnection();Send APDU Command
This feature allows you to send an APDU command to the Ledger device. The code sample shows how to send a command and receive a response from the device.
const TransportWebHID = require('@ledgerhq/hw-transport-webhid');
async function sendCommand() {
const transport = await TransportWebHID.create();
const response = await transport.send(0xE0, 0x01, 0x00, 0x00, Buffer.from([]));
console.log('Response:', response);
}
sendCommand();Close Connection
This feature allows you to close the connection with the Ledger device. The code sample demonstrates how to properly close the transport connection.
const TransportWebHID = require('@ledgerhq/hw-transport-webhid');
async function closeConnection() {
const transport = await TransportWebHID.create();
await transport.close();
console.log('Connection closed');
}
closeConnection();@ledgerhq/hw-transport-u2f is a similar package that uses the U2F (Universal 2nd Factor) protocol to communicate with Ledger devices. Unlike WebHID, U2F is more widely supported across different browsers but may have limitations in terms of speed and functionality compared to WebHID.
@ledgerhq/hw-transport-webusb provides a transport layer using the WebUSB API. It offers similar functionalities to WebHID but requires user permission to access USB devices. WebUSB can be more versatile in terms of device compatibility but may not be supported in all browsers.
@ledgerhq/hw-transport-node-hid is designed for Node.js environments and uses the HID protocol to communicate with Ledger devices. It is suitable for desktop applications but not for web applications, unlike WebHID which is specifically for web use.
GitHub, Ledger Devs Discord, Developer Portal
Allows to communicate with Ledger Hardware Wallets.
[Web] (WebHID) – WebHID check browser support.
You may be using this package to open a USB connection between your web application and the device.
For a smooth and quick integration:
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.
Please check @ledgerhq/hw-transport-webusb documentation because it is very similar paradigm.
WebUSB is currently only supported on Google Chrome / Chromium DEV version and by explicitly enabling chrome://flags/#enable-experimental-web-platform-features
Extends Transport
WebHID Transport implementation
device HIDDevice import TransportWebHID from "@ledgerhq/hw-transport-webhid";
...
TransportWebHID.create().then(transport => ...)
Release the transport device
Returns Promise<void>
Exchange with the device using APDU protocol.
apdu Buffer Returns Promise<Buffer> a promise of apdu response
Check if WebUSB transport is supported.
List the WebUSB devices that was previously authorized by the user.
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!
observer Observer<DescriptorEvent<HIDDevice>> Returns Subscription
Similar to create() except it will always display the device permission (even if some devices are already accepted).
Similar to create() except it will never display the device permission (it returns a Promise<?Transport>, null if it fails to find a device).
Create a Ledger transport with a HIDDevice
device HIDDevice FAQs
Ledger Hardware Wallet WebHID implementation of the communication layer
The npm package @ledgerhq/hw-transport-webhid receives a total of 91,151 weekly downloads. As such, @ledgerhq/hw-transport-webhid popularity was classified as popular.
We found that @ledgerhq/hw-transport-webhid demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.