🎉 first commit.

Signed-off-by: Harmouch101 <eng.mahmoudharmouch@gmail.com>

Author: wiseaidev

docs/providers.rst

@@ -423,6 +423,7 @@ Eth
 - :meth:`web3.eth.mining <web3.eth.Eth.mining>`
 - :meth:`web3.eth.syncing <web3.eth.Eth.syncing>`
 - :meth:`web3.eth.call() <web3.eth.Eth.call>`
+- :meth:`web3.eth.createAccessList() <web3.eth.Eth.createAccessList>`
 - :meth:`web3.eth.estimate_gas() <web3.eth.Eth.estimate_gas>`
 - :meth:`web3.eth.generate_gas_price() <web3.eth.Eth.generate_gas_price>`
 - :meth:`web3.eth.get_balance() <web3.eth.Eth.get_balance>`

docs/web3.eth.rst

@@ -1078,6 +1078,38 @@ The following methods are available on the ``web3.eth`` namespace.
     View their `usage documentation <https://geth.ethereum.org/docs/rpc/ns-eth#3-object---state-override-set>`_
     for a list of possible parameters.
 
+.. py:method:: Eth.createAccessList(transaction, block_identifier=web3.eth.default_block)
+
+    * Delegates to ``eth_createAccessList`` RPC Method
+
+    This method creates an `EIP2930 <https://eips.ethereum.org/EIPS/eip-2930>`_ type ``accessList`` based on a given ``Transaction``. The ``accessList`` contains all storage slots and addresses read and written by the transaction, except for the sender account and the precompiles. This method uses the same ``transaction`` call object and ``block_identifier`` object as :meth:`~web3.eth.Eth.call()`. An ``accessList`` can be used to unstuck contracts that became inaccessible due to gas cost increases.
+
+    :param transaction: ``TransactionCall`` object.
+    :param block_identifier: Optional, blocknumber or ``latest`` or ``pending``
+
+    .. code-block:: python
+
+        >>> we3.eth.createAccessList({'from': '0x0', 'data': '0x0'})
+        {
+            'accessList': (
+                {
+                    'address': '0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae',
+                    'storageKeys': (
+                        '0x0000000000000000000000000000000000000000000000000000000000000003',
+                        '0x0000000000000000000000000000000000000000000000000000000000000007',
+                    )
+                },
+                {
+                    'address': '0xbb9bc244d798123fde783fcc1c72d3bb8c189413',
+                    'storageKeys': ()
+                },
+            ),
+            "gas": "21000"
+        }
+
+    The method ``eth_createAccessList`` returns list of addresses and storage keys used by the transaction, plus the gas consumed when the access list is added.
+
+    That is, it gives you the list of addresses and storage keys that will be used by that transaction, plus the gas consumed if the access list is included. Like ``eth_estimateGas``, this is an estimation; the list could change when the transaction is actually mined. Adding an ``accessList`` to your transaction does not necessary result in lower gas usage compared to a transaction without an access list.
 
 .. py:method:: Eth.fee_history(block_count, newest_block, reward_percentiles=None)
 

tests/core/middleware/test_transaction_signing.py

@@ -135,6 +135,8 @@ def hex_to_bytes(s):
         ('eth_sendTransaction', SAME_KEY_MIXED_TYPE[3], ADDRESS_2, NotImplementedError),
         ('eth_sendTransaction', SAME_KEY_MIXED_TYPE[4], ADDRESS_2, NotImplementedError),
         ('eth_call', MIXED_KEY_MIXED_TYPE, ADDRESS_1, NotImplementedError),
+        ('createAccessList', SAME_KEY_SAME_TYPE, hex_to_bytes(ADDRESS_1),
+         'eth_createAccessList'),
         ('eth_sendTransaction', SAME_KEY_SAME_TYPE, hex_to_bytes(ADDRESS_1),
          'eth_sendRawTransaction'),
     )

web3/_utils/method_formatters.py

@@ -372,6 +372,16 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
 
 signed_tx_formatter = apply_formatters_to_dict(SIGNED_TX_FORMATTER)
 
+ACCESS_LIST_FORMATTER = apply_list_to_array_formatter({
+    'address': to_checksum_address,
+    'storageKeys': apply_list_to_array_formatter(to_hexbytes(64))
+})
+
+ACCESS_LIST_RESPONCE_FORMATTER = apply_formatters_to_dict({
+    "accessList": ACCESS_LIST_FORMATTER,
+    "gasUsed": to_integer_if_hex,
+})
+
 FILTER_PARAM_NORMALIZERS = apply_formatters_to_dict({
     'address': apply_formatter_if(is_string, lambda x: [x])
 })
