Block release v3.0.0 #682

evertonfraga · 2020-03-31T23:40:18Z

This PR initially supersedes ethereumjs/ethereumjs-block#74. Given that this is now a monorepo, I aim to perform the respective integrations in downstream libraries (see diagram below).

Integrate ethereumjs-block v3.0.0 in ethereumjs-blockchain
Integrate ethereumjs-block v3.0.0 in ethereumjs-vm

Closes #680

codecov · 2020-04-02T02:33:24Z

Codecov Report

Merging #682 into vm/release-v5 will decrease coverage by 1.34%.
The diff coverage is 85.71%.

@@                Coverage Diff                @@
##           vm/release-v5     #682      +/-   ##
=================================================
- Coverage          91.69%   90.34%   -1.35%     
=================================================
  Files                 47       43       -4     
  Lines               3011     3005       -6     
  Branches             469      469              
=================================================
- Hits                2761     2715      -46     
- Misses               151      194      +43     
+ Partials              99       96       -3

Flag	Coverage Δ
#account	`94.11% <ø> (ø)`
#block	`82.82% <83.78%> (-5.45%)`	⬇️
#blockchain	`89.22% <85.00%> (+0.21%)`	⬆️
#common	`94.11% <ø> (-0.26%)`	⬇️
#tx	`94.02% <ø> (-0.09%)`	⬇️
#vm	`92.53% <100.00%> (ø)`

Impacted Files	Coverage Δ
packages/block/src/header.ts	`67.21% <0.00%> (-21.32%)`	⬇️
packages/blockchain/src/index.ts	`87.79% <80.00%> (+0.07%)`	⬆️
packages/block/src/block.ts	`71.15% <81.81%> (-14.15%)`	⬇️
packages/block/src/from-rpc.ts	`86.66% <100.00%> (+0.45%)`	⬆️
packages/blockchain/src/dbManager.ts	`95.31% <100.00%> (+0.07%)`	⬆️
packages/vm/lib/evm/evm.ts	`91.97% <100.00%> (ø)`
packages/vm/lib/runBlock.ts	`80.95% <100.00%> (ø)`
packages/vm/lib/runCall.ts	`86.36% <100.00%> (ø)`
packages/vm/lib/runCode.ts	`95.45% <100.00%> (ø)`
packages/vm/lib/runTx.ts	`91.13% <100.00%> (ø)`
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b5e2958...d63eb98. Read the comment docs.

holgerd77 · 2020-04-02T19:57:05Z

packages/block/src/from-rpc.ts

