Remove StarknetEthProxyCheck (#1292)

* Remove StarknetEthProxyCheck

* fix lint

* remove eth_proxy tests

* feedback

* add changelog

* feedback

* Update docs/migration_guide.rst

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

---------

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>

Author: tkumor3

docs/guide/resolving_proxy_contracts.rst

@@ -37,6 +37,9 @@ By default, ``proxy_config`` uses a configuration with two **ProxyChecks**:
  - ArgentProxyCheck - resolves `Argent Proxy <https://github.com/argentlabs/argent-contracts-starknet/blob/b7c4af7462a461386d29551400b985832ba942de/contracts/upgrade/Proxy.cairo>`_.
  - OpenZeppelinProxyCheck - resolves `OpenZeppelin Proxy <https://github.com/OpenZeppelin/cairo-contracts/blob/d12abf335f5c778fd19d6f99e91c099b40865deb/src/openzeppelin/upgrades/presets/Proxy.cairo>`_.
 
+.. warning::
+    ``StarknetEthProxyCheck`` has been removed, because the StarkGate ETH Token was upgraded to Cairo 2, meaning it isn't a Proxy anymore. Currently, all StarkGate's Token contracts use interface of ERC20 to interact.
+
 It's possible to define own ProxyCheck implementation and later pass it to :meth:`Contract.from_address <starknet_py.contract.Contract.from_address>`, so it knows how to resolve the Proxy.
 
 The **ProxyCheck** base class implements the following interface:

docs/migration_guide.rst

@@ -1,6 +1,15 @@
 Migration guide
 ===============
 
+**********************
+0.20.0 Migration guide
+**********************
+
+0.20.0 Breaking Changes
+-----------------------
+
+1. :class:`StarknetEthProxyCheck` has been removed from the Proxy checks
+
 **********************
 0.19.0 Migration guide
 **********************

starknet_py/contract.py

@@ -783,9 +783,8 @@ async def from_address(
         :param provider: BaseAccount or Client.
         :param proxy_config: Proxy resolving config
             If set to ``True``, will use default proxy checks
-            :class:`starknet_py.proxy.proxy_check.OpenZeppelinProxyCheck`,
-            :class:`starknet_py.proxy.proxy_check.ArgentProxyCheck`,
-            and :class:`starknet_py.proxy.proxy_check.StarknetEthProxyCheck`.
+            :class:`starknet_py.proxy.proxy_check.OpenZeppelinProxyCheck` and
+            :class:`starknet_py.proxy.proxy_check.ArgentProxyCheck`.
 
             If set to ``False``, :meth:`Contract.from_address` will not resolve proxies.
 

starknet_py/proxy/contract_abi_resolver.py

@@ -18,7 +18,6 @@
     ArgentProxyCheck,
     OpenZeppelinProxyCheck,
     ProxyCheck,
-    StarknetEthProxyCheck,
 )
 
 
@@ -41,7 +40,6 @@ def prepare_proxy_config(proxy_config: ProxyConfig) -> ProxyConfig:
     proxy_checks = [
         OpenZeppelinProxyCheck(),
         ArgentProxyCheck(),
-        StarknetEthProxyCheck(),
     ]
     return {"proxy_checks": proxy_checks}
 

starknet_py/proxy/proxy_check.py

@@ -77,25 +77,3 @@ async def _get_storage_at_or_none(
             block_hash="latest",
         )
         return result or None
-
-
-class StarknetEthProxyCheck(ProxyCheck):
-    async def implementation_address(
-        self, address: Address, client: Client
-    ) -> Optional[int]:
-        return await self.implementation(address, client)
-
-    async def implementation_hash(
-        self, address: Address, client: Client
-    ) -> Optional[int]:
-        return None
-
-    @staticmethod
-    async def implementation(address: Address, client: Client) -> Optional[int]:
-        call = Call(
-            to_addr=address,
-            selector=get_selector_from_name("implementation"),
-            calldata=[],
-        )
-        (implementation,) = await client.call_contract(call=call)
-        return implementation

starknet_py/tests/e2e/docs/guide/test_resolving_proxies.py

@@ -7,11 +7,7 @@
 from starknet_py.net.client_models import Call
 from starknet_py.net.models import Address
 from starknet_py.proxy.contract_abi_resolver import ProxyConfig
-from starknet_py.proxy.proxy_check import (
-    ArgentProxyCheck,
-    ProxyCheck,
-    StarknetEthProxyCheck,
-)
+from starknet_py.proxy.proxy_check import ArgentProxyCheck, ProxyCheck
 
 
 @pytest.mark.asyncio
@@ -35,15 +31,15 @@ async def test_resolving_proxies(
     address = proxy_oz_argent.deployed_contract.address
     # docs-1: start
     # To use contract behind a proxy as a regular contract, set proxy_config to True
-    # It will check if your proxy is OpenZeppelin proxy / ArgentX proxy / proxy of Starknet Eth contract
+    # It will check if your proxy is OpenZeppelin proxy / ArgentX proxy
     contract = await Contract.from_address(
         address=address, provider=account, proxy_config=True
     )
 
     # After that contract can be used as usual
     # docs-1: end
     # docs-2: start
-    # To resolve proxy contract other than OpenZeppelin / ArgentX / Starknet Eth proxy, a custom ProxyCheck is needed
+    # To resolve proxy contract other than OpenZeppelin / ArgentX, a custom ProxyCheck is needed
     # The ProxyCheck below resolves proxy contracts which have implementation
     # stored in impl() function as class hash
     class CustomProxyCheck(ProxyCheck):
@@ -69,9 +65,7 @@ async def implementation_hash(
     proxy_config = ProxyConfig(proxy_checks=[CustomProxyCheck()])
 
     # More ProxyCheck instances can be passed to proxy_checks for it to be flexible
-    proxy_config = ProxyConfig(
-        proxy_checks=[CustomProxyCheck(), ArgentProxyCheck(), StarknetEthProxyCheck()]
-    )
+    proxy_config = ProxyConfig(proxy_checks=[CustomProxyCheck(), ArgentProxyCheck()])
 
     # docs-2: end
     address = proxy_impl_func.deployed_contract.address

starknet_py/tests/e2e/fixtures/proxy.py

@@ -39,7 +39,6 @@ def custom_proxy() -> str:
     scope="session",
     params=[
         "oz_proxy_address_0.8.1_compiled.json",
-        "eth_proxy_compiled.json",
     ],
 )
 def old_proxy(request) -> str: