VM/EVM: Update and align README Documentation #2016
Conversation
holgerd77
added
PR state: WIP
type: docs
package: vm
target: master
Codecov Report
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Ok, this is now ready for review. 🙂 |
|
(note that it likely makes sense to primarily (or at least: additionally) directly take a peek in the resulting EVM README and VM README files instead of comparing the diffs in this PR) |
holgerd77
force-pushed
the
vm-evm-readme-updates
branch
from
7702b25
to
c0156f2
Compare
|
Will admin-merge here since people are already getting confused by the state of the READMEs and submit unnecessary PRs, see #2023. It would still be good if someone can give this a read. |
|
LGTM! 🚀 |
|
|
||
| ### Clique/PoA Chains | ||
| To ensure a unified interface the `EVM` provides a TypeScript `EEI` interface providing which includes the necessary function signatures for access to environmental parameters as well as the VM state. |
There was a problem hiding this comment.
To ensure a unified interface the EVM provides a TypeScript EEI interface which includes the necessary function signatures for access to environmental parameters as well as the VM state.
There was a problem hiding this comment.
Thanks, have added these tasks to the newly revived "Tiny Fixes Meta Issue" issue #2032 🙂, since otherwise too small left-overs to address separately.
| const common = new Common({ chain: Chain.Goerli }) | ||
| const hardforkByBlockNumber = true | ||
| const vm = new VM({ common, hardforkByBlockNumber }) | ||
| To build the EVM for standalone use in the browser, see: [Running the EVM in a browser](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/evm/examples/run-code-browser.js). |
There was a problem hiding this comment.
This does not currently work, no?
There was a problem hiding this comment.
Yeah, you're right, we should give a short mention.
WIP, will continue tomorrow on this.