Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Commit

Permalink
Bumped version to v1.1.0, added CHANGELOG entry, README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
holgerd77 committed Feb 5, 2019
1 parent 0938708 commit 7dc5cf2
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 4 deletions.
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,47 @@ 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).

## [1.1.0] - 2019-02-04

**Petersburg Hardfork Support**

This release now supports the new `Petersburg` (aka
`constantinopleFix`) HF removing support for [EIP 1283](https://eips.ethereum.org/EIPS/eip-1283). `Petersburg` is conceptualized
within the library as a separate delta-containing HF, only removing `EIP 1283`
support and containing nothing else. It should therefore always be applied
together with the `Constantinople` HF, either by using the same block number to
update on both (`mainnet` scenario) or applying subsequently on subsequent
block numbers (`ropsten` scenario).

HF related changes (from PR [#44](https://github.com/ethereumjs/ethereumjs-common/pull/44)):

- New `hardforks/petersburg.json` HF file
- `constantinople` and `petersburg` block numbers for `ropsten` and `mainnet`
- Updated tests, new `petersburg` related tests

**Launched/Final Goerli Configuration Support**

The release now supports the final [Goerli](https://github.com/goerli/testnet)
cross-client testnet configuration.

Goerli related changes (from PR [#48](https://github.com/ethereumjs/ethereumjs-common/pull/48)):

- Updated `chains/goerli.json` configuration file (`chainId` -> 5,
`networkId` -> 5, genesis parameters)
- HF block numbers up to `petersburg` hardfork
- Updated bootstrap nodes
- Updated `genesisStates/goerli.json` genesis state
- Test updates

**Other Changes**

- Fixed a bug in `hardforkGteHardfork()` where non-active hardforks were considered equal to `chainstart` when `onlyActive` is passed, see
PR [#44](https://github.com/ethereumjs/ethereumjs-common/pull/44)
- Use CLI scripts from ethereumjs-config in package.json, PR
[#43](https://github.com/ethereumjs/ethereumjs-common/pull/43)

[1.1.0]: https://github.com/ethereumjs/ethereumjs-common/compare/v1.0.0...v1.1.0

## [1.0.0] - 2019-01-23

First `TypeScript` based release of the library (for details see
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It is encouraged to also explicitly set the `supportedHardforks` if the initiali
only supports a certain range of `hardforks`:

```javascript
let c = new Common('ropsten', null, ['byzantium', 'constantinople'])
let c = new Common('ropsten', null, ['byzantium', 'constantinople', 'petersburg'])
```

This will e.g. throw an error when a param is requested for an unsupported hardfork and
Expand All @@ -58,7 +58,7 @@ depending hardfork parameters. There are also additional helper functions like
`paramByBlock (topic, name, blockNumber)` or `hardforkIsActiveOnBlock (hardfork, blockNumber)`
to ease `blockNumber` based access to parameters.

- [API Docs](./docs/Readme.md)
- [API Docs](./docs/README.md)

# Hardfork Params

Expand All @@ -72,6 +72,7 @@ library supported:
- `spuriousDragon`
- `byzantium`
- `constantinople`
- `petersburg` (aka `constantinopleFix`, apply together with `constantinople`)

For hardfork-specific parameter access with the `param()` and `paramByBlock()` functions
you can use the following `topics`:
Expand Down Expand Up @@ -101,7 +102,7 @@ Supported chains:
- `ropsten`
- `rinkeby`
- `kovan`
- `goerli` (EXPERIMENTAL)
- `goerli` (final configuration since `v1.1.0`)
- Private/custom chain parameters

The following chain-specific parameters are provided:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ethereumjs-common",
"version": "1.0.0",
"version": "1.1.0",
"description": "Resources common to all Ethereum implementations",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down

0 comments on commit 7dc5cf2

Please sign in to comment.