[#1938] - Generate geth fixture for geth version 1.10.3. Fixed some s…

…pelling as I read through some documentation and updated some of the contributing documentation to allow for a smoother process.
ethereum · Jun 10, 2021 · f924990 · f924990
1 parent 10e55fa
commit f924990
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 20 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -219,23 +219,23 @@ jobs:
       - image: circleci/python:3.6
     environment:
       TOXENV: py36-integration-goethereum-ipc
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py36-integration-goethereum-http:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.6
     environment:
       TOXENV: py36-integration-goethereum-http
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py36-integration-goethereum-ws:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.6
     environment:
       TOXENV: py36-integration-goethereum-ws
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   # py36-integration-parity-ipc:
     # <<: *parity_steps
@@ -311,23 +311,23 @@ jobs:
       - image: circleci/python:3.7
     environment:
       TOXENV: py37-integration-goethereum-ipc
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py37-integration-goethereum-http:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.7
     environment:
       TOXENV: py37-integration-goethereum-http
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py37-integration-goethereum-ws:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.7
     environment:
       TOXENV: py37-integration-goethereum-ws
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   # py37-integration-parity-ipc:
     # <<: *parity_steps
@@ -408,23 +408,23 @@ jobs:
       - image: circleci/python:3.8
     environment:
       TOXENV: py38-integration-goethereum-ipc
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py38-integration-goethereum-http:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.8
     environment:
       TOXENV: py38-integration-goethereum-http
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py38-integration-goethereum-ws:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.8
     environment:
       TOXENV: py38-integration-goethereum-ws
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   # py38-integration-parity-ipc:
     # <<: *parity_steps
@@ -500,23 +500,23 @@ jobs:
       - image: circleci/python:3.9
     environment:
       TOXENV: py39-integration-goethereum-ipc
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py39-integration-goethereum-http:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.9
     environment:
       TOXENV: py39-integration-goethereum-http
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   py39-integration-goethereum-ws:
     <<: *geth_steps
     docker:
       - image: circleci/python:3.9
     environment:
       TOXENV: py39-integration-goethereum-ws
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
   # py39-integration-parity-ipc:
   #   <<: *parity_steps
@@ -566,7 +566,7 @@ jobs:
       - image: circleci/python:3.9
     environment:
       TOXENV: benchmark
-      GETH_VERSION: v1.10.1
+      GETH_VERSION: v1.10.3
 
 workflows:
   version: 2.1

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -131,6 +131,13 @@ Running the tests
 
 A great way to explore the code base is to run the tests.
 
+
+First, install the test dependencies:
+
+.. code:: sh
+
+    $ pip install -e ".[test]"
+
 You can run all tests with:
 
 .. code:: sh
@@ -217,6 +224,12 @@ Our integration tests make use of Geth and Parity/OpenEthereum private networks.
 When new versions of the client software are introduced, new fixtures should be
 generated.
 
+Before generating new fixtures, make sure you have the test dependencies installed:
+
+.. code:: sh
+
+    $ pip install -e ".[test]"
+
 .. note::
 
     A "fixture" is a pre-synced network. It's the result of configuring and running
@@ -231,19 +244,19 @@ Geth fixtures
    this purpose, because it enables you to easily manage multiple versions of Geth.
 
    Note that ``py-geth`` will need updating to support each new Geth version as well.
-   Add newer Geth version to py-geth is straightforward; see past commits for a template.
+   Adding newer Geth versions to py-geth is straightforward; see past commits for a template.
 
    If py-geth has the Geth version you need, install that version locally. For example:
 
    .. code:: sh
 
-       $ python -m geth.install v1.10.1
+       $ python -m geth.install v1.10.3
 
 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.10.1/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py ./tests/integration/geth-1.10.1-fixture
+       $ GETH_BINARY=~/.py-geth/geth-v1.10.3/bin/geth python ./tests/integration/generate_fixtures/go_ethereum.py ./tests/integration/geth-1.10.3-fixture
 
 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`` file to point to this new fixture. Delete the old fixture.

diff --git a/docs/gas_price.rst b/docs/gas_price.rst
@@ -15,7 +15,7 @@ dictionary and returns a gas price (denominated in wei).
 Retrieving gas price
 --------------------
 
-To retreive the gas price using the selected strategy simply call
+To retrieve the gas price using the selected strategy simply call
 :meth:`~web3.eth.Eth.generate_gas_price`
 
 .. code-block:: python

diff --git a/docs/providers.rst b/docs/providers.rst
@@ -100,7 +100,7 @@ How Automated Detection Works
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Web3 attempts to connect to nodes in the following order, using the first
-succesful connection it can make:
+successful connection it can make:
 
 1. The connection specified by an environment variable, see :ref:`provider_uri`
 2. :class:`~web3.providers.ipc.IPCProvider`, which looks for several IPC file locations.

diff --git a/newsfragments/1938.misc.rst b/newsfragments/1938.misc.rst
@@ -0,0 +1 @@
+Generate Geth test fixture for v1.10.3.
diff --git a/tests/integration/geth-1.10.1-fixture.zip b/tests/integration/geth-1.10.1-fixture.zip
diff --git a/tests/integration/geth-1.10.3-fixture.zip b/tests/integration/geth-1.10.3-fixture.zip
diff --git a/tests/integration/go_ethereum/conftest.py b/tests/integration/go_ethereum/conftest.py
@@ -19,7 +19,7 @@
 
 KEYFILE_PW = 'web3py-test'
 
-GETH_FIXTURE_ZIP = 'geth-1.10.1-fixture.zip'
+GETH_FIXTURE_ZIP = 'geth-1.10.3-fixture.zip'
 
 
 @pytest.fixture(scope='module')

diff --git a/web3/tools/benchmark/node.py b/web3/tools/benchmark/node.py
@@ -24,7 +24,7 @@
     kill_proc_gracefully,
 )
 
-GETH_FIXTURE_ZIP = "geth-1.10.1-fixture.zip"
+GETH_FIXTURE_ZIP = "geth-1.10.3-fixture.zip"
 
 
 class GethBenchmarkFixture: