@metamask/key-tree - npm Package Compare versions

Comparing version 8.0.0 to 9.0.0

CHANGELOG.md

@@ -9,2 +9,12 @@ # Changelog
 
+## [9.0.0]
+### Changed
+- **BREAKING:** Disallow importing from `./dist` paths ([#147](https://github.com/MetaMask/key-tree/pull/147))
+- Export `mnemonicPhraseToBytes` and `createBip39KeyFromSeed` ([#149](https://github.com/MetaMask/key-tree/pull/149))
+
+### Fixed
+- Add support for Node.js with ESM ([#147](https://github.com/MetaMask/key-tree/pull/147))
+- Remove `postinstall` script ([#146](https://github.com/MetaMask/key-tree/pull/146))
+  - This caused installation to fail.
+
 ## [8.0.0]
@@ -147,3 +157,4 @@ ### Changed
 
-[Unreleased]: https://github.com/MetaMask/key-tree/compare/v8.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/key-tree/compare/v9.0.0...HEAD
+[9.0.0]: https://github.com/MetaMask/key-tree/compare/v8.0.0...v9.0.0
 [8.0.0]: https://github.com/MetaMask/key-tree/compare/v7.1.1...v8.0.0
@@ -150,0 +161,0 @@ [7.1.1]: https://github.com/MetaMask/key-tree/compare/v7.1.0...v7.1.1

dist/cjs/derivers/index.js

@@ -5,6 +5,14 @@ "use strict";
 });
-Object.defineProperty(exports, "derivers", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    derivers: function() {
         return derivers;
+    },
+    createBip39KeyFromSeed: function() {
+        return _bip39.createBip39KeyFromSeed;
     }
@@ -11,0 +19,0 @@ });

dist/cjs/index.js

@@ -38,2 +38,8 @@ "use strict";
         return _utils.isValidBIP32PathSegment;
+    },
+    mnemonicPhraseToBytes: function() {
+        return _utils.mnemonicPhraseToBytes;
+    },
+    createBip39KeyFromSeed: function() {
+        return _derivers.createBip39KeyFromSeed;
     }
@@ -47,2 +53,3 @@ });
 const _utils = require("./utils");
+const _derivers = require("./derivers");
 function _export_star(from, to) {
@@ -49,0 +56,0 @@ Object.keys(from).forEach(function(k) {

dist/esm/derivers/index.js

@@ -9,3 +9,4 @@ import * as bip32 from './bip32';
 };
+export { createBip39KeyFromSeed } from './bip39';
 
 //# sourceMappingURL=index.js.map

dist/esm/index.js

@@ -6,4 +6,5 @@ export { BIP44Node } from './BIP44Node';
 export * from './constants';
-export { isValidBIP32PathSegment } from './utils';
+export { isValidBIP32PathSegment, mnemonicPhraseToBytes } from './utils';
+export { createBip39KeyFromSeed } from './derivers';
 
 //# sourceMappingURL=index.js.map

dist/types/BIP44CoinTypeNode.d.ts

@@ -1,5 +0,7 @@
-import { BIP44Node, BIP44NodeInterface, JsonBIP44Node } from './BIP44Node';
-import { BIP39Node, BIP44Depth, BIP44PurposeNodeToken, CoinTypeHDPathString, HardenedBIP32Node } from './constants';
-import { SupportedCurve } from './curves';
-import { CoinTypeToAddressIndices, getBIP44ChangePathString } from './utils';
+import type { BIP44NodeInterface, JsonBIP44Node } from './BIP44Node';
+import { BIP44Node } from './BIP44Node';
+import type { BIP39Node, BIP44Depth, BIP44PurposeNodeToken, CoinTypeHDPathString, HardenedBIP32Node } from './constants';
+import type { SupportedCurve } from './curves';
+import type { CoinTypeToAddressIndices } from './utils';
+import { getBIP44ChangePathString } from './utils';
 export declare type CoinTypeHDPathTuple = [
@@ -6,0 +8,0 @@ BIP39Node,

dist/types/BIP44Node.d.ts

@@ -1,3 +0,3 @@
-import { BIP44Depth, PartialHDPathTuple, RootedSLIP10PathTuple } from './constants';
-import { SupportedCurve } from './curves';
+import type { BIP44Depth, PartialHDPathTuple, RootedSLIP10PathTuple } from './constants';
+import type { SupportedCurve } from './curves';
 import { SLIP10Node } from './SLIP10Node';
@@ -4,0 +4,0 @@ export declare type BIP44ExtendedKeyOptions = {

dist/types/derivation.d.ts

 import { BIP44CoinTypeNode } from './BIP44CoinTypeNode';
 import { BIP44Node } from './BIP44Node';
-import { SLIP10Path } from './constants';
-import { SupportedCurve } from './curves';
+import type { SLIP10Path } from './constants';
+import type { SupportedCurve } from './curves';
 import { SLIP10Node } from './SLIP10Node';
@@ -6,0 +6,0 @@ /**

dist/types/derivers/bip32.d.ts

@@ -1,3 +0,3 @@
-import { DeriveChildKeyArgs } from '.';
-import { SLIP10Node } from '../SLIP10Node';
+import type { DeriveChildKeyArgs } from '.';
+import type { SLIP10Node } from '../SLIP10Node';
 /**
@@ -4,0 +4,0 @@ * Converts a BIP-32 private key to an Ethereum address.

dist/types/derivers/bip39.d.ts

@@ -1,4 +0,4 @@
-import { DeriveChildKeyArgs } from '.';
-import { BIP39StringNode } from '../constants';
-import { Curve } from '../curves';
+import type { DeriveChildKeyArgs } from '.';
+import type { BIP39StringNode } from '../constants';
+import type { Curve } from '../curves';
 import { SLIP10Node } from '../SLIP10Node';
@@ -5,0 +5,0 @@ /**

dist/types/derivers/index.d.ts

@@ -1,3 +0,3 @@
-import { Curve } from '../curves';
-import { SLIP10Node } from '../SLIP10Node';
+import type { Curve } from '../curves';
+import type { SLIP10Node } from '../SLIP10Node';
 import * as bip32 from './bip32';
@@ -27,2 +27,3 @@ import * as bip39 from './bip39';
 };
+export { createBip39KeyFromSeed } from './bip39';
 //# sourceMappingURL=index.d.ts.map

dist/types/derivers/shared.d.ts

@@ -1,3 +0,3 @@
-import { DeriveChildKeyArgs } from '.';
-import { Curve } from '../curves';
+import type { DeriveChildKeyArgs } from '.';
+import type { Curve } from '../curves';
 import { SLIP10Node } from '../SLIP10Node';
@@ -4,0 +4,0 @@ declare type ErrorHandler = (error: unknown, options: DeriveNodeArgs) => Promise<DeriveNodeArgs>;

dist/types/derivers/slip10.d.ts

@@ -1,3 +0,3 @@
-import { DeriveChildKeyArgs } from '.';
-import { SLIP10Node } from '../SLIP10Node';
+import type { DeriveChildKeyArgs } from '.';
+import type { SLIP10Node } from '../SLIP10Node';
 /**
@@ -4,0 +4,0 @@ * Derive a SLIP-10 child key with a given path from a parent key.

dist/types/index.d.ts

@@ -11,3 +11,4 @@ export type { BIP44NodeInterface, JsonBIP44Node, BIP44ExtendedKeyOptions, BIP44DerivationPathOptions, } from './BIP44Node';
 export type { CoinTypeToAddressIndices } from './utils';
-export { isValidBIP32PathSegment } from './utils';
+export { isValidBIP32PathSegment, mnemonicPhraseToBytes } from './utils';
+export { createBip39KeyFromSeed } from './derivers';
 //# sourceMappingURL=index.d.ts.map

dist/types/SLIP10Node.d.ts

@@ -1,5 +0,5 @@
-import { BIP44CoinTypeNode } from './BIP44CoinTypeNode';
-import { BIP44Node } from './BIP44Node';
-import { RootedSLIP10PathTuple, SLIP10PathTuple } from './constants';
-import { SupportedCurve } from './curves';
+import type { BIP44CoinTypeNode } from './BIP44CoinTypeNode';
+import type { BIP44Node } from './BIP44Node';
+import type { RootedSLIP10PathTuple, SLIP10PathTuple } from './constants';
+import type { SupportedCurve } from './curves';
 /**
@@ -6,0 +6,0 @@ * A wrapper for SLIP-10 Hierarchical Deterministic (HD) tree nodes, i.e.

dist/types/utils.d.ts

@@ -1,3 +0,3 @@
-import { BIP32Node, ChangeHDPathString, CoinTypeHDPathString, CoinTypeToAddressTuple, HardenedBIP32Node, UnhardenedBIP32Node, UnprefixedNode } from './constants';
-import { SupportedCurve } from './curves';
+import type { BIP32Node, ChangeHDPathString, CoinTypeHDPathString, CoinTypeToAddressTuple, HardenedBIP32Node, UnhardenedBIP32Node, UnprefixedNode } from './constants';
+import type { SupportedCurve } from './curves';
 /**
@@ -4,0 +4,0 @@ * Gets a string representation of a BIP-44 path of depth 2, i.e.:

package.json

 {
   "name": "@metamask/key-tree",
-  "version": "8.0.0",
+  "version": "9.0.0",
   "description": "An interface over BIP-32 and BIP-39 key derivation paths",
@@ -15,2 +15,10 @@ "homepage": "https://github.com/MetaMask/key-tree#readme",
   "author": "kumavis",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "main": "./dist/cjs/index.js",
@@ -29,7 +37,7 @@ "module": "./dist/esm/index.js",
     "build:docs": "typedoc",
-    "build:esm": "swc src --out-dir dist/esm --config-file .swcrc.build.json --config module.type=es6",
+    "build:esm": "swc src --out-dir dist/esm --config-file .swcrc.build.json --config module.type=es6 && yarn build:esm:package",
+    "build:esm:package": "echo >dist/esm/package.json \"{\\\"type\\\":\\\"module\\\"}\"",
     "build:source": "yarn build:esm && yarn build:cjs",
     "build:types": "tsc --project tsconfig.build.json",
     "generate-vectors": "ts-node scripts/generate-vectors.ts > ./test/vectors/derivation.json",
-    "postinstall": "simple-git-hooks",
     "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check && yarn lint:dependencies --check && yarn lint:changelog",
@@ -46,13 +54,2 @@ "lint:changelog": "auto-changelog validate",
   },
-  "simple-git-hooks": {
-    "pre-commit": "yarn lint-staged && yarn dedupe --check"
-  },
-  "lint-staged": {
-    "*.{js,ts}": [
-      "eslint --fix"
-    ],
-    "!(CHANGELOG).{json,yml,md}": [
-      "prettier --write"
-    ]
-  },
   "dependencies": {
@@ -70,6 +67,6 @@ "@metamask/scure-bip39": "^2.1.0",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eslint-config": "^11.0.1",
-    "@metamask/eslint-config-jest": "^11.0.0",
-    "@metamask/eslint-config-nodejs": "^11.0.1",
-    "@metamask/eslint-config-typescript": "^11.0.0",
+    "@metamask/eslint-config": "^12.0.0",
+    "@metamask/eslint-config-jest": "^12.0.0",
+    "@metamask/eslint-config-nodejs": "^12.0.0",
+    "@metamask/eslint-config-typescript": "^12.0.0",
     "@swc/cli": "^0.1.62",
@@ -82,16 +79,15 @@ "@swc/core": "^1.3.66",
     "depcheck": "^1.4.3",
-    "eslint": "^8.27.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.5",
-    "eslint-plugin-jsdoc": "^39.6.2",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "~2.26.0",
+    "eslint-plugin-jest": "^27.2.2",
+    "eslint-plugin-jsdoc": "^39.9.1",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
     "jest": "^28.1.3",
     "jest-it-up": "^2.0.2",
-    "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.3.0",
     "rimraf": "^3.0.2",
-    "simple-git-hooks": "^2.8.0",
     "ts-jest": "^28.0.7",
@@ -113,4 +109,2 @@ "ts-node": "^10.9.1",
       "@lavamoat/preinstall-always-fail": false,
-      "$root$": false,
-      "simple-git-hooks": false,
       "@swc/core": true
@@ -117,0 +111,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

569809

increased by0.59%

Dev dependency count

31

decreased by-3.12%

Number of package files

107

increased by0.94%

Lines of code

5860

increased by0.36%

Number of high supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes