@decentralchain/ledger

@decentralchain/ledger

DecentralChain Ledger hardware wallet integration library.

Overview

Communicate with Ledger Nano S/X devices to derive public keys and sign transactions securely on the hardware device. Supports WebUSB, Web Bluetooth, and Node HID transports.

Part of the DecentralChain SDK.

Requirements

• Node.js >= 24
• A Ledger Nano S or Nano X with the DCC application installed
• A compatible transport (@ledgerhq/hw-transport-webusb, @ledgerhq/hw-transport-web-ble, etc.)

Installation

npm install @decentralchain/ledger

You also need a Ledger transport package:

npm install @ledgerhq/hw-transport-webusb

Quick Start

import { DCCLedger } from '@decentralchain/ledger';
import TransportWebUSB from '@ledgerhq/hw-transport-webusb';

const ledger = new DCCLedger({ transport: TransportWebUSB });
await ledger.tryConnect();

// Get public key and address for account 0
const user = await ledger.getUserDataById(0);
console.log(user.address, user.publicKey);

// Sign a transaction
const signature = await ledger.signTransaction(0, {
  dataBuffer: transactionBytes,
  dataType: 4,
  dataVersion: 2,
});

API Reference

new DCCLedger(options)

Create a new Ledger integration instance.

Option	Type	Default	Description
transport	LedgerTransportFactory	—	Required. A @ledgerhq/hw-transport-* class
debug	boolean	false	Enable binary exchange logging
openTimeout	number	—	Connection timeout (ms)
listenTimeout	number	—	Listen request timeout (ms)
exchangeTimeout	number	—	Exchange call timeout (ms)
networkCode	number	76	DCC network code (76 = mainnet)

tryConnect(): Promise<void>

Connect (or reconnect) to the Ledger device.

disconnect(): Promise<void>

Close the active transport connection.

probeDevice(): Promise<boolean>

Returns true if the device is connected and the DCC app is open.

getUserDataById(id: number): Promise<User>

Derive wallet data for an account index.

Returns { id, path, address, publicKey, statusCode }.

getVersion(): Promise<number[]>

Query the installed DCC application version ([major, minor, patch]).

getPaginationUsersData(from: number, limit: number): Promise<User[]>

Retrieve wallet data for a range of consecutive account indices.

signTransaction(userId, data): Promise<string>

Sign a transaction. The Ledger device displays parsed transaction details.

signOrder(userId, data): Promise<string>

Sign an exchange order.

signSomeData(userId, data): Promise<string>

Sign arbitrary data bytes (device shows raw data warning).

signRequest(userId, data): Promise<string>

Sign a request payload.

signMessage(userId, message): Promise<string>

Sign an ASCII text message.

All signing methods return a Base58-encoded signature string.

getLastError(): unknown

Return the last error from a Ledger operation, or null.

getPathById(id: number): string

Build the BIP-44 derivation path for an account index.

Supported Transports

• @ledgerhq/hw-transport-webusb — Chrome/Edge WebUSB
• @ledgerhq/hw-transport-web-ble — Web Bluetooth
• @ledgerhq/hw-transport-node-hid — Node.js USB HID
• @ledgerhq/hw-transport-http — HTTP proxy

Development

Prerequisites

• Node.js >= 24 (see .node-version)
• npm >= 10

Setup

git clone https://github.com/Decentral-America/ledger.git
cd ledger
npm install

Scripts

Command	Description
npm run build	Build distribution files
npm test	Run tests with Vitest
npm run test:watch	Tests in watch mode
npm run test:coverage	Tests with V8 coverage
npm run typecheck	TypeScript type checking
npm run lint	Biome lint
npm run lint:fix	Biome lint with auto-fix
npm run format	Format with Biome
npm run validate	Full CI validation pipeline
npm run bulletproof	Format + lint fix + typecheck + test
npm run bulletproof:check	CI-safe: check format + lint + tc + test

Quality Gates

• TypeScript strict mode with all strict flags enabled
• Biome with type-aware rules
• Biome formatting enforced
• 90% code coverage thresholds
• Bundle size budget (10 kB gzipped)
• Package export validation (publint + attw)

Related packages

Package	Description
@decentralchain/signature-adapter	Multi-provider signing adapter
@decentralchain/signer	Transaction signing orchestrator
@decentralchain/transactions	Transaction builders and signers
@decentralchain/ts-lib-crypto	Cryptographic primitives

Contributing

See CONTRIBUTING.md.

Security

To report a vulnerability, see SECURITY.md.

License

MIT — Copyright (c) DecentralChain