@@ -426,6 +436,7 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
         (is_length(2), call_without_override),
         (is_length(3), call_with_override),
     )),
+    RPC.eth_createAccessList: apply_formatter_at_index(transaction_param_formatter, 0),
     RPC.eth_estimateGas: apply_one_of_formatters((
         (is_length(1), estimate_gas_without_block_id),
         (is_length(2), estimate_gas_with_block_id),
@@ -459,6 +470,7 @@ def apply_list_to_array_formatter(formatter: Any) -> Callable[..., Any]:
     RPC.eth_chainId: to_integer_if_hex,
     RPC.eth_coinbase: to_checksum_address,
     RPC.eth_call: HexBytes,
+    RPC.eth_createAccessList: ACCESS_LIST_RESPONCE_FORMATTER,
     RPC.eth_estimateGas: to_integer_if_hex,
     RPC.eth_feeHistory: fee_history_formatter,
     RPC.eth_maxPriorityFeePerGas: to_integer_if_hex,

web3/_utils/rpc_abi.py

@@ -43,6 +43,7 @@ class RPC:
     eth_accounts = RPCEndpoint("eth_accounts")
     eth_blockNumber = RPCEndpoint("eth_blockNumber")
     eth_call = RPCEndpoint("eth_call")
+    eth_createAccessList = RPCEndpoint("eth_createAccessList")
     eth_chainId = RPCEndpoint("eth_chainId")
     eth_coinbase = RPCEndpoint("eth_coinbase")
     eth_estimateGas = RPCEndpoint("eth_estimateGas")
@@ -178,6 +179,7 @@ class RPC:
 RPC_ABIS = {
     # eth
     'eth_call': TRANSACTION_PARAMS_ABIS,
+    'eth_createAccessList': TRANSACTION_PARAMS_ABIS,
     'eth_estimateGas': TRANSACTION_PARAMS_ABIS,
     'eth_getBalance': ['address', None],
     'eth_getBlockByHash': ['bytes32', 'bool'],

web3/eth.py

@@ -868,6 +868,11 @@ def sign_munger(
         mungers=[BaseEth.call_munger]
     )
 
+    createAccessList: Method[Callable[..., Union[bytes, bytearray]]] = Method(
+        RPC.eth_createAccessList,
+        mungers=[BaseEth.call_munger]
+    )
+
     def estimate_gas(
         self,
         transaction: TxParams,

web3/middleware/cache.py

@@ -284,6 +284,7 @@ def middleware(method: RPCEndpoint, params: Any) -> RPCResponse:
     # 'eth_sendTransaction',
     # 'eth_sendRawTransaction',
     'eth_call',
+    'eth_createAccessList',
     'eth_estimateGas',
     # 'eth_getBlockByHash',
     'eth_getBlockByNumber',

web3/middleware/exception_retry_request.py

@@ -53,6 +53,7 @@
     'eth_getTransactionCount',
     'eth_getRawTransactionByHash',
     'eth_call',
+    'eth_createAccessList',
     'eth_estimateGas',
     'eth_newBlockFilter',
     'eth_newPendingTransactionFilter',

web3/middleware/validation.py

@@ -113,7 +113,8 @@ def _transaction_param_validator(web3_chain_id: int) -> Callable[..., Any]:
 METHODS_TO_VALIDATE = [
     RPC.eth_sendTransaction,
     RPC.eth_estimateGas,
-    RPC.eth_call
+    RPC.eth_call,
+    RPC.eth_createAccessList
 ]
 
 

web3/providers/eth_tester/middleware.py

@@ -224,6 +224,10 @@ def is_hexstr(value: Any) -> bool:
             transaction_request_transformer,
             apply_formatter_if(is_not_named_block, to_integer_if_hex),
         ),
+        RPCEndpoint('eth_createAccessList'): apply_formatters_to_args(
+            transaction_request_transformer,
+            apply_formatter_if(is_not_named_block, to_integer_if_hex),
+        )
         RPCEndpoint('eth_uninstallFilter'): apply_formatters_to_args(hex_to_integer),
         RPCEndpoint('eth_getCode'): apply_formatters_to_args(
             identity,
@@ -323,6 +327,7 @@ def middleware(method: RPCEndpoint, params: Any) -> RPCResponse:
             'eth_call',
             'eth_estimateGas',
             'eth_sendTransaction',
+            'eth_createAccessList',
         ):
             filled_transaction = pipe(
                 params[0],