CHANGELOG.md

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

Changed

• Bump @metamask/keyring-sdk from ^2.0.2 to ^2.2.0 (#544, #546, #562)
• Bump @metamask/keyring-utils from ^3.2.0 to ^3.3.1 (#544, #546)
• Bump @metamask/keyring-api from ^23.1.0 to ^23.5.0 (#562, #569, #583, #587)
• Bump @metamask/superstruct from ^3.3.0 to ^3.4.0 (#577)

14.1.1

Changed

• Bump @metamask/keyring-api from ^23.0.1 to ^23.1.0 (#538)
• Bump @metamask/keyring-sdk from ^2.0.1 to ^2.0.2 (#538)

14.1.0

Added

• Expose same getters in HdKeyring (v2 keyring wrapper from /v2) (#529)
  • We need this as some consumers were already using those getters when using the v1 keyring.

14.0.1

Changed

• Bump @metamask/account-api from ^1.0.2 to ^1.0.3 (#518)
• Bump @metamask/keyring-api from ^23.0.0 to ^23.0.1 (#518)
• Bump @metamask/keyring-sdk from ^2.0.0 to ^2.0.1 (#518)

Fixed

• Workaround Browserify subpath export for /v2 (#516)

14.0.0

Added

• Add ./v2 subpath export for keyring v2 implementation (#513)
  • HdKeyring and HdKeyringOptions are now available from @metamask/eth-hd-keyring/v2.

Changed

• BREAKING: Move and rename HdKeyringV2 and HdKeyringV2Options to the new ./v2 subpath export (#513)
  • HdKeyringV2 is now HdKeyring from @metamask/eth-hd-keyring/v2.
  • HdKeyringV2Options is now HdKeyringOptions from @metamask/eth-hd-keyring/v2.
• Bump @metamask/utils from ^11.10.0 to ^11.11.0 (#483)
• Bump @metamask/account-api from ^1.0.1 to ^1.0.2 (#515)
• Bump @metamask/keyring-api from ^22.0.0 to ^23.0.0 (#515)
• Bump @metamask/keyring-sdk from ^1.2.0 to ^2.0.0 (#515)

13.1.1

Changed

• Add new dependency @metamask/keyring-sdk@1.2.0 (#478, #482, #496, #509)
  • This package now contains the keyring v2 wrapper helpers (EthKeyringWrapper, EthKeyringMethod).
  • The account ID (generated by KeyringAccountRegistry) are now deterministic for EVM addresses.
• Bump @metamask/keyring-api from ^21.6.0 to ^22.0.0 (#482)
• Bump @metamask/account-api from ^1.0.0 to ^1.0.1 (#487)
• Bump @metamask/utils from ^11.1.0 to ^11.10.0 (#489)

13.1.0

Added

• Add HdKeyringV2 class implementing KeyringV2 interface (#398, #402, #404, #410, #413, #451, #453)
  • Wraps legacy HdKeyring to expose accounts via the unified KeyringV2 API and the KeyringAccount type.
  • Extends EthKeyringWrapper for common Ethereum logic.

Fixed

• Enforce mnemonics validation (#450)
  • Validates mnemonics against BIP39 specification (word count, wordlist, checksum) before use.
  • Throws for invalid mnemonics.

13.0.0

Added

• Export types SerializedHDKeyringState and DeserializableHDKeyringState (#255)

Changed

• BREAKING: The method signature for signTypedData has been changed (#224)
  • The method now accepts a TypedDataV1 object when SignTypedDataVersion.V1 is passed in the options, and TypedMessage<Types> when other versions are requested.
• BREAKING: The HdKeyring class now extends Keyring from @metamask/keyring-utils (#255)
  • The deserialize method does not accept Buffer mnemonic anymore
  • The options argument to deserialize is no longer optional
  • getAccounts is now async
• Switched to using a Map for wallet storage (#374)
  • Improves performance of account lookup and removal to constant time
• Cache derived account addresses (#373)
  • Avoids recomputing addresses from public keys on every getAccounts() call

Removed

• BREAKING: HDKeyringState type is no longer exported (#255)
  • This has effectively been replaced with SerializedHDKeyringState and DeserializableHDKeyringState

12.1.0

Added

• Store mnemonic seed in HdKeyring.seed (#244)

12.0.0

Changed

• BREAKING: The method signTransaction can now returns various type of transactions (#209)
  • Initially was supporting: Transaction | AccessListEIP2930Transaction | FeeMarketEIP1559Transaction (types from @ethereumjs/tx).
  • Now also supports BlobEIP4844Transaction | EOACodeEIP7702Transaction (types from @ethereumjs/tx).
• BREAKING: Bump @ethereumjs/tx from ^4.2.0 to ^5.4.0 (#209)
• BREAKING: Bump @ethereumjs/util from ^8.1.0 to ^9.1.0 (#209)

11.0.0

Changed

• BREAKING: The HdKeyring is not exported as default anymore (#161)

10.0.1

Changed

• Use ts-bridge/cli@0.6.3 (#214)
  • This new version fixes a bug regarding some missing exports.

10.0.0

Added

• Add signEip7702Authorization method (#182)

Changed

• BREAKING: Added types to HdKeyring (#166)
  • All methods on HdKeyring retain their existing signatures, but now have types.
• Bump @metamask/eth-sig-util dependency from ^8.0.0 to 8.2.0 (#177, #134)
• Bump @metamask/utils dependency from ^9.3.1 to 11.1.0 (#134, #167)

9.0.1

Changed

• Use ts-bridge/cli@0.6.1 (#118)
  • This new version fixes a bug with CJS re-exports.

9.0.0

Changed

• BREAKING: Move seed generation to deserialization (#100)
  • Using the constructor directly no longer generates the seed required for account derivation.
  • Both serialize and deserialize are now proper async methods.
• Allow passing native custom cryptographic functions (#102)
  • The seed generation is now relying @metamask/key-tree package (instead of @metamask/scure-bip39).
  • The constructor now allows a new option cryptographicFunctions which allows the use of custom cryptographic functions during seed generation.

8.0.0

Changed

• BREAKING: Bump @metamask/eth-sig-util dependency from ^7.0.3 to ^8.0.0 (#79)
  • signTypedData no longer support number for addresses, see here.

7.0.4

Changed

• Bump sinon and @types/sinon to latest versions (#51)
• Add syncpack and sync dependencies (#53)

7.0.3

Changed

• Bump @metamask/* and @lavamoat/* dependencies (#46)
• Move deepmerge to devDependencies (#44)

7.0.2

Changed

• Convert to monorepo
  • Package name does not change (@metamask/eth-hd-keyring) and sources have been moved to: packages/keyring-eth-hd.
  • You can find all the changes here.

7.0.1

Changed

• BREAKING: Update minimum Node.js version from v14 to v16 (#98)
• Bump dependencies (#99)
  • BREAKING: @metamask/eth-sig-util from ^6.0.0 to ^7.0.0
  • BREAKING: @metamask/utils from ^5.0.2 to ^8.1.0
  • @ethereumjs/tx from ^4.1.1 to ^4.2.0
  • @ethereumjs/util from 8.0.5 to ^8.1.0
  • ethereum-cryptography from ^1.2.0 to ^2.1.2

7.0.0 [RETRACTED]

Changed

• This version was retracted due to a bug causing code to be missing from published package.

6.0.2

Fixed

• Bump dependencies (#94)
  • @ethereumjs/util from ^8.0.2 to ^8.1.0
  • @metamask/eth-sig-util from ^5.0.2 to ^6.0.0
  • @metamask/scure-bip39 from ^2.0.3 to ^2.1.0
  • @metamask/utils from ^5.0.0 to ^5.0.2
  • ethereum-cryptography from ^1.1.2 to ^1.2.0

6.0.1 [RETRACTED]

Changed

• This version was retracted due to a bug causing code to be missing from published package.

6.0.0

Changed

• Revert mnemonic serialization format from Record<number, number> (i.e. a stringified Uint8Array) which was introduced in v5.0.0 back to an untyped array of utf8 encoded bytes, which was the format prior to v5.0.0 (#81)

5.0.1 [DEPRECATED]

Removed

• Remove prepack script and references in order to fix publish release flow (#77)

5.0.0 [DEPRECATED]

Changed

• BREAKING: Update minimum Node.js version from v12 to v14 (#67)
• BREAKING: Makes version-specific signTypedData methods private (#71)
  • Consumers should use the generic signTypedData method and pass the version they'd like as a property in the options argument.
• BREAKING: Makes the wallets property private (#71)
  • Consumers should not use this property as it is intended for internal use only.
• BREAKING: Makes getPrivateKeyFor a private method (#71)
  • Consumers who wish to get the private key for a given account should use the exportAccount method.
• BREAKING: Bumps browser requirements to those with ES2020 support or greater (#70)
  • This change is introduced in update of @metamask/eth-sig-util to v5 and new direct dependency on ethereumjs/util v8.0.2
• Replaces use of ethereumjs-wallet implementation of hdkey with one from ethereum-cryptography and adapts accordingly. (#69)
• Replaces @metamask/bip39 with @metamask/scure-bip39 (#67)

Removed

• BREAKING: Remove redundant newGethSignMessage method (#71)
  • Consumers can use signPersonalMessage method as a replacement for newGethSignMessage.
• BREAKING: HDKeyring no longer extends EventEmitter, so no EventEmitter methods are available on this class (#70)
• Removes ethereumjs-util dependency. (#67)

4.0.2

Added

• Add parameter validation for constructor / deserialize method (#65)
  • As of v4.0.0, the deserialize method (which is also called by the constructor) can no longer generate accounts with the numberOfAccounts option without a mnemonic. Prior to v4.0.0, a mnemonic was generated automatically if it was missing, but we now want to ensure a mnemonic is never implicitly generated without the caller knowing.

4.0.1

Added

• Add tests to get coverage to 100% (#62)

Fixed

• Fix bug where an unexpected error would occur if the mnemonic passed to _initFromMnemonic was a buffer array (#62)

4.0.0

Changed

• BREAKING: Do not allow re-initialization of keyring instance (#55)
  • Consumers are now required to call generateRandomMnemonic() after initialization for creating new SRPs.
• BREAKING: Update minimum Node.js version from v10 to v12 (#45)
• Add @lavamoat/allow-scripts (#47)
  • We now have an allowlist for all post-install scripts. The standard setup script has been added, along with new contributor documentation in the README to explain this script.
• Obfuscate serialized mnemonic (#59)
  • Class variable mnemonic on HdKeyring can now be either type Buffer or type string.
  • Deserialize method (and HdKeyring constructor by extension) can no longer be passed an options object containing a value for numberOfAccounts if it is not also containing a value for mnemonic.
• Package name changed from eth-hd-keyring to @metamask/eth-hd-keyring.