@metamask/eth-hd-keyring 6.0.0 → 7.0.0

package/.eslintrc.js

@@ -1,17 +1,36 @@
 module.exports = {
   root: true,
 
-  extends: ['@metamask/eslint-config', '@metamask/eslint-config-nodejs'],
+  extends: ['@metamask/eslint-config'],
 
   overrides: [
     {
-      files: ['test/**/*.js'],
-      extends: ['@metamask/eslint-config-jest'],
-      rules: {
-        'node/no-unpublished-require': 0,
+      files: ['*.ts'],
+      extends: ['@metamask/eslint-config-typescript'],
+    },
+
+    {
+      files: ['*.js'],
+      parserOptions: {
+        sourceType: 'script',
       },
+      extends: ['@metamask/eslint-config-nodejs'],
+    },
+
+    {
+      files: ['*.test.ts', '*.test.js'],
+      extends: [
+        '@metamask/eslint-config-jest',
+        '@metamask/eslint-config-nodejs',
+      ],
     },
   ],
 
-  ignorePatterns: ['!.eslintrc.js', '!.prettierrc.js'],
+  ignorePatterns: [
+    '!.eslintrc.js',
+    '!.prettierrc.js',
+    'dist/',
+    'docs/',
+    '.yarn/',
+  ],
 };

package/.nvmrc

@@ -1 +1 @@
-v12
+v18

package/CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0]
+### 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`
+
+## [6.0.1]
+### Added
+- Export Typescript definitions ([#90](https://github.com/MetaMask/eth-hd-keyring/pull/90))
+
+### Fixed
+- Bump dependencies ([#94](https://github.com/MetaMask/eth-hd-keyring/pull/94))
+  * `@ethereumjs/util` from `^8.0.2` to `^8.1.0`
+  * `@metamask/eth-sig-util` from `^5.0.2` to `^6.0.0`
+  * `@metamask/scure-bip39` from `^2.0.3` to `^2.1.0`
+  * `@metamask/utils` from `^5.0.0` to `^5.0.2`
+  * `ethereum-cryptography` from `^1.1.2` to `^1.2.0`
+
 ## [6.0.0]
 ### Changed
 - Revert mnemonic serialization format from `Record<number, number>` (i.e. a stringified `Uint8Array`) which was introduced in v5.0.0 back to an untyped array of utf8 encoded bytes, which was the format prior to v5.0.0 ([#81](https://github.com/MetaMask/eth-hd-keyring/pull/81))
@@ -58,7 +80,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.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eth-hd-keyring/compare/v7.0.0...HEAD
+[7.0.0]: https://github.com/MetaMask/eth-hd-keyring/compare/v6.0.1...v7.0.0
+[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
 [5.0.1]: https://github.com/MetaMask/eth-hd-keyring/compare/v5.0.0...v5.0.1
 [5.0.0]: https://github.com/MetaMask/eth-hd-keyring/compare/v4.0.2...v5.0.0

package/README.md

@@ -77,7 +77,7 @@ Exports the specified account as a private key hex string.
 
 ### Setup
 
-- Install [Node.js](https://nodejs.org) version 12
+- Install [Node.js](https://nodejs.org) version 18
   - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
 - Install [Yarn v3](https://yarnpkg.com/getting-started/install)
 - Run `yarn install` to install dependencies and run any required post-install scripts

package/jest.config.js

@@ -3,10 +3,10 @@ module.exports = {
   coverageReporters: ['text', 'html'],
   coverageThreshold: {
     global: {
-      branches: 84,
+      branches: 73.91,
       functions: 100,
-      lines: 95,
-      statements: 95,
+      lines: 91.81,
+      statements: 91.95,
     },
   },
   moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],
@@ -18,6 +18,9 @@ module.exports = {
   // modules.
   restoreMocks: true,
   testEnvironment: 'node',
-  testMatch: ['**/test/**/*.js'],
+  testMatch: ['./**/*.test.ts'],
   testTimeout: 2500,
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-hd-keyring",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "A simple standard interface for a seed phrase generated set of Ethereum accounts.",
   "keywords": [
     "ethereum",
@@ -18,6 +18,7 @@
   "author": "Dan Finlay",
   "main": "index.js",
   "scripts": {
+    "build": "tsc --project tsconfig.build.json",
     "lint": "yarn lint:eslint && yarn lint:misc --check",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
@@ -25,34 +26,45 @@
     "test": "jest"
   },
   "dependencies": {
-    "@ethereumjs/util": "^8.0.2",
-    "@metamask/eth-sig-util": "^5.0.2",
-    "@metamask/scure-bip39": "^2.0.3",
-    "ethereum-cryptography": "^1.1.2"
+    "@ethereumjs/tx": "^4.2.0",
+    "@ethereumjs/util": "^8.1.0",
+    "@metamask/bip39": "^4.0.0",
+    "@metamask/eth-sig-util": "^7.0.0",
+    "@metamask/scure-bip39": "^2.1.0",
+    "@metamask/utils": "^8.1.0",
+    "ethereum-cryptography": "^2.1.2"
   },
   "devDependencies": {
-    "@ethereumjs/tx": "^4.0.1",
-    "@lavamoat/allow-scripts": "^2.1.0",
+    "@lavamoat/allow-scripts": "^2.3.1",
+    "@lavamoat/preinstall-always-fail": "^1.0.0",
     "@metamask/auto-changelog": "^2.5.0",
-    "@metamask/bip39": "^4.0.0",
     "@metamask/eslint-config": "^8.0.0",
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^8.0.0",
+    "@metamask/eslint-config-typescript": "^11.1.0",
     "@metamask/eth-hd-keyring": "4.0.1",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.14.6",
+    "@typescript-eslint/eslint-plugin": "latest",
+    "@typescript-eslint/parser": "^5.54.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-jsdoc": "latest",
     "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"
+    "prettier-plugin-packagejson": "^2.2.12",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.23.26",
+    "typescript": "^4.9.5"
   },
   "packageManager": "yarn@3.3.0",
   "engines": {
-    "node": ">= 14.0.0"
+    "node": "^16.20 || ^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",