From 9581eddf08d279b7fe49ff3b80f3c77830887a0e Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 16 Aug 2022 20:45:53 +0000 Subject: [PATCH 1/3] 6.0.0 --- CHANGELOG.md | 25 ++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48267288..aa7c0391 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [6.0.0] +### Uncategorized +- Bump @metamask/auto-changelog from 2.5.0 to 2.6.1 ([#109](https://github.com/MetaMask/eth-block-tracker/pull/109)) +- Add `destroy` method to block tracker classes ([#106](https://github.com/MetaMask/eth-block-tracker/pull/106)) +- Rewrite tests using Jest ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) +- Remove sometimes-unsupported newHeads parameter ([#108](https://github.com/MetaMask/eth-block-tracker/pull/108)) +- Standardize repo (minus tests) ([#97](https://github.com/MetaMask/eth-block-tracker/pull/97)) +- Update dev dependencies ([#96](https://github.com/MetaMask/eth-block-tracker/pull/96)) +- Bump simple-get from 2.8.1 to 2.8.2 ([#99](https://github.com/MetaMask/eth-block-tracker/pull/99)) +- Bump ajv from 6.10.2 to 6.12.6 ([#100](https://github.com/MetaMask/eth-block-tracker/pull/100)) +- Bump copy-props from 2.0.4 to 2.0.5 ([#98](https://github.com/MetaMask/eth-block-tracker/pull/98)) +- Bump minimist from 1.2.5 to 1.2.6 ([#95](https://github.com/MetaMask/eth-block-tracker/pull/95)) +- Bump tar from 4.4.17 to 4.4.19 ([#87](https://github.com/MetaMask/eth-block-tracker/pull/87)) +- Migrate from CircleCI to GitHub Actions ([#88](https://github.com/MetaMask/eth-block-tracker/pull/88)) +- Bump tar from 4.4.8 to 4.4.17 ([#86](https://github.com/MetaMask/eth-block-tracker/pull/86)) +- Bump path-parse from 1.0.6 to 1.0.7 ([#85](https://github.com/MetaMask/eth-block-tracker/pull/85)) +- Bump normalize-url from 4.3.0 to 4.5.1 ([#83](https://github.com/MetaMask/eth-block-tracker/pull/83)) +- Bump hosted-git-info from 2.8.4 to 2.8.9 ([#81](https://github.com/MetaMask/eth-block-tracker/pull/81)) +- Bump lodash from 4.17.19 to 4.17.21 ([#80](https://github.com/MetaMask/eth-block-tracker/pull/80)) +- Repo standardization ([#79](https://github.com/MetaMask/eth-block-tracker/pull/79)) +- Bump y18n from 3.2.1 to 3.2.2 ([#78](https://github.com/MetaMask/eth-block-tracker/pull/78)) + ## [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 +95,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 7e5f5269..f3773eec 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", From 7fdde799abe317a31d29d24de67141be6ba9767f Mon Sep 17 00:00:00 2001 From: Elliot Winkler Date: Tue, 16 Aug 2022 15:06:22 -0600 Subject: [PATCH 2/3] Update changelog --- CHANGELOG.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aa7c0391..9ab8636f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,26 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ## [6.0.0] -### Uncategorized -- Bump @metamask/auto-changelog from 2.5.0 to 2.6.1 ([#109](https://github.com/MetaMask/eth-block-tracker/pull/109)) +### Added - Add `destroy` method to block tracker classes ([#106](https://github.com/MetaMask/eth-block-tracker/pull/106)) -- Rewrite tests using Jest ([#103](https://github.com/MetaMask/eth-block-tracker/pull/103)) -- Remove sometimes-unsupported newHeads parameter ([#108](https://github.com/MetaMask/eth-block-tracker/pull/108)) -- Standardize repo (minus tests) ([#97](https://github.com/MetaMask/eth-block-tracker/pull/97)) -- Update dev dependencies ([#96](https://github.com/MetaMask/eth-block-tracker/pull/96)) -- Bump simple-get from 2.8.1 to 2.8.2 ([#99](https://github.com/MetaMask/eth-block-tracker/pull/99)) -- Bump ajv from 6.10.2 to 6.12.6 ([#100](https://github.com/MetaMask/eth-block-tracker/pull/100)) -- Bump copy-props from 2.0.4 to 2.0.5 ([#98](https://github.com/MetaMask/eth-block-tracker/pull/98)) -- Bump minimist from 1.2.5 to 1.2.6 ([#95](https://github.com/MetaMask/eth-block-tracker/pull/95)) -- Bump tar from 4.4.17 to 4.4.19 ([#87](https://github.com/MetaMask/eth-block-tracker/pull/87)) -- Migrate from CircleCI to GitHub Actions ([#88](https://github.com/MetaMask/eth-block-tracker/pull/88)) -- Bump tar from 4.4.8 to 4.4.17 ([#86](https://github.com/MetaMask/eth-block-tracker/pull/86)) -- Bump path-parse from 1.0.6 to 1.0.7 ([#85](https://github.com/MetaMask/eth-block-tracker/pull/85)) -- Bump normalize-url from 4.3.0 to 4.5.1 ([#83](https://github.com/MetaMask/eth-block-tracker/pull/83)) -- Bump hosted-git-info from 2.8.4 to 2.8.9 ([#81](https://github.com/MetaMask/eth-block-tracker/pull/81)) -- Bump lodash from 4.17.19 to 4.17.21 ([#80](https://github.com/MetaMask/eth-block-tracker/pull/80)) -- Repo standardization ([#79](https://github.com/MetaMask/eth-block-tracker/pull/79)) -- Bump y18n from 3.2.1 to 3.2.2 ([#78](https://github.com/MetaMask/eth-block-tracker/pull/78)) +- 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:** 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 double check this. +- **BREAKING:** Require Node >= 12 ([#79](https://github.com/MetaMask/eth-block-tracker/pull/79)) + +### 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 From 35b4c6ca6a55e3c1fe9ef22faa36926d4e93ceb5 Mon Sep 17 00:00:00 2001 From: Elliot Winkler Date: Mon, 22 Aug 2022 16:10:50 -0600 Subject: [PATCH 3/3] Update changelog with new changes --- CHANGELOG.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ab8636f..87aa0994 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,11 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [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)) @@ -22,8 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - 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 double check this. -- **BREAKING:** Require Node >= 12 ([#79](https://github.com/MetaMask/eth-block-tracker/pull/79)) + - 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))