Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 4.81 KB

CHANGELOG.md

File metadata and controls

72 lines (59 loc) · 4.81 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

8.1.0

Changed

  • Allow deserializing vaults with unrecognized keyrings (#169)
    • 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

  • Restore full state return value (#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:
      • createNewVaultAndKeychain
      • submitPassword
      • submitEncryptionKey
      • addNewAccount
      • removeAccount
    • 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)
    • This is required to support MetaMask extension builds using manifest v3.
    • This is enabled via the option cacheEncryptionKey.
    • The encryption key and salt have been added to the memStore as encryptionKey and encryptionSalt. The salt is used to verify that the key matches the vault being decrypted.
    • If the cacheEncryptionKey option is enabled, the encryption key and salt get cached in the memStore whenever the password is submitted.
    • The encryption key can be submitted with the new method submitEncryptionKey.
    • 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)
  • BREAKING:: Remove password parameter from persistAllKeyrings and createFirstKeyTree (#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)

7.0.2

Fixed

  • createNewVaultAndRestore now accepts a seedphrase formatted as an array of numbers (#138)

7.0.1

Fixed

  • Fix breaking change in addNewKeyring function that was accidentally introduced in v7.0.0 (#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) relied upon the options being undefined in some cases.

7.0.0

Added

  • Add forget Keyring method for some hardware devices (#124)
  • Add @lavamoat/allow-scripts (#109)

Changed

  • BREAKING: Bump eth-hd-keyring to latest version (#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 createNewVaultAndKeychain all keyrings are cleared first thing (#129)
  • Validate user imported seedphrase across all bip39 wordlists (#77)