Only apply to_hexbytes formatter if value is not null

Author: fselmo

newsfragments/2321.bugfix.rst

@@ -0,0 +1 @@
+``to_hexbytes`` block formatters no longer throw when value is ``None``

tests/core/eth-module/test_block_api.py

@@ -0,0 +1,64 @@
+import pytest
+
+from web3._utils.rpc_abi import (
+    RPC,
+)
+from web3.middleware import (
+    construct_result_generator_middleware,
+)
+
+
+@pytest.fixture(autouse=True)
+def wait_for_first_block(web3, wait_for_block):
+    wait_for_block(web3)
+
+
+def test_uses_default_block(web3, extra_accounts,
+                            wait_for_transaction):
+    assert(web3.eth.default_block == 'latest')
+    web3.eth.default_block = web3.eth.block_number
+    assert(web3.eth.default_block == web3.eth.block_number)
+
+
+def test_uses_defaultBlock_with_warning(web3, extra_accounts,
+                                        wait_for_transaction):
+    with pytest.warns(DeprecationWarning):
+        assert web3.eth.defaultBlock == 'latest'
+
+    with pytest.warns(DeprecationWarning):
+        web3.eth.defaultBlock = web3.eth.block_number
+
+    with pytest.warns(DeprecationWarning):
+        assert(web3.eth.defaultBlock == web3.eth.block_number)
+
+
+def test_get_block_formatters_with_null_values(web3):
+    null_values_block = {
+        'baseFeePerGas': None,
+        'extraData': None,
+        'gasLimit': None,
+        'gasUsed': None,
+        'size': None,
+        'timestamp': None,
+        'hash': None,
+        'logsBloom': None,
+        'miner': None,
+        'mixHash': None,
+        'nonce': None,
+        'number': None,
+        'parentHash': None,
+        'sha3Uncles': None,
+        'difficulty': None,
+        'receiptsRoot': None,
+        'statesRoot': None,
+        'totalDifficulty': None,
+        'transactionsRoot': None,
+    }
+    result_middleware = construct_result_generator_middleware({
+        RPC.eth_getBlockByNumber: lambda *_: null_values_block,
+    })
+
+    web3.middleware_onion.inject(result_middleware, 'result_middleware', layer=0)
+
+    received_block = web3.eth.get_block('pending')
+    assert received_block == null_values_block

tests/core/eth-module/test_default_block_api.py

@@ -210,29 +210,29 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
 
 BLOCK_FORMATTERS = {
     'baseFeePerGas': to_integer_if_hex,
-    'extraData': to_hexbytes(32, variable_length=True),
+    'extraData': apply_formatter_if(is_not_null, to_hexbytes(32, variable_length=True)),
     'gasLimit': to_integer_if_hex,
     'gasUsed': to_integer_if_hex,
     'size': to_integer_if_hex,
     'timestamp': to_integer_if_hex,
     'hash': apply_formatter_if(is_not_null, to_hexbytes(32)),
     'logsBloom': apply_formatter_if(is_not_null, to_hexbytes(256)),
     'miner': apply_formatter_if(is_not_null, to_checksum_address),
-    'mixHash': to_hexbytes(32),
+    'mixHash': apply_formatter_if(is_not_null, to_hexbytes(32)),
     'nonce': apply_formatter_if(is_not_null, to_hexbytes(8, variable_length=True)),
     'number': apply_formatter_if(is_not_null, to_integer_if_hex),
     'parentHash': apply_formatter_if(is_not_null, to_hexbytes(32)),
     'sha3Uncles': apply_formatter_if(is_not_null, to_hexbytes(32)),
     'uncles': apply_list_to_array_formatter(to_hexbytes(32)),
     'difficulty': to_integer_if_hex,
-    'receiptsRoot': to_hexbytes(32),
-    'stateRoot': to_hexbytes(32),
+    'receiptsRoot': apply_formatter_if(is_not_null, to_hexbytes(32)),
+    'stateRoot': apply_formatter_if(is_not_null, to_hexbytes(32)),
     'totalDifficulty': to_integer_if_hex,
     'transactions': apply_one_of_formatters((
         (is_array_of_dicts, apply_list_to_array_formatter(transaction_result_formatter)),
         (is_array_of_strings, apply_list_to_array_formatter(to_hexbytes(32))),
     )),
-    'transactionsRoot': to_hexbytes(32),
+    'transactionsRoot': apply_formatter_if(is_not_null, to_hexbytes(32)),
 }