From fe00e9e5e696a1a63f2adb3e6abcbcdb92b04548 Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Fri, 19 Jun 2020 10:46:10 +0200 Subject: [PATCH 1/3] Bumped version to v0.0.6, updated README, added CHANGELOG entry --- CHANGELOG.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 15 ++++++++++++++- package.json | 2 +- 3 files changed, 67 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df34ce2..ea9e7d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,58 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) (modification: no type change headlines) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [0.0.6] - 2020-06-19 + +### Revival Release 🌻 + +After a longer period of stalled development this release brings the `EthereumJS` client back +to life respectively a usable state by doing necessary dependency updates and modernizing CI. +It also comes with an updated documentation and user-facing improvements like a more reliable +and better communicated sync mechanism. + +Most notable for development is the upgrade of the `ethereumjs-devp2p` dependency to `v3.0.1`. +The devp2p library is now `TypeScript` based and comes with an improved debugging experience +which will be helpful when working on further improving the sync reliability of the client and +hunting for networking bugs. + +To ease jumping into the code base there is now a new structure +[diagram](https://github.com/ethereumjs/ethereumjs-client/blob/master/diagram/client.svg) +showing the relations between the main components as well as the initialization and message flow. + +## Changes + +**Dependencies, CI and Docs** +- Added Node 12, removed Node 8 on CI runs, updated `level` and `ethereumjs-common` dependency, + PR [#111](https://github.com/ethereumjs/ethereumjs-client/pull/111) +- Upgraded CI provider to GitHub actions, + PR [#119](https://github.com/ethereumjs/ethereumjs-client/pull/119) +- Updated `ethereumjs-util` to `v7.0.2`, + PR [#129](https://github.com/ethereumjs/ethereumjs-client/pull/129) +- Added up-to-date version of the `README`, `Outdated` notice for the project summary, + PR [#114](https://github.com/ethereumjs/ethereumjs-client/pull/114) +- Added `JSON-RPC` documentation to `README`, + PR [#124](https://github.com/ethereumjs/ethereumjs-client/pull/124) +- New high-level structure diagram, + PR [#134](https://github.com/ethereumjs/ethereumjs-client/pull/134) + +**Bug Fixes and Maintenance** +- Fixed tx initialization bug, PR [#113](https://github.com/ethereumjs/ethereumjs-client/pull/113) +- fix(rpc): Handle rpc request with empty params, + PR [#122](https://github.com/ethereumjs/ethereumjs-client/pull/122) +- Fixed light sync block init bug, + PR [#127](https://github.com/ethereumjs/ethereumjs-client/pull/127) +- `RPC` test method cleanup, + PR [#126](https://github.com/ethereumjs/ethereumjs-client/pull/126) +- Removed old fields `consensus` and `finality`, + PR [#120](https://github.com/ethereumjs/ethereumjs-client/pull/120) + +**New Features** +- Improved sync reliability, + PR [#133](https://github.com/ethereumjs/ethereumjs-client/pull/133) +- Added `eth_getBlockTransactionCountByHash` RPC method, + PR [#125](https://github.com/ethereumjs/ethereumjs-client/pull/125) + +[0.0.6]: https://github.com/ethereumjs/ethereumjs-client/compare/v0.0.5...v0.0.6 ## [0.0.5] - 2019-02-12 - Add support for final [Goerli](https://github.com/goerli/testnet) testnet, diff --git a/README.md b/README.md index d5dc8fc..208b5a8 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,14 @@ You can run the current state of the client with: ethereumjs --network=mainnet [--loglevel=debug] ``` -Or show the help with +For development you might want to connect to `rinkeby` as the network with the currently +most reliable connection: + +```shell +ethereumjs --network rinkeby +``` + +The help can be shown with: ```shell ethereumjs --help ``` @@ -305,6 +312,12 @@ also make use of subclasses of the ``Fetcher`` class that help fetch headers and - ``Node`` [**In Progress**] Represents the top-level ethereum node, and is responsible for managing the lifecycle of included services. - ``RPCManager`` [**In Progress**] Implements an embedded JSON-RPC server to handle incoming RPC requests. +## Develper + +### Diagram Updates + +To update the structure diagram files in the root folder open the `client.drawio` file in [draw.io](https://draw.io/), make your changes, and open a PR with the updated files. Export `svg` and `png` with `border` `width=20` and `transparency=false`. For `png` go to "Advanced" and select `300 DPI`. + ## Environment / Ecosystem **EthereumJS Ecosystem** diff --git a/package.json b/package.json index 84b5550..05e9acc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ethereumjs-client", - "version": "0.0.5", + "version": "0.0.6", "description": "EthereumJS client implementation", "main": "./lib/index.js", "bin": { From 3d15846dbfc73a2342187f244842be5387a39d6c Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Fri, 19 Jun 2020 11:43:44 -0700 Subject: [PATCH 2/3] Fix typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 208b5a8..8a422af 100644 --- a/README.md +++ b/README.md @@ -312,7 +312,7 @@ also make use of subclasses of the ``Fetcher`` class that help fetch headers and - ``Node`` [**In Progress**] Represents the top-level ethereum node, and is responsible for managing the lifecycle of included services. - ``RPCManager`` [**In Progress**] Implements an embedded JSON-RPC server to handle incoming RPC requests. -## Develper +## Developer ### Diagram Updates From 12df2509bbac956c71096b53da80fca1704382cf Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Sat, 20 Jun 2020 08:43:17 +0200 Subject: [PATCH 3/3] Added PR #131 to CHANGELOG --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ea9e7d1..f519ccc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -53,6 +53,8 @@ showing the relations between the main components as well as the initialization **New Features** - Improved sync reliability, PR [#133](https://github.com/ethereumjs/ethereumjs-client/pull/133) +- Added `eth_blockNumber` RPC method, + PR [#131](https://github.com/ethereumjs/ethereumjs-client/pull/131) - Added `eth_getBlockTransactionCountByHash` RPC method, PR [#125](https://github.com/ethereumjs/ethereumjs-client/pull/125)