diff --git a/CHANGELOG.md b/CHANGELOG.md index 48267288..87aa0994 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [6.0.0] +### Added +- Add logging ([#112](https://github.com/MetaMask/eth-block-tracker/pull/112)) + - You will not be able to see log messages by default, but you can turn them on for this library by setting the `DEBUG` environment variable to `metamask:eth-block-tracker:*` or `metamask:*`. +- Add `destroy` method to block tracker classes ([#106](https://github.com/MetaMask/eth-block-tracker/pull/106)) +- Update PollingBlockTracker to support new `blockResetDuration` option ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) +- Expose types that represent options to PollingBlockTracker and SubscribeBlockTracker constructors ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) + +### Changed +- **BREAKING:** Require Node >= 14 ([#113](https://github.com/MetaMask/eth-block-tracker/pull/113)) +- **BREAKING:** Make BaseBlockTracker abstract ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) + - If you are using this class directly, you must only use PollingBlockTracker or SubscribeBlockTracker. +- **BREAKING:** Make options for BaseBlockTracker required ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) + - Subclasses must pass a set of options to `super` in their constructors. +- Make argument to `removeAllListeners` in BaseBlockTracker optional ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) +- **BREAKING:** Update signatures for `_start` and `_end` in BaseBlockTracker ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) + - Subclasses must provide an implementation for both of these methods; they are no longer no-ops. + - Both methods must return a promise. +- Update SubscribeBlockTracker to not pass empty `newHeads` parameter to `eth_subscribe` call ([#108](https://github.com/MetaMask/eth-block-tracker/pull/108)) + - This change was made because OpenEthereum does not support this parameter. While we've done our best to confirm that this will not be a breaking change for other Ethereum implementations, you will want to confirm no breakages for yours. + +### Security +- Add `@lavamoat/allow-scripts` to ensure that install scripts are opt-in for dependencies ([#97](https://github.com/MetaMask/eth-block-tracker/pull/97)) + ## [5.0.1] - 2021-03-25 ### Fixed - Add missing `types` field to `package.json` ([#75](https://github.com/MetaMask/eth-block-tracker/pull/75)) @@ -73,7 +97,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Add RpcBlockTracker -[Unreleased]: https://github.com/MetaMask/eth-block-tracker/compare/v5.0.1...HEAD +[Unreleased]: https://github.com/MetaMask/eth-block-tracker/compare/v6.0.0...HEAD +[6.0.0]: https://github.com/MetaMask/eth-block-tracker/compare/v5.0.1...v6.0.0 [5.0.1]: https://github.com/MetaMask/eth-block-tracker/compare/v5.0.0...v5.0.1 [5.0.0]: https://github.com/MetaMask/eth-block-tracker/compare/v4.4.3...v5.0.0 [4.4.3]: https://github.com/MetaMask/eth-block-tracker/compare/v4.0.0...v4.4.3 diff --git a/package.json b/package.json index 2d7a3b21..6302610f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "eth-block-tracker", - "version": "5.0.1", + "version": "6.0.0", "description": "A block tracker for the Ethereum blockchain. Keeps track of the latest block.", "repository": { "type": "git",