Merge branch 'master' into patch-1

Author: medariox

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 5.24.0
+current_version = 5.25.0
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-(?P<stage>[^.]*)\.(?P<devnum>\d+))?

docs/contracts.rst

@@ -1092,54 +1092,54 @@ Event Log Object
 
 .. doctest:: createFilter
 
-     >>> transfer_filter = my_token_contract.events.Transfer.createFilter(fromBlock="0x0", argument_filters={'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf'})
-     >>> transfer_filter.get_new_entries()
-     [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'value': 10}),
-      'event': 'Transfer',
-      'logIndex': 0,
-      'transactionIndex': 0,
-      'transactionHash': HexBytes('0x0005643c2425552308b4a28814a4dedafb5d340a811b3d2b1c019b290ffd7410'),
-      'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
-      'blockHash': HexBytes('...'),
-      'blockNumber': 2})]
-     >>> transfer_filter.get_new_entries()
-     []
-     >>> tx_hash = contract.functions.transfer(alice, 10).transact({'gas': 899000, 'gasPrice': 200000})
-     >>> tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
-     >>> transfer_filter.get_new_entries()
-     [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'value': 10}),
-      'event': 'Transfer',
-      'logIndex': 0,
-      'transactionIndex': 0,
-      'transactionHash': HexBytes('0xea111a49b82b0a0729d49f9ad924d8f87405d01e3fa87463cf2903848aacf7d9'),
-      'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
-      'blockHash': HexBytes('...'),
-      'blockNumber': 3})]
-     >>> transfer_filter.get_all_entries()
+    >>> transfer_filter = my_token_contract.events.Transfer.createFilter(fromBlock="0x0", argument_filters={'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf'})
+    >>> transfer_filter.get_new_entries()
     [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'value': 10}),
-      'event': 'Transfer',
-      'logIndex': 0,
-      'transactionIndex': 0,
-      'transactionHash': HexBytes('0x9da859237e7259832b913d51cb128c8d73d1866056f7a41b52003c953e749678'),
-      'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
-      'blockHash': HexBytes('0xc9c32c3250f77aa3fba2fea1cdeeb0397e7dc68b444747e6eb3db65708aaacd8'),
-      'blockNumber': 2}),
-      AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
-      'value': 10}),
-      'event': 'Transfer',
-      'logIndex': 0,
-      'transactionIndex': 0,
-      'transactionHash': HexBytes('0xea111a49b82b0a0729d49f9ad924d8f87405d01e3fa87463cf2903848aacf7d9'),
-      'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
-      'blockHash': HexBytes('...'),
-      'blockNumber': 3})]
+     'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'value': 10}),
+     'event': 'Transfer',
+     'logIndex': 0,
+     'transactionIndex': 0,
+     'transactionHash': HexBytes('0x9da859237e7259832b913d51cb128c8d73d1866056f7a41b52003c953e749678'),
+     'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
+     'blockHash': HexBytes('...'),
+     'blockNumber': 2})]
+    >>> transfer_filter.get_new_entries()
+    []
+    >>> tx_hash = contract.functions.transfer(alice, 10).transact({'gas': 899000, 'gasPrice': 674302241})
+    >>> tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
+    >>> transfer_filter.get_new_entries()
+    [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'value': 10}),
+     'event': 'Transfer',
+     'logIndex': 0,
+     'transactionIndex': 0,
+     'transactionHash': HexBytes('0xa23e7ef4d2692c5cf34ee99123c9c73099e9c3b68c7850f91c1cbcb91ac327e0'),
+     'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
+     'blockHash': HexBytes('...'),
+     'blockNumber': 3})]
+    >>> transfer_filter.get_all_entries()
+    [AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'value': 10}),
+     'event': 'Transfer',
+     'logIndex': 0,
+     'transactionIndex': 0,
+     'transactionHash': HexBytes('0x9da859237e7259832b913d51cb128c8d73d1866056f7a41b52003c953e749678'),
+     'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
+     'blockHash': HexBytes('...'),
+     'blockNumber': 2}),
+     AttributeDict({'args': AttributeDict({'from': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'to': '0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf',
+     'value': 10}),
+     'event': 'Transfer',
+     'logIndex': 0,
+     'transactionIndex': 0,
+     'transactionHash': HexBytes('0xa23e7ef4d2692c5cf34ee99123c9c73099e9c3b68c7850f91c1cbcb91ac327e0'),
+     'address': '0xF2E246BB76DF876Cef8b38ae84130F4F55De395b',
+     'blockHash': HexBytes('...'),
+     'blockNumber': 3})]
 
 Utils
 -----

docs/providers.rst

@@ -409,6 +409,7 @@ Eth
 - :meth:`web3.eth.get_block() <web3.eth.Eth.get_block>`
 - :meth:`web3.eth.get_code() <web3.eth.Eth.get_code>`
 - :meth:`web3.eth.get_raw_transaction() <web3.eth.Eth.get_raw_transaction>`
