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

12.0.2

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)

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

12.0.0

Added

• Add ./v2 subpath export for keyring v2 implementation (#513)
  • LedgerKeyring and LedgerKeyringOptions are now available from @metamask/eth-ledger-bridge-keyring/v2.

Changed

• BREAKING: Move and rename LedgerKeyringV2 and LedgerKeyringV2Options to the new ./v2 subpath export (#513)
  • LedgerKeyringV2 is now LedgerKeyring from @metamask/eth-ledger-bridge-keyring/v2.
  • LedgerKeyringV2Options is now LedgerKeyringOptions from @metamask/eth-ledger-bridge-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)

Fixed

• Add dynamic NFT and ERC-20 check (#506)

11.4.0

Added

• Add getTransactionSelector to read the 4-byte calldata selector from serialized transaction hex (legacy and typed txs) (#506)
  • Ledger mobile bridge passes nft: true to clearSignTransaction when that selector is NFT-only (ERC-721 / ERC-1155).
• Add ERC20_WRITE_SELECTORS for the three EIP-20 write functions (transfer, transferFrom, approve) (#506)

11.3.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).
  • The account ID (generated by KeyringAccountRegistry) are now deterministic for EVM addresses.
• Bump @metamask/hw-wallet-sdk from ^0.6.0 to ^0.8.0 (#482), (#497)
• 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)

11.3.0

Changed

• Integrate @metamask/hw-wallet-sdk for standardized hardware wallet error handling (#446)
  • Replace custom error handling with HardwareWalletError from the SDK.
  • Use LEDGER_ERROR_MAPPINGS from the SDK for consistent error code mapping.
  • Re-export HardwareWalletError, ErrorCode, Severity, Category, and error mappings for consumer convenience.
  • Deprecate LedgerStatusError in favor of HardwareWalletError.
  • Prefix Ledger transport error messages for compatibility.

11.2.0

Added

• Add LedgerKeyringV2 class implementing KeyringV2 interface (#416), (#451), (#453)
  • Wraps legacy LedgerKeyring to expose accounts via the unified KeyringV2 API and the KeyringAccount type.
  • Extends EthKeyringWrapper for common Ethereum logic.

Changed

• Normalize signature v value from Ledger devices for proper recovery (#449)

11.1.2

Changed

• Increase ledger iframe timeout interval (#314)

11.1.1

Changed

• Refactor error handling around TransportStatusError (#301)

11.1.0

Changed

• Better error handling for Ledger signing operations (#294)

11.0.3

Fixed

• Removed timeout for messages requiring user actions (#279)

11.0.2

Fixed

• Increase timeout for user action requests (#275)

11.0.1

Fixed

• Fix use of salt value as a string for signTypedData<V4> (#249)
• Use timeouts for Ledger iframe messages (#271)

11.0.0

Changed

• BREAKING: The signTypedData method now requires SignTypedDataVersion.V4 as version for the options argument (#224)

Fixed

• Trim 0x prefix for signTransaction (#253)
  • This regression was due to latest @ethereumjs upgrade.

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: LedgerKeyring now implements the Keyring type (#194)
  • The class does not extend EventEmitter anymore.
  • The LedgerKeyring.accounts class variable is now a readonly Hex[] array.
  • The addAccounts method signature has been changed:
    • An amount number parameter is now required to specify the number of accounts to add.
    • The method now returns a promise resolving to an array of Hex addresses.
  • The unlock method now returns Promise<Hex>.
  • The getAccounts method now returns Promise<Hex[]>.
  • The deserialize method now requires a LedgerKeyringSerializedState typed parameter.
  • The signTransaction method now accepts an Hex typed value as the address parameter.
  • The signMessage method now accepts an Hex typed value as the withAccount parameter.
  • The signPersonalMessage method now accepts an Hex typed value as the withAccount parameter.
  • The signTypedData method now accepts an Hex typed value as the withAccount parameter.
  • The unlockAccountByAddress method now accepts an Hex typed value as the address parameter.

Removed

• BREAKING: The exportAccount method has been removed (#194)

8.0.5

Changed

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

8.0.4

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.3

Fixed

• Bump @ledgerhq/hw-app-eth dependency from ^6.39.0 to ^6.42.0 (#153)
  • Required to fix handling of EIP-712 content.

8.0.2

Changed

• Bump @metamask/eth-sig-util dependency from ^8.0.0 to ^8.1.2 (#134)

Fixed

• Fix webpack build about non-exported EIP712Message type (#140)

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

Changed

• BREAKING: Enable Ledger clear signing (#99)
  • The LedgerSignTypedDataParams type now requires a new message field which replaces the domainSeparatorHex and hashStructMessage}Hex fields.

7.0.0

Added

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

6.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.

Fixed

• Device ID will now be cleared up when forgetting a device (#86)

5.0.1

Changed

• Bump @ledgerhq/hw-app-eth dependency to ^6.39.0 (#68)
  • This new dependency version reduces the resulting package bundle size.

5.0.0

Changed

• BREAKING: addAccounts will now only return newly created accounts (#63)
  • This keyring was initially returning every accounts (previous and new ones), which is different from what is expected in the [Keyring interface].(https://github.com/MetaMask/utils/blob/v9.2.1/src/keyring.ts#L65)

4.1.4

Changed

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

4.1.3

Changed

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

4.1.2

Changed

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

4.1.1

Fixed

• The promise returned by the init method now resolves only after iframe has been loaded (#236)
  • updateTransportMethod will throw an error when called before init

4.1.0

Changed

• Refactor error message in LedgerKeyring (#232)
• Extend LedgerMobileBridge type from LedgerBridge (#233)
• Create new MetaMaskLedgerHwAppEth instance instead of re-using previous instance (#231)

4.0.0

Added

• Add classes LedgerMobileBridge, LedgerTransportMiddleware, and MetaMaskLedgerHwAppEth to support Bluetooth as a HW Ledger Transport option (#225)

Changed

• BREAKING: The LedgerKeyring method setAccountToUnlock now only accepts an input of type number (#225)
• BREAKING: Removed the chainCode property from the GetPublicKeyResponse type (#225)

3.0.0

Added

• Add getOptions and setOptions methods to LedgerBridge interface (#210)

Changed

• BREAKING: LedgerIframeBridge class constructor now takes an options object with bridgeUrl (#210)
• BREAKING: LedgerBridge init function now takes no parameters (#210)
• BREAKING: LedgerBridgeKeyringOptions no longer contain bridgeUrl (#210)
• BREAKING: LedgerBridge interface is now parameterized over its option type (#210)
• Minor performance enhancement (#211)

Fixed

• BREAKING: IFrameMessageResponse now has more restrictive typings (#207) (#207)

2.0.1

Fixed

• Fix invalid rlp data error for legacy transactions in 2.0.0 (#212)

2.0.0

Changed

• BREAKING: Remove support for major node versions 14,15,17,19. Minimum Node.js version is now 16. (#204)
• Bump @metamask/eth-sig-util from ^6.0.1 to ^7.0.0 (#205)

Fixed

• Move @metamask/utils from deendencies to devDependencies (#209)

1.0.1

Fixed

• Bump dependency hdkey from 0.8.0 to ^2.1.0 (#196)
• Replace dependency eth-sig-util@^2 with @metamask/eth-sig-util@^6 (#157)
• Replace dependency ethereumjs-util@^7.0.9 with @ethereumjs/util@^8.0.0 and @ethereumjs/rlp (#153)

1.0.0

Changed

• BREAKING: Separate the bridge from the keyring (#156)
  • The Ledger bridge is now a separate class (LedgerIframeBridge), which must be constructed separately from the keyring and passed in as a constructor argument.
  • The bridge initialization has been moved from the keyring constructor to the keyring init method. The bridge is expected to be passed to the keyring uninitialized, and the keyring init method is expected to be called after keyring construction (before the keyring is used).
  • The keyring constructor no longer accepts keyring state. Instead, any pre-existing keyring state should be passed to the deserialize method after construction.
• BREAKING: Export changed from default to named (#174)
  • The keyring is exported as LedgerKeyring
• Add TypeScript types (#174)

0.15.0

Changed

• BREAKING: @ethereumjs/tx upgraded to major version 4, which includes a shift from storing numerical values as BNs to storing them as native BigInts. This is a breaking change for users of this keyring who access the values of the tx object, or that use those tx objects to interact with other libraries that depend on @ethereumsjs/tx versions under 4.0.0. (#181)

0.14.0

Changed

• BREAKING: The minimum version of Node.js required for this package has been bumped to v14. (#169)

Fixed

• Fix incorrect v for EIP-712 signatures and personal_sign (#152)

0.13.0

Added

• hdk.publicKey and hdk.chainCode should not be updated when unlocking using hdPath for an account. (#146)

0.12.0

Added

• Add a new destroy method which will remove the message event listener from window. (#145)

0.11.0

Added

• Add a new isConnected method which allows determining if the device is last known to be connected. (#131)

Changed

• Messaging now runs off of message IDs instead of assuming the response received is from the last message sent, which will not always been true. (#132)

0.10.0

Added

• Add a new attemptMakeApp method which allows clients to attempt a creation of the Ledger transport for the purposes of detecting/catching potential connection errors. (#126)

0.9.0

Changed

• updateTransportMethod no longer defaults its parameter to false, and now names the param sent with the 'ledger-update-transport' message transportType. This better is to support the use of an enum, instead of a boolean, for specifying transport preferences. (#114)

0.8.0

Added

• Allow ledger-bridge iframe to connect Ledger wia WebHID, when it is supported by the current browser (#107)

Changed

• Reject with an Error object if unlocking is not successful (#104)
• Ensure that logs of errors only have a single Error: string in the message (#105)

0.7.0

Changed

• Remove unused events and ethereumjs-tx dependencies (#101), (#102)
• Update eth-ledger-bridge-keyring to support EIP-1559 transactions (#98), (#97), (#96)

0.6.0

Added

• Support new versions of ethereumjs/tx (#68)