Rename all references of geth_poa to extradata_to_poa

- The middleware changed names in the refactor, but this commit puts the finishing touches and closes ethereum#899

Author: fselmo

docs/examples.rst

@@ -688,8 +688,8 @@ Inject the middleware into the middleware onion
 
 .. code-block:: python
 
-    from web3.middleware import geth_poa_middleware
-    w3.middleware_onion.inject(geth_poa_middleware, layer=0)
+    from web3.middleware import extradata_to_poa_middleware
+    w3.middleware_onion.inject(extradata_to_poa_middleware, layer=0)
 
 Just remember that you have to sign all transactions locally, as infura does not handle any keys from your wallet ( refer to `this`_  )
 

docs/middleware.rst

@@ -446,16 +446,15 @@ Time-based Cache Middleware
 Proof of Authority
 ~~~~~~~~~~~~~~~~~~
 
-.. py:method:: web3.middleware.geth_poa_middleware
-               web3.middleware.async_geth_poa_middleware
+.. py:class:: web3.middleware.extradata_to_poa_middleware
 
 .. note::
     It's important to inject the middleware at the 0th layer of the middleware onion:
-    ``w3.middleware_onion.inject(geth_poa_middleware, layer=0)``
+    ``w3.middleware_onion.inject(extradata_to_poa_middleware, layer=0)``
 
-The ``geth_poa_middleware`` is required to connect to ``geth --dev`` or the Goerli 
-public network. It may also be needed for other EVM compatible blockchains like Polygon
-or BNB Chain (Binance Smart Chain).
+The ``extradata_to_poa_middleware`` is required to connect to ``geth --dev`` and may
+also be needed for other EVM compatible blockchains like Polygon or
+BNB Chain (Binance Smart Chain).
 
 If the middleware is not injected at the 0th layer of the middleware onion, you may get
 errors like the example below when interacting with your EVM node.
@@ -468,7 +467,8 @@ errors like the example below when interacting with your EVM node.
     for more details. The full extraData is: HexBytes('...')
 
 
-The easiest way to connect to a default ``geth --dev`` instance which loads the middleware is:
+The easiest way to connect to a default ``geth --dev`` instance which loads the
+middleware is:
 
 
 .. code-block:: python
@@ -489,25 +489,26 @@ unique IPC location and loads the middleware:
     # connect to the IPC location started with 'geth --dev --datadir ~/mynode'
     >>> w3 = Web3(IPCProvider('~/mynode/geth.ipc'))
 
-    >>> from web3.middleware import geth_poa_middleware
+    >>> from web3.middleware import extradata_to_poa_middleware
 
     # inject the poa compatibility middleware to the innermost layer (0th layer)
-    >>> w3.middleware_onion.inject(geth_poa_middleware, layer=0)
+    >>> w3.middleware_onion.inject(extradata_to_poa_middleware, layer=0)
 
     # confirm that the connection succeeded
     >>> w3.client_version
     'Geth/v1.7.3-stable-4bb3c89d/linux-amd64/go1.9'
 
