@metamask/eth-ledger-bridge-keyring 11.1.2 → 11.2.0

package/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [11.2.0]
+
+### Added
+
+- Add `LedgerKeyringV2` class implementing `KeyringV2` interface ([#416](https://github.com/MetaMask/accounts/pull/416)), ([#451](https://github.com/MetaMask/accounts/pull/451)), ([#453](https://github.com/MetaMask/accounts/pull/453))
+  - Wraps legacy `LedgerKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
+  - Extends `EthKeyringWrapper` for common Ethereum logic.
+
+### Fixed
+
+- Normalize signature `v` value from Ledger devices for proper recovery ([#449](https://github.com/MetaMask/accounts/pull/449))
+
 ## [11.1.2]
 
 ### Changed
@@ -342,7 +354,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support new versions of ethereumjs/tx ([#68](https://github.com/MetaMask/eth-ledger-bridge-keyring/pull/68))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.1.2...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.2.0...HEAD
+[11.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.1.2...@metamask/eth-ledger-bridge-keyring@11.2.0
 [11.1.2]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.1.1...@metamask/eth-ledger-bridge-keyring@11.1.2
 [11.1.1]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.1.0...@metamask/eth-ledger-bridge-keyring@11.1.1
 [11.1.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-ledger-bridge-keyring@11.0.3...@metamask/eth-ledger-bridge-keyring@11.1.0

package/dist/index.cjs

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ledger-keyring.cjs"), exports);
+__exportStar(require("./ledger-keyring-v2.cjs"), exports);
 __exportStar(require("./ledger-iframe-bridge.cjs"), exports);
 __exportStar(require("./ledger-mobile-bridge.cjs"), exports);
 __exportStar(require("./ledger-transport-middleware.cjs"), exports);

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAiC;AACjC,6DAAuC;AACvC,6DAAuC;AAEvC,oEAA8C;AAE9C,sDAAgC","sourcesContent":["export * from './ledger-keyring';\nexport * from './ledger-iframe-bridge';\nexport * from './ledger-mobile-bridge';\nexport type * from './ledger-bridge';\nexport * from './ledger-transport-middleware';\nexport type * from './type';\nexport * from './ledger-hw-app';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAiC;AACjC,0DAAoC;AACpC,6DAAuC;AACvC,6DAAuC;AAEvC,oEAA8C;AAE9C,sDAAgC","sourcesContent":["export * from './ledger-keyring';\nexport * from './ledger-keyring-v2';\nexport * from './ledger-iframe-bridge';\nexport * from './ledger-mobile-bridge';\nexport type * from './ledger-bridge';\nexport * from './ledger-transport-middleware';\nexport type * from './type';\nexport * from './ledger-hw-app';\n"]}

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 export * from "./ledger-keyring.cjs";
+export * from "./ledger-keyring-v2.cjs";
 export * from "./ledger-iframe-bridge.cjs";
 export * from "./ledger-mobile-bridge.cjs";
 export type * from "./ledger-bridge.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,2CAAuC;AACvC,2CAAuC;AACvC,yCAAqC;AACrC,kDAA8C;AAC9C,gCAA4B;AAC5B,oCAAgC"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,wCAAoC;AACpC,2CAAuC;AACvC,2CAAuC;AACvC,yCAAqC;AACrC,kDAA8C;AAC9C,gCAA4B;AAC5B,oCAAgC"}

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 export * from "./ledger-keyring.mjs";
+export * from "./ledger-keyring-v2.mjs";
 export * from "./ledger-iframe-bridge.mjs";
 export * from "./ledger-mobile-bridge.mjs";
 export type * from "./ledger-bridge.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,2CAAuC;AACvC,2CAAuC;AACvC,yCAAqC;AACrC,kDAA8C;AAC9C,gCAA4B;AAC5B,oCAAgC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,wCAAoC;AACpC,2CAAuC;AACvC,2CAAuC;AACvC,yCAAqC;AACrC,kDAA8C;AAC9C,gCAA4B;AAC5B,oCAAgC"}

package/dist/index.mjs

@@ -1,4 +1,5 @@
 export * from "./ledger-keyring.mjs";
+export * from "./ledger-keyring-v2.mjs";
 export * from "./ledger-iframe-bridge.mjs";
 export * from "./ledger-mobile-bridge.mjs";
 export * from "./ledger-transport-middleware.mjs";

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,2CAAuC;AACvC,2CAAuC;AAEvC,kDAA8C;AAE9C,oCAAgC","sourcesContent":["export * from './ledger-keyring';\nexport * from './ledger-iframe-bridge';\nexport * from './ledger-mobile-bridge';\nexport type * from './ledger-bridge';\nexport * from './ledger-transport-middleware';\nexport type * from './type';\nexport * from './ledger-hw-app';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAiC;AACjC,wCAAoC;AACpC,2CAAuC;AACvC,2CAAuC;AAEvC,kDAA8C;AAE9C,oCAAgC","sourcesContent":["export * from './ledger-keyring';\nexport * from './ledger-keyring-v2';\nexport * from './ledger-iframe-bridge';\nexport * from './ledger-mobile-bridge';\nexport type * from './ledger-bridge';\nexport * from './ledger-transport-middleware';\nexport type * from './type';\nexport * from './ledger-hw-app';\n"]}

package/dist/ledger-keyring-v2.cjs

@@ -0,0 +1,227 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LedgerKeyringV2_instances, _LedgerKeyringV2_getChecksumHexAddress, _LedgerKeyringV2_parseDerivationPath, _LedgerKeyringV2_getIndexForAddress, _LedgerKeyringV2_createKeyringAccount;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerKeyringV2 = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const utils_1 = require("@metamask/utils");
+/**
+ * Methods supported by Ledger keyring EOA accounts.
+ * Ledger keyrings support a subset of signing methods (no encryption, app keys, or EIP-7702).
+ */
+const LEDGER_KEYRING_METHODS = [
+    keyring_api_1.EthMethod.SignTransaction,
+    keyring_api_1.EthMethod.PersonalSign,
+    keyring_api_1.EthMethod.SignTypedDataV4,
+];
+const ledgerKeyringV2Capabilities = {
+    scopes: [keyring_api_1.EthScope.Eoa],
+    bip44: {
+        deriveIndex: true,
+        derivePath: true,
+    },
+};
+/**
+ * Ledger Live HD path constant.
+ */
+const LEDGER_LIVE_HD_PATH = `m/44'/60'/0'/0/0`;
+/**
+ * BIP-44 standard HD path prefix constant for Ethereum.
+ */
+const BIP44_HD_PATH_PREFIX = `m/44'/60'/0'/0`;
+/**
+ * Regex pattern for validating and parsing Ledger Live derivation paths.
+ * Format: m/44'/60'/{index}'/0/0
+ */
+const LEDGER_LIVE_PATH_PATTERN = /^m\/44'\/60'\/(\d+)'\/0\/0$/u;
+/**
+ * Regex pattern for validating and parsing non-Ledger-Live derivation paths.
+ * Supports Legacy (m/44'/60'/0'/{index}), BIP44 (m/44'/60'/0'/0/{index}),
+ * and custom paths that follow the m/44'/60'/... pattern.
+ */
+const INDEX_AT_END_PATH_PATTERN = /^(m\/44'\/60'(?:\/\d+'?)*)\/(\d+)$/u;
+class LedgerKeyringV2 extends keyring_api_1.EthKeyringWrapper {
+    constructor(options) {
+        super({
+            type: keyring_api_1.KeyringType.Ledger,
+            inner: options.legacyKeyring,
+            capabilities: ledgerKeyringV2Capabilities,
+        });
+        _LedgerKeyringV2_instances.add(this);
+        this.entropySource = options.entropySource;
+    }
+    async getAccounts() {
+        const addresses = await this.inner.getAccounts();
+        if (addresses.length === 0) {
+            return [];
+        }
+        return addresses.map((address) => {
+            // Check if we already have this account in the registry
+            const existingId = this.registry.getAccountId(address);
+            if (existingId) {
+                const cached = this.registry.get(existingId);
+                if (cached) {
+                    return cached;
+                }
+            }
+            const addressIndex = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getIndexForAddress).call(this, address);
+            return __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_createKeyringAccount).call(this, address, addressIndex);
+        });
+    }
+    async createAccounts(options) {
+        return this.withLock(async () => {
+            if (options.type === 'bip44:derive-path' ||
+                options.type === 'bip44:derive-index') {
+                // Validate that the entropy source matches this keyring's entropy source
+                if (options.entropySource !== this.entropySource) {
+                    throw new Error(`Entropy source mismatch: expected '${this.entropySource}', got '${options.entropySource}'`);
+                }
+            }
+            else {
+                throw new Error(`Unsupported account creation type for LedgerKeyring: ${String(options.type)}`);
+            }
+            // Check if an account at this index already exists with the same derivation path
+            const currentAccounts = await this.getAccounts();
+            let targetIndex;
+            let basePath;
+            let derivationPath;
+            if (options.type === 'bip44:derive-path') {
+                // Parse the derivation path to extract base path and index
+                const parsed = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_parseDerivationPath).call(this, options.derivationPath);
+                targetIndex = parsed.index;
+                basePath = parsed.basePath;
+                derivationPath = options.derivationPath;
+            }
+            else {
+                // derive-index uses BIP-44 standard path by default
+                targetIndex = options.groupIndex;
+                basePath = BIP44_HD_PATH_PREFIX;
+                derivationPath = `${basePath}/${targetIndex}`;
+            }
+            const existingAccount = currentAccounts.find((account) => {
+                return (account.options.entropy.groupIndex === targetIndex &&
+                    account.options.entropy.derivationPath === derivationPath);
+            });
+            if (existingAccount) {
+                return [existingAccount];
+            }
+            // Derive the account at the specified index
+            this.inner.setHdPath(basePath);
+            this.inner.setAccountToUnlock(targetIndex);
+            const [newAddress] = await this.inner.addAccounts(1);
+            if (!newAddress) {
+                throw new Error('Failed to create new account');
+            }
+            const newAccount = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_createKeyringAccount).call(this, newAddress, targetIndex);
+            return [newAccount];
+        });
+    }
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    async deleteAccount(accountId) {
+        await this.withLock(async () => {
+            const { address } = await this.getAccount(accountId);
+            const hexAddress = this.toHexAddress(address);
+            // Remove from the legacy keyring
+            this.inner.removeAccount(hexAddress);
+            // Remove from the registry
+            this.registry.delete(accountId);
+        });
+    }
+}
+exports.LedgerKeyringV2 = LedgerKeyringV2;
+_LedgerKeyringV2_instances = new WeakSet(), _LedgerKeyringV2_getChecksumHexAddress = function _LedgerKeyringV2_getChecksumHexAddress(address) {
+    return (0, utils_1.getChecksumAddress)((0, utils_1.add0x)(address));
+}, _LedgerKeyringV2_parseDerivationPath = function _LedgerKeyringV2_parseDerivationPath(derivationPath) {
+    // Try Ledger Live format first: m/44'/60'/{index}'/0/0
+    const ledgerLiveMatch = derivationPath.match(LEDGER_LIVE_PATH_PATTERN);
+    if (ledgerLiveMatch?.[1]) {
+        return {
+            // This constant is used by `inner.setHdPath` to determine which derivation
+            // mode we should use (Ledger Live derivation mode here).
+            basePath: LEDGER_LIVE_HD_PATH,
+            index: parseInt(ledgerLiveMatch[1], 10),
+        };
+    }
+    // Try index-at-end format: m/44'/60'/.../{index}
+    const indexAtEndMatch = derivationPath.match(INDEX_AT_END_PATH_PATTERN);
+    if (indexAtEndMatch) {
+        // If the condition is true, indexAtEndMatch[1] and indexAtEndMatch[2] are defined, so
+        // we can safely cast them to string.
+        // This is necessary to get 100% code coverage.
+        return {
+            // Here, we use a derivation path prefix for `inner.setHdPath`
+            // (prefix + index derivation mode).
+            basePath: indexAtEndMatch[1],
+            index: parseInt(indexAtEndMatch[2], 10),
+        };
+    }
+    throw new Error(`Invalid derivation path format: ${derivationPath}. ` +
+        `Expected Ledger Live (m/44'/60'/{index}'/0/0) or index-at-end (m/44'/60'/.../{index}) format.`);
+}, _LedgerKeyringV2_getIndexForAddress = function _LedgerKeyringV2_getIndexForAddress(address) {
+    const checksummedAddress = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getChecksumHexAddress).call(this, address);
+    const details = this.inner.accountDetails[checksummedAddress];
+    if (!details) {
+        throw new Error(`Address ${checksummedAddress} not found in account details`);
+    }
+    // Extract index from hdPath
+    const { hdPath } = details;
+    if (!hdPath) {
+        throw new Error(`No HD path found for address ${checksummedAddress}`);
+    }
+    // Ledger supports multiple derivation path formats:
+    // - Ledger Live (bip44: true): m/44'/60'/{index}'/0/0 - index at position 3
+    // - Other paths (bip44: false): {hdPath}/{index} - index at end
+    //   - BIP44: m/44'/60'/0'/0/{index}
+    //   - Legacy: m/44'/60'/0'/{index}
+    //   - Custom paths via setHdPath
+    //
+    // We use the `bip44` flag to determine which extraction pattern to use.
+    if (details.bip44) {
+        // Ledger Live format: m/44'/60'/{index}'/0/0
+        const match = hdPath.match(LEDGER_LIVE_PATH_PATTERN);
+        if (match?.[1]) {
+            return parseInt(match[1], 10);
+        }
+    }
+    else {
+        // Index-at-end format: m/44'/60'/.../{index}
+        const match = hdPath.match(INDEX_AT_END_PATH_PATTERN);
+        if (match?.[2]) {
+            return parseInt(match[2], 10);
+        }
+    }
+    throw new Error(`Could not extract index from HD path: ${hdPath}`);
+}, _LedgerKeyringV2_createKeyringAccount = function _LedgerKeyringV2_createKeyringAccount(address, addressIndex) {
+    const id = this.registry.register(address);
+    const checksummedAddress = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getChecksumHexAddress).call(this, address);
+    const details = this.inner.accountDetails[checksummedAddress];
+    if (!details?.hdPath) {
+        throw new Error(`No HD path found for address ${checksummedAddress}. Cannot create account.`);
+    }
+    const account = {
+        id,
+        type: keyring_api_1.EthAccountType.Eoa,
+        address,
+        scopes: [...this.capabilities.scopes],
+        methods: [...LEDGER_KEYRING_METHODS],
+        options: {
+            entropy: {
+                type: keyring_api_1.KeyringAccountEntropyTypeOption.Mnemonic,
+                id: this.entropySource,
+                groupIndex: addressIndex,
+                derivationPath: details.hdPath,
+            },
+        },
+    };
+    this.registry.set(account);
+    return account;
+};
+//# sourceMappingURL=ledger-keyring-v2.cjs.map

