Tiny fixes #1177

ryanio · 2021-03-30T20:07:11Z

This PR combines some tiny fixes from #905, including:

Add blockchain leveldb object support info blockchain: fix heads for leveldown #972 (comment)
Add structure diagram edit URL Mermaid chart below the diagram to make the update procedure more transparent
VM: Add better description for addresses used along VM.runCode(), see Misleading description in runCode #979
Add some dev documentation along the comment from @ryanio On-demand testing for VM State and Blockchain #951 (comment)
Common: Fix README typo from Common: Custom Chain File Integration #1034 (comment)
Permalink updates ethereumjs-vm -> ethereumjs-monorepo
Add Trie, Util to issue templates

This PR additionally:

Updates typedoc to latest, removes some deprecated options
Fixes devp2p peer communication examples with new tx library updates

I haven't regenerated the docs yet since it looks like it will change a few hundred files (since the library mode was removed) and I wanted to make the review easier, so I can add that as a last commit after review, or before the next release, whichever you'd prefer @holgerd77.

codecov · 2021-03-30T20:13:12Z

Codecov Report

Merging #1177 (f97dae7) into master (8733939) will decrease coverage by 0.09%.
The diff coverage is n/a.

Flag	Coverage Δ
block	`82.25% <ø> (-0.06%)`	⬇️
blockchain	`84.23% <ø> (ø)`
client	`84.05% <ø> (+0.01%)`	⬆️
common	`87.39% <ø> (+0.52%)`	⬆️
devp2p	`83.88% <ø> (-0.42%)`	⬇️
ethash	`82.08% <ø> (ø)`
tx	`84.30% <ø> (ø)`
vm	`83.63% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

ryanio · 2021-03-30T20:56:15Z

client karma run is having some trouble with a downstream update: Uncaught TypeError: TextDecoder is not a constructor

it looks like it's from web-encoding v1.1.2 which was just released, i'm looking into if it's an issue on our end or theirs.

holgerd77 · 2021-03-31T14:04:31Z

@ryanio Cool! 😄 👍

Maybe don't regenerate the docs, I'd rather do this along the PR on the releases, so if we merge earlier here than I would do this on the release PR, then we are more flexible here and I would really like to get these releases out this week. If I will do the releases before the merge here it is also better to wait since it otherwise would get a bit tricky on rebase (I've also changed a lot of docs there).

* update to latest * update markdown plugin to latest * remove deprecated options: - inputFiles -> entryPoints - mode - excludeNotExported

…ANGELOGs

…ansform

ryanio · 2021-04-01T04:46:24Z

ok this should be ready for review now! feel free to merge if it looks good.

holgerd77

Looks good, thanks, nice clean-up! 😄 👍

holgerd77 · 2021-04-06T07:40:19Z

packages/vm/typedoc.js

@@ -11,7 +10,6 @@ module.exports = {
    'lib/evm/**',
    'lib/state/cache.ts',
  ],
-  excludeNotExported: true,


Do you have got a clear reason to have this removed? I haven't got the complete oversight of the consequences right now.

yes this option was removed:

This is mentioned in the release notes here: https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0

Removed options - mode, excludeNotExported, includeDeclarations, ignoreCompilerErrors, entryPoint

the real impacting change is that the experimental library mode was removed and there is a new default mode. so our newly regenerated docs after these changes may look quite different in structure and markup, but should hopefully be an improvement and align with the future development of the package.

holgerd77 · 2021-04-06T07:42:38Z

packages/block/package.json

@@ -58,10 +58,10 @@
    "eslint-config-prettier": "^6.11.0",
    "eslint-plugin-implicit-dependencies": "^1.0.4",
    "istanbul": "^0.4.1",
-    "karma": "^5.2.1",
-    "karma-browserify": "^7.0.0",
+    "karma": "^6.3.2",


Out of interest: have you looked if this has any practical consequences (performance, test quality or realism 😄 ,...)?

i was updating the deps in trying to resolve some miscellaneous issues but it was all working fine so i decided to keep the version bumps :)

holgerd77 · 2021-04-06T07:43:57Z

package.json

@@ -15,7 +15,7 @@
  "scripts": {
    "postinstall": "npm run bootstrap",
    "bootstrap": "lerna bootstrap --ignore-scripts --include-dependencies --no-ci --hoist && npm run temporaryClientFixes && npm run build",
-    "temporaryClientFixes": "cp node_modules/interface-datastore/dist/src/key.d.ts node_modules/interface-datastore/src && cd node_modules/bcrypto && npm i",
+    "temporaryClientFixes": "rm -r node_modules/acorn && cp -r node_modules/karma-typescript/node_modules/acorn/ node_modules/acorn/ && cp node_modules/interface-datastore/dist/src/key.d.ts node_modules/interface-datastore/src && cd node_modules/bcrypto && npm i",


Can you give a (very short) description what is happening here (or have I missed?)?

yes I should have noted this, thanks.

this is a small temporary workaround fix for an updated acorn version which karma-typescript needs for the es6-transform plugin (which i described here: #1177 (comment)). karma was hanging on the transform step when using an older version of acorn. our node_modules has several acorn version but the one on the top level that was being used was outdated, so i copy the newer version located inside karma-typescript/node_modules to the top level node_modules which resolved the problem.

i'll check back in a few weeks and if the issue is resolved (most likely by other modules updating their acorn dependency version) i can remove this temporary workaround 👍

holgerd77 · 2021-04-06T07:46:21Z

packages/client/package.json

@@ -102,6 +102,7 @@
    "karma-firefox-launcher": "^2.1.0",
    "karma-tap": "^4.2.0",
    "karma-typescript": "^5.5.1",
+    "karma-typescript-es6-transform": "^5.5.1",


Is this introduction related to the quoted problem?

client karma run is having some trouble with a downstream update: Uncaught TypeError: TextDecoder is not a constructor

it looks like it's from web-encoding v1.1.2 which was just released, i'm looking into if it's an issue on our end or theirs.

yes, so after I reported my bug they did a new release updating the browser file but it was an esmodules (es6) file so I needed this plugin to transform it to es5 to work in our pipeline.

ryanio added the PR state: needs review label Mar 30, 2021

ryanio added the PR state: WIP label Mar 31, 2021

ryanio added 14 commits March 31, 2021 21:23

add issue templates for trie, util

af484d9

update ethereumjs-vm links to ethereumjs-monorepo (repository renaming)

b1d58c6

fix readme typo

0e1ec59

runCode: add more description for caller and address

ea825b5

add clarifying notes to blockchain.db typedoc regarding encoding-down

c6b0f73

add mermaid diagram edit url and instructions

9b2f11f

block: fix typo in comment

e401885

add developer docs for label type: test all hardforks

de8b8a4

typedoc:

143cab9

* update to latest * update markdown plugin to latest * remove deprecated options: - inputFiles -> entryPoints - mode - excludeNotExported

fix devp2p peer communication examples with new tx library updates

7cfa4da

update permalinks from ethereumjs-vm to ethereumjs-monorepo in CH…

c85ba89

…ANGELOGs

permalink update, typo fix

9ba0db9

update karma deps to latest

ceb9ff8

update package-lock for latest web-encoding release, add karma es6 tr…

aa4f2d6

…ansform

ryanio force-pushed the tiny-fixes branch from a5eceb2 to aa4f2d6 Compare April 1, 2021 04:24

ryanio removed the PR state: WIP label Apr 1, 2021

Merge branch 'master' into tiny-fixes

f97dae7

holgerd77 approved these changes Apr 6, 2021

View reviewed changes

holgerd77 merged commit a141b52 into master Apr 6, 2021

holgerd77 deleted the tiny-fixes branch April 6, 2021 07:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tiny fixes #1177

Tiny fixes #1177

ryanio commented Mar 30, 2021

codecov bot commented Mar 30, 2021 •

edited

Loading

ryanio commented Mar 30, 2021

holgerd77 commented Mar 31, 2021

ryanio commented Apr 1, 2021

holgerd77 left a comment

holgerd77 Apr 6, 2021

ryanio Apr 6, 2021

ryanio Apr 6, 2021

holgerd77 Apr 6, 2021

ryanio Apr 6, 2021

holgerd77 Apr 6, 2021

ryanio Apr 6, 2021

holgerd77 Apr 6, 2021

ryanio Apr 6, 2021

Tiny fixes #1177

Tiny fixes #1177

Conversation

ryanio commented Mar 30, 2021

codecov bot commented Mar 30, 2021 • edited Loading

Codecov Report

ryanio commented Mar 30, 2021

holgerd77 commented Mar 31, 2021

ryanio commented Apr 1, 2021

holgerd77 left a 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

codecov bot commented Mar 30, 2021 •

edited

Loading