refactor: align options type

Author: mikesposito

.github/workflows/security-code-scanner.yml

@@ -1,10 +1,13 @@
-name: 'MetaMask Security Code Scanner'
+name: MetaMask Security Code Scanner
 
 on:
   push:
-    branches: ['main']
+    branches:
+      - main
   pull_request:
-    branches: ['main']
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
   run-security-scan:

packages/keyring-eth-hd/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** The method signature for `signTypedData` has been changed ([#224](https://github.com/MetaMask/accounts/pull/224))
+  - The method now accepts a `TypedDataV1` object when `SignTypedDataVersion.V1` is passed in the options, and `TypedMessage<Types>` when other versions are requested.
+
 ## [12.0.0]
 
 ### Changed
@@ -22,8 +27,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - **BREAKING:** The `HdKeyring` is not exported as default anymore ([#161](https://github.com/MetaMask/accounts/pull/161))
-- **BREAKING:** The method signature for `signTypedData` has been changed ([#224](https://github.com/MetaMask/accounts/pull/224))
-  - The method now accepts a `TypedDataV1` object when `SignTypedDataVersion.V1` is passed in the options, and `TypedMessage<Types>` when other versions are requested.
 
 ## [10.0.1]
 

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

@@ -19,9 +19,12 @@ import {
   type MessageTypes,
   type EIP7702Authorization,
 } from '@metamask/eth-sig-util';
+import { mnemonicPhraseToBytes } from '@metamask/key-tree';
 import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import { assert, bytesToHex, hexToBytes, type Hex } from '@metamask/utils';
 import { webcrypto } from 'crypto';
+// eslint-disable-next-line n/no-sync
+import { mnemonicToSeedSync } from 'ethereum-cryptography/bip39';
 import { keccak256 } from 'ethereum-cryptography/keccak';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 import OldHdKeyring from 'old-hd-keyring';
@@ -37,6 +40,10 @@ const sampleMnemonic =
 const firstAcct = '0x1c96099350f13d558464ec79b9be4445aa0ef579';
 const secondAcct = '0x1b00aed43a693f3a957f9feb5cc08afa031e37a0';
 
+const sampleMnemonicBytes = mnemonicPhraseToBytes(sampleMnemonic);
+// eslint-disable-next-line n/no-sync
+const sampleMnemonicSeed = mnemonicToSeedSync(sampleMnemonic);
+
 const notKeyringAddress = '0xbD20F6F5F1616947a39E11926E78ec94817B3931';
 
 const getAddressAtIndex = (keyring: HdKeyring, index: number): Hex => {
@@ -175,6 +182,8 @@ describe('hd-keyring', () => {
       const accounts = keyring.getAccounts();
       expect(accounts[0]).toStrictEqual(firstAcct);
       expect(accounts[1]).toStrictEqual(secondAcct);
+      expect(keyring.mnemonic).toStrictEqual(sampleMnemonicBytes);
+      expect(keyring.seed).toStrictEqual(sampleMnemonicSeed);
     });
 
     it('deserializes with a typeof buffer mnemonic', async () => {
@@ -188,6 +197,8 @@ describe('hd-keyring', () => {
       const accounts = keyring.getAccounts();
       expect(accounts[0]).toStrictEqual(firstAcct);
       expect(accounts[1]).toStrictEqual(secondAcct);
+      expect(keyring.mnemonic).toStrictEqual(sampleMnemonicBytes);
+      expect(keyring.seed).toStrictEqual(sampleMnemonicSeed);
     });
 
     it('deserializes with a typeof Uint8Array mnemonic', async () => {
@@ -207,6 +218,8 @@ describe('hd-keyring', () => {
       const accounts = keyring.getAccounts();
       expect(accounts[0]).toStrictEqual(firstAcct);
       expect(accounts[1]).toStrictEqual(secondAcct);
+      expect(keyring.mnemonic).toStrictEqual(sampleMnemonicBytes);
+      expect(keyring.seed).toStrictEqual(sampleMnemonicSeed);
     });
 
     it('deserializes using custom cryptography', async () => {
@@ -251,6 +264,8 @@ describe('hd-keyring', () => {
       const accounts = keyring.getAccounts();
       expect(accounts[0]).toStrictEqual(firstAcct);
       expect(accounts[1]).toStrictEqual(secondAcct);
+      expect(keyring.mnemonic).toStrictEqual(sampleMnemonicBytes);
+      expect(keyring.seed).toStrictEqual(sampleMnemonicSeed);
       expect(cryptographicFunctions.pbkdf2Sha512).toHaveBeenCalledTimes(1);
     });
 

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

@@ -90,6 +90,8 @@ export class HdKeyring {
 
   mnemonic?: Uint8Array | null;
 
+  seed?: Uint8Array | null;
+
   root?: HDKey | null;
 
   hdWallet?: HDKey;
@@ -154,6 +156,7 @@ export class HdKeyring {
     }
     this.#wallets = [];
     this.mnemonic = null;
+    this.seed = null;
     this.root = null;
     this.hdPath = opts.hdPath ?? hdPathString;
 
@@ -338,30 +341,31 @@ export class HdKeyring {
    * Sign a typed message using the private key of the specified account.
    * This method is compatible with the `eth_signTypedData` RPC method.
    *
-   * @param withAccount - The address of the account.
-   * @param typedData - The typed data to sign.
-   * @param opts - The options for signing the message.
+   * @param address - The address of the account.
+   * @param data - The typed data to sign.
+   * @param options - The options for signing the message.
    * @returns The signature of the message.
    */
   async signTypedData<
     Version extends SignTypedDataVersion,
     Types extends MessageTypes,
     Options extends { version: Version },
   >(
-    withAccount: Hex,
-    typedData: Version extends 'V1' ? TypedDataV1 : TypedMessage<Types>,
-    opts?: HDKeyringAccountSelectionOptions & Options,
+    address: Hex,
+    data: Version extends 'V1' ? TypedDataV1 : TypedMessage<Types>,
+    options?: HDKeyringAccountSelectionOptions & Options,
   ): Promise<string> {
-    const options = opts ?? { version: SignTypedDataVersion.V1 };
+    let { version } = options ?? { version: SignTypedDataVersion.V1 };
+
     // Treat invalid versions as "V1"
-    const version = Object.keys(SignTypedDataVersion).includes(options.version)
-      ? options.version
+    version = Object.keys(SignTypedDataVersion).includes(version)
+      ? version
       : SignTypedDataVersion.V1;
 
-    const privateKey = this.#getPrivateKeyFor(withAccount, opts);
+    const privateKey = this.#getPrivateKeyFor(address, options);
     return signTypedData({
       privateKey: Buffer.from(privateKey),
-      data: typedData,
+      data,
       version,
     });
   }
@@ -591,12 +595,12 @@ export class HdKeyring {
 
     this.mnemonic = this.#mnemonicToUint8Array(mnemonic);
 
-    const seed = await mnemonicToSeed(
+    this.seed = await mnemonicToSeed(
       this.mnemonic,
       '', // No passphrase
       this.#cryptographicFunctions,
     );
-    this.hdWallet = HDKey.fromMasterSeed(seed);
+    this.hdWallet = HDKey.fromMasterSeed(this.seed);
     this.root = this.hdWallet.derive(this.hdPath);
   }
 

packages/keyring-eth-ledger-bridge/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** The `signTypedData` method now requires `SignTypedDataVersion.V4` as version for the `options` argument ([#224](https://github.com/MetaMask/accounts/pull/224)).
+
 ## [10.0.0]
 
 ### Changed
@@ -35,7 +39,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The `signPersonalMessage` method now accepts an `Hex` typed value as the `withAccount` parameter.
   - The `signTypedData` method now accepts an `Hex` typed value as the `withAccount` parameter.
   - The `unlockAccountByAddress` method now accepts an `Hex` typed value as the `address` parameter.
-- **BREAKING:** The `signTypedData` method now requires `SignTypedDataVersion` as version for the `options` argument ([#224](https://github.com/MetaMask/accounts/pull/224)).
 
 ### Removed
 

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

@@ -494,9 +494,9 @@ export class LedgerKeyring implements Keyring {
   }
 
   async signTypedData<
-    Version extends SignTypedDataVersion,
+    Version extends SignTypedDataVersion.V4,
     Types extends MessageTypes,
-    Options extends { version?: Version },
+    Options extends { version: Version },
   >(
     withAccount: Hex,
     data: TypedMessage<Types>,

packages/keyring-eth-simple/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** The method signature for `signTypedData` has been changed ([#224](https://github.com/MetaMask/accounts/pull/224))
+  - The method now accepts a `TypedDataV1` object when `SignTypedDataVersion.V1` is passed in the options, and `TypedMessage<Types>` when other versions are requested.
+  - The `options` argument type has been changed to `{ version: SignTypedDataVersion } | undefined`.
+
 ## [10.0.0]
 
 ### Changed
@@ -23,8 +29,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **BREAKING:** The `SimpleKeyring` class now implements `Keyring` from `@metamask/keyring-utils` ([#217](https://github.com/MetaMask/accounts/pull/217))
   - The `deserialize` method now requires a `string[]` argument.
-- **BREAKING:** The method signature for `signTypedData` has been changed ([#224](https://github.com/MetaMask/accounts/pull/224))
-  - The method now accepts a `TypedDataV1` object when `SignTypedDataVersion.V1` is passed in the options, and `TypedMessage<Types>` when other versions are requested.
 
 ## [8.1.1]
 

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

@@ -160,22 +160,21 @@ export default class SimpleKeyring implements Keyring {
   async signTypedData<
     Version extends SignTypedDataVersion,
     Types extends MessageTypes,
-    Options extends { version?: Version } & KeyringOpt,
+    Options extends { version: Version } & KeyringOpt,
   >(
     address: Hex,
-    typedData: Version extends 'V1' ? TypedDataV1 : TypedMessage<Types>,
-    opts?: Options,
+    data: Version extends 'V1' ? TypedDataV1 : TypedMessage<Types>,
+    options?: Options,
   ): Promise<string> {
-    const options = opts ?? { version: SignTypedDataVersion.V1 };
-    // Treat invalid versions as "V1"
-    let version = SignTypedDataVersion.V1;
+    let { version } = options ?? { version: SignTypedDataVersion.V1 };
 
-    if (options.version && isSignTypedDataVersion(options.version)) {
-      version = SignTypedDataVersion[options.version];
+    // Treat invalid versions as "V1"
+    if (!isSignTypedDataVersion(version)) {
+      version = SignTypedDataVersion.V1;
     }
 
-    const privateKey = this.#getPrivateKeyFor(address, opts);
-    return signTypedData({ privateKey, data: typedData, version });
+    const privateKey = this.#getPrivateKeyFor(address, options);
+    return signTypedData({ privateKey, data, version });
   }
 
   // get public key for nacl

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]
 
+### Changed
+
+- **BREAKING:** The method signature for `signTypedData` has been changed ([#224](https://github.com/MetaMask/accounts/pull/224))
+  - The `options` argument type has been changed to `{ version: SignTypedDataVersion.V3 | SignTypedDataVersion.V4 } | undefined`.
+  - The `options.version` argument type has been restricted to accept `SignTypedDataVersion.V3 | SignTypedDataVersion.V4` ([#224](https://github.com/MetaMask/accounts/pull/224))
+
 ## [8.0.0]
 
 ### Changed
@@ -35,7 +41,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The `signPersonalMessage` method now accepts an `Hex` typed value as the `withAccount` parameter.
   - The `signTypedData` method now accepts an `Hex` typed value as the `withAccount` parameter.
   - The `unlockAccountByAddress` method now accepts an `Hex` typed value as the `address` parameter.
-- **BREAKING:** The `signTypedData` `options.version` argument type has been restricted to accept `SignTypedDataVersion.V3 | SignTypedDataVersion.V4` ([#224](https://github.com/MetaMask/accounts/pull/224))
 
 ### Removed
 

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

@@ -462,12 +462,14 @@ export class TrezorKeyring implements Keyring {
   async signTypedData<
     Version extends SignTypedDataVersion.V3 | SignTypedDataVersion.V4,
     Types extends MessageTypes,
-    Options extends { version?: Version },
+    Options extends { version: Version },
   >(
     address: Hex,
     data: TypedMessage<Types>,
-    { version }: Options,
+    options?: Options,
   ): Promise<string> {
+    const { version } = options ?? { version: SignTypedDataVersion.V4 };
+
     const dataWithHashes = transformTypedData(
       data,
       version === SignTypedDataVersion.V4,