Create script + docs to assist with forks #1903

cburgdorf · 2019-12-17T14:51:31Z

What was wrong?

Forking is error prone and undocumented.

How was it fixed?

To-Do

Clean up commit history

Add entry to the release notes

Cute Animal Picture

veox

Highlighted a few typos.

veox · 2019-12-19T15:46:49Z

docs/guides/implementing_vm_forks.rst

+Implementing VM forks
+=====================
+
+The Ethereum protocol follows specified rules which continue to be improved through so called


s/so called/so-called/

veox · 2019-12-19T15:46:57Z

docs/guides/implementing_vm_forks.rst

+The Ethereum protocol follows specified rules which continue to be improved through so called
+`Ethereum Improvement Proposals (EIPs) <https://eips.ethereum.org/>`_. Every now and then the
+community agrees on a few EIPs to become part of the next protocol upgrade. These upgrades happen
+through so called `Hardforks <https://en.wikipedia.org/wiki/Fork_(blockchain)>`_ which define:


s/so called/so-called/

veox · 2019-12-19T15:48:02Z

docs/guides/implementing_vm_forks.rst

+through so called `Hardforks <https://en.wikipedia.org/wiki/Fork_(blockchain)>`_ which define:
+
+1. A name for the set of rule changes (e.g. the Istanbul hardfork)
+2. A block number from which on blocks are processed according to these new rules (e.g. ``9069000``)


s/on blocks are/blocks start being/

veox · 2019-12-19T15:49:40Z

docs/guides/implementing_vm_forks.rst

+
+
+This guide covers how to implement new hardforks in Py-EVM. The specifics and impact of each rule
+change many vary a lot between different hardforks and it is out of the scope of this guide to


s/many vary/may vary/

veox · 2019-12-19T15:51:48Z

docs/guides/implementing_vm_forks.rst

+------------------------
+
+Every fork is encapsulated in its own module under ``eth.vm.forks.<fork-name>``. To create the
+scaffolding for a new fork run ``python scripts/forking/create_fork.py`` and follow the assistent.


s/assistent/assistant/

veox · 2019-12-19T15:56:18Z

docs/guides/implementing_vm_forks.rst

+
+Ethereum is a protocol that powers different networks. Most notably, the ethereum mainnet but there
+are also other networks such as testnetworks (e.g. Görli) or xDai. If and when a specific network
+will activate a concrete fork remains to be configured on a per network basis.


Suggestion for the entire paragraph:

Ethereum is a protocol that powers different networks - most notably, the Ethereum mainnet; but there
are also other value-bearing networks (e.g. xDai), or test networks (e.g. Görli). Whether and when a specific network
will activate a fork remains to be configured on a per-network basis.

BTW, I think xDai is the project name, and they're using the POA side-chain.

veox · 2019-12-19T15:56:42Z

docs/guides/implementing_vm_forks.rst

+are also other networks such as testnetworks (e.g. Görli) or xDai. If and when a specific network
+will activate a concrete fork remains to be configured on a per network basis.
+
+At the time of writing, Py-EVM has supports the following three networks:


s/has supports/supports/

veox · 2019-12-19T15:57:13Z

docs/guides/implementing_vm_forks.rst

+
+For each network that wants to activate the fork, we have to create a new constant in
+``eth/chains/<network>/constants.py`` that describes the block number at which the fork becomes
+active as seen in the following example:


s/active/active,/

pipermerriam · 2019-12-19T19:59:24Z

scripts/forking/create_fork.py

+
+    if not all(x.isalpha() or x.isspace() for x in fork_name):
+        print(f"Can't use {fork_name} as fork name, must be alphabetical")
+        return


Should probably return non-zero so sys.exit(1)?

pipermerriam · 2019-12-19T20:00:00Z

scripts/forking/create_fork.py

+        print(f"Can't use {fork_name} as fork name, must be alphabetical")
+        return
+
+    print("Specify the fork base (e.g Istanbul):")


This strikes me as something we can pre-populate a default for by looking at the latest mainnet fork.

pipermerriam · 2019-12-19T20:02:56Z

scripts/forking/create_fork.py

