chore: fix typo

Author: ByteZhang1024

README.md

@@ -56,6 +56,7 @@ linkStyle default opacity:0.5
   keyring_api --> keyring_utils;
   eth_hd_keyring --> keyring_utils;
   eth_ledger_bridge_keyring --> keyring_utils;
+  eth_onekey_keyring --> keyring_utils;
   eth_qr_keyring --> keyring_utils;
   eth_simple_keyring --> keyring_utils;
   eth_trezor_keyring --> keyring_utils;

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

@@ -23,10 +23,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 70.51,
-      functions: 90.12,
-      lines: 92.83,
-      statements: 92.88,
+      branches: 70.81,
+      functions: 87.95,
+      lines: 92.22,
+      statements: 92.28,
     },
   },
 });

packages/keyring-eth-onekey/package.json

@@ -50,6 +50,7 @@
     "@ethereumjs/tx": "^5.4.0",
     "@ethereumjs/util": "^9.1.0",
     "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/utils": "^11.1.0",
     "@noble/hashes": "^1.7.0",
     "@onekeyfe/hd-core": "1.1.6-patch.4",
     "@onekeyfe/hd-shared": "1.1.6-patch.4",
@@ -62,6 +63,7 @@
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-utils": "workspace:^",
     "@ts-bridge/cli": "^0.6.3",
     "@types/bytebuffer": "^5.0.49",
     "@types/ethereumjs-tx": "^1.0.1",

packages/keyring-eth-onekey/src/onekey-bridge.ts

@@ -2,7 +2,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/naming-convention */
 import type {
-  ConnectSettings,
   Params,
   EVMSignedTx,
   EVMSignTransactionParams,
@@ -32,7 +31,7 @@ export type OneKeyBridge = {
 
   off(event: string): void;
 
-  init(settings: Partial<ConnectSettings>): Promise<void>;
+  init(): Promise<void>;
 
   dispose(): Promise<void>;
 

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

@@ -146,26 +146,6 @@ describe('OneKeyKeyring', function () {
     });
   });
 