+- :meth:`web3.eth.get_raw_transaction_by_block() <web3.eth.Eth.get_raw_transaction_by_block>`
 - :meth:`web3.eth.get_transaction() <web3.eth.Eth.get_transaction>`
 - :meth:`web3.eth.get_transaction_count() <web3.eth.Eth.get_transaction_count>`
 - :meth:`web3.eth.send_transaction() <web3.eth.Eth.send_transaction>`

docs/releases.rst

@@ -3,6 +3,46 @@ Release Notes
 
 .. towncrier release notes start
 
+v5.25.0 (2021-11-19)
+--------------------
+
+Features
+~~~~~~~~
+
+- Support for ``w3.eth.get_raw_transaction_by_block``, and async support for
+  ``w3.eth.get_raw_transaction_by_block`` (`#2209
+  <https://github.com/ethereum/web3.py/issues/2209>`__)
+
+
+Bugfixes
+~~~~~~~~
+
+- BadResponseFormat error thrown instead of KeyError when a response gets sent
+  back without a ``result`` key. (`#2188
+  <https://github.com/ethereum/web3.py/issues/2188>`__)
+
+
+Improved Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+- Correct link to Websocket library documentation (`#2173
+  <https://github.com/ethereum/web3.py/issues/2173>`__)
+- Doc update to make it clearer that enable_unstable_package_management()
+  method is on the web3 instance (`#2208
+  <https://github.com/ethereum/web3.py/issues/2208>`__)
+
+
+Misc
+~~~~
+
+- `#2102 <https://github.com/ethereum/web3.py/issues/2102>`__, `#2179
+  <https://github.com/ethereum/web3.py/issues/2179>`__, `#2191
+  <https://github.com/ethereum/web3.py/issues/2191>`__, `#2201
+  <https://github.com/ethereum/web3.py/issues/2201>`__, `#2205
+  <https://github.com/ethereum/web3.py/issues/2205>`__, `#2212
+  <https://github.com/ethereum/web3.py/issues/2212>`__
+
+
 v5.24.0 (2021-09-27)
 --------------------
 

docs/web3.eth.rst

@@ -617,7 +617,8 @@ The following methods are available on the ``web3.eth`` namespace.
     ``eth_getTransactionByBlockNumberAndIndex`` if ``block_identifier`` is an
     integer or one of the predefined block parameters ``'latest', 'earliest',
     'pending'``, otherwise delegates to
-    ``eth_getTransactionByBlockHashAndIndex``. If the transaction has not yet been mined throws :class:`web3.exceptions.TransactionNotFound`.
+    ``eth_getTransactionByBlockHashAndIndex``.
+    If a transaction is not found at specified arguments, throws :class:`web3.exceptions.TransactionNotFound`.
 
     .. code-block:: python
 
@@ -659,6 +660,28 @@ The following methods are available on the ``web3.eth`` namespace.
     .. warning:: Deprecated: This method is deprecated in favor of
       :attr:`~web3.eth.Eth.get_transaction_by_block`
 
+.. py:method:: Eth.get_raw_transaction_by_block(block_identifier, transaction_index)
+
+    * Delegates to ``eth_getRawTransactionByBlockNumberAndIndex`` or
+      ``eth_getRawTransactionByBlockHashAndIndex`` RPC Methods
+
+    Returns the raw transaction at the index specified by ``transaction_index``
+    from the block specified by ``block_identifier``.  Delegates to
+    ``eth_getRawTransactionByBlockNumberAndIndex`` if ``block_identifier`` is an
+    integer or one of the predefined block parameters ``'latest', 'earliest',
+    'pending'``, otherwise delegates to
+    ``eth_getRawTransactionByBlockHashAndIndex``.
+    If a transaction is not found at specified arguments, throws :class:`web3.exceptions.TransactionNotFound`.
+
+    .. code-block:: python
+
+        >>> web3.eth.get_raw_transaction_by_block('latest', 0)
+        HexBytes('0x02f87582053901843b9aca00843b9aca008301d8a894e2dfcfa89a45abdc3de91f7a2844b276b8451d2e888ac7230489e8000080c001a028dcd2e11682288c00237f377280bc6a478a6b27e9c2d745262152add1b1dfcba04e7a33b7ce2a37fc3cd3af7bdc7d7beff721664d56508defa188df35afd77c2c')
+        >>> web3.eth.get_raw_transaction_by_block(2, 0)
+        HexBytes('0x02f87582053901843b9aca00843b9aca008301d8a894e2dfcfa89a45abdc3de91f7a2844b276b8451d2e888ac7230489e8000080c001a028dcd2e11682288c00237f377280bc6a478a6b27e9c2d745262152add1b1dfcba04e7a33b7ce2a37fc3cd3af7bdc7d7beff721664d56508defa188df35afd77c2c')
+        >>> web3.eth.get_raw_transaction_by_block('0xca609fb606a04ce6aaec76415cd0b9d8c2bc83ad2a4d17db7fd403ee7d97bf40', 0)
+        HexBytes('0x02f87582053901843b9aca00843b9aca008301d8a894e2dfcfa89a45abdc3de91f7a2844b276b8451d2e888ac7230489e8000080c001a028dcd2e11682288c00237f377280bc6a478a6b27e9c2d745262152add1b1dfcba04e7a33b7ce2a37fc3cd3af7bdc7d7beff721664d56508defa188df35afd77c2c')
+
 .. py:method:: Eth.wait_for_transaction_receipt(transaction_hash, timeout=120, poll_latency=0.1)
 
     Waits for the transaction specified by ``transaction_hash`` to be included in a block, then

