From e113155fae248e75bb5afcf24eff518b8fdb4a71 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 25 Oct 2023 02:11:04 +0000 Subject: [PATCH 1/3] 1.1.0 --- CHANGELOG.md | 58 ++++++++++++++++++++-------------------------------- package.json | 2 +- 2 files changed, 23 insertions(+), 37 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7348021ca..1ae57af42 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,4 @@ # Changelog - All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -7,66 +6,69 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [1.0.0] +## [1.1.0] +### Uncategorized +- chore(deps): bump @metamask/snaps-utils from 3.0.0 to 3.1.0 ([#169](https://github.com/MetaMask/keyring-api/pull/169)) +- docs: minor fixes to the docs ([#174](https://github.com/MetaMask/keyring-api/pull/174)) +- chore: add missing "Keyring" to docs ([#173](https://github.com/MetaMask/keyring-api/pull/173)) +- docs: update MetaMask version and remove admonitions ([#172](https://github.com/MetaMask/keyring-api/pull/172)) +- chore(deps-dev): bump @metamask/auto-changelog from 3.4.0 to 3.4.1 ([#168](https://github.com/MetaMask/keyring-api/pull/168)) +- chore(deps): bump @metamask/snaps-ui from 3.0.0 to 3.0.1 ([#171](https://github.com/MetaMask/keyring-api/pull/171)) +- test: enable lcov report exporter ([#161](https://github.com/MetaMask/keyring-api/pull/161)) +- feat: define `UuidStruct` as a named type ([#159](https://github.com/MetaMask/keyring-api/pull/159)) +- chore(deps): bump @babel/traverse from 7.22.5 to 7.23.2 ([#163](https://github.com/MetaMask/keyring-api/pull/163)) +- chore(deps-dev): bump @metamask/auto-changelog from 3.3.0 to 3.4.0 ([#165](https://github.com/MetaMask/keyring-api/pull/165)) +- chore(deps): bump @metamask/json-rpc-engine from 7.1.1 to 7.2.0 ([#164](https://github.com/MetaMask/keyring-api/pull/164)) +- fix: allow the request ID to be a string, number or null ([#156](https://github.com/MetaMask/keyring-api/pull/156)) +- docs: add guideline to sanitize errors ([#160](https://github.com/MetaMask/keyring-api/pull/160)) +- fix: use `UuidStruct` for IDs in the internap API ([#158](https://github.com/MetaMask/keyring-api/pull/158)) +- refactor: move internal RPC methods to `rpc.ts` ([#157](https://github.com/MetaMask/keyring-api/pull/157)) +- chore(deps): bump @metamask/snaps-registry from 2.0.0 to 2.1.0 ([#155](https://github.com/MetaMask/keyring-api/pull/155)) +- chore(deps): bump @metamask/providers from 13.0.0 to 13.1.0 ([#153](https://github.com/MetaMask/keyring-api/pull/153)) +## [1.0.0] ### Added - - Add migration steps to 1.0.0 ([#149](https://github.com/MetaMask/keyring-api/pull/149)). - Add Account Snaps security guidelines ([#143](https://github.com/MetaMask/keyring-api/pull/143)). ### Changed - - Bump @metamask/rpc-errors from 6.0.0 to 6.1.0 ([#151](https://github.com/MetaMask/keyring-api/pull/151)). - Bump postcss from 8.4.24 to 8.4.31 ([#150](https://github.com/MetaMask/keyring-api/pull/150)). ## [1.0.0-rc.1] - ### Added - - Document how to migrate from API 0.1.x to 0.2.x ([#124](https://github.com/MetaMask/keyring-api/pull/124)). ### Changed - - **BREAKING:** Use the `onKeyringRequest` snap export ([#145](https://github.com/MetaMask/keyring-api/pull/145)). - **BREAKING:** Change the events' prefix to `notify:` ([#139](https://github.com/MetaMask/keyring-api/pull/139)). ## [0.2.7] - ### Added - - Export events types ([#125](https://github.com/MetaMask/keyring-api/pull/125)) ## [0.2.6] - ### Changed - - Remove unused lavamoat allowed scripts ([#122](https://github.com/MetaMask/keyring-api/pull/122)). - Update events in sequence diagram ([#121](https://github.com/MetaMask/keyring-api/pull/121)). - Update Snap and ESLint dependencies ([#117](https://github.com/MetaMask/keyring-api/pull/117)). - Bump @metamask/rpc-methods from 0.38.1-flask.1 to 2.0.0 ([#120](https://github.com/MetaMask/keyring-api/pull/120)). ## [0.2.5] - ### Changed - - Remove `buildHandlersChain` ([#114](https://github.com/MetaMask/keyring-api/pull/114)). - Update doc for `eth_signTransaction` ([#111](https://github.com/MetaMask/keyring-api/pull/111)). - Remove un-versioned `eth_signTypedData` method ([#113](https://github.com/MetaMask/keyring-api/pull/113)). ## [0.2.4] - ### Changed - - Fix linting and compatibility with older `tsc` ([#108](https://github.com/MetaMask/keyring-api/pull/108)). ## [0.2.3] - ### Added - - Add redirection message to snap async response ([#102](https://github.com/MetaMask/keyring-api/pull/102)). ### Changed - - Use `Omit` instead of `OmitUnion` ([#106](https://github.com/MetaMask/keyring-api/pull/106)). - Update `KeyringResponse` comment ([#103](https://github.com/MetaMask/keyring-api/pull/103)). - Use `KeyringRpcMethod` enum instead of string ([#105](https://github.com/MetaMask/keyring-api/pull/105)). @@ -76,28 +78,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Bump @metamask/providers from 11.1.1 to 11.1.2 ([#98](https://github.com/MetaMask/keyring-api/pull/98)). ## [0.2.2] - ### Added - - Add architecture and EVM methods docs ([#86](https://github.com/MetaMask/keyring-api/pull/86)). - Add `lastSelected` and `lastActive` to metadata ([#92](https://github.com/MetaMask/keyring-api/pull/92)). ### Changed - - Make request `params` optional ([#96](https://github.com/MetaMask/keyring-api/pull/96)). - Remove `lastActive` field from internal account model ([#95](https://github.com/MetaMask/keyring-api/pull/95)). - Move request ID to outer request ([#94](https://github.com/MetaMask/keyring-api/pull/94)). ## [0.2.1] - ### Changed - - Set `snap` object keys to be mandatory and move `name` to `metadata` ([#87](https://github.com/MetaMask/keyring-api/pull/87)). ## [0.2.0] - ### Added - - Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65)). - Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74)). - Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75)). @@ -105,7 +100,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43)). ### Changed - - Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42)). - Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30)). - Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63)). @@ -117,38 +111,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35)). ## [0.1.3] - ### Changed - - Downgrade snaps dependencies to `0.35.2-flask.1` ([#25](https://github.com/MetaMask/keyring-api/pull/25)). ## [0.1.2] - ### Changed - - Update snaps dependencies ([#21](https://github.com/MetaMask/keyring-api/pull/21)). ## [0.1.1] - ### Added - - Validate snap responses for type correctness ([#15](https://github.com/MetaMask/keyring-api/pull/15)). ### Changed - - Rename RPC handling functions ([#16](https://github.com/MetaMask/keyring-api/pull/16)). ## [0.1.0] - 2023-06-20 - ### Added - - Usage examples to [`README.md`](./README.md). - Keyring API definition. - JSON-RPC snap keyring client. It is intended to be used by a snap's companion dapp to send requests to the snap. - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap. - Helper functions to create keyring handler in the snap. -[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v1.0.0...HEAD +[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v1.1.0...HEAD +[1.1.0]: https://github.com/MetaMask/keyring-api/compare/v1.0.0...v1.1.0 [1.0.0]: https://github.com/MetaMask/keyring-api/compare/v1.0.0-rc.1...v1.0.0 [1.0.0-rc.1]: https://github.com/MetaMask/keyring-api/compare/v0.2.7...v1.0.0-rc.1 [0.2.7]: https://github.com/MetaMask/keyring-api/compare/v0.2.6...v0.2.7 diff --git a/package.json b/package.json index 7c17a0e63..91e3fd348 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@metamask/keyring-api", - "version": "1.0.0", + "version": "1.1.0", "description": "MetaMask Keyring API", "keywords": [ "metamask", From b234789414960f87366a8cf508d5054fd45c76ef Mon Sep 17 00:00:00 2001 From: legobt <6wbvkn0j@anonaddy.me> Date: Wed, 25 Oct 2023 18:32:06 +0000 Subject: [PATCH 2/3] update changelog --- CHANGELOG.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ae57af42..551467a36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,24 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ## [1.1.0] -### Uncategorized -- chore(deps): bump @metamask/snaps-utils from 3.0.0 to 3.1.0 ([#169](https://github.com/MetaMask/keyring-api/pull/169)) -- docs: minor fixes to the docs ([#174](https://github.com/MetaMask/keyring-api/pull/174)) -- chore: add missing "Keyring" to docs ([#173](https://github.com/MetaMask/keyring-api/pull/173)) -- docs: update MetaMask version and remove admonitions ([#172](https://github.com/MetaMask/keyring-api/pull/172)) -- chore(deps-dev): bump @metamask/auto-changelog from 3.4.0 to 3.4.1 ([#168](https://github.com/MetaMask/keyring-api/pull/168)) -- chore(deps): bump @metamask/snaps-ui from 3.0.0 to 3.0.1 ([#171](https://github.com/MetaMask/keyring-api/pull/171)) -- test: enable lcov report exporter ([#161](https://github.com/MetaMask/keyring-api/pull/161)) -- feat: define `UuidStruct` as a named type ([#159](https://github.com/MetaMask/keyring-api/pull/159)) -- chore(deps): bump @babel/traverse from 7.22.5 to 7.23.2 ([#163](https://github.com/MetaMask/keyring-api/pull/163)) -- chore(deps-dev): bump @metamask/auto-changelog from 3.3.0 to 3.4.0 ([#165](https://github.com/MetaMask/keyring-api/pull/165)) -- chore(deps): bump @metamask/json-rpc-engine from 7.1.1 to 7.2.0 ([#164](https://github.com/MetaMask/keyring-api/pull/164)) -- fix: allow the request ID to be a string, number or null ([#156](https://github.com/MetaMask/keyring-api/pull/156)) -- docs: add guideline to sanitize errors ([#160](https://github.com/MetaMask/keyring-api/pull/160)) -- fix: use `UuidStruct` for IDs in the internap API ([#158](https://github.com/MetaMask/keyring-api/pull/158)) -- refactor: move internal RPC methods to `rpc.ts` ([#157](https://github.com/MetaMask/keyring-api/pull/157)) -- chore(deps): bump @metamask/snaps-registry from 2.0.0 to 2.1.0 ([#155](https://github.com/MetaMask/keyring-api/pull/155)) -- chore(deps): bump @metamask/providers from 13.0.0 to 13.1.0 ([#153](https://github.com/MetaMask/keyring-api/pull/153)) + +### Changed +- `UuidStruct` is now a named type ([#159](https://github.com/MetaMask/keyring-api/pull/159)) +- Migrate from `@metamask/rpc-methods` to `@metamask/snaps-rpc-methods` ([#175](https://github.com/MetaMask/keyring-api/pull/175)) + +### Fixed +- Allow the request ID to be a string, number or null ([#156](https://github.com/MetaMask/keyring-api/pull/156)) +- Documentation fixes ([#160](https://github.com/MetaMask/keyring-api/pull/160)) ([#174](https://github.com/MetaMask/keyring-api/pull/174)) ([#173](https://github.com/MetaMask/keyring-api/pull/173)) ([#172](https://github.com/MetaMask/keyring-api/pull/172)) +- Use `UuidStruct` for IDs in the internal API ([#158](https://github.com/MetaMask/keyring-api/pull/158)) +- Bump `@metamask/json-rpc-engine` from `^7.1.1` to `^7.2.0` ([#164](https://github.com/MetaMask/keyring-api/pull/164)) ## [1.0.0] ### Added From b8f91d560d0d093d325d939cab5278ba10e877eb Mon Sep 17 00:00:00 2001 From: legobt <6wbvkn0j@anonaddy.me> Date: Wed, 25 Oct 2023 23:28:28 +0000 Subject: [PATCH 3/3] lint changelog --- CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 551467a36..3a9b9ca2c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -9,58 +10,77 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [1.1.0] ### Changed + - `UuidStruct` is now a named type ([#159](https://github.com/MetaMask/keyring-api/pull/159)) - Migrate from `@metamask/rpc-methods` to `@metamask/snaps-rpc-methods` ([#175](https://github.com/MetaMask/keyring-api/pull/175)) ### Fixed + - Allow the request ID to be a string, number or null ([#156](https://github.com/MetaMask/keyring-api/pull/156)) - Documentation fixes ([#160](https://github.com/MetaMask/keyring-api/pull/160)) ([#174](https://github.com/MetaMask/keyring-api/pull/174)) ([#173](https://github.com/MetaMask/keyring-api/pull/173)) ([#172](https://github.com/MetaMask/keyring-api/pull/172)) - Use `UuidStruct` for IDs in the internal API ([#158](https://github.com/MetaMask/keyring-api/pull/158)) - Bump `@metamask/json-rpc-engine` from `^7.1.1` to `^7.2.0` ([#164](https://github.com/MetaMask/keyring-api/pull/164)) ## [1.0.0] + ### Added + - Add migration steps to 1.0.0 ([#149](https://github.com/MetaMask/keyring-api/pull/149)). - Add Account Snaps security guidelines ([#143](https://github.com/MetaMask/keyring-api/pull/143)). ### Changed + - Bump @metamask/rpc-errors from 6.0.0 to 6.1.0 ([#151](https://github.com/MetaMask/keyring-api/pull/151)). - Bump postcss from 8.4.24 to 8.4.31 ([#150](https://github.com/MetaMask/keyring-api/pull/150)). ## [1.0.0-rc.1] + ### Added + - Document how to migrate from API 0.1.x to 0.2.x ([#124](https://github.com/MetaMask/keyring-api/pull/124)). ### Changed + - **BREAKING:** Use the `onKeyringRequest` snap export ([#145](https://github.com/MetaMask/keyring-api/pull/145)). - **BREAKING:** Change the events' prefix to `notify:` ([#139](https://github.com/MetaMask/keyring-api/pull/139)). ## [0.2.7] + ### Added + - Export events types ([#125](https://github.com/MetaMask/keyring-api/pull/125)) ## [0.2.6] + ### Changed + - Remove unused lavamoat allowed scripts ([#122](https://github.com/MetaMask/keyring-api/pull/122)). - Update events in sequence diagram ([#121](https://github.com/MetaMask/keyring-api/pull/121)). - Update Snap and ESLint dependencies ([#117](https://github.com/MetaMask/keyring-api/pull/117)). - Bump @metamask/rpc-methods from 0.38.1-flask.1 to 2.0.0 ([#120](https://github.com/MetaMask/keyring-api/pull/120)). ## [0.2.5] + ### Changed + - Remove `buildHandlersChain` ([#114](https://github.com/MetaMask/keyring-api/pull/114)). - Update doc for `eth_signTransaction` ([#111](https://github.com/MetaMask/keyring-api/pull/111)). - Remove un-versioned `eth_signTypedData` method ([#113](https://github.com/MetaMask/keyring-api/pull/113)). ## [0.2.4] + ### Changed + - Fix linting and compatibility with older `tsc` ([#108](https://github.com/MetaMask/keyring-api/pull/108)). ## [0.2.3] + ### Added + - Add redirection message to snap async response ([#102](https://github.com/MetaMask/keyring-api/pull/102)). ### Changed + - Use `Omit` instead of `OmitUnion` ([#106](https://github.com/MetaMask/keyring-api/pull/106)). - Update `KeyringResponse` comment ([#103](https://github.com/MetaMask/keyring-api/pull/103)). - Use `KeyringRpcMethod` enum instead of string ([#105](https://github.com/MetaMask/keyring-api/pull/105)). @@ -70,21 +90,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Bump @metamask/providers from 11.1.1 to 11.1.2 ([#98](https://github.com/MetaMask/keyring-api/pull/98)). ## [0.2.2] + ### Added + - Add architecture and EVM methods docs ([#86](https://github.com/MetaMask/keyring-api/pull/86)). - Add `lastSelected` and `lastActive` to metadata ([#92](https://github.com/MetaMask/keyring-api/pull/92)). ### Changed + - Make request `params` optional ([#96](https://github.com/MetaMask/keyring-api/pull/96)). - Remove `lastActive` field from internal account model ([#95](https://github.com/MetaMask/keyring-api/pull/95)). - Move request ID to outer request ([#94](https://github.com/MetaMask/keyring-api/pull/94)). ## [0.2.1] + ### Changed + - Set `snap` object keys to be mandatory and move `name` to `metadata` ([#87](https://github.com/MetaMask/keyring-api/pull/87)). ## [0.2.0] + ### Added + - Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65)). - Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74)). - Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75)). @@ -92,6 +119,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43)). ### Changed + - Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42)). - Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30)). - Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63)). @@ -103,22 +131,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35)). ## [0.1.3] + ### Changed + - Downgrade snaps dependencies to `0.35.2-flask.1` ([#25](https://github.com/MetaMask/keyring-api/pull/25)). ## [0.1.2] + ### Changed + - Update snaps dependencies ([#21](https://github.com/MetaMask/keyring-api/pull/21)). ## [0.1.1] + ### Added + - Validate snap responses for type correctness ([#15](https://github.com/MetaMask/keyring-api/pull/15)). ### Changed + - Rename RPC handling functions ([#16](https://github.com/MetaMask/keyring-api/pull/16)). ## [0.1.0] - 2023-06-20 + ### Added + - Usage examples to [`README.md`](./README.md). - Keyring API definition. - JSON-RPC snap keyring client. It is intended to be used by a snap's companion dapp to send requests to the snap.