karl
karl copied to clipboard
Published
20 hours ago •
cleanunicorn
cleanunicorn
Update web3 to 5.31.0
This PR updates web3 from 4.9.1 to 5.31.0.
Changelog
5.28.0
--------------------
Features
~~~~~~~~
- Added Async functions for Geth Personal and Admin modules (`1413
<https://github.com/ethereum/web3.py/issues/1413>`__)
- async support for formatting, validation, and geth poa middlewares (`2098
<https://github.com/ethereum/web3.py/issues/2098>`__)
- Calculate a default ``maxPriorityFeePerGas`` using ``eth_feeHistory`` when
``eth_maxPriorityFeePerGas`` is not available, since the latter is not a part
of the Ethereum JSON-RPC specs and only supported by certain clients. (`2259
<https://github.com/ethereum/web3.py/issues/2259>`__)
- Allow NamedTuples in ABI inputs (`2312
<https://github.com/ethereum/web3.py/issues/2312>`__)
- Add async `eth.syncing` method (`2331
<https://github.com/ethereum/web3.py/issues/2331>`__)
Bugfixes
~~~~~~~~
- remove `ens.utils.dict_copy` decorator (`1423
<https://github.com/ethereum/web3.py/issues/1423>`__)
- The exception retry middleware whitelist was missing a comma between
``txpool`` and ``testing`` (`2327
<https://github.com/ethereum/web3.py/issues/2327>`__)
- Properly initialize external modules that do not inherit from the
``web3.module.Module`` class (`2328
<https://github.com/ethereum/web3.py/issues/2328>`__)
5.27.0
--------------------
Features
~~~~~~~~
- Added Async functions for Geth TxPool (`1413
<https://github.com/ethereum/web3.py/issues/1413>`__)
- external modules are no longer required to inherit from the
``web3.module.Module`` class (`2304
<https://github.com/ethereum/web3.py/issues/2304>`__)
- Add async `eth.get_logs` method (`2310
<https://github.com/ethereum/web3.py/issues/2310>`__)
- add Async access to `default_account` and `default_block` (`2315
<https://github.com/ethereum/web3.py/issues/2315>`__)
- Update eth-tester and eth-account dependencies to pull in bugfix from
eth-keys (`2320 <https://github.com/ethereum/web3.py/issues/2320>`__)
Bugfixes
~~~~~~~~
- Fixed issues with parsing tuples and nested tuples in event logs (`2211
<https://github.com/ethereum/web3.py/issues/2211>`__)
- In ENS the contract function to resolve an ENS address was being called twice
in error. One of those calls was removed. (`2318
<https://github.com/ethereum/web3.py/issues/2318>`__)
- ``to_hexbytes`` block formatters no longer throw when value is ``None``
(`2321 <https://github.com/ethereum/web3.py/issues/2321>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- fix typo in `eth.account` docs (`2111
<https://github.com/ethereum/web3.py/issues/2111>`__)
- explicitly add `output_values` to contracts example (`2293
<https://github.com/ethereum/web3.py/issues/2293>`__)
- update imports for `AsyncHTTPProvider` sample code (`2302
<https://github.com/ethereum/web3.py/issues/2302>`__)
- fixed broken link to filter schema (`2303
<https://github.com/ethereum/web3.py/issues/2303>`__)
- add github link to the main docs landing page (`2313
<https://github.com/ethereum/web3.py/issues/2313>`__)
- fix typos and update referenced `geth` version (`2326
<https://github.com/ethereum/web3.py/issues/2326>`__)
Misc
~~~~
- `2217 <https://github.com/ethereum/web3.py/issues/2217>`__
5.26.0
--------------------
Features
~~~~~~~~
- Add ``middlewares`` property to ``NamedElementOnion`` /
``web3.middleware_onion``. Returns current middlewares in proper order for
importing into a new ``Web3`` instance (`2239
<https://github.com/ethereum/web3.py/issues/2239>`__)
- Add async ``eth.hashrate`` method (`2243
<https://github.com/ethereum/web3.py/issues/2243>`__)
- Add async ``eth.chain_id`` method (`2251
<https://github.com/ethereum/web3.py/issues/2251>`__)
- Add async ``eth.mining`` method (`2252
<https://github.com/ethereum/web3.py/issues/2252>`__)
- Add async ``eth.get_transaction_receipt`` and
``eth.wait_for_transaction_receipt`` methods (`2265
<https://github.com/ethereum/web3.py/issues/2265>`__)
- Add async `eth.accounts` method (`2284
<https://github.com/ethereum/web3.py/issues/2284>`__)
- Support for attaching external modules to the ``Web3`` instance when
instantiating the ``Web3`` instance, via the ``external_modules`` argument,
or via the new ``attach_modules()`` method (`2288
<https://github.com/ethereum/web3.py/issues/2288>`__)
Bugfixes
~~~~~~~~
- Fixed doctest that wasn't running in ``docs/contracts.rst`` (`2213
<https://github.com/ethereum/web3.py/issues/2213>`__)
- Key mapping fix to eth-tester middleware for access list storage keys (`2224
<https://github.com/ethereum/web3.py/issues/2224>`__)
- Inherit ``Web3`` instance middlewares when instantiating ``ENS`` with
``ENS.fromWeb3()`` method (`2239
<https://github.com/ethereum/web3.py/issues/2239>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Fix example docs to show a TransactionNotFound error, instead of None (`2199
<https://github.com/ethereum/web3.py/issues/2199>`__)
- fix typo in ethpm.rst (`2277
<https://github.com/ethereum/web3.py/issues/2277>`__)
- Clarify provider usage in Quickstart docs (`2287
<https://github.com/ethereum/web3.py/issues/2287>`__)
- Address common BSC usage question (`2289
<https://github.com/ethereum/web3.py/issues/2289>`__)
Misc
~~~~
- `1729 <https://github.com/ethereum/web3.py/issues/1729>`__, `#2233
<https://github.com/ethereum/web3.py/issues/2233>`__, `#2242
<https://github.com/ethereum/web3.py/issues/2242>`__, `#2260
<https://github.com/ethereum/web3.py/issues/2260>`__, `#2261
<https://github.com/ethereum/web3.py/issues/2261>`__, `#2283
<https://github.com/ethereum/web3.py/issues/2283>`__
5.25.0
--------------------
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>`__
5.24.0
--------------------
Features
~~~~~~~~
- Add async ``eth.send_raw_transaction`` method (`2135
<https://github.com/ethereum/web3.py/issues/2135>`__)
- Updated eth-account version to v0.5.6 - adds support for signing typed
transactions without needing to explicitly set the transaction type and now
accepts correct JSON-RPC structure for accessList for typed transactions
(`2157 <https://github.com/ethereum/web3.py/issues/2157>`__)
Bugfixes
~~~~~~~~
- Encode block_count as hex before making eth_feeHistory RPC call (`2117
<https://github.com/ethereum/web3.py/issues/2117>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Fix typo in AsyncHTTPProvider docs (`2131
<https://github.com/ethereum/web3.py/issues/2131>`__)
- Update AsyncHTTPProvider doc Supported Methods to include
``web3.eth.send_raw_transaction()``. (`2135
<https://github.com/ethereum/web3.py/issues/2135>`__)
- Improve messaging around usage and implementation questions, directing users
to the appropriate channel (`2138
<https://github.com/ethereum/web3.py/issues/2138>`__)
- Clarify some contract ``ValueError`` error messages. (`2146
<https://github.com/ethereum/web3.py/issues/2146>`__)
- Updated docs for w3.eth.account.sign_transaction to reflect that transaction
type is no longer needed to successfully sign typed transactions and to
illustrate how to structure an optional accessList parameter in a typed
transaction (`2157 <https://github.com/ethereum/web3.py/issues/2157>`__)
Misc
~~~~
- `2105 <https://github.com/ethereum/web3.py/issues/2105>`__
5.23.1
--------------------
Features
~~~~~~~~
- Add constants for the zero address, zero hash, max int, and wei per ether. (`2109 <https://github.com/ethereum/web3.py/issues/2109>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Renamed "1559 transaction" to "dynamic fee transaction" where appropriate to keep consistency among the general code base for 1559 transaction (type=2) naming (`2118 <https://github.com/ethereum/web3.py/issues/2118>`__)
- Update AsyncHTTPProvider doc example to include modules and middlewares keyword arguments (`2123 <https://github.com/ethereum/web3.py/issues/2123>`__)
Misc
~~~~
- `2110 <https://github.com/ethereum/web3.py/issues/2110>`__, `#2118 <https://github.com/ethereum/web3.py/issues/2118>`__, `#2122 <https://github.com/ethereum/web3.py/issues/2122>`__
5.23.0
--------------------
Features
~~~~~~~~
- Add support for eth_feeHistory RPC method (`2038 <https://github.com/ethereum/web3.py/issues/2038>`__)
- Add support for eth_maxPriorityFeePerGas RPC method (`2100 <https://github.com/ethereum/web3.py/issues/2100>`__)
Bugfixes
~~~~~~~~
- Hot fix for string interpolation issue with contract function call decoding exception to facilitate extracting a meaningful message from the eth_call response (`2096 <https://github.com/ethereum/web3.py/issues/2096>`__)
- Bypass adding a ``gasPrice`` via the gas price strategy, if one is set, when EIP-1559 transaction params are used for ``send_transaction`` (`2099 <https://github.com/ethereum/web3.py/issues/2099>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Update feeHistory docs (`2104 <https://github.com/ethereum/web3.py/issues/2104>`__)
5.22.0
--------------------
Features
~~~~~~~~
- Add support for eth_getRawTransactionByHash RPC method (`2039 <https://github.com/ethereum/web3.py/issues/2039>`__)
- Add AsyncNet module (`2044 <https://github.com/ethereum/web3.py/issues/2044>`__)
- Add async ``eth.get_balance``, ``eth.get_code``, ``eth.get_transaction_count`` methods. (`2056 <https://github.com/ethereum/web3.py/issues/2056>`__)
- eth_signTransaction support for eip-1559 params 'maxFeePerGas' and 'maxPriorityFeePerGas' (`2082 <https://github.com/ethereum/web3.py/issues/2082>`__)
- Add support for async ``w3.eth.call``. (`2083 <https://github.com/ethereum/web3.py/issues/2083>`__)
Bugfixes
~~~~~~~~
- If a transaction hash was passed as a string rather than a HexByte to ``w3.eth.wait_for_transaction_receipt``, and the time was exhausted before the transaction is in the chain, the error being raised was a TypeError instead of the correct TimeExhausted error. This is because the ``to_hex`` method in the TimeExhausted error message expects a primitive as the first argument, and a string doesn't qualify as a primitive. Fixed by converting the transaction_hash to HexBytes instead. (`2068 <https://github.com/ethereum/web3.py/issues/2068>`__)
- Hot fix for a string interpolation issue in message when BadFunctionCallOutput is raised for call_contract_function() (`2069 <https://github.com/ethereum/web3.py/issues/2069>`__)
- ``fill_transaction_defaults()`` no longer sets a default ``gasPrice`` if 1559 fees are present in the transaction parameters. This fixes sign-and-send middleware issues with 1559 fees. (`2092 <https://github.com/ethereum/web3.py/issues/2092>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Clarify that ``send_transaction``, ``modify_transaction``, and ``replace_transaction`` return HexByte objects instead of strings. (`2058 <https://github.com/ethereum/web3.py/issues/2058>`__)
- Added troubleshooting section for Microsoft Visual C++ error on Windows machines (`2077 <https://github.com/ethereum/web3.py/issues/2077>`__)
- Updated the sign-and-send middleware docs to include EIP-1559 as well as legacy transaction examples (`2092 <https://github.com/ethereum/web3.py/issues/2092>`__)
Misc
~~~~
- `2073 <https://github.com/ethereum/web3.py/issues/2073>`__, `#2080 <https://github.com/ethereum/web3.py/issues/2080>`__, `#2085 <https://github.com/ethereum/web3.py/issues/2085>`__
5.21.0
--------------------
Features
~~~~~~~~
- Adds support for EIP 1559 transaction keys: `maxFeePerGas` and `maxPriorityFeePerGas` (`2060 <https://github.com/ethereum/web3.py/issues/2060>`__)
Bugfixes
~~~~~~~~
- Bugfix where an error response got passed to a function expecting a block identifier.
Split out null result formatters from the error formatters and added some tests. (`2022 <https://github.com/ethereum/web3.py/issues/2022>`__)
- Fix broken tests and use the new 1559 params for most of our test transactions. (`2053 <https://github.com/ethereum/web3.py/issues/2053>`__)
- Set a default maxFeePerGas value consistent with Geth (`2055 <https://github.com/ethereum/web3.py/issues/2055>`__)
- Fix bug in geth PoA middleware where a ``None`` response should throw a ``BlockNotFound`` error, but was instead throwing an ``AttributeError`` (`2064 <https://github.com/ethereum/web3.py/issues/2064>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Added general documentation on unit and integration testing and how to contribute to our test suite. (`2053 <https://github.com/ethereum/web3.py/issues/2053>`__)
5.20.1
--------------------
Bugfixes
~~~~~~~~
- Have the geth dev IPC auto connection check for the ``WEB3_PROVIDER_URI`` environment variable. (`2023 <https://github.com/ethereum/web3.py/issues/2023>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Remove reference to allowing multiple providers in docs (`2018 <https://github.com/ethereum/web3.py/issues/2018>`__)
- Update "Contract Deployment Example" docs to use ``py-solc-x`` as ``solc`` is no longer maintained. (`2020 <https://github.com/ethereum/web3.py/issues/2020>`__)
- Detail using unreleased Geth builds in CI (`2037 <https://github.com/ethereum/web3.py/issues/2037>`__)
- Clarify that a missing trie node error could occur when using ``block_identifier`` with ``.call()``
on a node that isn't running in archive mode (`2048 <https://github.com/ethereum/web3.py/issues/2048>`__)
Misc
~~~~
- `1938 <https://github.com/ethereum/web3.py/issues/1938>`__, `#2015 <https://github.com/ethereum/web3.py/issues/2015>`__, `#2021 <https://github.com/ethereum/web3.py/issues/2021>`__, `#2025 <https://github.com/ethereum/web3.py/issues/2025>`__, `#2028 <https://github.com/ethereum/web3.py/issues/2028>`__, `#2029 <https://github.com/ethereum/web3.py/issues/2029>`__, `#2035 <https://github.com/ethereum/web3.py/issues/2035>`__
5.20.0
--------------------
Features
~~~~~~~~
- Add new AsyncHTTPProvider. No middleware or session caching support yet.
Also adds async ``w3.eth.gas_price``, and async ``w3.isConnected()`` methods. (`1978 <https://github.com/ethereum/web3.py/issues/1978>`__)
- Add ability for AsyncHTTPProvider to accept middleware
Also adds async gas_price_strategy middleware, and moves gas estimate to middleware.
AsyncEthereumTesterProvider now inherits from AsyncBase (`1999 <https://github.com/ethereum/web3.py/issues/1999>`__)
- Support state_override in contract function call. (`2005 <https://github.com/ethereum/web3.py/issues/2005>`__)
Bugfixes
~~~~~~~~
- Test ethpm caching + bump Sphinx version. (`1977 <https://github.com/ethereum/web3.py/issues/1977>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Clarify solidityKeccak documentation. (`1971 <https://github.com/ethereum/web3.py/issues/1971>`__)
- Improve contributor documentation context and ordering. (`2008 <https://github.com/ethereum/web3.py/issues/2008>`__)
- Add docs for unstable AsyncHTTPProvider (`2017 <https://github.com/ethereum/web3.py/issues/2017>`__)
Misc
~~~~
- `1979 <https://github.com/ethereum/web3.py/issues/1979>`__, `#1980 <https://github.com/ethereum/web3.py/issues/1980>`__, `#1993 <https://github.com/ethereum/web3.py/issues/1993>`__, `#2002 <https://github.com/ethereum/web3.py/issues/2002>`__
5.19.0
--------------------
Features
~~~~~~~~
- Handle optional ``eth_call`` state override param. (`1921 <https://github.com/ethereum/web3.py/issues/1921>`__)
- Add list_storage_keys deprecate listStorageKeys (`1944 <https://github.com/ethereum/web3.py/issues/1944>`__)
- Add net_peers deprecate netPeers (`1946 <https://github.com/ethereum/web3.py/issues/1946>`__)
- Add trace_replay_transaction deprecate traceReplayTransaction (`1949 <https://github.com/ethereum/web3.py/issues/1949>`__)
- Add add_reserved_peer deprecate addReservedPeer (`1951 <https://github.com/ethereum/web3.py/issues/1951>`__)
- Add ``parity.set_mode``, deprecate ``parity.setMode`` (`1954 <https://github.com/ethereum/web3.py/issues/1954>`__)
- Add ``parity.trace_raw_transaction``, deprecate ``parity.traceRawTransaction`` (`1955 <https://github.com/ethereum/web3.py/issues/1955>`__)
- Add ``parity.trace_call``, deprecate ``parity.traceCall`` (`1957 <https://github.com/ethereum/web3.py/issues/1957>`__)
- Add trace_filter deprecate traceFilter (`1960 <https://github.com/ethereum/web3.py/issues/1960>`__)
- Add trace_block, deprecate traceBlock (`1961 <https://github.com/ethereum/web3.py/issues/1961>`__)
- Add trace_replay_block_transactions, deprecate traceReplayBlockTransactions (`1962 <https://github.com/ethereum/web3.py/issues/1962>`__)
- Add ``parity.trace_transaction``, deprecate ``parity.traceTransaction`` (`1963 <https://github.com/ethereum/web3.py/issues/1963>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Document ``eth_call`` state overrides. (`1965 <https://github.com/ethereum/web3.py/issues/1965>`__)
Misc
~~~~
- `1774 <https://github.com/ethereum/web3.py/issues/1774>`__, `#1805 <https://github.com/ethereum/web3.py/issues/1805>`__, `#1945 <https://github.com/ethereum/web3.py/issues/1945>`__, `#1964 <https://github.com/ethereum/web3.py/issues/1964>`__
5.18.0
--------------------
Features
~~~~~~~~
- Add ``w3.eth.modify_transaction`` deprecate ``w3.eth.modifyTransaction`` (`1886 <https://github.com/ethereum/web3.py/issues/1886>`__)
- Add ``w3.eth.get_transaction_receipt``, deprecate ``w3.eth.getTransactionReceipt`` (`1893 <https://github.com/ethereum/web3.py/issues/1893>`__)
- Add ``w3.eth.wait_for_transaction_receipt`` deprecate ``w3.eth.waitForTransactionReceipt`` (`1896 <https://github.com/ethereum/web3.py/issues/1896>`__)
- Add ``w3.eth.set_contract_factory`` deprecate ``w3.eth.setContractFactory`` (`1900 <https://github.com/ethereum/web3.py/issues/1900>`__)
- Add ``w3.eth.generate_gas_price`` deprecate ``w3.eth.generateGasPrice`` (`1905 <https://github.com/ethereum/web3.py/issues/1905>`__)
- Add ``w3.eth.set_gas_price_strategy`` deprecate ``w3.eth.setGasPriceStrategy`` (`1906 <https://github.com/ethereum/web3.py/issues/1906>`__)
- Add ``w3.eth.estimate_gas`` deprecate ``w3.eth.estimateGas`` (`1913 <https://github.com/ethereum/web3.py/issues/1913>`__)
- Add ``w3.eth.sign_typed_data`` deprecate ``w3.eth.signTypedData`` (`1915 <https://github.com/ethereum/web3.py/issues/1915>`__)
- Add ``w3.eth.get_filter_changes`` deprecate ``w3.eth.getFilterChanges`` (`1916 <https://github.com/ethereum/web3.py/issues/1916>`__)
- Add ``eth.get_filter_logs``, deprecate ``eth.getFilterLogs`` (`1919 <https://github.com/ethereum/web3.py/issues/1919>`__)
- Add ``eth.uninstall_filter``, deprecate ``eth.uninstallFilter`` (`1920 <https://github.com/ethereum/web3.py/issues/1920>`__)
- Add ``w3.eth.get_logs`` deprecate ``w3.eth.getLogs`` (`1925 <https://github.com/ethereum/web3.py/issues/1925>`__)
- Add ``w3.eth.submit_hashrate`` deprecate ``w3.eth.submitHashrate`` (`1926 <https://github.com/ethereum/web3.py/issues/1926>`__)
- Add ``w3.eth.submit_work`` deprecate ``w3.eth.submitWork`` (`1927 <https://github.com/ethereum/web3.py/issues/1927>`__)
- Add ``w3.eth.get_work``, deprecate ``w3.eth.getWork`` (`1934 <https://github.com/ethereum/web3.py/issues/1934>`__)
- Adds public get_block_number method. (`1937 <https://github.com/ethereum/web3.py/issues/1937>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Add ABI type examples to docs (`1890 <https://github.com/ethereum/web3.py/issues/1890>`__)
- Promote the new Ethereum Python Discord server on the README. (`1898 <https://github.com/ethereum/web3.py/issues/1898>`__)
- Escape reserved characters in install script of Contributing docs. (`1909 <https://github.com/ethereum/web3.py/issues/1909>`__)
- Add detailed event filtering examples. (`1910 <https://github.com/ethereum/web3.py/issues/1910>`__)
- Add docs example for tuning log levels. (`1928 <https://github.com/ethereum/web3.py/issues/1928>`__)
- Add some performance tips in troubleshooting docs. (`1929 <https://github.com/ethereum/web3.py/issues/1929>`__)
- Add existing contract interaction to docs examples. (`1933 <https://github.com/ethereum/web3.py/issues/1933>`__)
- Replace Gitter links with the Python Discord server. (`1936 <https://github.com/ethereum/web3.py/issues/1936>`__)
Misc
~~~~
- `1887 <https://github.com/ethereum/web3.py/issues/1887>`__, `#1907 <https://github.com/ethereum/web3.py/issues/1907>`__, `#1917 <https://github.com/ethereum/web3.py/issues/1917>`__, `#1930 <https://github.com/ethereum/web3.py/issues/1930>`__, `#1935 <https://github.com/ethereum/web3.py/issues/1935>`__
5.17.0
--------------------
Features
~~~~~~~~
- Added ``get_transaction_count``, and deprecated ``getTransactionCount`` (`1844 <https://github.com/ethereum/web3.py/issues/1844>`__)
- Add ``w3.eth.send_transaction``, deprecate ``w3.eth.sendTransaction`` (`1878 <https://github.com/ethereum/web3.py/issues/1878>`__)
- Add ``web3.eth.sign_transaction``, deprecate ``web3.eth.signTransaction`` (`1879 <https://github.com/ethereum/web3.py/issues/1879>`__)
- Add ``w3.eth.send_raw_transaction``, deprecate ``w3.eth.sendRawTransaction`` (`1880 <https://github.com/ethereum/web3.py/issues/1880>`__)
- Add ``w3.eth.replace_transaction`` deprecate ``w3.eth.replaceTransaction`` (`1882 <https://github.com/ethereum/web3.py/issues/1882>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Fix return type of ``send_transaction`` in docs. (`686 <https://github.com/ethereum/web3.py/issues/686>`__)
5.16.0
--------------------
Features
~~~~~~~~
- Added ``get_block_transaction_count``, and deprecated ``getBlockTransactionCount`` (`1841 <https://github.com/ethereum/web3.py/issues/1841>`__)
- Move ``defaultAccount`` to ``default_account``. Deprecate ``defaultAccount``. (`1848 <https://github.com/ethereum/web3.py/issues/1848>`__)
- Add ``eth.default_block``, deprecate ``eth.defaultBlock``.
Also adds ``parity.default_block``, and deprecates ``parity.defaultBlock``. (`1849 <https://github.com/ethereum/web3.py/issues/1849>`__)
- Add ``eth.gas_price``, deprecate ``eth.gasPrice`` (`1850 <https://github.com/ethereum/web3.py/issues/1850>`__)
- Added ``eth.block_number`` property. Deprecated ``eth.blockNumber`` (`1851 <https://github.com/ethereum/web3.py/issues/1851>`__)
- Add ``eth.chain_id``, deprecate ``eth.chainId`` (`1852 <https://github.com/ethereum/web3.py/issues/1852>`__)
- Add ``eth.protocol_version``, deprecate ``eth.protocolVersion`` (`1853 <https://github.com/ethereum/web3.py/issues/1853>`__)
- Add ``eth.get_code``, deprecate ``eth.getCode`` (`1856 <https://github.com/ethereum/web3.py/issues/1856>`__)
- Deprecate ``eth.getProof``, add ``eth.get_proof`` (`1857 <https://github.com/ethereum/web3.py/issues/1857>`__)
- Add ``eth.get_transaction``, deprecate ``eth.getTransaction`` (`1858 <https://github.com/ethereum/web3.py/issues/1858>`__)
- Add ``eth.get_transaction_by_block``, deprecate ``eth.getTransactionByBlock`` (`1859 <https://github.com/ethereum/web3.py/issues/1859>`__)
- Add get_uncle_by_block, deprecate getUncleByBlock (`1862 <https://github.com/ethereum/web3.py/issues/1862>`__)
- Add get_uncle_count, deprecate getUncleCount (`1863 <https://github.com/ethereum/web3.py/issues/1863>`__)
Bugfixes
~~~~~~~~
- Fix event filter creation if the event ABI contains a ``values`` key. (`1807 <https://github.com/ethereum/web3.py/issues/1807>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Remove v5 breaking changes link from the top of the release notes. (`1837 <https://github.com/ethereum/web3.py/issues/1837>`__)
- Add account creation troubleshooting docs. (`1855 <https://github.com/ethereum/web3.py/issues/1855>`__)
- Document passing a struct into a contract function. (`1860 <https://github.com/ethereum/web3.py/issues/1860>`__)
- Add instance configuration troubleshooting docs. (`1865 <https://github.com/ethereum/web3.py/issues/1865>`__)
- Clarify nonce lookup in sendRawTransaction docs. (`1866 <https://github.com/ethereum/web3.py/issues/1866>`__)
- Updated docs for web3.eth methods: eth.getTransactionReceipt and eth.waitForTransactionReceipt (`1868 <https://github.com/ethereum/web3.py/issues/1868>`__)
5.15.0
--------------------
Features
~~~~~~~~
- Add ``get_storage_at`` method and deprecate ``getStorageAt``. (`1828 <https://github.com/ethereum/web3.py/issues/1828>`__)
- Add ``eth.get_block`` method and deprecate ``eth.getBlock``. (`1829 <https://github.com/ethereum/web3.py/issues/1829>`__)
Bugfixes
~~~~~~~~
- PR 1585 changed the error that was coming back from eth-tester when the Revert opcode was called,
which broke some tests in downstream libraries. This PR reverts back to raising the original error. (`1813 <https://github.com/ethereum/web3.py/issues/1813>`__)
- Added a new ``ContractLogicError`` for when a contract reverts a transaction.
``ContractLogicError`` will replace ``SolidityError``, in v6. (`1814 <https://github.com/ethereum/web3.py/issues/1814>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Introduce Beacon API documentation (`1836 <https://github.com/ethereum/web3.py/issues/1836>`__)
Misc
~~~~
- `1602 <https://github.com/ethereum/web3.py/issues/1602>`__, `#1827 <https://github.com/ethereum/web3.py/issues/1827>`__, `#1831 <https://github.com/ethereum/web3.py/issues/1831>`__, `#1833 <https://github.com/ethereum/web3.py/issues/1833>`__, `#1834 <https://github.com/ethereum/web3.py/issues/1834>`__
5.14.0
--------------------
Bugfixes
~~~~~~~~
- Remove docs/web3.* from the gitignore to allow for the beacon docs to be added to git,
and add ``beacon`` to the default web3 modules that get loaded. (`1824 <https://github.com/ethereum/web3.py/issues/1824>`__)
- Remove auto-documenting from the Beacon API (`1825 <https://github.com/ethereum/web3.py/issues/1825>`__)
Features
~~~~~~~~
- Introduce experimental Ethereum 2.0 beacon node API (`1758 <https://github.com/ethereum/web3.py/issues/1758>`__)
- Add new get_balance method on Eth class. Deprecated getBalance. (`1806 <https://github.com/ethereum/web3.py/issues/1806>`__)
Misc
~~~~
- `1815 <https://github.com/ethereum/web3.py/issues/1815>`__, `#1816 <https://github.com/ethereum/web3.py/issues/1816>`__
5.13.1
--------------------
Bugfixes
~~~~~~~~
- Handle revert reason parsing for Ganache (`1794 <https://github.com/ethereum/web3.py/issues/1794>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Document Geth and Parity/OpenEthereum fixture generation (`1787 <https://github.com/ethereum/web3.py/issues/1787>`__)
Misc
~~~~
- `1778 <https://github.com/ethereum/web3.py/issues/1778>`__, `#1780 <https://github.com/ethereum/web3.py/issues/1780>`__, `#1790 <https://github.com/ethereum/web3.py/issues/1790>`__, `#1791 <https://github.com/ethereum/web3.py/issues/1791>`__, `#1796 <https://github.com/ethereum/web3.py/issues/1796>`__
5.13.0
--------------------
Features
~~~~~~~~
- Raise `SolidityError` exceptions that contain the revert reason when a `call` fails. (`941 <https://github.com/ethereum/web3.py/issues/941>`__)
Bugfixes
~~~~~~~~
- Update eth-tester dependency to fix tester environment install version conflict. (`1782 <https://github.com/ethereum/web3.py/issues/1782>`__)
Misc
~~~~
- `1757 <https://github.com/ethereum/web3.py/issues/1757>`__, `#1767 <https://github.com/ethereum/web3.py/issues/1767>`__
5.12.3
--------------------
Misc
~~~~
- `1752 <https://github.com/ethereum/web3.py/issues/1752>`__, `#1759 <https://github.com/ethereum/web3.py/issues/1759>`__, `#1773 <https://github.com/ethereum/web3.py/issues/1773>`__, `#1775 <https://github.com/ethereum/web3.py/issues/1775>`__
5.12.2
--------------------
Bugfixes
~~~~~~~~
- Address the use of multiple providers in the docs (`1701 <https://github.com/ethereum/web3.py/issues/1701>`__)
- Remove stale connection errors from docs (`1737 <https://github.com/ethereum/web3.py/issues/1737>`__)
- Allow ENS name resolution for methods that use the ``Method`` class (`1749 <https://github.com/ethereum/web3.py/issues/1749>`__)
Misc
~~~~
- `1727 <https://github.com/ethereum/web3.py/issues/1727>`__, `#1728 <https://github.com/ethereum/web3.py/issues/1728>`__, `#1733 <https://github.com/ethereum/web3.py/issues/1733>`__, `#1735 <https://github.com/ethereum/web3.py/issues/1735>`__, `#1741 <https://github.com/ethereum/web3.py/issues/1741>`__, `#1746 <https://github.com/ethereum/web3.py/issues/1746>`__, `#1748 <https://github.com/ethereum/web3.py/issues/1748>`__, `#1753 <https://github.com/ethereum/web3.py/issues/1753>`__, `#1768 <https://github.com/ethereum/web3.py/issues/1768>`__
5.12.1
--------------------
Misc
~~~~
- `1708 <https://github.com/ethereum/web3.py/issues/1708>`__, `#1709 <https://github.com/ethereum/web3.py/issues/1709>`__, `#1715 <https://github.com/ethereum/web3.py/issues/1715>`__, `#1722 <https://github.com/ethereum/web3.py/issues/1722>`__, `#1724 <https://github.com/ethereum/web3.py/issues/1724>`__
5.12.0
--------------------
Features
~~~~~~~~
- Update `web3.pm` and `ethpm` module to EthPM v3 specification. (`1652 <https://github.com/ethereum/web3.py/issues/1652>`__)
- Allow consumer to initialize `HttpProvider` with their own `requests.Session`. This allows the `HttpAdapter` connection pool to be tuned as desired. (`1469 <https://github.com/ethereum/web3.py/issues/1469>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Use ethpm v3 packages in examples documentation. (`1683 <https://github.com/ethereum/web3.py/issues/1683>`__)
- Modernize the deploy contract example. (`1679 <https://github.com/ethereum/web3.py/issues/1679>`__)
- Add contribution guidelines and a code of conduct. (`1691 <https://github.com/ethereum/web3.py/issues/1691>`__)
Misc
~~~~
- `1687 <https://github.com/ethereum/web3.py/issues/1687>`__
- `1690 <https://github.com/ethereum/web3.py/issues/1690>`__
5.12.0beta.3
---------------------------
Bugfixes
~~~~~~~~
- Include ethpm-spec solidity examples in distribution. (`1686 <https://github.com/ethereum/web3.py/issues/1686>`__)
5.12.0beta.2
---------------------------
Bugfixes
~~~~~~~~
- Support ethpm-spec submodule in distributions. (`1682 <https://github.com/ethereum/web3.py/issues/1682>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Modernize the deploy contract example. (`1679 <https://github.com/ethereum/web3.py/issues/1679>`__)
- Use ethpm v3 packages in examples documentation. (`1683 <https://github.com/ethereum/web3.py/issues/1683>`__)
5.12.0beta.1
---------------------------
Features
~~~~~~~~
- Allow consumer to initialize `HttpProvider` with their own `requests.Session`. This allows the `HttpAdapter` connection pool to be tuned as desired. (`1469 <https://github.com/ethereum/web3.py/issues/1469>`__)
- Update `web3.pm` and `ethpm` module to EthPM v3 specification. (`1652 <https://github.com/ethereum/web3.py/issues/1652>`__)
Bugfixes
~~~~~~~~
- Update outdated reference url in ethpm docs and tests. (`1680 <https://github.com/ethereum/web3.py/issues/1680>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Add a :meth:`~web3.eth.Eth.getBalance` example and provide more context for using the `fromWei` and `toWei` utility methods. (`1676 <https://github.com/ethereum/web3.py/issues/1676>`__)
- Overhaul the Overview documentation to provide a tour of major features. (`1681 <https://github.com/ethereum/web3.py/issues/1681>`__)
5.11.1
--------------------
Bugfixes
~~~~~~~~
- Added formatter rules for eth_tester middleware to allow :meth:`~web3.eth.Eth.getBalance` by using integer block numbers (`1660 <https://github.com/ethereum/web3.py/issues/1660>`__)
- Fix type annotations within the ``eth.py`` module. Several arguments that defaulted to ``None`` were not declared ``Optional``. (`1668 <https://github.com/ethereum/web3.py/issues/1668>`__)
- Fix type annotation warning when using string URI to instantiate an HTTP or WebsocketProvider. (`1669 <https://github.com/ethereum/web3.py/issues/1669>`__)
- Fix type annotations within the ``web3`` modules. Several arguments that defaulted to ``None`` were not declared ``Optional``. (`1670 <https://github.com/ethereum/web3.py/issues/1670>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Breaks up links into three categories (Intro, Guides, and API) and adds content to the index page: a lib introduction and some "Getting Started" links. (`1671 <https://github.com/ethereum/web3.py/issues/1671>`__)
- Fills in some gaps in the Quickstart guide and adds provider connection details for local nodes. (`1673 <https://github.com/ethereum/web3.py/issues/1673>`__)
5.11.0
--------------------
Features
~~~~~~~~
- Accept a block identifier in the ``Contract.estimateGas`` method. Includes a related upgrade of eth-tester to v0.5.0-beta.1. (`1639 <https://github.com/ethereum/web3.py/issues/1639>`__)
- Introduce a more specific validation error, ``ExtraDataLengthError``. This enables tools to detect when someone may be connected to a POA network, for example, and provide a smoother developer experience. (`1666 <https://github.com/ethereum/web3.py/issues/1666>`__)
Bugfixes
~~~~~~~~
- Correct the type annotations of `FilterParams.address` (`1664 <https://github.com/ethereum/web3.py/issues/1664>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Corrects the return value of ``getTransactionReceipt``, description of caching middleware, and deprecated method names. (`1663 <https://github.com/ethereum/web3.py/issues/1663>`__)
- Corrects documentation of websocket timeout configuration. (`1665 <https://github.com/ethereum/web3.py/issues/1665>`__)
5.10.0
--------------------
Features
~~~~~~~~
- An update of ``eth-tester`` includes a change of the default fork from Constantinople to Muir Glacier. `1636 <https://github.com/ethereum/web3.py/issues/1636>`__
Bugfixes
~~~~~~~~
- ``my_contract.events.MyEvent`` was incorrectly annotated so that ``MyEvent`` was marked as a ``ContractEvent`` instance. Fixed to be a class type, i.e., ``Type[ContractEvent]``. (`1646 <https://github.com/ethereum/web3.py/issues/1646>`__)
- IPCProvider correctly handled ``pathlib.Path`` input, but warned against its type. Fixed to permit Path objects in addition to strings. (`1647 <https://github.com/ethereum/web3.py/issues/1647>`__)
Misc
~~~~
- `1636 <https://github.com/ethereum/web3.py/issues/1636>`__
5.9.0
-------------------
Features
~~~~~~~~
- Upgrade eth-account to use v0.5.2+. eth-account 0.5.2 adds support for hd accounts
Also had to pin eth-keys to get dependencies to resolve. (`1622 <https://github.com/ethereum/web3.py/issues/1622>`__)
Bugfixes
~~~~~~~~
- Fix local_filter_middleware new entries bug (`1514 <https://github.com/ethereum/web3.py/issues/1514>`__)
- ENS ``name`` and ENS ``address`` can return ``None``. Fixes return types. (`1633 <https://github.com/ethereum/web3.py/issues/1633>`__)
5.8.0
-------------------
Features
~~~~~~~~
- Introduced ``list_wallets`` method to the ``GethPersonal`` class. (`1516 <https://github.com/ethereum/web3.py/issues/1516>`__)
- Added block_identifier parameter to `ContractConstructor.estimateGas` method. (`1588 <https://github.com/ethereum/web3.py/issues/1588>`__)
- Add snake_case methods to Geth and Parity Personal Modules.
Deprecate camelCase methods. (`1589 <https://github.com/ethereum/web3.py/issues/1589>`__)
- Added new weighted keyword argument to the time based gas price strategy.
If ``True``, it will more give more weight to more recent block times. (`1614 <https://github.com/ethereum/web3.py/issues/1614>`__)
- Adds support for Solidity's new(ish) receive function.
Adds a new contract API that mirrors the existing fallback API: ``contract.receive`` (`1623 <https://github.com/ethereum/web3.py/issues/1623>`__)
Bugfixes
~~~~~~~~
- Fixed hasattr overloader method in the web3.ContractEvent, web3.ContractFunction,
and web3.ContractCaller classes by implementing a try/except handler
that returns False if an exception is raised in the __getattr__ overloader method
(since __getattr__ HAS to be called in every __hasattr__ call).
Created two new Exception classes, 'ABIEventFunctionNotFound' and 'ABIFunctionNotFound',
which inherit from both AttributeError and MismatchedABI, and replaced the MismatchedABI
raises in ContractEvent, ContractFunction, and ContractCaller with a raise to the created class
in the __getattr__ overloader method of the object. (`1594 <https://github.com/ethereum/web3.py/issues/1594>`__)
- Change return type of rpc_gas_price_strategy from int to Wei (`1612 <https://github.com/ethereum/web3.py/issues/1612>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Fix typo in "Internals" docs. Changed asyncronous --> asynchronous (`1607 <https://github.com/ethereum/web3.py/issues/1607>`__)
- Improve documentation that introduces and troubleshoots Providers. (`1609 <https://github.com/ethereum/web3.py/issues/1609>`__)
- Add documentation for when to use each transaction method. (`1610 <https://github.com/ethereum/web3.py/issues/1610>`__)
- Remove incorrect web3 for w3 in doc example (`1615 <https://github.com/ethereum/web3.py/issues/1615>`__)
- Add examples for using web3.contract via the ethpm module. (`1617 <https://github.com/ethereum/web3.py/issues/1617>`__)
- Add dark mode to documentation. Also fixes a bunch of formatting issues in docs. (`1626 <https://github.com/ethereum/web3.py/issues/1626>`__)
Misc
~~~~
- `1545 <https://github.com/ethereum/web3.py/issues/1545>`__
5.7.0
-------------------
Features
~~~~~~~~
- Add snake_case methods for the net module
Also moved net module to use ModuleV2 instead of Module (`1592 <https://github.com/ethereum/web3.py/issues/1592>`__)
Bugfixes
~~~~~~~~
- Fix return type of eth_getCode. Changed from Hexstr to HexBytes. (`1601 <https://github.com/ethereum/web3.py/issues/1601>`__)
Misc
~~~~
- `1590 <https://github.com/ethereum/web3.py/issues/1590>`__
5.6.0
-------------------
Features
~~~~~~~~
- Add snake_case methods to Geth Miner class, deprecate camelCase methods (`1579 <https://github.com/ethereum/web3.py/issues/1579>`__)
- Add snake_case methods for the net module, deprecate camelCase methods (`1581 <https://github.com/ethereum/web3.py/issues/1581>`__)
- Add PEP561 type marker (`1583 <https://github.com/ethereum/web3.py/issues/1583>`__)
Bugfixes
~~~~~~~~
- Increase replacement tx minimum gas price bump
Parity/OpenEthereum requires a replacement transaction's
gas to be a minimum of 12.5% higher than the original
(vs. Geth's 10%). (`1570 <https://github.com/ethereum/web3.py/issues/1570>`__)
5.5.1
-------------------
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Documents the `getUncleCount` method. (`1534 <https://github.com/ethereum/web3.py/issues/1534>`__)
Misc
~~~~
- `1576 <https://github.com/ethereum/web3.py/issues/1576>`__
5.5.0
-------------------
Features
~~~~~~~~
- ENS had to release a new registry to push a bugfix. See
`this article <https://medium.com/the-ethereum-name-service/ens-registry-migration-bug-fix-new-features-64379193a5a>`_
for background information. Web3.py uses the new registry for all default ENS interactions, now. (`1573 <https://github.com/ethereum/web3.py/issues/1573>`__)
Bugfixes
~~~~~~~~
- Minor bugfix in how ContractCaller looks up abi functions. (`1552 <https://github.com/ethereum/web3.py/issues/1552>`__)
- Update modules to use compatible typing-extensions import. (`1554 <https://github.com/ethereum/web3.py/issues/1554>`__)
- Make 'from' and 'to' fields checksum addresses in returned transaction receipts (`1562 <https://github.com/ethereum/web3.py/issues/1562>`__)
- Use local Trinity's IPC socket if it is available, for newer versions of Trinity. (`1563 <https://github.com/ethereum/web3.py/issues/1563>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Add Matomo Tracking to Docs site.
Matomo is an Open Source web analytics platform that allows us
to get better insights and optimize for our audience without
the negative consequences of other compareable platforms.
Read more: https://matomo.org/why-matomo/ (`#1541 <https://github.com/ethereum/web3.py/issues/1541>`__)
- Fix web3 typo in docs (`1559 <https://github.com/ethereum/web3.py/issues/1559>`__)
Misc
~~~~
- `1521 <https://github.com/ethereum/web3.py/issues/1521>`__, `#1546 <https://github.com/ethereum/web3.py/issues/1546>`__, `#1571 <https://github.com/ethereum/web3.py/issues/1571>`__
5.4.0
-------------------
Features
~~~~~~~~
- Add __str__ to IPCProvider (`1536 <https://github.com/ethereum/web3.py/issues/1536>`__)
Bugfixes
~~~~~~~~
- Add required typing-extensions library to setup.py (`1544 <https://github.com/ethereum/web3.py/issues/1544>`__)
5.3.1
-------------------
Bugfixes
~~~~~~~~
- Only apply hexbytes formatting to r and s values in transaction if present (`1531 <https://github.com/ethereum/web3.py/issues/1531>`__)
- Update eth-utils dependency which contains mypy bugfix. (`1537 <https://github.com/ethereum/web3.py/issues/1537>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Update Contract Event documentation to show correct example (`1515 <https://github.com/ethereum/web3.py/issues/1515>`__)
- Add documentation to methods that raise an error in v5 instead of returning ``None`` (`1527 <https://github.com/ethereum/web3.py/issues/1527>`__)
Misc
~~~~
- `1518 <https://github.com/ethereum/web3.py/issues/1518>`__, `#1532 <https://github.com/ethereum/web3.py/issues/1532>`__
5.3.0
-------------------
Features
~~~~~~~~
- Support handling ENS domains in ERC1319 URIs. (`1489 <https://github.com/ethereum/web3.py/issues/1489>`__)
Bugfixes
~~~~~~~~
- Make local block filter return empty list when when no blocks mined (`1255 <https://github.com/ethereum/web3.py/issues/1255>`__)
- Google protobuf dependency was updated to `3.10.0` (`1493 <https://github.com/ethereum/web3.py/issues/1493>`__)
- Infura websocket provider works when no secret key is present (`1501 <https://github.com/ethereum/web3.py/issues/1501>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Update Quickstart instructions to use the auto Infura module instead of the more complicated web3 auto module (`1482 <https://github.com/ethereum/web3.py/issues/1482>`__)
- Remove outdated py.test command from readme (`1483 <https://github.com/ethereum/web3.py/issues/1483>`__)
Misc
~~~~
- `1461 <https://github.com/ethereum/web3.py/issues/1461>`__, `#1471 <https://github.com/ethereum/web3.py/issues/1471>`__, `#1475 <https://github.com/ethereum/web3.py/issues/1475>`__, `#1476 <https://github.com/ethereum/web3.py/issues/1476>`__, `#1479 <https://github.com/ethereum/web3.py/issues/1479>`__, `#1488 <https://github.com/ethereum/web3.py/issues/1488>`__, `#1492 <https://github.com/ethereum/web3.py/issues/1492>`__, `#1498 <https://github.com/ethereum/web3.py/issues/1498>`__
5.2.2
-------------------
Features
~~~~~~~~
- Add poll_latency to waitForTransactionReceipt (`1453 <https://github.com/ethereum/web3.py/issues/1453>`__)
Bugfixes
~~~~~~~~
- Fix flaky Parity whisper module test (`1473 <https://github.com/ethereum/web3.py/issues/1473>`__)
Misc
~~~~
- `1472 <https://github.com/ethereum/web3.py/issues/1472>`__, `#1474 <https://github.com/ethereum/web3.py/issues/1474>`__
5.2.1
-------------------
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Update documentation for unlock account duration (`1464 <https://github.com/ethereum/web3.py/issues/1464>`__)
- Clarify module installation command for OSX>=10.15 (`1467 <https://github.com/ethereum/web3.py/issues/1467>`__)
Misc
~~~~
- `1468 <https://github.com/ethereum/web3.py/issues/1468>`__
5.2.0
-------------------
Features
~~~~~~~~
- Add ``enable_strict_bytes_type_checking`` flag to web3 instance (`1419 <https://github.com/ethereum/web3.py/issues/1419>`__)
- Move Geth Whisper methods to snake case and deprecate camel case methods (`1433 <https://github.com/ethereum/web3.py/issues/1433>`__)
Bugfixes
~~~~~~~~
- Add null check to logsbloom formatter (`1445 <https://github.com/ethereum/web3.py/issues/1445>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Reformat autogenerated towncrier release notes (`1460 <https://github.com/ethereum/web3.py/issues/1460>`__)
5.1.0
-----------------------
Features
~~~~~~~~
- Add ``contract_types`` property to ``Package`` class. (`1440 <https://github.com/ethereum/web3.py/issues/1440>`__)
Bugfixes
~~~~~~~~
- Fix flaky parity integration test in the whisper module (`1147 <https://github.com/ethereum/web3.py/issues/1147>`__)
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Remove whitespace, move ``topics`` key -> ``topic`` in Geth docs (`1425 <https://github.com/ethereum/web3.py/issues/1425>`__)
- Enforce stricter doc checking, turning warnings into errors to fail CI builds
to catch issues quickly.
Add missing ``web3.tools.rst`` to the table of contents and fix incorrectly formatted
JSON example. (`1437 <https://github.com/ethereum/web3.py/issues/1437>`__)
- Add example using Geth POA Middleware with Infura Rinkeby Node (`1444 <https://github.com/ethereum/web3.py/issues/1444>`__)
Misc
~~~~
- `1446 <https://github.com/ethereum/web3.py/issues/1446>`__, `#1451 <https://github.com/ethereum/web3.py/issues/1451>`__
5.0.2
------
Released August 22, 2019
- Bugfixes
- [ethPM] Fix bug in package id and release id fetching strategy
- `1427 <https://github.com/ethereum/web3.py/pull/1427>`_
5.0.1
------
Released August 15, 2019
- Bugfixes
- [ethPM] Add begin/close chars to package name regex
- `1418 <https://github.com/ethereum/web3.py/pull/1418>`_
- [ethPM] Update deployments to work when only abi available
- `1417 <https://github.com/ethereum/web3.py/pull/1417>`_
- Fix tuples handled incorrectly in ``decode_function_input``
- `1410 <https://github.com/ethereum/web3.py/pull/1410>`_
- Misc
- Eliminate ``signTransaction`` warning
- `1404 <https://github.com/ethereum/web3.py/pull/1404>`_
5.0.0
------
Released August 1, 2019
- Features
- ``web3.eth.chainId`` now returns an integer instead of hex
- `1394 <https://github.com/ethereum/web3.py/pull/1394>`_
- Bugfixes
- Deprecation Warnings now show for methods that have a
``combomethod`` decorator
- `1401 <https://github.com/ethereum/web3.py/pull/1401>`_
- Misc
- [ethPM] Add ethPM to the docker file
- `1405 <https://github.com/ethereum/web3.py/pull/1405>`_
- Docs
- Docs are updated to use checksummed addresses
- `1390 <https://github.com/ethereum/web3.py/pull/1390>`_
- Minor doc formatting fixes
- `1338 <https://github.com/ethereum/web3.py/pull/1338>`_ &
`1345 <https://github.com/ethereum/web3.py/pull/1345>`_
5.0.0beta.5
-------------
Released July 31, 2019
*This is intended to be the final release before the stable v5 release.*
- Features
- Parity operating mode can be read and set
- `1355 <https://github.com/ethereum/web3.py/pull/1355>`_
- Process a single event log, instead of a whole transaction
receipt
- `1354 <https://github.com/ethereum/web3.py/pull/1354>`_
- Docs
- Remove doctest dependency on ethtoken
- `1395 <https://github.com/ethereum/web3.py/pull/1395>`_
- Bugfixes
- [ethPM] Bypass IPFS validation for large files
- `1393 <https://github.com/ethereum/web3.py/pull/1393>`_
- Misc
- [ethPM] Update default Registry solidity contract
- `1400 <https://github.com/ethereum/web3.py/pull/1400>`_
- [ethPM] Update web3.pm to use new simple Registry implementation
- `1398 <https://github.com/ethereum/web3.py/pull/1398>`_
- Update dependency requirement formatting for releasing
- `1403 <https://github.com/ethereum/web3.py/pull/1403>`_
5.0.0beta.4
-------------
Released July 18,2019
- Features
- [ethPM] Update registry uri to support basic uris w/o package id
- `1389 <https://github.com/ethereum/web3.py/pull/1389>`_
- Docs
- Clarify in docs the return of ``Eth.sendRawTransaction()`` as
a HexBytes object, not a string.
- `1384 <https://github.com/ethereum/web3.py/pull/1384>`_
- Misc
- [ethPM] Migrate tests over from pytest-ethereum
- `1385 <https://github.com/ethereum/web3.py/pull/1385>`_
5.0.0beta.3
-------------
Released July 15, 2019
- Features
- Add eth_getProof support
- `1185 <https://github.com/ethereum/web3.py/pull/1185>`_
- Implement web3.pm.get_local_package()
- `1372 <https://github.com/ethereum/web3.py/pull/1372>`_
- Update registry URIs to support chain IDs
- `1382 <https://github.com/ethereum/web3.py/pull/1382>`_
- Add error flags to ``event.processReceipt``
- `1366 <https://github.com/ethereum/web3.py/pull/1366>`_
- Bugfixes
- Remove full IDNA processing in favor of UTS46
- `1364 <https://github.com/ethereum/web3.py/pull/1364>`_
- Misc
- Migrate py-ethpm library to web3/ethpm
- `1379 <https://github.com/ethereum/web3.py/pull/1379>`_
- Relax canonical address requirement in ethPM
- `1380 <https://github.com/ethereum/web3.py/pull/1380>`_
- Replace ethPM's infura strategy with web3's native infura support
- `1383 <https://github.com/ethereum/web3.py/pull/1383>`_
- Change ``combine_argument_formatters`` to ``apply_formatters_to_sequence``
- `1360 <https://github.com/ethereum/web3.py/pull/1360>`_
- Move ``pytest.xfail`` instances to ``pytest.mark.xfail``
- `1376 <https://github.com/ethereum/web3.py/pull/1376>`_
- Change ``net.version`` to ``eth.chainId`` in default
transaction params
- `1378 <https://github.com/ethereum/web3.py/pull/1378>`_
5.0.0beta.2
-------------
Released May 13, 2019
- Features
- Mark deprecated sha3 method as static
- `1350 <https://github.com/ethereum/web3.py/pull/1350>`_
- Upgrade to eth-account v0.4.0
- `1348 <https://github.com/ethereum/web3.py/pull/1348>`_
- Docs
- Add note about web3[tester] in documentation
- `1325 <https://github.com/ethereum/web3.py/pull/1325>`_
- Misc
- Replace ``web3._utils.toolz`` imports with ``eth_utils.toolz``
- `1317 <https://github.com/ethereum/web3.py/pull/1317>`_
5.0.0beta.1
-------------
Released May 6, 2019
- Features
- Add support for tilda in provider IPC Path
- `1049 <https://github.com/ethereum/web3.py/pull/1049>`_
- EIP 712 Signing Supported
- `1319 <https://github.com/ethereum/web3.py/pull/1319>`_
- Docs
- Update contract example to use ``compile_standard``
- `1263 <https://github.com/ethereum/web3.py/pull/1263>`_
- Fix typo in middleware docs
- `1339 <https://github.com/ethereum/web3.py/pull/1339>`_
5.0.0alpha.11
---------------
Released April 24, 2019
- Docs
- Add documentation for web3.py unit tests
- `1324 <https://github.com/ethereum/web3.py/pull/1324>`_
- Misc
- Update deprecated collections.abc imports
- `1334 <https://github.com/ethereum/web3.py/pull/1334>`_
- Fix documentation typo
- `1335 <https://github.com/ethereum/web3.py/pull/1335>`_
- Upgrade eth-tester version
- `1332 <https://github.com/ethereum/web3.py/pull/1332>`_
5.0.0alpha.10
---------------
Released April 15, 2019
- Features
- Add getLogs by blockHash
- `1269 <https://github.com/ethereum/web3.py/pull/1269>`_
- Implement chainId endpoint
- `1295 <https://github.com/ethereum/web3.py/pull/1295>`_
- Moved non-standard JSON-RPC endpoints to applicable
Parity/Geth docs. Deprecated ``web3.version`` for ``web3.api``
- `1290 <https://github.com/ethereum/web3.py/pull/1290>`_
- Moved Whisper endpoints to applicable Geth or Parity namespace
- `1308 <https://github.com/ethereum/web3.py/pull/1308>`_
- Added support for Goerli provider
- `1286 <https://github.com/ethereum/web3.py/pull/1286>`_
- Added addReservedPeer to Parity module
- `1311 <https://github.com/ethereum/web3.py/pull/1311>`_
- Bugfixes
- Cast gas price values to integers in gas strategies
- `1297 <https://github.com/ethereum/web3.py/pull/1297>`_
- Missing constructor function no longer ignores constructor args
- `1316 <https://github.com/ethereum/web3.py/pull/1316>`_
- Misc
- Require eth-utils >= 1.4, downgrade Go version for integration tests
- `1310 <https://github.com/ethereum/web3.py/pull/1310>`_
- Fix doc build warnings
- `1331 <https://github.com/ethereum/web3.py/pull/1331>`_
- Zip Fixture data
- `1307 <https://github.com/ethereum/web3.py/pull/1307>`_
- Update Geth version for integration tests
- `1301 <https://github.com/ethereum/web3.py/pull/1301>`_
- Remove unneeded testrpc
- `1322 <https://github.com/ethereum/web3.py/pull/1322>`_
- Add ContractCaller docs to v5 migration guide
- `1323 <https://github.com/ethereum/web3.py/pull/1323>`_
5.0.0alpha.9
--------------
Released March 26, 2019
- Breaking Changes
- Raise error if there is no Infura API Key
- `1294 <https://github.com/ethereum/web3.py/pull/1294>`_ &
- `1299 <https://github.com/ethereum/web3.py/pull/1299>`_
- Misc
- Upgraded Parity version for integration testing
- `1292 <https://github.com/ethereum/web3.py/pull/1292>`_
5.0.0alpha.8
--------------
Released March 20, 2019
- Breaking Changes
- Removed ``web3/utils`` directory in favor of ``web3/_utils``
- `1282 <https://github.com/ethereum/web3.py/pull/1282>`_
- Relocated personal RPC endpoints to Parity and Geth class
- `1211 <https://github.com/ethereum/web3.py/pull/1211>`_
- Deprecated ``web3.net.chainId()``, ``web3.eth.getCompilers()``,
and ``web3.eth.getTransactionFromBlock()``. Removed ``web3.eth.enableUnauditedFeatures()``
- `1270 <https://github.com/ethereum/web3.py/pull/1270>`_
- Relocated eth_protocolVersion and web3_clientVersion
- `1274 <https://github.com/ethereum/web3.py/pull/1274>`_
- Relocated ``web3.txpool`` to ``web3.geth.txpool``
- `1275 <https://github.com/ethereum/web3.py/pull/1275>`_
- Relocated admin module to Geth namespace
- `1288 <https://github.com/ethereum/web3.py/pull/1288>`_
- Relocated miner module to Geth namespace
- `1287 <https://github.com/ethereum/web3.py/pull/1287>`_
- Features
- Implement ``eth_submitHashrate`` and ``eth_submitWork`` JSONRPC endpoints.
- `1280 <https://github.com/ethereum/web3.py/pull/1280>`_
- Implement ``web3.eth.signTransaction``
- `1277 <https://github.com/ethereum/web3.py/pull/1277>`_
- Docs
- Added v5 migration docs
- `1284 <https://github.com/ethereum/web3.py/pull/1284>`_
5.0.0alpha.7
--------------
Released March 11, 2019
- Breaking Changes
- Updated JSON-RPC calls that lookup txs or blocks to raise
an error if lookup fails
- `1218 <https://github.com/ethereum/web3.py/pull/1218>`_ and
`1268 <https://github.com/ethereum/web3.py/pull/1268>`_
- Features
- Tuple ABI support
- `1235 <https://github.com/ethereum/web3.py/pull/1235>`_
- Bugfixes
- One last ``middleware_stack`` was still hanging on.
Changed to ``middleware_onion``
- `1262 <https://github.com/ethereum/web3.py/pull/1262>`_
5.0.0alpha.6
--------------
Released February 25th, 2019
- Features
- New ``NoABIFound`` error for cases where there is no ABI
- `1247 <https://github.com/ethereum/web3.py/pull/1247>`_
- Misc
- Interact with Infura using an API Key. Key will be required after March 27th.
- `1232 <https://github.com/ethereum/web3.py/pull/1232>`_
- Remove ``process_type`` utility function in favor of
eth-abi functionality
- `1249 <https://github.com/ethereum/web3.py/pull/1249>`_
5.0.0alpha.5
--------------
Released February 13th, 2019
- Breaking Changes
- Remove deprecated ``buildTransaction``, ``call``, ``deploy``,
``estimateGas``, and ``transact`` methods
- `1232 <https://github.com/ethereum/web3.py/pull/1232>`_
- Features
- Adds ``Web3.toJSON`` method
- `1173 <https://github.com/ethereum/web3.py/pull/1173>`_
- Contract Caller API Implemented
- `1227 <https://github.com/ethereum/web3.py/pull/1227>`_
- Add Geth POA middleware to use Rinkeby with Infura Auto
- `1234 <https://github.com/ethereum/web3.py/pull/1234>`_
- Add manifest and input argument validation to ``pm.release_package()``
- `1237 <https://github.com/ethereum/web3.py/pull/1237>`_
- Misc
- Clean up intro and block/tx sections in Filter docs
- `1223 <https://github.com/ethereum/web3.py/pull/1223>`_
- Remove unnecessary ``EncodingError`` exception catching
- `1224 <https://github.com/ethereum/web3.py/pull/1224>`_
- Improvements to ``merge_args_and_kwargs`` utility function
- `1228 <https://github.com/ethereum/web3.py/pull/1228>`_
- Update vyper registry assets
- `1242 <https://github.com/ethereum/web3.py/pull/1242>`_
5.0.0alpha.4
--------------
Released January 23rd, 2019
- Breaking Changes
- Rename ``middleware_stack`` to ``middleware_onion``
- `1210 <https://github.com/ethereum/web3.py/pull/1210>`_
- Drop already deprecated ``web3.soliditySha3``
- `1217 <https://github.com/ethereum/web3.py/pull/1217>`_
- ENS: Stop inferring ``.eth`` TLD on domain names
- `1205 <https://github.com/ethereum/web3.py/pull/1205>`_
- Bugfixes
- Validate ``ethereum_tester`` class in ``EthereumTesterProvider``
- `1217 <https://github.com/ethereum/web3.py/pull/1217>`_
- Support ``getLogs()`` method without creating filters
- `1192 <https://github.com/ethereum/web3.py/pull/1192>`_
- Features
- Stablize the ``PM`` module
- `1125 <https://github.com/ethereum/web3.py/pull/1125>`_
- Implement async ``Version`` module
- `1166 <https://github.com/ethereum/web3.py/pull/1166>`_
- Misc
- Update .gitignore to ignore ``.DS_Store`` and ``.mypy_cache/``
- `1215 <https://github.com/ethereum/web3.py/pull/1215>`_
- Change CircleCI badge link to CircleCI project
- `1214 <https://github.com/ethereum/web3.py/pull/1214>`_
5.0.0alpha.3
--------------
Released January 15th, 2019
- Breaking Changes
- Remove ``web3.miner.hashrate`` and ``web3.version.network``
- `1198 <https://github.com/ethereum/web3.py/pull/1198>`_
- Remove ``web3.providers.tester.EthereumTesterProvider``
and ``web3.providers.tester.TestRPCProvider``
- `1199 <https://github.com/ethereum/web3.py/pull/1199>`_
- Change ``manager.providers`` from list to single ``manager.provider``
- `1200 <https://github.com/ethereum/web3.py/pull/1200>`_
- Replace deprecated ``web3.sha3`` method with ``web3.keccak`` method
- `1207 <https://github.com/ethereum/web3.py/pull/1207>`_
- Drop auto detect testnets for IPCProvider
- `1206 <https://github.com/ethereum/web3.py/pull/1206>`_
- Bugfixes
- Add check to make sure blockHash exists
- `1158 <https://github.com/ethereum/web3.py/pull/1158>`_
- Misc
- Remove some unreachable code in `providers/base.py`
- `1160 <https://github.com/ethereum/web3.py/pull/1160>`_
- Migrate tester provider results from middleware to defaults
- `1188 <https://github.com/ethereum/web3.py/pull/1188>`_
- Fix doc formatting for build_filter method
- `1187 <https://github.com/ethereum/web3.py/pull/1187>`_
- Add ERC20 example in docs
- `1178 <https://github.com/ethereum/web3.py/pull/1178>`_
- Code style improvements
- `1194 <https://github.com/ethereum/web3.py/pull/1194>`_
& `1191 <https://github.com/ethereum/web3.py/pull/1191>`_
- Convert Web3 instance variables to w3
- `1186 <https://github.com/ethereum/web3.py/pull/1186>`_
- Update eth-utils dependencies and clean up other dependencies
- `1195 <https://github.com/ethereum/web3.py/pull/1195>`_
5.0.0alpha.2
--------------
Released December 20th, 2018
- Breaking Changes
- Remove support for python3.5, drop support for eth-abi v1
- `1163 <https://github.com/ethereum/web3.py/pull/1163>`_
- Features
- Support for custom ReleaseManager was fixed
- `1165 <https://gi
