@metamask/eth-hd-keyring 6.0.2 → 7.0.1

package/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.1]
+### Changed
+- **BREAKING:** Update minimum Node.js version from v14 to v16 ([#98](https://github.com/MetaMask/eth-hd-keyring/pull/98))
+- Bump dependencies ([#99](https://github.com/MetaMask/eth-hd-keyring/pull/99))
+  * **BREAKING:** `@metamask/eth-sig-util` from `^6.0.0` to `^7.0.0`
+  * **BREAKING:** `@metamask/utils` from `^5.0.2` to `^8.1.0`
+  * `@ethereumjs/tx` from `^4.1.1` to `^4.2.0`
+  * `@ethereumjs/util` from `8.0.5` to `^8.1.0`
+  * `ethereum-cryptography` from `^1.2.0` to `^2.1.2`
+
+## [7.0.0] [RETRACTED]
+### Changed
+- This version was retracted due to a bug causing code to be missing from published package.
+
 ## [6.0.2]
 ### Fixed
 - Bump dependencies ([#94](https://github.com/MetaMask/eth-hd-keyring/pull/94))
@@ -71,7 +85,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Deserialize method (and `HdKeyring` constructor by extension) can no longer be passed an options object containing a value for `numberOfAccounts` if it is not also containing a value for `mnemonic`.
 - Package name changed from `eth-hd-keyring` to `@metamask/eth-hd-keyring`.
 
-[Unreleased]: https://github.com/MetaMask/eth-hd-keyring/compare/v6.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/eth-hd-keyring/compare/v7.0.1...HEAD
+[7.0.1]: https://github.com/MetaMask/eth-hd-keyring/compare/v7.0.0...v7.0.1
+[7.0.0]: https://github.com/MetaMask/eth-hd-keyring/compare/v6.0.2...v7.0.0
 [6.0.2]: https://github.com/MetaMask/eth-hd-keyring/compare/v6.0.1...v6.0.2
 [6.0.1]: https://github.com/MetaMask/eth-hd-keyring/compare/v6.0.0...v6.0.1
 [6.0.0]: https://github.com/MetaMask/eth-hd-keyring/compare/v5.0.1...v6.0.0

package/index.js

@@ -2,7 +2,6 @@ const { HDKey } = require('ethereum-cryptography/hdkey');
 const { keccak256 } = require('ethereum-cryptography/keccak');
 const { bytesToHex } = require('ethereum-cryptography/utils');
 const {
-  stripHexPrefix,
   privateToPublic,
   publicToAddress,
   ecsign,
@@ -20,6 +19,7 @@ const {
   signTypedData,
   SignTypedDataVersion,
 } = require('@metamask/eth-sig-util');
+const { assertIsHexString, remove0x } = require('@metamask/utils');
 
 // Options:
 const hdPathString = `m/44'/60'/0'/0`;
@@ -176,7 +176,8 @@ class HdKeyring {
 
   // For eth_sign, we need to sign arbitrary data:
   async signMessage(address, data, opts = {}) {
-    const message = stripHexPrefix(data);
+    assertIsHexString(data);
+    const message = remove0x(data);
     const privKey = this._getPrivateKeyFor(address, opts);
     const msgSig = ecsign(Buffer.from(message, 'hex'), privKey);
     const rawMsgSig = concatSig(msgSig.v, msgSig.r, msgSig.s);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-hd-keyring",
-  "version": "6.0.2",
+  "version": "7.0.1",
   "description": "A simple standard interface for a seed phrase generated set of Ethereum accounts.",
   "keywords": [
     "ethereum",
@@ -25,14 +25,14 @@
     "test": "jest"
   },
   "dependencies": {
-    "@ethereumjs/util": "8.0.5",
-    "@metamask/eth-sig-util": "^6.0.0",
+    "@ethereumjs/util": "^8.1.0",
+    "@metamask/eth-sig-util": "^7.0.0",
     "@metamask/scure-bip39": "^2.1.0",
-    "@metamask/utils": "^5.0.2",
-    "ethereum-cryptography": "^1.2.0"
+    "@metamask/utils": "^8.1.0",
+    "ethereum-cryptography": "^2.1.2"
   },
   "devDependencies": {
-    "@ethereumjs/tx": "^4.2.0",
+    "@ethereumjs/tx": "^4.0.1",
     "@lavamoat/allow-scripts": "^2.3.1",
     "@lavamoat/preinstall-always-fail": "^1.0.0",
     "@metamask/auto-changelog": "^2.5.0",
@@ -41,20 +41,20 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^8.0.0",
     "@metamask/eth-hd-keyring": "4.0.1",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^29.4.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jest": "^24.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.3.1",
-    "jest": "^27.5.1",
+    "jest": "^29.4.3",
     "prettier": "^2.4.1",
     "prettier-plugin-packagejson": "^2.2.12"
   },
   "packageManager": "yarn@3.3.0",
   "engines": {
-    "node": ">= 14.0.0"
+    "node": "^16.20 || ^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",
@@ -67,4 +67,4 @@
       "@metamask/eth-hd-keyring>ethereumjs-util>ethereum-cryptography>secp256k1": false
     }
   }
-}
+}

package/test/index.js

@@ -578,7 +578,9 @@ describe('hd-keyring', () => {
         numberOfAccounts: 1,
       });
       const localMessage = 'hello there!';
-      const msgHashHex = bufferToHex(keccak256(Buffer.from(localMessage)));
+      const msgHashHex = bufferToHex(
+        Buffer.from(keccak256(Buffer.from(localMessage))),
+      );
       await keyring.addAccounts(9);
       const addresses = await keyring.getAccounts();
       const signatures = await Promise.all(
@@ -608,7 +610,7 @@ describe('hd-keyring', () => {
       });
 
       await expect(keyring.signMessage(firstAcct, '')).rejects.toThrow(
-        'Cannot convert 0x to a BigInt',
+        'Value must be a hexadecimal string',
       );
     });
 

package/.github/CODEOWNERS

@@ -1,4 +0,0 @@
-# Lines starting with '#' are comments.
-# Each line is a file pattern followed by one or more owners.
-
-*                                    @MetaMask/devs

package/.github/workflows/build-lint-test.yml

@@ -1,73 +0,0 @@
-name: Build, Lint, and Test
-
-on:
-  workflow_call:
-
-jobs:
-  prepare:
-    name: Prepare
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: 'yarn'
-      - name: Install Yarn dependencies
-        run: yarn --immutable
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    needs:
-      - prepare
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 18.x, 19.x]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-      - run: yarn --immutable --immutable-cache
-      - run: yarn lint
-      - name: Validate RC changelog
-        if: ${{ startsWith(github.head_ref, 'release/') }}
-        run: yarn auto-changelog validate --rc
-      - name: Validate changelog
-        if: ${{ !startsWith(github.head_ref, 'release/') }}
-        run: yarn auto-changelog validate
-      - name: Require clean working directory
-        shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi
-  test:
-    name: Test
-    runs-on: ubuntu-latest
-    needs:
-      - prepare
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 18.x, 19.x]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-      - run: yarn --immutable --immutable-cache
-      - run: yarn test
-      - name: Require clean working directory
-        shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi

package/.github/workflows/create-release-pr.yml

@@ -1,41 +0,0 @@
-name: Create Release Pull Request
-
-on:
-  workflow_dispatch:
-    inputs:
-      base-branch:
-        description: 'The base branch for git operations and the pull request.'
-        default: 'main'
-        required: true
-      release-type:
-        description: 'A SemVer version diff, i.e. major, minor, patch, prerelease etc. Mutually exclusive with "release-version".'
-        required: false
-      release-version:
-        description: 'A specific version to bump to. Mutually exclusive with "release-type".'
-        required: false
-
-jobs:
-  create-release-pr:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          # This is to guarantee that the most recent tag is fetched.
-          # This can be configured to a more reasonable value by consumers.
-          fetch-depth: 0
-          # We check out the specified branch, which will be used as the base
-          # branch for all git operations and the release PR.
-          ref: ${{ github.event.inputs.base-branch }}
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-      - uses: MetaMask/action-create-release-pr@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          release-type: ${{ github.event.inputs.release-type }}
-          release-version: ${{ github.event.inputs.release-version }}

package/.github/workflows/main.yml

@@ -1,70 +0,0 @@
-name: Main
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-
-jobs:
-  check-workflows:
-    name: Check workflows
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Download actionlint
-        id: download-actionlint
-        run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/7fdc9630cc360ea1a469eed64ac6d78caeda1234/scripts/download-actionlint.bash) 1.6.22
-        shell: bash
-      - name: Check workflow files
-        run: ${{ steps.download-actionlint.outputs.executable }} -color
-        shell: bash
-
-  build-lint-test:
-    name: Build, lint, and test
-    uses: ./.github/workflows/build-lint-test.yml
-
-  all-jobs-completed:
-    name: All jobs completed
-    runs-on: ubuntu-latest
-    needs:
-      - check-workflows
-      - build-lint-test
-    outputs:
-      PASSED: ${{ steps.set-output.outputs.PASSED }}
-    steps:
-      - name: Set PASSED output
-        id: set-output
-        run: echo "PASSED=true" >> "$GITHUB_OUTPUT"
-
-  all-jobs-pass:
-    name: All jobs pass
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    needs: all-jobs-completed
-    steps:
-      - name: Check that all jobs have passed
-        run: |
-          passed="${{ needs.all-jobs-completed.outputs.PASSED }}"
-          if [[ $passed != "true" ]]; then
-            exit 1
-          fi
-  is-release:
-    # release merge commits come from github-actions
-    if: startsWith(github.event.commits[0].author.name, 'github-actions')
-    needs: all-jobs-pass
-    outputs:
-      IS_RELEASE: ${{ steps.is-release.outputs.IS_RELEASE }}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: MetaMask/action-is-release@v1
-        id: is-release
-
-  publish-release:
-    needs: is-release
-    if: needs.is-release.outputs.IS_RELEASE == 'true'
-    name: Publish release
-    permissions:
-      contents: write
-    uses: ./.github/workflows/publish-release.yml
-    secrets:
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/publish-release.yml

@@ -1,50 +0,0 @@
-name: Publish Release
-
-on:
-  workflow_call:
-    secrets:
-      NPM_TOKEN:
-        required: true
-
-jobs:
-  publish-release:
-    permissions:
-      contents: write
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.sha }}
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-      - uses: MetaMask/action-publish-release@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  publish-npm-dry-run:
-    runs-on: ubuntu-latest
-    needs: publish-release
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.sha }}
-      - name: Dry Run Publish
-        # omit npm-token token to perform dry run publish
-        uses: MetaMask/action-npm-publish@v2
-
-  publish-npm:
-    environment: npm-publish
-    runs-on: ubuntu-latest
-    needs: publish-npm-dry-run
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.sha }}
-      - name: Publish
-        uses: MetaMask/action-npm-publish@v2
-        with:
-          # This `NPM_TOKEN` needs to be manually set per-repository.
-          # Look in the repository settings under "Environments", and set this token in the `npm-publish` environment.
-          npm-token: ${{ secrets.NPM_TOKEN }}