-  describe('init', function () {
-    it('initialises the bridge', async function () {
-      const initStub = sinon.stub().resolves();
-      bridge.init = initStub;
-
-      await keyring.init({
-        fetchConfig: true,
-        connectSrc: CONNECT_SRC,
-        env: 'web',
-      });
-
-      expect(initStub.calledOnce).toBe(true);
-      sinon.assert.calledWithExactly(initStub, {
-        fetchConfig: true,
-        connectSrc: CONNECT_SRC,
-        env: 'web',
-      });
-    });
-  });
-
   describe('destroy', function () {
     it('calls dispose on bridge', async function () {
       const disposeStub = sinon.stub().resolves();
@@ -447,14 +427,16 @@ describe('OneKeyKeyring', function () {
           Buffer.from(Address.fromString(fakeAccounts[0]).bytes),
         );
 
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       const returnedTx = await keyring.signTransaction(fakeAccounts[0], fakeTx);
       // assert that the v,r,s values got assigned to tx.
       expect(returnedTx.v).toBeDefined();
       expect(returnedTx.r).toBeDefined();
       expect(returnedTx.s).toBeDefined();
       // ensure we get a older version transaction back
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       expect((returnedTx as EthereumTx).getChainId()).toBe(1);
-      expect((returnedTx as TypedTransaction).common).toBeUndefined();
+      expect(returnedTx.common).toBeUndefined();
       expect(ethereumSignTransactionStub.calledOnce).toBe(true);
     });
 
@@ -482,11 +464,10 @@ describe('OneKeyKeyring', function () {
         newFakeTx,
       );
       // ensure we get a new version transaction back
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       // eslint-disable-next-line @typescript-eslint/unbound-method
       expect((returnedTx as EthereumTx).getChainId).toBeUndefined();
-      expect(
-        (returnedTx as TypedTransaction).common.chainId().toString(16),
-      ).toBe('1');
+      expect(returnedTx.common.chainId().toString(16)).toBe('1');
       expect(ethereumSignTransactionStub.calledOnce).toBe(true);
     });
 
@@ -517,11 +498,10 @@ describe('OneKeyKeyring', function () {
         contractDeploymentFakeTx,
       );
       // ensure we get a new version transaction back
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       // eslint-disable-next-line @typescript-eslint/unbound-method
       expect((returnedTx as EthereumTx).getChainId).toBeUndefined();
-      expect(
-        (returnedTx as TypedTransaction).common.chainId().toString(16),
-      ).toBe('1');
+      expect(returnedTx.common.chainId().toString(16)).toBe('1');
       expect(ethereumSignTransactionStub.calledOnce).toBe(true);
       expect(ethereumSignTransactionStub.getCall(0).args[0]).toStrictEqual({
         passphraseState: '',
@@ -771,6 +751,7 @@ describe('OneKeyKeyring', function () {
       bridge.ethereumSignTransaction = sinon.stub().resolves(errorResponse);
 
       try {
+        // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
         await keyring.signTransaction(fakeAccounts[0], fakeTx);
         throw new Error('Expected error was not thrown');
       } catch (error) {
@@ -911,6 +892,7 @@ describe('OneKeyKeyring', function () {
       // @ts-expect-error - for testing purposes
       fakeTx.to = null;
 
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       const result = await keyring.signTransaction(fakeAccounts[0], fakeTx);
       expect(result).toBeDefined();
 
@@ -1006,7 +988,7 @@ describe('OneKeyKeyring', function () {
     it('should handle init bridge method', async function () {
       const initSpy = sinon.stub(bridge, 'init').resolves();
 
-      await keyring.init({ debug: true });
+      await keyring.init();
       expect(initSpy.calledOnce).toBe(true);
 
       // Test destroy method by calling keyring destroy
@@ -1052,6 +1034,7 @@ describe('OneKeyKeyring', function () {
           Buffer.from(Address.fromString(fakeAccounts[0]).bytes),
         );
 
+      // @ts-expect-error: intentionally using an old library that doesn't comply with TypedTransaction
       const result = await keyring.signTransaction(fakeAccounts[0], fakeTx);
       expect(result).toBeDefined();
       expect(result.v).toBeDefined();
@@ -1086,13 +1069,6 @@ describe('OneKeyKeyring', function () {
       }).toThrow('Bridge is a required dependency for the keyring');
     });
 
-    it('should handle event emission from bridge', function () {
-      const eventSpy = sinon.stub(keyring, 'emit');
-
-      expect(keyring.bridge).toBe(bridge);
-      expect(eventSpy.called).toBe(false);
-    });
-
     describe('HD path variations', function () {
       it('should handle Ledger Legacy HD path in setHdPath', function () {
         // Cover branches in #isSameHdPath for Ledger Legacy

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

@@ -5,6 +5,8 @@ import { TransactionFactory } from '@ethereumjs/tx';
 import * as ethUtil from '@ethereumjs/util';
 import type { MessageTypes, TypedMessage } from '@metamask/eth-sig-util';
 import { SignTypedDataVersion, TypedDataUtils } from '@metamask/eth-sig-util';
+import type { Keyring } from '@metamask/keyring-utils';
+import type { Hex, Json } from '@metamask/utils';
 import type {
   ConnectSettings,
   EthereumSignTypedDataMessage,
@@ -57,16 +59,16 @@ export type AccountPage = AccountPageEntry[];
 
 export type OneKeyControllerOptions = {
   hdPath?: string;
-  accounts?: string[];
+  accounts?: Hex[];
   accountDetails?: Readonly<Record<string, AccountDetails>>;
   page?: number;
   passphraseState?: string;
 };
 
 export type OneKeyControllerState = {
   hdPath: string;
-  accounts: readonly string[];
-  accountDetails: Readonly<Record<string, AccountDetails>>;
+  accounts: string[];
+  accountDetails: Record<string, AccountDetails>;
   page: number;
   passphraseState?: string;
 };
@@ -127,7 +129,7 @@ function isEmptyPassphrase(passphraseState: string | undefined): boolean {
   );
 }
 
-export class OneKeyKeyring extends EventEmitter {
+export class OneKeyKeyring implements Keyring {
   readonly type: string = keyringType;
 
   static type: string = keyringType;
@@ -140,7 +142,7 @@ export class OneKeyKeyring extends EventEmitter {
 
   hdk = new HDKey();
 
-  accounts: readonly string[] = [];
+  accounts: readonly Hex[] = [];
 
   accountDetails: Record<string, AccountDetails> = {};
 
@@ -154,43 +156,53 @@ export class OneKeyKeyring extends EventEmitter {
 
   bridge: OneKeyBridge;
 
-  constructor({ bridge }: { bridge: OneKeyBridge }) {
-    super();
+  eventEmitter: EventEmitter;
 
+  constructor({ bridge }: { bridge: OneKeyBridge }) {
     if (!bridge) {
       throw new Error('Bridge is a required dependency for the keyring');
     }
 
+    this.eventEmitter = new EventEmitter();
+
     this.bridge = bridge;
     this.bridge.on(ONEKEY_HARDWARE_UI_EVENT, (_event: any) => {
-      this.emit(ONEKEY_HARDWARE_UI_EVENT, _event);
+      this.eventEmitter.emit(ONEKEY_HARDWARE_UI_EVENT, _event);
     });
   }
 
-  async init(settings: Partial<ConnectSettings>): Promise<void> {
-    return this.bridge.init(settings);
+  async init(): Promise<void> {
+    return this.bridge.init();
   }
 
   async destroy(): Promise<void> {
     this.bridge.off(ONEKEY_HARDWARE_UI_EVENT);
     return this.bridge.dispose();
   }
 
+  on(event: string, callback: (event: any) => void): void {
+    this.eventEmitter.on(event, callback);
+  }
+
+  off(event: string, callback: (event: any) => void): void {
+    this.eventEmitter.off(event, callback);
+  }
+
   async serialize(): Promise<OneKeyControllerState> {
-    return Promise.resolve({
+    return {
       hdPath: this.hdPath,
-      accounts: this.accounts,
-      accountDetails: this.accountDetails,
+      accounts: [...this.accounts],
+      accountDetails: { ...this.accountDetails },
       page: this.page,
-    });
+    };
   }
 
-  async deserialize(opts: OneKeyControllerOptions = {}): Promise<void> {
+  async deserialize(state: Json): Promise<void> {
+    const opts = state as OneKeyControllerOptions;
     this.hdPath = opts.hdPath ?? defaultHdPath;
     this.accounts = opts.accounts ?? [];
     this.accountDetails = opts.accountDetails ?? {};
     this.page = opts.page ?? 0;
-    return Promise.resolve();
   }
 
   getModel(): string | undefined {
@@ -273,15 +285,15 @@ export class OneKeyKeyring extends EventEmitter {
     });
   }
 
-  async addAccounts(numberOfAccounts = 1): Promise<readonly string[]> {
+  async addAccounts(numberOfAccounts = 1): Promise<Hex[]> {
     await this.unlock().catch((error) => {
       throw new Error(error?.toString() || 'Unknown error');
     });
 
     return new Promise((resolve, reject) => {
       const from = this.unlockedAccount;
       const to = from + numberOfAccounts;
-      const newAccounts: string[] = [];
+      const newAccounts: Hex[] = [];
 
       try {
         for (let i = from; i < to; i++) {
@@ -329,7 +341,7 @@ export class OneKeyKeyring extends EventEmitter {
     return this.#getPage(-1);
   }
 
-  async getAccounts(): Promise<readonly string[]> {
+  async getAccounts(): Promise<Hex[]> {
     return Promise.resolve(this.accounts.slice());
   }
 
@@ -353,7 +365,7 @@ export class OneKeyKeyring extends EventEmitter {
   }
 
   #normalize(buffer: Buffer): string {
-    return ethUtil.bytesToHex(buffer);
+    return ethUtil.bytesToHex(new Uint8Array(buffer));
   }
 
   /**
@@ -368,15 +380,16 @@ export class OneKeyKeyring extends EventEmitter {
    * ethereumjs transaction.
    */
   async signTransaction(
-    address: string,
-    tx: TypedTransaction | OldEthJsTransaction,
-  ): Promise<TypedTransaction | OldEthJsTransaction> {
+    address: Hex,
+    tx: TypedTransaction,
+  ): Promise<TypedTransaction> {
     if (isOldStyleEthereumjsTx(tx)) {
       // In this version of ethereumjs-tx we must add the chainId in hex format
       // to the initial v value. The chainId must be included in the serialized
       // transaction which is only communicated to ethereumjs-tx in this
       // value. In newer versions the chainId is communicated via the 'Common'
       // object.
+      // @ts-expect-error - support old transactions
       return this.#signTransaction(
         address,
         // @types/ethereumjs-tx and old ethereumjs-tx versions document
@@ -386,10 +399,11 @@ export class OneKeyKeyring extends EventEmitter {
         tx.getChainId() as unknown as number,
         tx,
         (payload) => {
-          tx.v = Buffer.from(payload.v, 'hex');
-          tx.r = Buffer.from(payload.r, 'hex');
-          tx.s = Buffer.from(payload.s, 'hex');
-          return tx;
+          const newTx = tx as OldEthJsTransaction;
+          newTx.v = Buffer.from(payload.v, 'hex');
+          newTx.r = Buffer.from(payload.r, 'hex');
+          newTx.s = Buffer.from(payload.s, 'hex');
+          return newTx;
         },
       );
     }
@@ -632,10 +646,10 @@ export class OneKeyKeyring extends EventEmitter {
     return accountDetails;
   }
 
-  #addressFromIndex(i: number): string {
+  #addressFromIndex(i: number): Hex {
     const dkey = this.hdk.derive(this.#getDerivePath(i));
     const address = ethUtil.bytesToHex(
-      ethUtil.publicToAddress(dkey.publicKey, true),
+      ethUtil.publicToAddress(new Uint8Array(dkey.publicKey), true),
     );
     return ethUtil.toChecksumAddress(address);
   }

packages/keyring-utils/src/keyring.ts

@@ -77,7 +77,6 @@ export type Keyring = {
    * @param state - A JSON-serializable representation of the keyring state.
    */
   deserialize(state: Json): Promise<void>;
-
   /**
    * Method to include asynchronous configuration.
    */

yarn.lock

@@ -1753,6 +1753,8 @@ __metadata:
     "@lavamoat/preinstall-always-fail": "npm:^2.1.0"
     "@metamask/auto-changelog": "npm:^3.4.4"
     "@metamask/eth-sig-util": "npm:^8.2.0"
+    "@metamask/keyring-utils": "workspace:^"
+    "@metamask/utils": "npm:^11.1.0"
     "@noble/hashes": "npm:^1.7.0"
     "@onekeyfe/hd-core": "npm:1.1.6-patch.4"
     "@onekeyfe/hd-shared": "npm:1.1.6-patch.4"