Merge pull request #946 from ethereumjs/beta.2-releases

Beta.2 Releases

Author: holgerd77

README.md

@@ -43,13 +43,13 @@ This monorepo uses [Lerna](https://lerna.js.org/). It links the local packages t
 TLDR: Setup
 ```sh
 npm install
-npm build
+npm run build
 ```
 
 TLDR: To update dependencies and (re-)link packages
 ```sh
 npm run bootstrap
-npm build
+npm run build
 ```
 
 Above is the quickest way to set you up. Going down the road, there are two sets of commands: *project* and *package-specific* commands. You can find them at `./package.json` and `./packages/*/package.json`, respectively. Here's a breakdown:

packages/block/CHANGELOG.md

@@ -6,7 +6,9 @@ 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).
 
-## 3.0.0-beta.2 - UNRELEASED
+## 3.0.0-beta.2 - 2020-11-12
+
+This is the second beta release towards a final library release, see [beta.1 release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/%40ethereumjs%2Ftx%403.0.0-beta.1) for an overview on the full changes since the last publicly released version.
 
 - Added `freeze` option to allow for block freeze deactivation (e.g. to allow for subclassing block and adding additional parameters), see PR [#941](https://github.com/ethereumjs/ethereumjs-vm/pull/941)
 - **Breaking:** Difficulty-depending methods `canonicalDifficulty()` and `validateDifficulty()` in block and header now throw on non-PoW chains, see PR [#937](https://github.com/ethereumjs/ethereumjs-vm/pull/937)

packages/block/README.md

@@ -8,13 +8,45 @@
 
 Implements schema and functions related to Ethereum's block.
 
+Note: this `README` reflects the state of the library from `v3.0.0` onwards. See `README` from the [standalone repository](https://github.com/ethereumjs/ethereumjs-block) for an introduction on the last preceeding release.
+
 # INSTALL
 
 `npm install @ethereumjs/block`
 
-# BROWSER
+# USAGE
+
+There are three static factories to instantiate a `Block` or `BlockHeader`:
+
+- `Block.fromBlockData(blockData: BlockData = {}, opts?: BlockOptions)`
+- `Block.fromRLPSerializedBlock(serialized: Buffer, opts?: BlockOptions)`
+- `Block.fromValuesArray(values: BlockBuffer, opts?: BlockOptions)`
+
+Instantiation Example:
+
+```typescript
+const headerData = {
+  number: 15,
+  parentHash: '0x6bfee7294bf44572b7266358e627f3c35105e1c3851f3de09e6d646f955725a7',
+  difficulty: 131072,
+  gasLimit: 8000000,
+  timestamp: 1562422144,
+}
+const header = BlockHeader.fromHeaderData(headerData)
+```
+
+Properties of a `Block` or `BlockHeader` object are frozen with `Object.freeze()` which gives you enhanced security and consistency properties when working with the instantiated object. This behavior can be modified using the `freeze` option in the constructor if needed.
+
+API Usage Example:
 
-This module works with `browserify`.
+```typescript
+try {
+  await block.validate(blockchain)
+  // Block validation has passed
+} catch (err) {
+  // handle errors appropriately
+}
+```
 
 # API
 

packages/block/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethereumjs/block",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.2",
   "description": "Provides Block serialization and help functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -39,8 +39,8 @@
   },
   "homepage": "https://github.com/ethereumjs/ethereumjs-vm/tree/master/packages/block#synopsis",
   "dependencies": {
-    "@ethereumjs/common": "2.0.0-beta.1",
-    "@ethereumjs/tx": "3.0.0-beta.1",
+    "@ethereumjs/common": "2.0.0-beta.2",
+    "@ethereumjs/tx": "3.0.0-beta.2",
     "@types/bn.js": "^4.11.6",
     "ethereumjs-util": "^7.0.7",
     "merkle-patricia-tree": "^4.0.0"

packages/blockchain/CHANGELOG.md

@@ -6,9 +6,9 @@ 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).
 
-## 5.0.0-beta.2 - UNRELEASED
+## 5.0.0-beta.2 - 2020-11-12
 
-This is the second beta release towards a final `v5.0.0` `Blockchain` library release, see [v5.0.0-beta.1 release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/%40ethereumjs%2Fblockchain%405.0.0-beta.1) for an overview on the full changes since the last publicly released version.
+This is the second beta release towards a final library release, see [beta.1 release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/%40ethereumjs%2Fblockchain%405.0.0-beta.1) for an overview on the full changes since the last publicly released version.
 
 This release introduces **new breaking changes**, so please carefully read the additional release note sections!
 
@@ -122,8 +122,6 @@ in performance benefits for Node.js consumers, see [here](https://github.com/eth
 - Fixed blockchain hanging forever in case code throws between a semaphore `lock`/`unlock`,
   Issue [#877](https://github.com/ethereumjs/ethereumjs-vm/issues/877)
 
-[5.0.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblockchain%404.0.2...%40ethereumjs%2Fblockchain%405.0.0
-
 ## 4.0.4 - 2020-07-27
 
 This release replaces the tilde (`~`) dependency from `ethereumjs-util` for a caret (`^`) one, meaning that any update to `ethereumjs-util` v6 will also be available for this library.

packages/blockchain/README.md

@@ -8,15 +8,13 @@
 
 A module to store and interact with blocks.
 
-# INSTALL
-
-`npm install ethereumjs-blockchain`
+Note: this `README` reflects the state of the library from `v5.0.0` onwards. See `README` from the [standalone repository](https://github.com/ethereumjs/ethereumjs-blockchain) for an introduction on the last preceeding release.
 
-# API
+# INSTALL
 
-[Documentation](./docs/README.md)
+`npm install @ethereumjs/blockchain`
 
-# EXAMPLE
+# USAGE
 
 The following is an example to iterate through an existing Geth DB (needs `level` to be installed separately).
 
@@ -29,8 +27,10 @@ const level = require('level')
 
 const gethDbPath = './chaindata' // Add your own path here. It will get modified, see remarks.
 
+const common = new Common({ chain: 'ropsten' })
 const db = level(gethDbPath)
-const blockchain = new Blockchain({ db })
+// Use the safe static constructor which awaits the init method
+const blockchain = Blockchain.create({ common, db })
 
 blockchain.iterator('i', (block) => {
   const blockNumber = block.header.number.toString()
@@ -41,6 +41,10 @@ blockchain.iterator('i', (block) => {
 
 **WARNING**: Since `@ethereumjs/blockchain` is also doing write operations on the DB for safety reasons only run this on a copy of your database, otherwise this might lead to a compromised DB state.
 
+# API
+
+[Documentation](./docs/README.md)
+
 # EthereumJS
 
 See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices.

packages/blockchain/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethereumjs/blockchain",
-  "version": "5.0.0-beta.1",
+  "version": "5.0.0-beta.2",
   "description": "A module to store and interact with blocks",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,8 +36,8 @@
   },
   "homepage": "https://github.com/ethereumjs/ethereumjs-vm/tree/master/packages/blockchain#synopsis",
   "dependencies": {
-    "@ethereumjs/block": "3.0.0-beta.1",
-    "@ethereumjs/common": "2.0.0-beta.1",
+    "@ethereumjs/block": "3.0.0-beta.2",
+    "@ethereumjs/common": "2.0.0-beta.2",
     "@ethereumjs/ethash": "1.0.0-beta.1",
     "ethereumjs-util": "^7.0.7",
     "level-mem": "^5.0.1",

packages/common/CHANGELOG.md

@@ -6,7 +6,9 @@ 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).
 
-## 2.0.0-beta.2 - UNRELEASED
+## 2.0.0-beta.2 - 2020-11-12
+
+This is the second beta release towards a final library release, see [beta.1 release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/%40ethereumjs%2Fcommon%402.0.0-beta.1) for an overview on the full changes since the last publicly released version.
 
 - Added consensus information to chains, new functions `Common.consensusType()` for consensus type access ("pow" or "poa") and `Common.consensusAlgorithm()` to get the associated algorithm or protocol (e.g. "ethash" PoW algorithm or "clique" PoA protocol), see PR [#937](https://github.com/ethereumjs/ethereumjs-vm/pull/937)
 

packages/common/README.md

@@ -8,7 +8,7 @@
 
 Resources common to all Ethereum implementations.
 
-Succeeds the old [ethereum/common](https://github.com/ethereumjs/common/) library.
+Note: this `README` reflects the state of the library from `v2.0.0` onwards. See `README` from the [standalone repository](https://github.com/ethereumjs/ethereumjs-common) for an introduction on the last preceeding release.
 
 # INSTALL
 
@@ -20,30 +20,36 @@ All parameters can be accessed through the `Common` class which can be required
 main package and instantiated either with just the `chain` (e.g. 'mainnet') or the `chain`
 together with a specific `hardfork` provided.
 
+If no hardfork is provided the common is initialized with the default hardfork.
+
+Current `DEFAULT_HARDFORK`: `istanbul`
+
 Here are some simple usage examples:
 
-```javascript
-const Common = require('@ethereumjs/common')
+```typescript
+import Common from '@ethereumjs/common'
 
-// Instantiate with only the chain
-let c = new Common({ chain: 'ropsten' })
-c.param('gasPrices', 'ecAddGas', 'byzantium') // 500
+// Instantiate with the chain (and the default hardfork)
+const c = new Common({ chain: 'ropsten' })
+c.param('gasPrices', 'ecAddGas') // 500
 
 // Chain and hardfork provided
 c = new Common({ chain: 'ropsten', hardfork: 'byzantium' })
 c.param('pow', 'minerReward') // 3000000000000000000
 
+// Instantiate with an EIP activated
+const c = new Common({ chain: 'mainnet', eips: [2537] })
+
 // Access genesis data for Ropsten network
 c.genesis().hash // 0x41941023680923e0fe4d74a34bdac8141f2540e3ae90623718e47d66d1ca4a2d
 
 // Get bootstrap nodes for chain/network
 c.bootstrapNodes() // Array with current nodes
 ```
 
-It is encouraged to also explicitly set the `supportedHardforks` if the initializing library
-only supports a certain range of `hardforks`:
+If the initializing library only supports a certain range of `hardforks` you can use the `supportedHardforks` option to restrict hardfork access on the `Common` instance:
 
-```javascript
+```typescript
 let c = new Common({
   chain: 'ropsten',
   supportedHardforks: ['byzantium', 'constantinople', 'petersburg'],
@@ -77,13 +83,16 @@ library supported:
 - `byzantium`
 - `constantinople`
 - `petersburg` (aka `constantinopleFix`, apply together with `constantinople`)
-- `istanbul` (`DEFAULT_HARDFORK`)
-- `muirGlacier`
+- `istanbul` (`DEFAULT_HARDFORK` (`v2.0.0` release series))
+- `muirGlacier` (since `v1.5.0`)
 
 ## Future Hardforks
 
-The `muirGlacier` HF delaying the difficulty bomb and scheduled for January 2020
-is supported by the library since `v1.5.0`.
+General support for the `berlin` hardfork has been added along `v2.0.0`, specification of the hardfork regarding EIPs included was not finalized upon release date.
+
+Currently supported `berlin` EIPs:
+
+- `EIP-2315`
 
 ## Parameter Access
 
@@ -102,9 +111,6 @@ hardfork.
 The hardfork-specific json files only contain the deltas from `chainstart` and
 shouldn't be accessed directly until you have a specific reason for it.
 
-Note: The list of `gasPrices` and gas price changes on hardforks is consistent
-but not complete, so there are currently gas price values missing (PRs welcome!).
-
 # Chain Params
 
 Supported chains:
@@ -113,14 +119,16 @@ Supported chains:
 - `ropsten`
 - `rinkeby`
 - `kovan`
-- `goerli` (final configuration since `v1.1.0`)
+- `goerli`
 - Private/custom chain parameters
 
 The following chain-specific parameters are provided:
 
 - `name`
 - `chainId`
 - `networkId`
+- `consensusType` (e.g. `pow` or `poa`)
+- `consensusAlgorithm` (e.g. `ethash` or `clique`)
 - `genesis` block header values
 - `hardforks` block numbers
 - `bootstrapNodes` list

packages/common/docs/classes/_index_.common.md

@@ -30,6 +30,8 @@ Common class to access chain and hardfork parameters
 * [bootstrapNodes](_index_.common.md#bootstrapnodes)
 * [chainId](_index_.common.md#chainid)
 * [chainName](_index_.common.md#chainname)
+* [consensusAlgorithm](_index_.common.md#consensusalgorithm)
+* [consensusType](_index_.common.md#consensustype)
 * [eips](_index_.common.md#eips)
 * [forkHash](_index_.common.md#forkhash)
 * [genesis](_index_.common.md#genesis)
@@ -269,6 +271,34 @@ chain name (lower case)
 
 ___
 
+###  consensusAlgorithm
+
+▸ **consensusAlgorithm**(): *string*
+
+*Defined in [index.ts:649](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/common/src/index.ts#L649)*
+
+Returns the concrete consensus implementation
+algorithm or protocol for the network
+e.g. "ethash" for "pow" consensus type or
+"clique" for "poa" consensus type
+
+**Returns:** *string*
+
+___
+
+###  consensusType
+
+▸ **consensusType**(): *string*
+
+*Defined in [index.ts:639](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/common/src/index.ts#L639)*
+
+Returns the consensus type of the network
+Possible values: "pow"|"poa"
+
+**Returns:** *string*
+
+___
+
 ###  eips
 
 ▸ **eips**(): *number[]*
@@ -338,13 +368,13 @@ ___
 
 ###  hardfork
 
-▸ **hardfork**(): *string | null*
+▸ **hardfork**(): *string*
 
 *Defined in [index.ts:599](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/common/src/index.ts#L599)*
 
 Returns the hardfork set
 
-**Returns:** *string | null*
+**Returns:** *string*
 
 Hardfork name