@metamask/slip44 2.1.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +15 -1
  2. package/README.md +30 -20
  3. package/package.json +30 -25
  4. package/slip44.json +1317 -3157
package/CHANGELOG.md CHANGED
@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [3.0.0]
10
+ ### Changed
11
+ - **BREAKING:** Require Node 14 or higher ([#28](https://github.com/MetaMask/slip44/pull/28))
12
+ - Update with latest data as of 2023-04-24 ([#68](https://github.com/MetaMask/slip44/pull/68))
13
+
14
+ ### Removed
15
+ - **BREAKING:** Removed `link` property as it was removed in the SLIP-44 document ([#25](https://github.com/MetaMask/slip44/pull/25))
16
+
17
+ ## [2.2.0]
18
+ ### Changed
19
+ - Update with latest SLIP-44 data as of 2022-08-07 ([#14](https://github.com/MetaMask/slip44/pull/14))
20
+
9
21
  ## [2.1.0]
10
22
  ### Changed
11
23
  - Update SLIP-44 data ([#3](https://github.com/MetaMask/slip44/pull/3))
@@ -26,7 +38,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
26
38
  ### Changed
27
39
  - Initial release.
28
40
 
29
- [Unreleased]: https://github.com/MetaMask/slip44/compare/v2.1.0...HEAD
41
+ [Unreleased]: https://github.com/MetaMask/slip44/compare/v3.0.0...HEAD
42
+ [3.0.0]: https://github.com/MetaMask/slip44/compare/v2.2.0...v3.0.0
43
+ [2.2.0]: https://github.com/MetaMask/slip44/compare/v2.1.0...v2.2.0
30
44
  [2.1.0]: https://github.com/MetaMask/slip44/compare/v2.0.0...v2.1.0
31
45
  [2.0.0]: https://github.com/MetaMask/slip44/compare/v1.0.0...v2.0.0
32
46
  [1.0.0]: https://github.com/MetaMask/slip44/releases/tag/v1.0.0
package/README.md CHANGED
@@ -1,6 +1,15 @@
1
1
  # @metamask/slip44
2
2
 
3
- A simple mapping between [SLIP-44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) identifiers and the associated metadata, parsed directly from the repository linked above.
3
+ A simple mapping between [SLIP-44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
4
+ identifiers and the associated metadata, parsed directly from the repository linked above.
5
+
6
+ ## Installation
7
+
8
+ `yarn add @metamask/slip44`
9
+
10
+ or
11
+
12
+ `npm install @metamask/slip44`
4
13
 
5
14
  ## Usage
6
15
 
@@ -18,7 +27,6 @@ type Slip44 = {
18
27
  hex: `0x${string}`;
19
28
  symbol: string;
20
29
  name: string;
21
- link?: string;
22
30
  };
23
31
  };
24
32
  ```
@@ -27,15 +35,17 @@ type Slip44 = {
27
35
 
28
36
  ### Setup
29
37
 
30
- - Install [Node.js](https://nodejs.org) version 12
38
+ - Install [Node.js](https://nodejs.org) version 14
31
39
  - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
32
- - Install [Yarn v1](https://yarnpkg.com/en/docs/install)
33
- - Run `yarn setup` to install dependencies and run any requried post-install scripts
34
- - **Warning:** Do not use the `yarn` / `yarn install` command directly. Use `yarn setup` instead. The normal install command will skip required post-install scripts, leaving your development environment in an invalid state.
40
+ - Install [Yarn v3](https://yarnpkg.com/getting-started/install)
41
+ - Run `yarn install` to install dependencies and run any required post-install scripts
35
42
 
36
43
  ### Building
37
44
 
38
- To fetch the current SLIP-44 specification and re-generate the exported data, run `yarn build`.
45
+ To fetch the current SLIP-44 specification and re-generate the exported data, run `yarn rebuild`.
46
+
47
+ Note that the `yarn build` command simply rebuilds the JSON file from the raw Markdown committed to this repository.
48
+ `yarn rebuild` re-fetches the markdown (via `yarn fetch`) and then runs `yarn build`.
39
49
 
40
50
  ### Testing and Linting
41
51
 
@@ -49,34 +59,34 @@ The project follows the same release process as the other libraries in the MetaM
49
59
 
50
60
  1. Choose a release version.
51
61
 
52
- - The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
62
+ - The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
53
63
 
54
64
  2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. `1.x` for a `v1` backport release).
55
65
 
56
- - The major version branch should be set to the most recent release with that major version. For example, when backporting a `v1.0.2` release, you'd want to ensure there was a `1.x` branch that was set to the `v1.0.1` tag.
66
+ - The major version branch should be set to the most recent release with that major version. For example, when backporting a `v1.0.2` release, you'd want to ensure there was a `1.x` branch that was set to the `v1.0.1` tag.
57
67
 
58
68
  3. Trigger the [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event [manually](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow) for the `Create Release Pull Request` action to create the release PR.
59
69
 
60
- - For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
61
- - This should trigger the [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) workflow to create the release PR.
70
+ - For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
71
+ - This should trigger the [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) workflow to create the release PR.
62
72
 
63
73
  4. Update the changelog to move each change entry into the appropriate change category ([See here](https://keepachangelog.com/en/1.0.0/#types) for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
64
74
 
65
- - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
66
- - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
67
- - Consolidate related changes into one change entry if it makes it easier to explain.
68
- - Run `yarn auto-changelog validate --rc` to check that the changelog is correctly formatted.
75
+ - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
76
+ - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
77
+ - Consolidate related changes into one change entry if it makes it easier to explain.
78
+ - Run `yarn auto-changelog validate --rc` to check that the changelog is correctly formatted.
69
79
 
70
80
  5. Review and QA the release.
71
81
 
72
- - If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
82
+ - If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
73
83
 
74
84
  6. Squash & Merge the release.
75
85
 
76
- - This should trigger the [`action-publish-release`](https://github.com/MetaMask/action-publish-release) workflow to tag the final release commit and publish the release on GitHub.
86
+ - This should trigger the [`action-publish-release`](https://github.com/MetaMask/action-publish-release) workflow to tag the final release commit and publish the release on GitHub.
77
87
 
78
88
  7. Publish the release on npm.
79
89
 
80
- - Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
81
- - Use `npm publish --dry-run` to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using `https://unpkg.com/browse/[package name]@[package version]/`).
82
- - Once you are confident the release contents are correct, publish the release using `npm publish`.
90
+ - Wait for the `publish-release` GitHub Action workflow to finish. This should trigger a second job (`publish-npm`), which will wait for a run approval by the [`npm publishers`](https://github.com/orgs/MetaMask/teams/npm-publishers) team.
91
+ - Approve the `publish-npm` job (or ask somebody on the npm publishers team to approve it for you).
92
+ - Once the `publish-npm` job has finished, check npm to verify that it has been published.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/slip44",
3
- "version": "2.1.0",
3
+ "version": "3.0.0",
4
4
  "description": "A simple mapping between slip44 IDs and their network metadata.",
5
5
  "keywords": [
6
6
  "Blockchain",
@@ -22,42 +22,47 @@
22
22
  "slip44.json"
23
23
  ],
24
24
  "scripts": {
25
- "build": "./src/generate.sh",
25
+ "build": "node src/build.js",
26
+ "build:clean": "rm -f slip44.json && yarn build",
27
+ "fetch": "./scripts/fetch.sh",
26
28
  "lint": "yarn lint:eslint && yarn lint:misc --check",
27
29
  "lint:eslint": "eslint . --cache --ext js,ts",
28
30
  "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
29
- "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' --ignore-path .gitignore",
30
- "prepublishOnly": "yarn build && yarn lint && yarn test",
31
+ "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '!src/slip44.md' '**/*.yml' --ignore-path .gitignore",
32
+ "prepack": "./scripts/prepack.sh",
33
+ "rebuild": "yarn fetch && yarn build:clean",
34
+ "rebuild:ci": "./scripts/fetch-rebuild-push.sh",
31
35
  "setup": "yarn install && yarn allow-scripts",
32
36
  "test": "jest",
33
37
  "test:watch": "jest --watch"
34
38
  },
35
39
  "devDependencies": {
36
- "@lavamoat/allow-scripts": "^1.0.5",
37
- "@metamask/auto-changelog": "^2.3.0",
38
- "@metamask/eslint-config": "^9.0.0",
39
- "@metamask/eslint-config-jest": "^9.0.0",
40
- "@metamask/eslint-config-nodejs": "^9.0.0",
41
- "@metamask/eslint-config-typescript": "^9.0.1",
40
+ "@lavamoat/allow-scripts": "^2.1.0",
41
+ "@metamask/auto-changelog": "^3.0.0",
42
+ "@metamask/eslint-config": "^11.0.1",
43
+ "@metamask/eslint-config-jest": "^11.0.0",
44
+ "@metamask/eslint-config-nodejs": "^11.0.1",
45
+ "@metamask/eslint-config-typescript": "^11.0.0",
42
46
  "@types/jest": "^26.0.13",
43
- "@typescript-eslint/eslint-plugin": "^4.21.0",
44
- "@typescript-eslint/parser": "^4.21.0",
45
- "eslint": "^7.23.0",
46
- "eslint-config-prettier": "^8.1.0",
47
- "eslint-plugin-import": "^2.22.1",
48
- "eslint-plugin-jest": "^24.3.4",
49
- "eslint-plugin-jsdoc": "^36.1.0",
47
+ "@typescript-eslint/eslint-plugin": "^5.42.1",
48
+ "@typescript-eslint/parser": "^5.42.1",
49
+ "eslint": "^8.27.0",
50
+ "eslint-config-prettier": "^8.5.0",
51
+ "eslint-plugin-import": "^2.26.0",
52
+ "eslint-plugin-jest": "^27.1.5",
53
+ "eslint-plugin-jsdoc": "^39.6.2",
50
54
  "eslint-plugin-node": "^11.1.0",
51
- "eslint-plugin-prettier": "^3.3.1",
52
- "jest": "^26.4.2",
53
- "prettier": "^2.2.1",
54
- "prettier-plugin-packagejson": "^2.2.11",
55
+ "eslint-plugin-prettier": "^4.2.1",
56
+ "jest": "^28.1.3",
57
+ "prettier": "^2.7.1",
58
+ "prettier-plugin-packagejson": "^2.2.18",
55
59
  "rimraf": "^3.0.2",
56
- "ts-jest": "^26.3.0",
57
- "typescript": "^4.2.4"
60
+ "ts-jest": "^28.0.7",
61
+ "typescript": "~4.8.4"
58
62
  },
63
+ "packageManager": "yarn@3.2.4",
59
64
  "engines": {
60
- "node": ">=12.0.0"
65
+ "node": ">=14.0.0"
61
66
  },
62
67
  "publishConfig": {
63
68
  "access": "public",
@@ -68,4 +73,4 @@
68
73
  "@lavamoat/preinstall-always-fail": false
69
74
  }
70
75
  }
71
- }
76
+ }