feat: add TrezorKeyringV2 (and OneKeyKeyringV2) (#412)

Related to: https://consensyssoftware.atlassian.net/browse/MUL-1321

## Examples

<!--
Are there any examples of this change being used in another repository?

When considering changes to the MetaMask module template, it's strongly
preferred that the change be experimented with in another repository
first. This gives reviewers a better sense of how the change works,
making it less likely the change will need to be reverted or adjusted
later.
-->

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Implements V2 adapters over legacy hardware keyrings to expose
accounts via the unified API.
> 
> - Add `TrezorKeyringV2` with capabilities for `bip44:derive-index` and
`bip44:derive-path`, derivation path parsing/validation
(`m/44'/60'/0'/0`, legacy MEW, SLIP-0044 testnet), account registry
caching, and graceful behavior when the device is locked
> - Add `OneKeyKeyringV2` extending `TrezorKeyringV2` with
`KeyringType.OneKey`
> - Export new wrappers from `src/index.ts`; update package deps to
`@metamask/keyring-api` and `@metamask/account-api`, tsconfig
references, and README dependency graph
> - Enhance legacy `trezor-keyring` by exposing `getIndexForAddress` and
refactoring path lookup; keep serialization behavior intact
> - Add comprehensive tests for account listing/creation, derivation
paths, deletion, serialization, and locked-device scenarios; raise Jest
coverage thresholds
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3432867. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Cursor Agent <[email protected]>

Author: mathieuartu

README.md

@@ -63,7 +63,9 @@ linkStyle default opacity:0.5
   eth_qr_keyring --> keyring_utils;
   eth_simple_keyring --> keyring_api;
   eth_simple_keyring --> keyring_utils;
+  eth_trezor_keyring --> keyring_api;
   eth_trezor_keyring --> keyring_utils;
+  eth_trezor_keyring --> account_api;
   keyring_internal_api --> keyring_api;
   keyring_internal_api --> keyring_utils;
   keyring_internal_snap_client --> keyring_api;

packages/keyring-eth-trezor/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `TrezorKeyringV2` and `OneKeyKeyringV2` classes implementing `KeyringV2` interface ([#412](https://github.com/MetaMask/accounts/pull/412))
+  - Wraps legacy `TrezorKeyring` and `OneKeyKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
+  - Extends `EthKeyringWrapper` for common Ethereum logic.
+
 ## [9.0.0]
 
 ### Changed

packages/keyring-eth-trezor/jest.config.js

@@ -23,10 +23,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 52.38,
-      functions: 91.22,
-      lines: 90.15,
-      statements: 90.35,
+      branches: 62.65,
+      functions: 93.15,
+      lines: 93.57,
+      statements: 93.66,
     },
   },
 });

packages/keyring-eth-trezor/package.json

@@ -49,6 +49,8 @@
     "@ethereumjs/tx": "^5.4.0",
     "@ethereumjs/util": "^9.1.0",
     "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/keyring-api": "workspace:^",
+    "@metamask/keyring-utils": "workspace:^",
     "@metamask/utils": "^11.1.0",
     "@trezor/connect-plugin-ethereum": "^9.0.5",
     "@trezor/connect-web": "^9.6.0",
@@ -59,8 +61,8 @@
     "@ethereumjs/common": "^4.4.0",
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
+    "@metamask/account-api": "workspace:^",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/keyring-utils": "workspace:^",
     "@ts-bridge/cli": "^0.6.3",
     "@types/ethereumjs-tx": "^1.0.1",
     "@types/hdkey": "^2.0.1",

packages/keyring-eth-trezor/src/index.ts

@@ -1,4 +1,6 @@
 export * from './trezor-keyring';
+export * from './trezor-keyring-v2';
 export * from './onekey-keyring';
+export * from './onekey-keyring-v2';
 export type * from './trezor-bridge';
 export * from './trezor-connect-bridge';

packages/keyring-eth-trezor/src/onekey-keyring-v2.test.ts

@@ -0,0 +1,63 @@
+import { KeyringType } from '@metamask/keyring-api';
+
+import { OneKeyKeyring } from './onekey-keyring';
+import { OneKeyKeyringV2 } from './onekey-keyring-v2';
+import type { TrezorBridge } from './trezor-bridge';
+import { TrezorKeyringV2 } from './trezor-keyring-v2';
+
+const entropySource = 'onekey-device-id-123';
+
+/**
+ * Get a mock bridge for the OneKeyKeyring.
+ *
+ * @returns A mock bridge.
+ */
+function getMockBridge(): TrezorBridge {
+  return {
+    init: jest.fn(),
+    dispose: jest.fn(),
+    getPublicKey: jest.fn(),
+    ethereumSignTransaction: jest.fn(),
+    ethereumSignMessage: jest.fn(),
+    ethereumSignTypedData: jest.fn(),
+    model: undefined,
+  } as unknown as TrezorBridge;
+}
+
+describe('OneKeyKeyringV2', () => {
+  const createInnerKeyring = (): OneKeyKeyring => {
+    return new OneKeyKeyring({ bridge: getMockBridge() });
+  };
+
+  describe('constructor', () => {
+    it('extends TrezorKeyringV2', () => {
+      const inner = createInnerKeyring();
+      const wrapper = new OneKeyKeyringV2({
+        legacyKeyring: inner,
+        entropySource,
+      });
+
+      expect(wrapper).toBeInstanceOf(TrezorKeyringV2);
+    });
+
+    it('sets the type to OneKey', () => {
+      const inner = createInnerKeyring();
+      const wrapper = new OneKeyKeyringV2({
+        legacyKeyring: inner,
+        entropySource,
+      });
+
+      expect(wrapper.type).toBe(KeyringType.OneKey);
+    });
+
+    it('stores the entropy source', () => {
+      const inner = createInnerKeyring();
+      const wrapper = new OneKeyKeyringV2({
+        legacyKeyring: inner,
+        entropySource,
+      });
+
+      expect(wrapper.entropySource).toBe(entropySource);
+    });
+  });
+});

packages/keyring-eth-trezor/src/onekey-keyring-v2.ts

@@ -0,0 +1,28 @@
+import { KeyringType, type EntropySourceId } from '@metamask/keyring-api';
+
+import type { OneKeyKeyring } from './onekey-keyring';
+import { TrezorKeyringV2 } from './trezor-keyring-v2';
+
+/**
+ * Options for creating a OneKeyKeyringV2 instance.
+ */
+export type OneKeyKeyringV2Options = {
+  legacyKeyring: OneKeyKeyring;
+  entropySource: EntropySourceId;
+};
+
+/**
+ * Concrete {@link KeyringV2} adapter for {@link OneKeyKeyring}.
+ *
+ * This wrapper extends {@link TrezorKeyringV2} since OneKeyKeyring extends
+ * TrezorKeyring. The only difference is the keyring type identifier.
+ */
+export class OneKeyKeyringV2 extends TrezorKeyringV2 {
+  constructor(options: OneKeyKeyringV2Options) {
+    super({
+      legacyKeyring: options.legacyKeyring,
+      entropySource: options.entropySource,
+      type: KeyringType.OneKey,
+    });
+  }
+}