package/dist/ledger-keyring-v2.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-keyring-v2.cjs","sourceRoot":"","sources":["../src/ledger-keyring-v2.ts"],"names":[],"mappings":";;;;;;;;;AACA,uDAY+B;AAE/B,2CAAsE;AAItE;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,uBAAS,CAAC,eAAe;IACzB,uBAAS,CAAC,YAAY;IACtB,uBAAS,CAAC,eAAe;CAC1B,CAAC;AAEF,MAAM,2BAA2B,GAAwB;IACvD,MAAM,EAAE,CAAC,sBAAQ,CAAC,GAAG,CAAC;IACtB,KAAK,EAAE;QACL,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAE9C;;;GAGG;AACH,MAAM,wBAAwB,GAAG,8BAA8B,CAAC;AAEhE;;;;GAIG;AACH,MAAM,yBAAyB,GAAG,qCAAqC,CAAC;AAoBxE,MAAa,eACX,SAAQ,+BAGP;IAKD,YAAY,OAA+B;QACzC,KAAK,CAAC;YACJ,IAAI,EAAE,yBAAW,CAAC,MAAM;YACxB,KAAK,EAAE,OAAO,CAAC,aAA0C;YACzD,YAAY,EAAE,2BAA2B;SAC1C,CAAC,CAAC;;QACH,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAC7C,CAAC;IAoJD,KAAK,CAAC,WAAW;QACf,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEjD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,wDAAwD;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC7C,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YAED,MAAM,YAAY,GAAG,uBAAA,IAAI,uEAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC,CAAC;YACvD,OAAO,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,OAAO,EAAE,YAAY,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC9B,IACE,OAAO,CAAC,IAAI,KAAK,mBAAmB;gBACpC,OAAO,CAAC,IAAI,KAAK,oBAAoB,EACrC,CAAC;gBACD,yEAAyE;gBACzE,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;oBACjD,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,CAAC,aAAa,WAAW,OAAO,CAAC,aAAa,GAAG,CAC5F,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,wDAAwD,MAAM,CAC5D,OAAO,CAAC,IAAI,CACb,EAAE,CACJ,CAAC;YACJ,CAAC;YAED,iFAAiF;YACjF,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEjD,IAAI,WAAmB,CAAC;YACxB,IAAI,QAAgB,CAAC;YACrB,IAAI,cAAsB,CAAC;YAE3B,IAAI,OAAO,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;gBACzC,2DAA2D;gBAC3D,MAAM,MAAM,GAAG,uBAAA,IAAI,wEAAqB,MAAzB,IAAI,EAAsB,OAAO,CAAC,cAAc,CAAC,CAAC;gBACjE,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC;gBAC3B,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;gBAE3B,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,oDAAoD;gBACpD,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;gBACjC,QAAQ,GAAG,oBAAoB,CAAC;gBAChC,cAAc,GAAG,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;YAChD,CAAC;YAED,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvD,OAAO,CACL,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,KAAK,WAAW;oBAClD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,KAAK,cAAc,CAC1D,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,IAAI,eAAe,EAAE,CAAC;gBACpB,OAAO,CAAC,eAAe,CAAC,CAAC;YAC3B,CAAC;YAED,4CAA4C;YAC5C,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC/B,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC3C,MAAM,CAAC,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAErD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,UAAU,GAAG,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,UAAU,EAAE,WAAW,CAAC,CAAC;YAEvE,OAAO,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,SAAoB;QACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAE9C,iCAAiC;YACjC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAErC,2BAA2B;YAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhRD,0CAgRC;qIAxPwB,OAAe;IACpC,OAAO,IAAA,0BAAkB,EAAC,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC,CAAC;AAC5C,CAAC,uFAaoB,cAAsB;IAIzC,uDAAuD;IACvD,MAAM,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACvE,IAAI,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzB,OAAO;YACL,2EAA2E;YAC3E,yDAAyD;YACzD,QAAQ,EAAE,mBAAmB;YAC7B,KAAK,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;SACxC,CAAC;IACJ,CAAC;IAED,iDAAiD;IACjD,MAAM,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACxE,IAAI,eAAe,EAAE,CAAC;QACpB,sFAAsF;QACtF,qCAAqC;QACrC,+CAA+C;QAC/C,OAAO;YACL,8DAA8D;YAC9D,oCAAoC;YACpC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAW;YACtC,KAAK,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC;SAClD,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,KAAK,CACb,mCAAmC,cAAc,IAAI;QACnD,+FAA+F,CAClG,CAAC;AACJ,CAAC,qFASmB,OAAY;IAC9B,MAAM,kBAAkB,GAAG,uBAAA,IAAI,0EAAuB,MAA3B,IAAI,EAAwB,OAAO,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAE9D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,WAAW,kBAAkB,+BAA+B,CAC7D,CAAC;IACJ,CAAC;IAED,4BAA4B;IAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,gCAAgC,kBAAkB,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IACpD,4EAA4E;IAC5E,gEAAgE;IAChE,oCAAoC;IACpC,mCAAmC;IACnC,iCAAiC;IACjC,EAAE;IACF,wEAAwE;IACxE,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,6CAA6C;QAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACrD,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,6CAA6C;QAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACtD,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC,yFAUC,OAAY,EACZ,YAAoB;IAEpB,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE3C,MAAM,kBAAkB,GAAG,uBAAA,IAAI,0EAAuB,MAA3B,IAAI,EAAwB,OAAO,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAE9D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,gCAAgC,kBAAkB,0BAA0B,CAC7E,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAiC;QAC5C,EAAE;QACF,IAAI,EAAE,4BAAc,CAAC,GAAG;QACxB,OAAO;QACP,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE,CAAC,GAAG,sBAAsB,CAAC;QACpC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,IAAI,EAAE,6CAA+B,CAAC,QAAQ;gBAC9C,EAAE,EAAE,IAAI,CAAC,aAAa;gBACtB,UAAU,EAAE,YAAY;gBACxB,cAAc,EAAE,OAAO,CAAC,MAAM;aAC/B;SACF;KACF,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import type { Bip44Account } from '@metamask/account-api';\nimport {\n  type CreateAccountOptions,\n  EthAccountType,\n  EthKeyringWrapper,\n  EthMethod,\n  EthScope,\n  type KeyringAccount,\n  KeyringAccountEntropyTypeOption,\n  type KeyringCapabilities,\n  type KeyringV2,\n  KeyringType,\n  type EntropySourceId,\n} from '@metamask/keyring-api';\nimport type { AccountId, EthKeyring } from '@metamask/keyring-utils';\nimport { add0x, getChecksumAddress, type Hex } from '@metamask/utils';\n\nimport type { LedgerKeyring } from './ledger-keyring';\n\n/**\n * Methods supported by Ledger keyring EOA accounts.\n * Ledger keyrings support a subset of signing methods (no encryption, app keys, or EIP-7702).\n */\nconst LEDGER_KEYRING_METHODS = [\n  EthMethod.SignTransaction,\n  EthMethod.PersonalSign,\n  EthMethod.SignTypedDataV4,\n];\n\nconst ledgerKeyringV2Capabilities: KeyringCapabilities = {\n  scopes: [EthScope.Eoa],\n  bip44: {\n    deriveIndex: true,\n    derivePath: true,\n  },\n};\n\n/**\n * Ledger Live HD path constant.\n */\nconst LEDGER_LIVE_HD_PATH = `m/44'/60'/0'/0/0`;\n\n/**\n * BIP-44 standard HD path prefix constant for Ethereum.\n */\nconst BIP44_HD_PATH_PREFIX = `m/44'/60'/0'/0`;\n\n/**\n * Regex pattern for validating and parsing Ledger Live derivation paths.\n * Format: m/44'/60'/{index}'/0/0\n */\nconst LEDGER_LIVE_PATH_PATTERN = /^m\\/44'\\/60'\\/(\\d+)'\\/0\\/0$/u;\n\n/**\n * Regex pattern for validating and parsing non-Ledger-Live derivation paths.\n * Supports Legacy (m/44'/60'/0'/{index}), BIP44 (m/44'/60'/0'/0/{index}),\n * and custom paths that follow the m/44'/60'/... pattern.\n */\nconst INDEX_AT_END_PATH_PATTERN = /^(m\\/44'\\/60'(?:\\/\\d+'?)*)\\/(\\d+)$/u;\n\n/**\n * Concrete {@link KeyringV2} adapter for {@link LedgerKeyring}.\n *\n * This wrapper exposes the accounts and signing capabilities of the legacy\n * Ledger keyring via the unified V2 interface.\n *\n * All Ledger keyring accounts are BIP-44 derived from the device.\n */\nexport type LedgerKeyringV2Options = {\n  legacyKeyring: LedgerKeyring;\n  entropySource: EntropySourceId;\n};\n\n// LedgerKeyring.signTransaction returns `TypedTransaction | OldEthJsTransaction` for\n// backwards compatibility with old ethereumjs-tx, but EthKeyring expects `TypedTxData`.\n// The runtime behavior is correct - we cast the type to satisfy the constraint.\ntype LedgerKeyringAsEthKeyring = LedgerKeyring & EthKeyring;\n\nexport class LedgerKeyringV2\n  extends EthKeyringWrapper<\n    LedgerKeyringAsEthKeyring,\n    Bip44Account<KeyringAccount>\n  >\n  implements KeyringV2\n{\n  readonly entropySource: EntropySourceId;\n\n  constructor(options: LedgerKeyringV2Options) {\n    super({\n      type: KeyringType.Ledger,\n      inner: options.legacyKeyring as LedgerKeyringAsEthKeyring,\n      capabilities: ledgerKeyringV2Capabilities,\n    });\n    this.entropySource = options.entropySource;\n  }\n\n  /**\n   * Normalizes an address to a checksummed hex address.\n   *\n   * @param address - The address to normalize.\n   * @returns The checksummed hex address.\n   */\n  #getChecksumHexAddress(address: string): Hex {\n    return getChecksumAddress(add0x(address));\n  }\n\n  /**\n   * Parses a derivation path to extract the base HD path and account index.\n   *\n   * Supports two path formats:\n   * - Ledger Live: m/44'/60'/{index}'/0/0 → base: m/44'/60'/0'/0/0, index from position 3\n   * - Index at end: m/44'/60'/.../{index} → base: m/44'/60'/..., index from last segment\n   *\n   * @param derivationPath - The full derivation path.\n   * @returns The base HD path and account index.\n   * @throws If the path format is invalid.\n   */\n  #parseDerivationPath(derivationPath: string): {\n    basePath: string;\n    index: number;\n  } {\n    // Try Ledger Live format first: m/44'/60'/{index}'/0/0\n    const ledgerLiveMatch = derivationPath.match(LEDGER_LIVE_PATH_PATTERN);\n    if (ledgerLiveMatch?.[1]) {\n      return {\n        // This constant is used by `inner.setHdPath` to determine which derivation\n        // mode we should use (Ledger Live derivation mode here).\n        basePath: LEDGER_LIVE_HD_PATH,\n        index: parseInt(ledgerLiveMatch[1], 10),\n      };\n    }\n\n    // Try index-at-end format: m/44'/60'/.../{index}\n    const indexAtEndMatch = derivationPath.match(INDEX_AT_END_PATH_PATTERN);\n    if (indexAtEndMatch) {\n      // If the condition is true, indexAtEndMatch[1] and indexAtEndMatch[2] are defined, so\n      // we can safely cast them to string.\n      // This is necessary to get 100% code coverage.\n      return {\n        // Here, we use a derivation path prefix for `inner.setHdPath`\n        // (prefix + index derivation mode).\n        basePath: indexAtEndMatch[1] as string,\n        index: parseInt(indexAtEndMatch[2] as string, 10),\n      };\n    }\n\n    throw new Error(\n      `Invalid derivation path format: ${derivationPath}. ` +\n        `Expected Ledger Live (m/44'/60'/{index}'/0/0) or index-at-end (m/44'/60'/.../{index}) format.`,\n    );\n  }\n\n  /**\n   * Gets the index for an address from the account details.\n   *\n   * @param address - The address to get the index for.\n   * @returns The index for the address.\n   * @throws If the address is not found in account details.\n   */\n  #getIndexForAddress(address: Hex): number {\n    const checksummedAddress = this.#getChecksumHexAddress(address);\n    const details = this.inner.accountDetails[checksummedAddress];\n\n    if (!details) {\n      throw new Error(\n        `Address ${checksummedAddress} not found in account details`,\n      );\n    }\n\n    // Extract index from hdPath\n    const { hdPath } = details;\n    if (!hdPath) {\n      throw new Error(`No HD path found for address ${checksummedAddress}`);\n    }\n\n    // Ledger supports multiple derivation path formats:\n    // - Ledger Live (bip44: true): m/44'/60'/{index}'/0/0 - index at position 3\n    // - Other paths (bip44: false): {hdPath}/{index} - index at end\n    //   - BIP44: m/44'/60'/0'/0/{index}\n    //   - Legacy: m/44'/60'/0'/{index}\n    //   - Custom paths via setHdPath\n    //\n    // We use the `bip44` flag to determine which extraction pattern to use.\n    if (details.bip44) {\n      // Ledger Live format: m/44'/60'/{index}'/0/0\n      const match = hdPath.match(LEDGER_LIVE_PATH_PATTERN);\n      if (match?.[1]) {\n        return parseInt(match[1], 10);\n      }\n    } else {\n      // Index-at-end format: m/44'/60'/.../{index}\n      const match = hdPath.match(INDEX_AT_END_PATH_PATTERN);\n      if (match?.[2]) {\n        return parseInt(match[2], 10);\n      }\n    }\n\n    throw new Error(`Could not extract index from HD path: ${hdPath}`);\n  }\n\n  /**\n   * Creates a Bip44Account object for the given address.\n   *\n   * @param address - The account address.\n   * @param addressIndex - The account index in the derivation path.\n   * @returns The created Bip44Account.\n   */\n  #createKeyringAccount(\n    address: Hex,\n    addressIndex: number,\n  ): Bip44Account<KeyringAccount> {\n    const id = this.registry.register(address);\n\n    const checksummedAddress = this.#getChecksumHexAddress(address);\n    const details = this.inner.accountDetails[checksummedAddress];\n\n    if (!details?.hdPath) {\n      throw new Error(\n        `No HD path found for address ${checksummedAddress}. Cannot create account.`,\n      );\n    }\n\n    const account: Bip44Account<KeyringAccount> = {\n      id,\n      type: EthAccountType.Eoa,\n      address,\n      scopes: [...this.capabilities.scopes],\n      methods: [...LEDGER_KEYRING_METHODS],\n      options: {\n        entropy: {\n          type: KeyringAccountEntropyTypeOption.Mnemonic,\n          id: this.entropySource,\n          groupIndex: addressIndex,\n          derivationPath: details.hdPath,\n        },\n      },\n    };\n\n    this.registry.set(account);\n    return account;\n  }\n\n  async getAccounts(): Promise<Bip44Account<KeyringAccount>[]> {\n    const addresses = await this.inner.getAccounts();\n\n    if (addresses.length === 0) {\n      return [];\n    }\n\n    return addresses.map((address) => {\n      // Check if we already have this account in the registry\n      const existingId = this.registry.getAccountId(address);\n      if (existingId) {\n        const cached = this.registry.get(existingId);\n        if (cached) {\n          return cached;\n        }\n      }\n\n      const addressIndex = this.#getIndexForAddress(address);\n      return this.#createKeyringAccount(address, addressIndex);\n    });\n  }\n\n  async createAccounts(\n    options: CreateAccountOptions,\n  ): Promise<Bip44Account<KeyringAccount>[]> {\n    return this.withLock(async () => {\n      if (\n        options.type === 'bip44:derive-path' ||\n        options.type === 'bip44:derive-index'\n      ) {\n        // Validate that the entropy source matches this keyring's entropy source\n        if (options.entropySource !== this.entropySource) {\n          throw new Error(\n            `Entropy source mismatch: expected '${this.entropySource}', got '${options.entropySource}'`,\n          );\n        }\n      } else {\n        throw new Error(\n          `Unsupported account creation type for LedgerKeyring: ${String(\n            options.type,\n          )}`,\n        );\n      }\n\n      // Check if an account at this index already exists with the same derivation path\n      const currentAccounts = await this.getAccounts();\n\n      let targetIndex: number;\n      let basePath: string;\n      let derivationPath: string;\n\n      if (options.type === 'bip44:derive-path') {\n        // Parse the derivation path to extract base path and index\n        const parsed = this.#parseDerivationPath(options.derivationPath);\n        targetIndex = parsed.index;\n        basePath = parsed.basePath;\n\n        derivationPath = options.derivationPath;\n      } else {\n        // derive-index uses BIP-44 standard path by default\n        targetIndex = options.groupIndex;\n        basePath = BIP44_HD_PATH_PREFIX;\n        derivationPath = `${basePath}/${targetIndex}`;\n      }\n\n      const existingAccount = currentAccounts.find((account) => {\n        return (\n          account.options.entropy.groupIndex === targetIndex &&\n          account.options.entropy.derivationPath === derivationPath\n        );\n      });\n\n      if (existingAccount) {\n        return [existingAccount];\n      }\n\n      // Derive the account at the specified index\n      this.inner.setHdPath(basePath);\n      this.inner.setAccountToUnlock(targetIndex);\n      const [newAddress] = await this.inner.addAccounts(1);\n\n      if (!newAddress) {\n        throw new Error('Failed to create new account');\n      }\n\n      const newAccount = this.#createKeyringAccount(newAddress, targetIndex);\n\n      return [newAccount];\n    });\n  }\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * @param accountId - The account ID to delete.\n   */\n  async deleteAccount(accountId: AccountId): Promise<void> {\n    await this.withLock(async () => {\n      const { address } = await this.getAccount(accountId);\n      const hexAddress = this.toHexAddress(address);\n\n      // Remove from the legacy keyring\n      this.inner.removeAccount(hexAddress);\n\n      // Remove from the registry\n      this.registry.delete(accountId);\n    });\n  }\n}\n"]}