-Why is ``geth_poa_middleware`` necessary?
-'''''''''''''''''''''''''''''''''''''''''
+Why is ``extradata_to_poa_middleware`` necessary?
+'''''''''''''''''''''''''''''''''''''''''''''''''
 
 There is no strong community consensus on a single Proof-of-Authority (PoA) standard yet.
 Some nodes have successful experiments running though. One is go-ethereum (geth),
 which uses a prototype PoA for its development mode and the Goerli test network.
 
 Unfortunately, it does deviate from the yellow paper specification, which constrains the
-``extraData`` field in each block to a maximum of 32-bytes. Geth's PoA uses more than
-32 bytes, so this middleware modifies the block data a bit before returning it.
+``extraData`` field in each block to a maximum of 32-bytes. Geth is one such example
+where PoA uses more than 32 bytes, so this middleware modifies the block data a bit
+before returning it.
 
 .. _local-filter:
 

docs/providers.rst

@@ -467,7 +467,6 @@ AsyncHTTPProvider
         - :meth:`Attribute Dict Middleware <web3.middleware.async_attrdict_middleware>`
         - :meth:`Buffered Gas Estimate Middleware <web3.middleware.async_buffered_gas_estimate_middleware>`
         - :meth:`Gas Price Strategy Middleware <web3.middleware.async_gas_price_strategy_middleware>`
-        - :meth:`Geth POA Middleware <web3.middleware.async_geth_poa_middleware>`
         - :meth:`Local Filter Middleware <web3.middleware.async_local_filter_middleware>`
         - :meth:`Simple Cache Middleware <web3.middleware.async_construct_simple_cache_middleware>`
         - :meth:`Stalecheck Middleware <web3.middleware.async_make_stalecheck_middleware>`

tests/core/eth-module/test_poa.py

@@ -26,7 +26,7 @@ def test_full_extra_data(w3, request_mocker):
         assert block.extraData == b"\xff" * 32
 
 
-def test_geth_proof_of_authority(w3, request_mocker):
+def test_extradata_to_poa_middleware(w3, request_mocker):
     w3.middleware_onion.inject(extradata_to_poa_middleware, layer=0)
 
     with request_mocker(

web3/_utils/module_testing/eth_module.py

@@ -650,7 +650,7 @@ async def test_validation_middleware_chain_id_mismatch(
             await async_w3.eth.send_transaction(txn_params)
 
     @pytest.mark.asyncio
-    async def test_geth_poa_middleware(
+    async def test_extradata_to_poa_middleware(
         self, async_w3: "AsyncWeb3", request_mocker: Type[RequestMocker]
     ) -> None:
         async_w3.middleware_onion.inject(extradata_to_poa_middleware, "poa", layer=0)

web3/_utils/module_testing/persistent_connection_provider.py

@@ -316,7 +316,7 @@ async def _mocked_recv_coro() -> bytes:
         async_w3.provider._ws.__setattr__("recv", actual_recv_fxn)
 
     @pytest.mark.asyncio
-    async def test_async_geth_poa_middleware_on_eth_subscription(
+    async def test_async_extradata_to_poa_middleware_on_eth_subscription(
         self,
         async_w3: "_PersistentConnectionWeb3",
     ) -> None:

web3/middleware/proof_of_authority.py

@@ -34,29 +34,35 @@
 
 is_not_null = complement(is_null)
 
-remap_geth_poa_fields = apply_key_map(
+remap_extradata_to_poa_fields = apply_key_map(
     {
         "extraData": "proofOfAuthorityData",
     }
 )
 
-pythonic_geth_poa = apply_formatters_to_dict(
+pythonic_extradata_to_poa = apply_formatters_to_dict(
     {
         "proofOfAuthorityData": HexBytes,
     }
 )
 
-geth_poa_cleanup = compose(pythonic_geth_poa, remap_geth_poa_fields)
+extradata_to_poa_cleanup = compose(
+    pythonic_extradata_to_poa, remap_extradata_to_poa_fields
+)
 
 
 extradata_to_poa_middleware = FormattingMiddlewareBuilder.build(
     result_formatters={
-        RPC.eth_getBlockByHash: apply_formatter_if(is_not_null, geth_poa_cleanup),
-        RPC.eth_getBlockByNumber: apply_formatter_if(is_not_null, geth_poa_cleanup),
+        RPC.eth_getBlockByHash: apply_formatter_if(
+            is_not_null, extradata_to_poa_cleanup
+        ),
+        RPC.eth_getBlockByNumber: apply_formatter_if(
+            is_not_null, extradata_to_poa_cleanup
+        ),
         RPC.eth_subscribe: apply_formatter_if(
             is_not_null,
             # original call to eth_subscribe returns a string, needs a dict check
-            apply_formatter_if(is_dict, geth_poa_cleanup),
+            apply_formatter_if(is_dict, extradata_to_poa_cleanup),
         ),
     },
 )

web3/types.py

@@ -219,7 +219,7 @@ class BlockData(TypedDict, total=False):
     withdrawals: Sequence[WithdrawalData]
     withdrawalsRoot: HexBytes
 
-    # geth_poa_middleware replaces extraData w/ proofOfAuthorityData
+    # extradata_to_poa_middleware replaces extraData w/ proofOfAuthorityData
     proofOfAuthorityData: HexBytes