@ledgerhq/devices
Version:
230 lines • 8.18 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getInfosForServiceUuid = exports.getBluetoothServiceUuids = exports.identifyProductName = exports.identifyUSBProductId = exports.identifyTargetId = exports.getDeviceModel = exports.ledgerUSBVendorId = exports.DeviceModelId = exports.IIWebUSB = exports.IICCID = exports.IIU2F = exports.IIKeyboardHID = exports.IIGenericHID = void 0;
const semver_1 = __importDefault(require("semver"));
/**
* The USB product IDs will be defined as MMII, encoding a model (MM) and an interface bitfield (II)
*
** Model
* Ledger Nano S : 0x10
* Ledger Blue : 0x00
* Ledger Nano X : 0x40
*
** Interface support bitfield
* Generic HID : 0x01
* Keyboard HID : 0x02
* U2F : 0x04
* CCID : 0x08
* WebUSB : 0x10
*/
exports.IIGenericHID = 0x01;
exports.IIKeyboardHID = 0x02;
exports.IIU2F = 0x04;
exports.IICCID = 0x08;
exports.IIWebUSB = 0x10;
var DeviceModelId;
(function (DeviceModelId) {
/** Ledger Blue */
DeviceModelId["blue"] = "blue";
/** Ledger Nano S */
DeviceModelId["nanoS"] = "nanoS";
/** Ledger Nano S Plus */
DeviceModelId["nanoSP"] = "nanoSP";
/** Ledger Nano X */
DeviceModelId["nanoX"] = "nanoX";
/** Ledger Stax */
DeviceModelId["stax"] = "stax";
/** Ledger Flex ("europa" is the internal name) */
DeviceModelId["europa"] = "europa";
/** Apex */
DeviceModelId["apex"] = "apex";
})(DeviceModelId || (exports.DeviceModelId = DeviceModelId = {}));
const devices = {
[DeviceModelId.blue]: {
id: DeviceModelId.blue,
productName: "Ledger Blue",
productIdMM: 0x00,
legacyUsbProductId: 0x0000,
usbOnly: true,
memorySize: 480 * 1024,
masks: [0x31000000, 0x31010000],
getBlockSize: (_firwareVersion) => 4 * 1024,
},
[DeviceModelId.nanoS]: {
id: DeviceModelId.nanoS,
productName: "Ledger Nano S",
productIdMM: 0x10,
legacyUsbProductId: 0x0001,
usbOnly: true,
memorySize: 320 * 1024,
masks: [0x31100000],
getBlockSize: (firmwareVersion) => semver_1.default.lt(semver_1.default.coerce(firmwareVersion) ?? "", "2.0.0") ? 4 * 1024 : 2 * 1024,
},
[DeviceModelId.nanoX]: {
id: DeviceModelId.nanoX,
productName: "Ledger Nano X",
productIdMM: 0x40,
legacyUsbProductId: 0x0004,
usbOnly: false,
memorySize: 2 * 1024 * 1024,
masks: [0x33000000],
getBlockSize: (_firwareVersion) => 4 * 1024,
bluetoothSpec: [
{
serviceUuid: "13d63400-2c97-0004-0000-4c6564676572",
notifyUuid: "13d63400-2c97-0004-0001-4c6564676572",
writeUuid: "13d63400-2c97-0004-0002-4c6564676572",
writeCmdUuid: "13d63400-2c97-0004-0003-4c6564676572",
},
],
},
[DeviceModelId.nanoSP]: {
id: DeviceModelId.nanoSP,
productName: "Ledger Nano S Plus",
productIdMM: 0x50,
legacyUsbProductId: 0x0005,
usbOnly: true,
memorySize: 1533 * 1024,
masks: [0x33100000],
getBlockSize: (_firmwareVersion) => 32,
},
[DeviceModelId.apex]: {
id: DeviceModelId.apex,
productName: "Ledger Apex",
productIdMM: 0x80,
legacyUsbProductId: 0x0008,
usbOnly: false,
memorySize: 1533 * 1024,
masks: [0x33400000],
getBlockSize: (_firmwareVersion) => 32,
bluetoothSpec: [
/**
* 13D63400-2C97-6004-0001-4C6564676572, 13D63400-2C97-6004-0002-4C6564676572, and 13D63400-2C97-6004-0003-4C6564676572 Characteristics for Service 13D63400-2C97-6004-0000-4C6564676572
*/
{
serviceUuid: "13d63400-2c97-6004-0000-4c6564676572", // WILL CHANGE, for now same as Stax
notifyUuid: "13d63400-2c97-6004-0001-4c6564676572", // WILL CHANGE, for now same as Stax
writeUuid: "13d63400-2c97-6004-0002-4c6564676572", // WILL CHANGE, for now same as Stax
writeCmdUuid: "13d63400-2c97-6004-0003-4c6564676572", // WILL CHANGE, for now same as Stax
},
],
},
[DeviceModelId.stax]: {
id: DeviceModelId.stax,
productName: "Ledger Stax",
productIdMM: 0x60,
legacyUsbProductId: 0x0006,
usbOnly: false,
memorySize: 1533 * 1024,
masks: [0x33200000],
getBlockSize: (_firmwareVersion) => 32,
bluetoothSpec: [
{
serviceUuid: "13d63400-2c97-6004-0000-4c6564676572",
notifyUuid: "13d63400-2c97-6004-0001-4c6564676572",
writeUuid: "13d63400-2c97-6004-0002-4c6564676572",
writeCmdUuid: "13d63400-2c97-6004-0003-4c6564676572",
},
],
},
[DeviceModelId.europa]: {
id: DeviceModelId.europa,
productName: "Ledger Flex",
productIdMM: 0x70,
legacyUsbProductId: 0x0007,
usbOnly: false,
memorySize: 1533 * 1024,
masks: [0x33300000],
getBlockSize: (_firmwareVersion) => 32,
bluetoothSpec: [
{
serviceUuid: "13d63400-2c97-3004-0000-4c6564676572",
notifyUuid: "13d63400-2c97-3004-0001-4c6564676572",
writeUuid: "13d63400-2c97-3004-0002-4c6564676572",
writeCmdUuid: "13d63400-2c97-3004-0003-4c6564676572",
},
],
},
};
const productMap = {
Blue: DeviceModelId.blue,
"Nano S": DeviceModelId.nanoS,
"Nano S Plus": DeviceModelId.nanoSP,
"Nano X": DeviceModelId.nanoX,
Stax: DeviceModelId.stax,
Europa: DeviceModelId.europa,
};
const devicesList = Object.values(devices);
/**
*
*/
exports.ledgerUSBVendorId = 0x2c97;
/**
*
*/
const getDeviceModel = (id) => {
const info = devices[id];
if (!info)
throw new Error("device '" + id + "' does not exist");
return info;
};
exports.getDeviceModel = getDeviceModel;
/**
* Given a `targetId`, return the deviceModel associated to it,
* based on the first two bytes.
*/
const identifyTargetId = (targetId) => {
const deviceModel = devicesList.find(({ masks }) => masks.find(mask => (targetId & 0xffff0000) === mask));
return deviceModel;
};
exports.identifyTargetId = identifyTargetId;
/**
* From a given USB product id, return the deviceModel associated to it.
*
* The mapping from the product id is only based on the 2 most significant bytes.
* For example, Stax is defined with a product id of 0x60ii, a product id 0x6011 would be mapped to it.
*/
const identifyUSBProductId = (usbProductId) => {
const legacy = devicesList.find(d => d.legacyUsbProductId === usbProductId);
if (legacy)
return legacy;
const mm = usbProductId >> 8;
const deviceModel = devicesList.find(d => d.productIdMM === mm);
return deviceModel;
};
exports.identifyUSBProductId = identifyUSBProductId;
const identifyProductName = (productName) => {
const deviceModel = devicesList.find(d => d.id === productMap[productName]);
return deviceModel;
};
exports.identifyProductName = identifyProductName;
const bluetoothServices = [];
const serviceUuidToInfos = {};
for (const id in devices) {
const deviceModel = devices[id];
const { bluetoothSpec } = deviceModel;
if (bluetoothSpec) {
for (let i = 0; i < bluetoothSpec.length; i++) {
const spec = bluetoothSpec[i];
bluetoothServices.push(spec.serviceUuid);
serviceUuidToInfos[spec.serviceUuid] = serviceUuidToInfos[spec.serviceUuid.replace(/-/g, "")] = {
deviceModel,
...spec,
};
}
}
}
/**
*
*/
const getBluetoothServiceUuids = () => bluetoothServices;
exports.getBluetoothServiceUuids = getBluetoothServiceUuids;
/**
*
*/
const getInfosForServiceUuid = (uuid) => serviceUuidToInfos[uuid.toLowerCase()];
exports.getInfosForServiceUuid = getInfosForServiceUuid;
//# sourceMappingURL=index.js.map