docs/web3.pm.rst

@@ -27,7 +27,7 @@ The ``web3.pm`` object exposes methods to interact with Packages as defined by `
 
    .. code-block:: python
 
-      >>> web3.enable_unstable_package_management_api()
+      >>> w3.enable_unstable_package_management_api()
       >>> w3.pm
       <web3.pm.PM at 0x....>
 

newsfragments/2102.misc.rst

@@ -0,0 +1 @@
+Fixed doctest that wasn't running in ``docs/contracts.rst``

newsfragments/2173.doc.rst

@@ -7,7 +7,7 @@
 
 extras_require = {
     'tester': [
-        "eth-tester[py-evm]==v0.6.0-beta.2",
+        "eth-tester[py-evm]==v0.6.0-beta.4",
         "py-geth>=3.6.0,<4",
     ],
     'linter': [
@@ -63,7 +63,7 @@
 setup(
     name='web3',
     # *IMPORTANT*: Don't manually change the version here. Use the 'bumpversion' utility.
-    version='5.24.0',
+    version='5.25.0',
     description="""Web3.py""",
     long_description_content_type='text/markdown',
     long_description=long_description,

newsfragments/2179.misc.rst

@@ -276,6 +276,12 @@ class TestEthereumTesterEthModule(EthModuleTest):
         EthModuleTest.test_eth_get_raw_transaction, ValueError)
     test_eth_get_raw_transaction_raises_error = not_implemented(
         EthModuleTest.test_eth_get_raw_transaction, ValueError)
+    test_eth_get_raw_transaction_by_block = not_implemented(
+        EthModuleTest.test_eth_get_raw_transaction_by_block, ValueError
+    )
+    test_eth_get_raw_transaction_by_block_raises_error = not_implemented(
+        EthModuleTest.test_eth_get_raw_transaction_by_block, ValueError
+    )
     test_eth_replace_transaction_already_mined = not_implemented(
         EthModuleTest.test_eth_replace_transaction_already_mined, ValueError
     )

newsfragments/2188.bugfix.rst

@@ -409,6 +409,11 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
         apply_formatter_at_index(to_hex_if_integer, 1),
     ),
     RPC.eth_getTransactionCount: apply_formatter_at_index(to_hex_if_integer, 1),
+    RPC.eth_getRawTransactionByBlockNumberAndIndex: compose(
+        apply_formatter_at_index(to_hex_if_integer, 0),
+        apply_formatter_at_index(to_hex_if_integer, 1),
+    ),
+    RPC.eth_getRawTransactionByBlockHashAndIndex: apply_formatter_at_index(to_hex_if_integer, 1),
     RPC.eth_getUncleCountByBlockNumber: apply_formatter_at_index(to_hex_if_integer, 0),
     RPC.eth_getUncleByBlockNumberAndIndex: compose(
         apply_formatter_at_index(to_hex_if_integer, 0),
@@ -468,6 +473,8 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
     RPC.eth_getFilterLogs: filter_result_formatter,
     RPC.eth_getLogs: filter_result_formatter,
     RPC.eth_getProof: apply_formatter_if(is_not_null, proof_formatter),
+    RPC.eth_getRawTransactionByBlockHashAndIndex: HexBytes,
+    RPC.eth_getRawTransactionByBlockNumberAndIndex: HexBytes,
     RPC.eth_getRawTransactionByHash: HexBytes,
     RPC.eth_getStorageAt: HexBytes,
     RPC.eth_getTransactionByBlockHashAndIndex: apply_formatter_if(
@@ -676,6 +683,8 @@ def raise_transaction_not_found_with_index(params: Tuple[BlockIdentifier, int])
     RPC.eth_getTransactionByBlockHashAndIndex: raise_transaction_not_found_with_index,
     RPC.eth_getTransactionByBlockNumberAndIndex: raise_transaction_not_found_with_index,
     RPC.eth_getTransactionReceipt: raise_transaction_not_found,
+    RPC.eth_getRawTransactionByBlockHashAndIndex: raise_transaction_not_found_with_index,
+    RPC.eth_getRawTransactionByBlockNumberAndIndex: raise_transaction_not_found_with_index,
     RPC.eth_getRawTransactionByHash: raise_transaction_not_found,
 }