@@ -61,6 +60,7 @@ function normalizeTxParams(_txParams: any) {
  // strict byte length checking
  txParams.to = txParams.to ? ethUtil.setLengthLeft(ethUtil.toBuffer(txParams.to), 20) : null
  // v as raw signature value {0,1}
-  txParams.v = txParams.v < 27 ? txParams.v + 27 : txParams.v
+  const v: number = txParams.v
+  txParams.v = v < 27 ? v + 27 : v


What is happening here?

tsc fix. This whole method needs a refactor to remove the magic numbers and is on my to-do list.

@holgerd77 I added a more descriptive comment to explain this magic number.

@evertonfraga looks great, would make for a good trivia question 😄

holgerd77 · 2020-04-02T20:00:33Z

packages/blockchain/src/index.ts

@@ -314,7 +312,7 @@ export default class Blockchain implements BlockchainInterface {
   * @hidden
   */
  _setCanonicalGenesisBlock(cb: any): void {
-    const genesisBlock = new Block(null, { common: this._common })
+    const genesisBlock = new Block(undefined, { common: this._common })


Just for understanding: was this a necessary change which triggered some test failure or something before respectively came along with some code changes in v3.0.0? Or is this just an adjustment to make things cleaner?

This first round of changes is to comply with the linter and tsc. There were several compilation failures and Blockchain code was not functional when bumping Block to 3.0.0.

In this specific case, null is not informed as a valid type in the Block constructor().

constructor( data: Buffer | [Buffer[], Buffer[], Buffer[]] | BlockData = {}, opts: ChainOptions = {}, )

Should we mention this in the v3.0.0 release notes?

Yes, definitely!

@holgerd77 I am leaning towards allowing null in Block constructor. What are your thoughts?

I can then revert the null to undefined changes made in this PR.

Would also have a tendency to keep it "as is".

got it. working on it.

Right. In the end, I have changed my mind regarding this.

The TypeScript community in general is not much of a fan of null values representing undefined values. In fact, this is a broad issue on how null is much often misused.

So, as the default code from TypeScript version of Block wasn't allowing null in their signature, I stick to it, and for JavaScript consumers, though, I added this check, which makes sure the method will behave as expected, so if a JS code initializes Block with data === null, data will become its null-object equivalent with value {}.

The impact in our TS code of using new Block(undefined, {}) is super low, only used in Block tests.

packages/blockchain/test/index.ts

packages/blockchain/package.json

… in ethereumjs/ethereumjs-block#93

evertonfraga · 2020-05-07T10:42:06Z

packages/block/package.json

@@ -54,7 +54,6 @@
    "@types/node": "^11.13.4",
    "@types/tape": "^4.2.33",
    "browserify": "^16.2.3",
-    "ethereumjs-blockchain": "^4.0.3",


removed this circular dependency

evertonfraga · 2020-05-14T20:34:14Z

lerna.json

-    "bootstrap": {
-      "ignore": "ethereumjs-block"
-    }
-  }


ethereumjs-block is now integrated to Lerna workflow, so this change removes it from the ignore list for the bootstrap command.

evertonfraga · 2020-05-14T20:35:06Z

package.json

@@ -11,8 +11,9 @@
    }
  },
  "scripts": {
-    "bootstrap": "lerna bootstrap --ignore-scripts && lerna exec npm i --scope=ethereumjs-block",


lerna bootstrap now installs packages for ethereumjs-block as well, so removing npm i here.

evertonfraga · 2020-05-14T20:36:27Z

packages/block/CHANGELOG.md

+
+[3.0.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%402.2.0...%40ethereumjs%2Fblock%403.0.0
+
+## [2.2.2] - 2019-12-17


picked 3.0.0, 2.2.1 and 2.2.2 changelog entries from its own branches in ethereumjs-block. Modified a bit 3.0.0 text.

looks great 👍

evertonfraga · 2020-05-14T20:37:35Z

packages/block/CHANGELOG.md

@@ -24,21 +134,21 @@ PR [#64](https://github.com/ethereumjs/ethereumjs-block/pull/64)
 - Remove `ethereumjs-testing` dependency (much smaller dev dependencies),
  PR [#61](https://github.com/ethereumjs/ethereumjs-block/pull/61)

-[2.2.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fvm%402.1.0...%40ethereumjs%2Fvm%402.2.0
+[2.2.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%402.1.0...%40ethereumjs%2Fblock%402.2.0


fixed comparison link, somehow the sed command used during the migration substituted it erroneously.

evertonfraga · 2020-05-14T20:37:52Z

packages/block/CHANGELOG.md


 ## [2.1.0] - 2018-10-19

 - **Constantinople** support, added difficulty bomb delay (EIP-1234), PR [#54](https://github.com/ethereumjs/ethereumjs-block/pull/54)
 - Updated test data, added Constantinople tests, PR [#56](https://github.com/ethereumjs/ethereumjs-block/pull/56), [#57](https://github.com/ethereumjs/ethereumjs-block/pull/57)
 - Added `timestamp` field to `setGenesisParams()`, PR [#52](https://github.com/ethereumjs/ethereumjs-block/pull/52)

-[2.1.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fvm%402.0.1...%40ethereumjs%2Fvm%402.1.0
+[2.1.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%402.0.1...%40ethereumjs%2Fblock%402.1.0


monorepo migration fix.

evertonfraga · 2020-05-14T20:37:59Z

packages/block/CHANGELOG.md


 ## [2.0.1] - 2018-08-08

 - Fixes `BlockHeader.prototype.validate()` bug, see PR [#49](https://github.com/ethereumjs/ethereumjs-block/pull/49)

-[2.0.1]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fvm%402.0.0...%40ethereumjs%2Fvm%402.0.1
+[2.0.1]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%402.0.0...%40ethereumjs%2Fblock%402.0.1


monorepo migration fix.

evertonfraga · 2020-05-14T20:38:27Z

packages/block/CHANGELOG.md

 - Correct block validation for all know hardforks, PR
  [#47](https://github.com/ethereumjs/ethereumjs-block/pull/47), if no hardfork is set validation logic
  is determined by block number in combination with the `chain` set
 - Genesis block initialization depending on the `chain` set (see `ethereumjs-common` for supported chains)
 - Extensive test additions to cover the newly introduced capabilities and changes
 - Fix default value for `nonce` (empty buffer -> `<Buffer 00 00 00 00 00 00 00 00>`), PR [#42](https://github.com/ethereumjs/ethereumjs-block/pull/42)

-[2.0.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fvm%401.7.1...%40ethereumjs%2Fvm%402.0.0
+[2.0.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%401.7.1...%40ethereumjs%2Fblock%402.0.0


monorepo link migration fix.

evertonfraga · 2020-05-14T20:38:59Z

packages/block/CHANGELOG.md

@@ -52,23 +162,23 @@ Changes in detail:
 - New initialization parameters `opts.chain` (default: `mainnet`) and `opts.hardfork`
  (default: `null`, block number-based behaviour), PR [#44](https://github.com/ethereumjs/ethereumjs-block/pull/44)
 - Alternatively a `Common` class object can be provided directly with the `opts.common` parameter,
-  see [API](https://github.com/ethereumjs/ethereumjs-block/blob/master/docs/index.md) docs
+  see [API](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/block/docs/index.md) docs


migrating link to monorepo structure.

evertonfraga · 2020-05-14T20:40:02Z

packages/block/package.json

@@ -10,7 +10,7 @@
  "scripts": {
    "build": "ethereumjs-config-build",
    "prepublishOnly": "npm run test && npm run build",
-    "coverage": "npx nyc npm run test:node",


npx is irrelevant here as nyc is listed as devDependency.

evertonfraga · 2020-05-14T20:40:34Z

packages/block/package.json

@@ -20,7 +20,7 @@
    "lint": "ethereumjs-config-lint",
    "lint:fix": "ethereumjs-config-lint-fix",
    "test": "npm run test:node && npm run test:browser",
-    "test:node": "npx tape -r ts-node/register test/*.spec.ts",


npx is irrelevant here as tape is listed as devDependency.

evertonfraga · 2020-05-14T20:44:41Z

packages/block/package.json

@@ -70,8 +69,5 @@
    "typedoc-plugin-markdown": "^2.2.17",
    "typescript": "^3.4.3",
    "typestrict": "^1.0.2"
-  },
-  "publishConfig": {
-    "directory": "src"


We can't do the direct typescript code linking yet without handling the browser tests in a cross-package scope.

evertonfraga · 2020-05-14T20:49:01Z

packages/block/test/block.spec.ts

+      st.end()
+    })
+  })
+


Adding some basic initialization tests

evertonfraga · 2020-05-14T20:53:27Z

packages/blockchain/src/dbManager.ts

    let body
    try {
      body = await this.getBody(hash, number)
    } catch (e) {
      body = [[], []]
    }

-    return new Block([header].concat(body), { common: this._common })
+    const blockData = [header].concat(body) as [Buffer[], Buffer[], Buffer[]]


TS compiler was erroring out on this block of code.

ryanio · 2020-05-15T02:35:14Z

packages/block/CHANGELOG.md

+### Promise-based API
+
+The API of this library is now completely promise-based, the old callback-style
+interface has been dropped.


evertonfraga · 2020-05-15T02:36:18Z

Thanks for the review, @ryanio!

ryanio · 2020-05-15T02:37:18Z

packages/block/src/block.ts

+    // Checking at runtime, to prevent errors down the path for JavaScript consumers.
+    if (data === null) {
+      data = {}
+    }


ryanio · 2020-05-15T02:48:02Z

packages/blockchain/src/index.ts

 const Ethash = require('ethashjs')
 const Stoplight = require('flow-stoplight')
 const level = require('level-mem')
 const semaphore = require('semaphore')

-export type Block = any


ryanio · 2020-05-15T02:51:11Z

packages/blockchain/src/index.ts

@@ -470,28 +468,29 @@ export default class Blockchain implements BlockchainInterface {

    async.series(
      [
-        verify,
+        async.asyncify(async function() {


oh nice 👍

a full refactor should be done to simplify all these mixed async methods. But that's already planned :)

ryanio · 2020-05-15T02:57:50Z

packages/vm/tests/tester.js

@@ -182,6 +182,8 @@ function runTests(name, runnerArgs, cb) {
      const runner = require(`./${name}Runner.js`)
      // Tests for HFs before Istanbul have been moved under `LegacyTests/Constantinople`:
      // https://github.com/ethereum/tests/releases/tag/v7.0.0-beta.1
+
+      // TODO: Replace with Common.lteHardfork('Istanbul')


👍 anything blocking this?

no! but I'd rather make in a separate PR, this one is beyond big. It should be handled with care, testing several test scopes.

ryanio

Wow looks great, nice work on everything that needed to happen for this integration @evertonfraga 👍

holgerd77 · 2020-05-15T10:53:40Z

Whew, this is really a biggy! 😁 Congrats on this, feel free to merge in from my side as well.

* block: version bump * block: adds changelog from v2.2.1 to v3.0.0 * blockchain: integrating ethereumjs block 3.0.0 * blockchain: converting canonicalDifficulty to buffer * blockchain: instantiating Block with empty/undefined data * blockchain: integrating Block 3.0.0 * block: lint:fix changes * All siloed tests passing. * vm: lint fix * leftovers of a rebase * lint fix * lint fix * vm,block: integrating Block with Lerna * block: remove circular dependency to ethereumjs-blockchain introduced in ethereumjs/ethereumjs-block#93 * block: removing unnecessary npx command * block: lint fix * blockchain: removing typo * vm: fix BlockHeader import * blockchain: fixing block initialization [Buffer[], Buffer[], Buffer[]] format * vm: updating methods to async * vm: misc changes * block: describing recovery bit normalization statement * block: removing source linking * docs: update for all packages

evertonfraga added PR state: WIP package: block labels Mar 31, 2020

evertonfraga self-assigned this Mar 31, 2020

holgerd77 reviewed Apr 2, 2020

View reviewed changes

packages/blockchain/test/index.ts Show resolved Hide resolved

holgerd77 reviewed Apr 2, 2020

View reviewed changes

packages/blockchain/package.json Show resolved Hide resolved

evertonfraga mentioned this pull request Apr 6, 2020

New release v3.0.0 ethereumjs/ethereumjs-block#74

Closed

evertonfraga changed the base branch from master to vm/release-v5 April 16, 2020 11:30

evertonfraga force-pushed the block/release-v3.0.0 branch from 6d32754 to 334e248 Compare April 21, 2020 11:05

evertonfraga force-pushed the block/release-v3.0.0 branch from 4a540c6 to a526d49 Compare April 30, 2020 18:20

evertonfraga added 12 commits May 1, 2020 14:19

block: version bump

2ac90fc

block: adds changelog from v2.2.1 to v3.0.0

3310aa1

blockchain: integrating ethereumjs block 3.0.0

ff3f0c9

blockchain: converting canonicalDifficulty to buffer

35bcf85

blockchain: instantiating Block with empty/undefined data

3653adb

blockchain: integrating Block 3.0.0

aced4c9

block: lint:fix changes

4ee9aec

All siloed tests passing.

55d3391

vm: lint fix

0d3f316

leftovers of a rebase

541f96d

lint fix

2b97af7

lint fix

e11b29a

evertonfraga force-pushed the block/release-v3.0.0 branch from 43aaefa to e11b29a Compare May 1, 2020 18:32

evertonfraga added 4 commits May 6, 2020 15:44

vm,block: integrating Block with Lerna

5368838

block: remove circular dependency to ethereumjs-blockchain introduced…

4cba1ba

… in ethereumjs/ethereumjs-block#93

block: removing unnecessary npx command

b61c5dc

block: lint fix

c512460

evertonfraga commented May 7, 2020

View reviewed changes

evertonfraga added the PR state: do-not-merge label May 14, 2020

evertonfraga commented May 14, 2020

View reviewed changes

ryanio reviewed May 15, 2020

View reviewed changes

ryanio approved these changes May 15, 2020

View reviewed changes

evertonfraga merged commit 4b9a096 into vm/release-v5 May 15, 2020

evertonfraga deleted the block/release-v3.0.0 branch May 15, 2020 11:45

evertonfraga mentioned this pull request Jun 6, 2020

VM v5 changes #767

Merged

evertonfraga added this to the VM v5 milestone Jun 12, 2020

holgerd77 mentioned this pull request Sep 14, 2020

Integrating the new ethereumjs-block version #692

Closed


		[3.0.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/%40ethereumjs%2Fblock%402.2.0...%40ethereumjs%2Fblock%403.0.0

		## [2.2.2] - 2019-12-17

Block release v3.0.0 #682

Block release v3.0.0 #682

Conversation

evertonfraga commented Mar 31, 2020 • edited Loading

codecov bot commented Apr 2, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

evertonfraga Apr 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evertonfraga Apr 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evertonfraga commented May 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryanio left a comment

Choose a reason for hiding this comment

holgerd77 commented May 15, 2020

evertonfraga commented Mar 31, 2020 •

edited

Loading

codecov bot commented Apr 2, 2020 •

edited

Loading

evertonfraga Apr 2, 2020 •

edited

Loading

evertonfraga Apr 2, 2020 •

edited

Loading