package/dist/ledger-keyring-v2.d.cts

@@ -0,0 +1,32 @@
+import type { Bip44Account } from "@metamask/account-api";
+import { type CreateAccountOptions, EthKeyringWrapper, type KeyringAccount, type KeyringV2, type EntropySourceId } from "@metamask/keyring-api";
+import type { AccountId, EthKeyring } from "@metamask/keyring-utils";
+import type { LedgerKeyring } from "./ledger-keyring.cjs";
+/**
+ * Concrete {@link KeyringV2} adapter for {@link LedgerKeyring}.
+ *
+ * This wrapper exposes the accounts and signing capabilities of the legacy
+ * Ledger keyring via the unified V2 interface.
+ *
+ * All Ledger keyring accounts are BIP-44 derived from the device.
+ */
+export type LedgerKeyringV2Options = {
+    legacyKeyring: LedgerKeyring;
+    entropySource: EntropySourceId;
+};
+type LedgerKeyringAsEthKeyring = LedgerKeyring & EthKeyring;
+export declare class LedgerKeyringV2 extends EthKeyringWrapper<LedgerKeyringAsEthKeyring, Bip44Account<KeyringAccount>> implements KeyringV2 {
+    #private;
+    readonly entropySource: EntropySourceId;
+    constructor(options: LedgerKeyringV2Options);
+    getAccounts(): Promise<Bip44Account<KeyringAccount>[]>;
+    createAccounts(options: CreateAccountOptions): Promise<Bip44Account<KeyringAccount>[]>;
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ledger-keyring-v2.d.cts.map

package/dist/ledger-keyring-v2.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-keyring-v2.d.cts","sourceRoot":"","sources":["../src/ledger-keyring-v2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAC1D,OAAO,EACL,KAAK,oBAAoB,EAEzB,iBAAiB,EAGjB,KAAK,cAAc,EAGnB,KAAK,SAAS,EAEd,KAAK,eAAe,EACrB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,gCAAgC;AAGrE,OAAO,KAAK,EAAE,aAAa,EAAE,6BAAyB;AA2CtD;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,aAAa,CAAC;IAC7B,aAAa,EAAE,eAAe,CAAC;CAChC,CAAC;AAKF,KAAK,yBAAyB,GAAG,aAAa,GAAG,UAAU,CAAC;AAE5D,qBAAa,eACX,SAAQ,iBAAiB,CACvB,yBAAyB,EACzB,YAAY,CAAC,cAAc,CAAC,CAE9B,YAAW,SAAS;;IAEpB,QAAQ,CAAC,aAAa,EAAE,eAAe,CAAC;gBAE5B,OAAO,EAAE,sBAAsB;IA2JrC,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;IAsBtD,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;IAmE1C;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAYzD"}

package/dist/ledger-keyring-v2.d.mts

@@ -0,0 +1,32 @@
+import type { Bip44Account } from "@metamask/account-api";
+import { type CreateAccountOptions, EthKeyringWrapper, type KeyringAccount, type KeyringV2, type EntropySourceId } from "@metamask/keyring-api";
+import type { AccountId, EthKeyring } from "@metamask/keyring-utils";
+import type { LedgerKeyring } from "./ledger-keyring.mjs";
+/**
+ * Concrete {@link KeyringV2} adapter for {@link LedgerKeyring}.
+ *
+ * This wrapper exposes the accounts and signing capabilities of the legacy
+ * Ledger keyring via the unified V2 interface.
+ *
+ * All Ledger keyring accounts are BIP-44 derived from the device.
+ */
+export type LedgerKeyringV2Options = {
+    legacyKeyring: LedgerKeyring;
+    entropySource: EntropySourceId;
+};
+type LedgerKeyringAsEthKeyring = LedgerKeyring & EthKeyring;
+export declare class LedgerKeyringV2 extends EthKeyringWrapper<LedgerKeyringAsEthKeyring, Bip44Account<KeyringAccount>> implements KeyringV2 {
+    #private;
+    readonly entropySource: EntropySourceId;
+    constructor(options: LedgerKeyringV2Options);
+    getAccounts(): Promise<Bip44Account<KeyringAccount>[]>;
+    createAccounts(options: CreateAccountOptions): Promise<Bip44Account<KeyringAccount>[]>;
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ledger-keyring-v2.d.mts.map

package/dist/ledger-keyring-v2.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledger-keyring-v2.d.mts","sourceRoot":"","sources":["../src/ledger-keyring-v2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAC1D,OAAO,EACL,KAAK,oBAAoB,EAEzB,iBAAiB,EAGjB,KAAK,cAAc,EAGnB,KAAK,SAAS,EAEd,KAAK,eAAe,EACrB,8BAA8B;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,gCAAgC;AAGrE,OAAO,KAAK,EAAE,aAAa,EAAE,6BAAyB;AA2CtD;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,aAAa,CAAC;IAC7B,aAAa,EAAE,eAAe,CAAC;CAChC,CAAC;AAKF,KAAK,yBAAyB,GAAG,aAAa,GAAG,UAAU,CAAC;AAE5D,qBAAa,eACX,SAAQ,iBAAiB,CACvB,yBAAyB,EACzB,YAAY,CAAC,cAAc,CAAC,CAE9B,YAAW,SAAS;;IAEpB,QAAQ,CAAC,aAAa,EAAE,eAAe,CAAC;gBAE5B,OAAO,EAAE,sBAAsB;IA2JrC,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;IAsBtD,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;IAmE1C;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAYzD"}

package/dist/ledger-keyring-v2.mjs

@@ -0,0 +1,223 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LedgerKeyringV2_instances, _LedgerKeyringV2_getChecksumHexAddress, _LedgerKeyringV2_parseDerivationPath, _LedgerKeyringV2_getIndexForAddress, _LedgerKeyringV2_createKeyringAccount;
+import { EthAccountType, EthKeyringWrapper, EthMethod, EthScope, KeyringAccountEntropyTypeOption, KeyringType } from "@metamask/keyring-api";
+import { add0x, getChecksumAddress } from "@metamask/utils";
+/**
+ * Methods supported by Ledger keyring EOA accounts.
+ * Ledger keyrings support a subset of signing methods (no encryption, app keys, or EIP-7702).
+ */
+const LEDGER_KEYRING_METHODS = [
+    EthMethod.SignTransaction,
+    EthMethod.PersonalSign,
+    EthMethod.SignTypedDataV4,
+];
+const ledgerKeyringV2Capabilities = {
+    scopes: [EthScope.Eoa],
+    bip44: {
+        deriveIndex: true,
+        derivePath: true,
+    },
+};
+/**
+ * Ledger Live HD path constant.
+ */
+const LEDGER_LIVE_HD_PATH = `m/44'/60'/0'/0/0`;
+/**
+ * BIP-44 standard HD path prefix constant for Ethereum.
+ */
+const BIP44_HD_PATH_PREFIX = `m/44'/60'/0'/0`;
+/**
+ * Regex pattern for validating and parsing Ledger Live derivation paths.
+ * Format: m/44'/60'/{index}'/0/0
+ */
+const LEDGER_LIVE_PATH_PATTERN = /^m\/44'\/60'\/(\d+)'\/0\/0$/u;
+/**
+ * Regex pattern for validating and parsing non-Ledger-Live derivation paths.
+ * Supports Legacy (m/44'/60'/0'/{index}), BIP44 (m/44'/60'/0'/0/{index}),
+ * and custom paths that follow the m/44'/60'/... pattern.
+ */
+const INDEX_AT_END_PATH_PATTERN = /^(m\/44'\/60'(?:\/\d+'?)*)\/(\d+)$/u;
+export class LedgerKeyringV2 extends EthKeyringWrapper {
+    constructor(options) {
+        super({
+            type: KeyringType.Ledger,
+            inner: options.legacyKeyring,
+            capabilities: ledgerKeyringV2Capabilities,
+        });
+        _LedgerKeyringV2_instances.add(this);
+        this.entropySource = options.entropySource;
+    }
+    async getAccounts() {
+        const addresses = await this.inner.getAccounts();
+        if (addresses.length === 0) {
+            return [];
+        }
+        return addresses.map((address) => {
+            // Check if we already have this account in the registry
+            const existingId = this.registry.getAccountId(address);
+            if (existingId) {
+                const cached = this.registry.get(existingId);
+                if (cached) {
+                    return cached;
+                }
+            }
+            const addressIndex = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getIndexForAddress).call(this, address);
+            return __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_createKeyringAccount).call(this, address, addressIndex);
+        });
+    }
+    async createAccounts(options) {
+        return this.withLock(async () => {
+            if (options.type === 'bip44:derive-path' ||
+                options.type === 'bip44:derive-index') {
+                // Validate that the entropy source matches this keyring's entropy source
+                if (options.entropySource !== this.entropySource) {
+                    throw new Error(`Entropy source mismatch: expected '${this.entropySource}', got '${options.entropySource}'`);
+                }
+            }
+            else {
+                throw new Error(`Unsupported account creation type for LedgerKeyring: ${String(options.type)}`);
+            }
+            // Check if an account at this index already exists with the same derivation path
+            const currentAccounts = await this.getAccounts();
+            let targetIndex;
+            let basePath;
+            let derivationPath;
+            if (options.type === 'bip44:derive-path') {
+                // Parse the derivation path to extract base path and index
+                const parsed = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_parseDerivationPath).call(this, options.derivationPath);
+                targetIndex = parsed.index;
+                basePath = parsed.basePath;
+                derivationPath = options.derivationPath;
+            }
+            else {
+                // derive-index uses BIP-44 standard path by default
+                targetIndex = options.groupIndex;
+                basePath = BIP44_HD_PATH_PREFIX;
+                derivationPath = `${basePath}/${targetIndex}`;
+            }
+            const existingAccount = currentAccounts.find((account) => {
+                return (account.options.entropy.groupIndex === targetIndex &&
+                    account.options.entropy.derivationPath === derivationPath);
+            });
+            if (existingAccount) {
+                return [existingAccount];
+            }
+            // Derive the account at the specified index
+            this.inner.setHdPath(basePath);
+            this.inner.setAccountToUnlock(targetIndex);
+            const [newAddress] = await this.inner.addAccounts(1);
+            if (!newAddress) {
+                throw new Error('Failed to create new account');
+            }
+            const newAccount = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_createKeyringAccount).call(this, newAddress, targetIndex);
+            return [newAccount];
+        });
+    }
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    async deleteAccount(accountId) {
+        await this.withLock(async () => {
+            const { address } = await this.getAccount(accountId);
+            const hexAddress = this.toHexAddress(address);
+            // Remove from the legacy keyring
+            this.inner.removeAccount(hexAddress);
+            // Remove from the registry
+            this.registry.delete(accountId);
+        });
+    }
+}
+_LedgerKeyringV2_instances = new WeakSet(), _LedgerKeyringV2_getChecksumHexAddress = function _LedgerKeyringV2_getChecksumHexAddress(address) {
+    return getChecksumAddress(add0x(address));
+}, _LedgerKeyringV2_parseDerivationPath = function _LedgerKeyringV2_parseDerivationPath(derivationPath) {
+    // Try Ledger Live format first: m/44'/60'/{index}'/0/0
+    const ledgerLiveMatch = derivationPath.match(LEDGER_LIVE_PATH_PATTERN);
+    if (ledgerLiveMatch?.[1]) {
+        return {
+            // This constant is used by `inner.setHdPath` to determine which derivation
+            // mode we should use (Ledger Live derivation mode here).
+            basePath: LEDGER_LIVE_HD_PATH,
+            index: parseInt(ledgerLiveMatch[1], 10),
+        };
+    }
+    // Try index-at-end format: m/44'/60'/.../{index}
+    const indexAtEndMatch = derivationPath.match(INDEX_AT_END_PATH_PATTERN);
+    if (indexAtEndMatch) {
+        // If the condition is true, indexAtEndMatch[1] and indexAtEndMatch[2] are defined, so
+        // we can safely cast them to string.
+        // This is necessary to get 100% code coverage.
+        return {
+            // Here, we use a derivation path prefix for `inner.setHdPath`
+            // (prefix + index derivation mode).
+            basePath: indexAtEndMatch[1],
+            index: parseInt(indexAtEndMatch[2], 10),
+        };
+    }
+    throw new Error(`Invalid derivation path format: ${derivationPath}. ` +
+        `Expected Ledger Live (m/44'/60'/{index}'/0/0) or index-at-end (m/44'/60'/.../{index}) format.`);
+}, _LedgerKeyringV2_getIndexForAddress = function _LedgerKeyringV2_getIndexForAddress(address) {
+    const checksummedAddress = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getChecksumHexAddress).call(this, address);
+    const details = this.inner.accountDetails[checksummedAddress];
+    if (!details) {
+        throw new Error(`Address ${checksummedAddress} not found in account details`);
+    }
+    // Extract index from hdPath
+    const { hdPath } = details;
+    if (!hdPath) {
+        throw new Error(`No HD path found for address ${checksummedAddress}`);
+    }
+    // Ledger supports multiple derivation path formats:
+    // - Ledger Live (bip44: true): m/44'/60'/{index}'/0/0 - index at position 3
+    // - Other paths (bip44: false): {hdPath}/{index} - index at end
+    //   - BIP44: m/44'/60'/0'/0/{index}
+    //   - Legacy: m/44'/60'/0'/{index}
+    //   - Custom paths via setHdPath
+    //
+    // We use the `bip44` flag to determine which extraction pattern to use.
+    if (details.bip44) {
+        // Ledger Live format: m/44'/60'/{index}'/0/0
+        const match = hdPath.match(LEDGER_LIVE_PATH_PATTERN);
+        if (match?.[1]) {
+            return parseInt(match[1], 10);
+        }
+    }
+    else {
+        // Index-at-end format: m/44'/60'/.../{index}
+        const match = hdPath.match(INDEX_AT_END_PATH_PATTERN);
+        if (match?.[2]) {
+            return parseInt(match[2], 10);
+        }
+    }
+    throw new Error(`Could not extract index from HD path: ${hdPath}`);
+}, _LedgerKeyringV2_createKeyringAccount = function _LedgerKeyringV2_createKeyringAccount(address, addressIndex) {
+    const id = this.registry.register(address);
+    const checksummedAddress = __classPrivateFieldGet(this, _LedgerKeyringV2_instances, "m", _LedgerKeyringV2_getChecksumHexAddress).call(this, address);
+    const details = this.inner.accountDetails[checksummedAddress];
+    if (!details?.hdPath) {
+        throw new Error(`No HD path found for address ${checksummedAddress}. Cannot create account.`);
+    }
+    const account = {
+        id,
+        type: EthAccountType.Eoa,
+        address,
+        scopes: [...this.capabilities.scopes],
+        methods: [...LEDGER_KEYRING_METHODS],
+        options: {
+            entropy: {
+                type: KeyringAccountEntropyTypeOption.Mnemonic,
+                id: this.entropySource,
+                groupIndex: addressIndex,
+                derivationPath: details.hdPath,
+            },
+        },
+    };
+    this.registry.set(account);
+    return account;
+};
+//# sourceMappingURL=ledger-keyring-v2.mjs.map