+    dash_case = normalized.replace(' ', '-')
+    pascal_case = normalized.title().replace(' ', '')
+
+    return Writing(


It would be ideal for this to output something like:

For name: "Istanbul" python module: ./eth/forks/istanbul/ block number variable name: "ISTANBUL_BLOCK_NUMBER" ...

So that it's being very explicit about what the script is going to do.

pipermerriam · 2019-12-19T20:03:05Z

scripts/forking/create_fork.py

+
+
+def create_fork(writing_new_fork: Writing, writing_parent_fork: Writing) -> None:
+    fork_path = FORKS_BASE_PATH / writing_new_fork.lower_snake_case


I would suggest writing all of this to a temporary directory and then moving the temporary directory into place once it's all done.

pipermerriam · 2019-12-19T20:06:19Z

scripts/forking/template/whitelabel/__init__.py

+from .state import IstanbulState
+
+
+class IstanbulVM(ConstantinopleVM):


I'm thinking these files should be templated rather than "white labeled"

from eth.vm.forks.<% parent_fork_snake_case %> import ( <% parent_fork_name %>VM, ) class <% fork_name %>VM(<% parent_fork_name %>VM): ...

This makes it future proof, otherwise we will likely run into a scenario where the find-replace regexing replaces text somewhere like a comment or something....

I'm thinking these files should be templated rather than "white labeled"

Yeah, I also thought about that. The one downside is that you'd lose the ability to run simple flake8/mypy checks against it. You'd have to actually create a fork and run flake8/mypy checks against the result. Not necessarily bad though.

Anyway, this PR is just a very early draft anyway. But thanks for reviewing anyway (also to @veox 👍 )

cburgdorf · 2020-04-08T07:35:16Z

@a1love Did you mean to tell us something?

scripts/forking/template/whitelabel/opcodes.py

scripts/forking/template/whitelabel/transactions.py

Co-authored-by: Jason Carver <ut96caarrs@snkmail.com>

cburgdorf force-pushed the christoph/doc/forks branch from 799ae30 to 8a97922 Compare December 18, 2019 08:17

veox reviewed Dec 19, 2019

View reviewed changes

veox mentioned this pull request Dec 19, 2019

Add support for Muir Glacier fork ethereum/trinity#1409

Merged

2 tasks

pipermerriam reviewed Dec 19, 2019

View reviewed changes

WIP

799af32

cburgdorf force-pushed the christoph/doc/forks branch from 8a97922 to 799af32 Compare May 26, 2020 13:41

Fix fork base path check

ca9e0fe

cburgdorf mentioned this pull request May 26, 2020

Implement Berlin fork stub #1933

Closed

2 tasks

carver reviewed Feb 19, 2021

View reviewed changes

scripts/forking/template/whitelabel/opcodes.py Outdated Show resolved Hide resolved

carver reviewed Feb 19, 2021

View reviewed changes

scripts/forking/template/whitelabel/transactions.py Outdated Show resolved Hide resolved

carver mentioned this pull request Feb 19, 2021

Implement Berlin fork stub #1969

Merged

2 tasks

cburgdorf and others added 2 commits February 19, 2021 09:51

Update scripts/forking/template/whitelabel/opcodes.py

1544ccb

Co-authored-by: Jason Carver <ut96caarrs@snkmail.com>

Update scripts/forking/template/whitelabel/transactions.py

992d3ec

Co-authored-by: Jason Carver <ut96caarrs@snkmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create script + docs to assist with forks #1903

Create script + docs to assist with forks #1903

cburgdorf commented Dec 17, 2019

veox left a comment

veox Dec 19, 2019

veox Dec 19, 2019

veox Dec 19, 2019

veox Dec 19, 2019

veox Dec 19, 2019

veox Dec 19, 2019 •

edited

veox Dec 19, 2019

veox Dec 19, 2019

pipermerriam Dec 19, 2019

pipermerriam Dec 19, 2019

pipermerriam Dec 19, 2019

pipermerriam Dec 19, 2019

pipermerriam Dec 19, 2019

cburgdorf Dec 20, 2019

cburgdorf commented Apr 8, 2020



		This guide covers how to implement new hardforks in Py-EVM. The specifics and impact of each rule
		change many vary a lot between different hardforks and it is out of the scope of this guide to



		def create_fork(writing_new_fork: Writing, writing_parent_fork: Writing) -> None:
		fork_path = FORKS_BASE_PATH / writing_new_fork.lower_snake_case

		from .state import IstanbulState


		class IstanbulVM(ConstantinopleVM):

Create script + docs to assist with forks #1903

Are you sure you want to change the base?

Create script + docs to assist with forks #1903

Conversation

cburgdorf commented Dec 17, 2019

What was wrong?

How was it fixed?

To-Do

Cute Animal Picture

veox 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

veox Dec 19, 2019 • edited

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

cburgdorf commented Apr 8, 2020

veox Dec 19, 2019 •

edited