From ff517b6f91d757f95fa173c258cd4270ff36e1e1 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 30 Nov 2022 15:14:17 +0000 Subject: [PATCH 1/6] 8.1.0 --- CHANGELOG.md | 9 ++++++++- package.json | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6380b8fe..38e3df5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [8.1.0] +### Uncategorized +- Fix: saving serialized keyring for which corresponding keyring class is not present ([#169](https://github.com/MetaMask/KeyringController/pull/169)) +- Bump @metamask/auto-changelog from 3.0.0 to 3.1.0 ([#165](https://github.com/MetaMask/KeyringController/pull/165)) +- Bump @metamask/browser-passworder from 4.0.1 to 4.0.2 ([#164](https://github.com/MetaMask/KeyringController/pull/164)) + ## [8.0.1] ### Fixed - Restore full state return value ([#161](https://github.com/MetaMask/KeyringController/pull/161)) @@ -58,7 +64,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Validate user imported seedphrase across all bip39 wordlists ([#77](https://github.com/MetaMask/KeyringController/pull/77)) -[Unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.0.1...HEAD +[Unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.1.0...HEAD +[8.1.0]: https://github.com/MetaMask/KeyringController/compare/v8.0.1...v8.1.0 [8.0.1]: https://github.com/MetaMask/KeyringController/compare/v8.0.0...v8.0.1 [8.0.0]: https://github.com/MetaMask/KeyringController/compare/v7.0.2...v8.0.0 [7.0.2]: https://github.com/MetaMask/KeyringController/compare/v7.0.1...v7.0.2 diff --git a/package.json b/package.json index bb90c5c2..f3cbf86c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "eth-keyring-controller", - "version": "8.0.1", + "version": "8.1.0", "description": "A module for managing various keyrings of Ethereum accounts, encrypting them, and using them.", "keywords": [ "ethereum", From 71ff59c6dcd3430aabfd9fd1fe65f7a6f2000c60 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Wed, 30 Nov 2022 20:51:11 +0530 Subject: [PATCH 2/6] Update changelog --- CHANGELOG.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38e3df5e..cf71993a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,10 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ## [8.1.0] -### Uncategorized +### Added - Fix: saving serialized keyring for which corresponding keyring class is not present ([#169](https://github.com/MetaMask/KeyringController/pull/169)) -- Bump @metamask/auto-changelog from 3.0.0 to 3.1.0 ([#165](https://github.com/MetaMask/KeyringController/pull/165)) -- Bump @metamask/browser-passworder from 4.0.1 to 4.0.2 ([#164](https://github.com/MetaMask/KeyringController/pull/164)) ## [8.0.1] ### Fixed From 57c64809fbafc856ece261104fefa44e9d8bee9e Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Thu, 1 Dec 2022 10:47:25 +0530 Subject: [PATCH 3/6] Update CHANGELOG.md Co-authored-by: Mark Stacey --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf71993a..23a82d36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [8.1.0] ### Added -- Fix: saving serialized keyring for which corresponding keyring class is not present ([#169](https://github.com/MetaMask/KeyringController/pull/169)) +- Allow deserializing vaults with unrecognized keyrings ([#169](https://github.com/MetaMask/KeyringController/pull/169)) + - When deserializing a vault with an unrecognized keyring, the controller will no longer crash. The unrecogized keyring vault data will be preserved in the vault for future use, but will otherwise be ignored. ## [8.0.1] ### Fixed From c102eeaa96fb4b3b56d667e665b18e6d62c2978b Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Thu, 1 Dec 2022 10:48:16 +0530 Subject: [PATCH 4/6] Update changelog --- CHANGELOG.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 23a82d36..74f0e425 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/), @@ -7,12 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ## [8.1.0] -### Added + +### Changed + - Allow deserializing vaults with unrecognized keyrings ([#169](https://github.com/MetaMask/KeyringController/pull/169)) - When deserializing a vault with an unrecognized keyring, the controller will no longer crash. The unrecogized keyring vault data will be preserved in the vault for future use, but will otherwise be ignored. ## [8.0.1] + ### Fixed + - Restore full state return value ([#161](https://github.com/MetaMask/KeyringController/pull/161)) - Some methods were accidentally changed in v8.0.0 to return nothing, where previously they returned the full KeyringController state. - The affected methods were: @@ -24,7 +29,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - They now all return the full state, just as they did in earlier versions. ## [8.0.0] [DEPRECATED] + ### Added + - Allow login with encryption key rather than password ([#152](https://github.com/MetaMask/KeyringController/pull/152)) - This is required to support MetaMask extension builds using manifest v3. - This is enabled via the option `cacheEncryptionKey`. @@ -34,36 +41,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - The `unlockKeyrings` method now accepts additional parameters for the encryption key and salt, though we don't recommend using this method directly. ### Changed + - **BREAKING:** Update minimum Node.js version to v14 ([#146](https://github.com/MetaMask/KeyringController/pull/146)) - **BREAKING:**: Remove password parameter from `persistAllKeyrings` and `createFirstKeyTree` ([#154](https://github.com/MetaMask/KeyringController/pull/154)) - The password or encryption key must now be set already before these method are called. It is set by `createNewVaultAndKeychain`, `createNewVaultAndRestore`, and `submitPassword`/`submitEncryptionKey`. - This change was made to reduce redundant state changes. ### Fixed + - Fix a typo in the duplicate account import error ([#153](https://github.com/MetaMask/KeyringController/pull/153)) ## [7.0.2] + ### Fixed + - `createNewVaultAndRestore` now accepts a seedphrase formatted as an array of numbers ([#138](https://github.com/MetaMask/KeyringController/pull/138)) ## [7.0.1] + ### Fixed + - Fix breaking change in `addNewKeyring` function that was accidentally introduced in v7.0.0 ([#136](https://github.com/MetaMask/KeyringController/pull/136)) - We updated the method such that keyrings were always constructed with constructor arguments, defaulting to an empty object if none were provided. But some keyrings ([such as the QR Keyring](https://github.com/KeystoneHQ/keystone-airgaped-base/blob/c5e2d06892118265ec2ee613b543095276d5b208/packages/base-eth-keyring/src/BaseKeyring.ts#L290)) relied upon the options being undefined in some cases. ## [7.0.0] + ### Added + - Add forget Keyring method for some hardware devices ([#124](https://github.com/MetaMask/KeyringController/pull/124)) - Add `@lavamoat/allow-scripts` ([#109](https://github.com/MetaMask/KeyringController/pull/109)) ### Changed + - **BREAKING**: Bump eth-hd-keyring to latest version ([#132](https://github.com/MetaMask/KeyringController/pull/132)) - - When calling the `addNewKeyring` method, an options object can no longer be passed containing a `numberOfAccounts` property without also including a `mnemonic`. Not adding any option argument will result in the generation of a new mnemonic and the addition of 1 account derived from that mnemonic to the keyring. + - When calling the `addNewKeyring` method, an options object can no longer be passed containing a `numberOfAccounts` property without also including a `mnemonic`. Not adding any option argument will result in the generation of a new mnemonic and the addition of 1 account derived from that mnemonic to the keyring. - When calling `createNewVaultAndKeychain` all keyrings are cleared first thing ([#129](https://github.com/MetaMask/KeyringController/pull/129)) - Validate user imported seedphrase across all bip39 wordlists ([#77](https://github.com/MetaMask/KeyringController/pull/77)) - -[Unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.1.0...HEAD +[unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.1.0...HEAD [8.1.0]: https://github.com/MetaMask/KeyringController/compare/v8.0.1...v8.1.0 [8.0.1]: https://github.com/MetaMask/KeyringController/compare/v8.0.0...v8.0.1 [8.0.0]: https://github.com/MetaMask/KeyringController/compare/v7.0.2...v8.0.0 From 94222d5299f06a8e9042cf8d1c5a3b3d22aceb40 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Thu, 1 Dec 2022 10:52:05 +0530 Subject: [PATCH 5/6] Update changelog --- CHANGELOG.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 74f0e425..46efadd4 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/), @@ -8,16 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ## [8.1.0] - ### Changed - - Allow deserializing vaults with unrecognized keyrings ([#169](https://github.com/MetaMask/KeyringController/pull/169)) - When deserializing a vault with an unrecognized keyring, the controller will no longer crash. The unrecogized keyring vault data will be preserved in the vault for future use, but will otherwise be ignored. ## [8.0.1] - ### Fixed - - Restore full state return value ([#161](https://github.com/MetaMask/KeyringController/pull/161)) - Some methods were accidentally changed in v8.0.0 to return nothing, where previously they returned the full KeyringController state. - The affected methods were: @@ -29,9 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - They now all return the full state, just as they did in earlier versions. ## [8.0.0] [DEPRECATED] - ### Added - - Allow login with encryption key rather than password ([#152](https://github.com/MetaMask/KeyringController/pull/152)) - This is required to support MetaMask extension builds using manifest v3. - This is enabled via the option `cacheEncryptionKey`. @@ -41,44 +34,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - The `unlockKeyrings` method now accepts additional parameters for the encryption key and salt, though we don't recommend using this method directly. ### Changed - - **BREAKING:** Update minimum Node.js version to v14 ([#146](https://github.com/MetaMask/KeyringController/pull/146)) - **BREAKING:**: Remove password parameter from `persistAllKeyrings` and `createFirstKeyTree` ([#154](https://github.com/MetaMask/KeyringController/pull/154)) - The password or encryption key must now be set already before these method are called. It is set by `createNewVaultAndKeychain`, `createNewVaultAndRestore`, and `submitPassword`/`submitEncryptionKey`. - This change was made to reduce redundant state changes. ### Fixed - - Fix a typo in the duplicate account import error ([#153](https://github.com/MetaMask/KeyringController/pull/153)) ## [7.0.2] - ### Fixed - - `createNewVaultAndRestore` now accepts a seedphrase formatted as an array of numbers ([#138](https://github.com/MetaMask/KeyringController/pull/138)) ## [7.0.1] - ### Fixed - - Fix breaking change in `addNewKeyring` function that was accidentally introduced in v7.0.0 ([#136](https://github.com/MetaMask/KeyringController/pull/136)) - We updated the method such that keyrings were always constructed with constructor arguments, defaulting to an empty object if none were provided. But some keyrings ([such as the QR Keyring](https://github.com/KeystoneHQ/keystone-airgaped-base/blob/c5e2d06892118265ec2ee613b543095276d5b208/packages/base-eth-keyring/src/BaseKeyring.ts#L290)) relied upon the options being undefined in some cases. ## [7.0.0] - ### Added - - Add forget Keyring method for some hardware devices ([#124](https://github.com/MetaMask/KeyringController/pull/124)) - Add `@lavamoat/allow-scripts` ([#109](https://github.com/MetaMask/KeyringController/pull/109)) ### Changed - - **BREAKING**: Bump eth-hd-keyring to latest version ([#132](https://github.com/MetaMask/KeyringController/pull/132)) - - When calling the `addNewKeyring` method, an options object can no longer be passed containing a `numberOfAccounts` property without also including a `mnemonic`. Not adding any option argument will result in the generation of a new mnemonic and the addition of 1 account derived from that mnemonic to the keyring. + - When calling the `addNewKeyring` method, an options object can no longer be passed containing a `numberOfAccounts` property without also including a `mnemonic`. Not adding any option argument will result in the generation of a new mnemonic and the addition of 1 account derived from that mnemonic to the keyring. - When calling `createNewVaultAndKeychain` all keyrings are cleared first thing ([#129](https://github.com/MetaMask/KeyringController/pull/129)) - Validate user imported seedphrase across all bip39 wordlists ([#77](https://github.com/MetaMask/KeyringController/pull/77)) -[unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.1.0...HEAD + +[Unreleased]: https://github.com/MetaMask/KeyringController/compare/v8.1.0...HEAD [8.1.0]: https://github.com/MetaMask/KeyringController/compare/v8.0.1...v8.1.0 [8.0.1]: https://github.com/MetaMask/KeyringController/compare/v8.0.0...v8.0.1 [8.0.0]: https://github.com/MetaMask/KeyringController/compare/v7.0.2...v8.0.0 From f1b904b7141cc145481c71f3cb7fc36335c5c847 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Thu, 1 Dec 2022 22:47:42 +0530 Subject: [PATCH 6/6] Update CHANGELOG.md Co-authored-by: Elliot Winkler --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46efadd4..51af87d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [8.1.0] ### Changed - Allow deserializing vaults with unrecognized keyrings ([#169](https://github.com/MetaMask/KeyringController/pull/169)) - - When deserializing a vault with an unrecognized keyring, the controller will no longer crash. The unrecogized keyring vault data will be preserved in the vault for future use, but will otherwise be ignored. + - When deserializing a vault with an unrecognized keyring, the controller will no longer crash. The unrecognized keyring vault data will be preserved in the vault for future use, but will otherwise be ignored. ## [8.0.1] ### Fixed