Update Geth to 1.14.12 (#3533)

* Update Geth to 1.14.12

* Update docs and conftest with new geth version

* Refactor shared logic in geth version string updates

* Update contributing docs

Author: kclowes

.circleci/config.yml

@@ -4,7 +4,7 @@ parameters:
   # NOTE: Do not update the `geth_version` manually. It is updated during the
   # integration test fixture generation.
   geth_version:
-    default: "1.14.5"
+    default: "1.14.12"
     type: string
   go_version:
     default: "1.22.4"

docs/contributing.rst

@@ -373,25 +373,26 @@ Geth Fixtures
 
    .. code:: sh
 
-       $ python -m geth.install v1.14.5
+      $ python -m geth.install v1.14.12
 
 2. Specify the Geth binary and run the fixture creation script (from within the web3.py directory):
 
    .. code:: sh
 
-       $ GETH_BINARY=~/.py-geth/geth-v1.14.5/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py
+      $ GETH_BINARY=~/.py-geth/geth-v1.14.12/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py
 
 3. The output of this script is your fixture, a zip file, which is now stored in ``/tests/integration/``.
-   Update the ``/tests/integration/go_ethereum/conftest.py`` and
-   ``/web3/tools/benchmark/node.py`` files to point to this new fixture. Delete the old
-   fixture.
+   The ``/tests/integration/go_ethereum/conftest.py`` and
+   ``/web3/tools/benchmark/node.py`` files should be updated automatically to point to this new fixture.
+   Delete the old fixture.
 
 4. Run the tests. To ensure that the tests run with the correct Geth version locally,
    you may again include the ``GETH_BINARY`` environment variable.
 
-5. Update the ``geth_version`` and ``pygeth_version`` parameter defaults in
-   ``/.circleci/config.yml`` to match the ``go-ethereum`` version used to generate the
-   test fixture and the ``py-geth`` version that supports installing it.
+5. The ``geth_version`` and ``pygeth_version`` parameter defaults in
+   ``/.circleci/config.yml`` should be automatically updated to match the
+   ``go-ethereum`` version used to generate the test fixture and the ``py-geth``
+   version that supports installing it.
 
 
 CI Testing With a Nightly Geth Build

docs/middleware.rst

@@ -350,7 +350,7 @@ middleware is:
 
     # confirm that the connection succeeded
     >>> w3.client_version
-    'Geth/v1.14.5-stable-4bb3c89d/linux-amd64/go1.22.4'
+    'Geth/v1.14.12-stable-4bb3c89d/linux-amd64/go1.22.4'
 
 This example connects to a local ``geth --dev`` instance on Linux with a
 unique IPC location and loads the middleware:
@@ -369,7 +369,7 @@ unique IPC location and loads the middleware:
 
     # confirm that the connection succeeded
     >>> w3.client_version
-    'Geth/v1.7.3-stable-4bb3c89d/linux-amd64/go1.9'
+    'Geth/v1.14.12-stable-4bb3c89d/linux-amd64/go1.22.4'
 
 Why is ``ExtraDataToPOAMiddleware`` necessary?
 ''''''''''''''''''''''''''''''''''''''''''''''

newsfragments/3533.internal.rst

@@ -0,0 +1 @@
+Upgrade Geth Fixture to 1.14.12

setup.py

@@ -9,7 +9,7 @@
         # Note: ethereum-maintained libraries in this list should be added to the
         # `install_pre_releases.py` script.
         "eth-tester[py-evm]>=0.11.0b1,<0.13.0b1",
-        "py-geth>=5.0.0",
+        "py-geth>=5.1.0",
     ],
     "dev": [
         "build>=0.9.0",

tests/integration/generate_fixtures/go_ethereum.py

@@ -361,25 +361,81 @@ def setup_chain_state(w3):
     return geth_fixture
 
 
-def update_circleci_geth_version(new_version):
-    file_path = "./.circleci/config.yml"
-    with open(file_path) as file:
-        lines = file.readlines()
-
+def update_geth_version_string(what_to_replace, new_version, change_next_line=False):
     replaced = False
-    for i, line in enumerate(lines):
-        if "geth_version:" in line:
-            if "default:" in lines[i + 1]:
-                lines[i + 1] = f'    default: "{new_version}"\n'
-                replaced = True
-                break
+    for file_path, changes in what_to_replace.items():
+        with open(file_path) as file:
+            lines = file.readlines()
+
+            for i, line in enumerate(lines):
+                for change in changes:
+                    if change["line_to_replace"] in line:
+                        if (
+                            change_next_line
+                            and change["next_line_contains"] in lines[i + 1]
+                        ):
+                            lines[i + 1] = change["replace_with"]
+                            replaced = True
+                            break
+                        else:
+                            lines[i] = change["replace_with"]
+                            replaced = True
+                            break
+
+        if not replaced:
+            raise ValueError("`geth_version` for {file_path} not found / replaced.")
+
+        with open(file_path, "w") as file:
+            file.writelines(lines)
+        print(f"Updated geth_version in {file_path} to {new_version}")
+
+
+def update_doc_version(new_version):
+    changes = {
+        "./docs/contributing.rst": [
+            {
+                "line_to_replace": "python -m geth.install ",
+                "replace_with": f"      $ python -m geth.install v{new_version}\n",
+            },
+            {
+                "line_to_replace": "GETH_BINARY=~",
+                "replace_with": f"      $ GETH_BINARY=~/.py-geth/geth-v{new_version}/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py\n",  # noqa: E501,
+            },
+        ]
+    }
 
-    if not replaced:
-        raise ValueError("`geth_version` for circleci not found / replaced.")
+    update_geth_version_string(changes, new_version)
+
+
+def update_fixture_generation_version(new_version):
+    changes = {
+        "./tests/integration/go_ethereum/conftest.py": [
+            {
+                "line_to_replace": "GETH_FIXTURE_ZIP = ",
+                "replace_with": f'GETH_FIXTURE_ZIP = "geth-{new_version}-fixture.zip"\n',  # noqa: E501
+            },
+        ],
+        "./web3/tools/benchmark/node.py": [
+            {
+                "line_to_replace": "GETH_FIXTURE_ZIP = ",
+                "replace_with": f'GETH_FIXTURE_ZIP = "geth-{new_version}-fixture.zip"\n',  # noqa: E501
+            },
+        ],
+    }
+    update_geth_version_string(changes, new_version)
 
-    with open(file_path, "w") as file:
-        file.writelines(lines)
-    print(f"Updated geth_version to {new_version}")
+
+def update_circleci_geth_version(new_version):
+    changes = {
+        "./.circleci/config.yml": [
+            {
+                "line_to_replace": "geth_version:\n",
+                "replace_with": f'    default: "{new_version}"\n',
+                "next_line_contains": "default:",
+            }
+        ]
+    }
+    update_geth_version_string(changes, new_version, change_next_line=True)
 
 
 if __name__ == "__main__":
@@ -390,3 +446,5 @@ def update_circleci_geth_version(new_version):
     geth_version = re.search(r"geth-v([\d.]+)/", geth_binary).group(1)
     generate_go_ethereum_fixture(f"./tests/integration/geth-{geth_version}-fixture")
     update_circleci_geth_version(geth_version)
+    update_fixture_generation_version(geth_version)
+    update_doc_version(geth_version)

tests/integration/geth-1.14.12-fixture.zip

@@ -34,7 +34,7 @@
 )
 
 KEYFILE_PW = "web3py-test"
-GETH_FIXTURE_ZIP = "geth-1.14.5-fixture.zip"
+GETH_FIXTURE_ZIP = "geth-1.14.12-fixture.zip"
 
 
 @pytest.fixture(scope="module")

tests/integration/geth-1.14.5-fixture.zip

@@ -24,7 +24,7 @@
     kill_proc_gracefully,
 )
 
-GETH_FIXTURE_ZIP = "geth-1.14.5-fixture.zip"
+GETH_FIXTURE_ZIP = "geth-1.14.12-fixture.zip"
 
 
 class GethBenchmarkFixture: