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.
- BREAKING: The
SimpleKeyring
class now implementsKeyring
from@metamask/keyring-utils
(#217)- The
deserialize
method now requires astring[]
argument.
- The
- BREAKING: The method signature for
signTypedData
has been changed (#224)- The method now accepts a
TypedDataV1
object whenSigntypedDataVersion.V1
is passed in the options, andTypedMessage<Types>
when other versions are requested
- The method now accepts a
- Use
ts-bridge/[email protected]
(#214)- This new version fixes a bug regarding some missing exports.
- Add
signEip7702Authorization
method (#182)
- Bump
@metamask/eth-sig-util
dependency from^8.0.0
to8.2.0
(#177), (#134) - Bump
@metamask/utils
dependency from^9.3.1
to11.1.0
(#134), (#167)
- Use
ts-bridge/[email protected]
(#118)- This new version fixes a bug with CJS re-exports.
- BREAKING: Add ESM build (#40)
- It's no longer possible to import files from
./dist
directly.
- It's no longer possible to import files from
- BREAKING: Bump
@metamask/eth-sig-util
dependency from^7.0.3
to^8.0.0
(#79)signTypedData
no longer supportnumber
for addresses, see here.
- Use TypeScript 5 (#55)
- 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.
- Package name does not change (
- Bump
@metamask/utils
from^8.1.0
to^9.0.0
(#177)
- Treat
undefined
andnull
as empty array in deserialize function (#163)
- 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)
- Treat
undefined
andnull
as empty array in deserialize function (#166)
- Add
validateMessage
option tosignMessage
to configure if runtime-validation should be done that input string is hex (default:true
) (#148)
- 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.
- Consumers should use the generic
- 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.
- Consumers who wish to get the private key for a given account should use the
- BREAKING: Set the minimum Node.js version to 14 (#68) (#109)
- Always return rejected Promise upon failure (#85)
- BREAKING: Remove redundant
newGethSignMessage
method (#72)- Consumers can use
signPersonalMessage
method as a replacement fornewGethSignMessage
.
- Consumers can use