Skip to content

CHANGELOG.md

Latest commit

 

History

History
176 lines (113 loc) · 8.86 KB

CHANGELOG.md

File metadata and controls

176 lines (113 loc) · 8.86 KB
Raw

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

Added

  • Add SimpleKeyringV2 class implementing KeyringV2 interface (#409), (#410), (#413)
    • Wraps legacy SimpleKeyring to expose accounts via the unified KeyringV2 API and the KeyringAccount type.
    • Extends EthKeyringWrapper for common Ethereum logic.

11.0.0

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.
    • The options argument type has been changed to { version: SignTypedDataVersion } | undefined.

10.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)

9.0.0

Changed

  • BREAKING: The SimpleKeyring class now implements Keyring from @metamask/keyring-utils (#217)
    • The deserialize method now requires a string[] argument.

8.1.1

Changed

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

8.1.0

Added

  • Add signEip7702Authorization method (#182)

Changed

  • 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)

8.0.1

Changed

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

8.0.0

Added

  • BREAKING: Add ESM build (#40)
    • It's no longer possible to import files from ./dist directly.

7.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.
  • Use TypeScript 5 (#55)

6.0.5

Changed

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

6.0.4

Changed

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

6.0.3

Changed

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

6.0.2

Changed

  • Bump @metamask/utils from ^8.1.0 to ^9.0.0 (#177)

6.0.1

Fixed

  • Treat undefined and null as empty array in deserialize function (#163)

6.0.0

Changed

  • BREAKING: Increase minimum Node.js version to 16 (#152)
  • BREAKING: Bump @metamask/eth-sig-util from ^6.0.1 to ^7.0.0 (#156)
  • Bump @metamask/utils from ^5.0.0 to ^8.1.0 (#153)
  • Bump ethereum-cryptography from ^1.2.0 to ^2.1.2 (#153)

5.1.1

Fixed

  • Treat undefined and null as empty array in deserialize function (#166)

5.1.0

Changed

  • Export TypeScript interfaces (#140)
  • Update all dependencies (#140) (#149)

Fixed

  • Add validateMessage option to signMessage to configure if runtime-validation should be done that input string is hex (default: true) (#148)

5.0.0

Changed

  • BREAKING: Makes version-specific signTypedData methods private (#84)
    • 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 (#87)
    • Consumers should not use this property as it is intended for internal use only.
  • BREAKING: Makes getPrivateKeyFor a private method (#83)
    • Consumers who wish to get the private key for a given account should use the exportAccount method.
  • BREAKING: Set the minimum Node.js version to 14 (#68) (#109)
  • Always return rejected Promise upon failure (#85)

Removed

  • BREAKING: Remove redundant newGethSignMessage method (#72)
    • Consumers can use signPersonalMessage method as a replacement for newGethSignMessage.