Merge pull request #12 from unparalleled-js/chore/upgrade-starknet.py

chore: upgrade starknet.py

ape_starknet/_utils.py

@@ -1,8 +1,14 @@
 import re
-from typing import Any, Union
+from typing import Any, Optional, Union
 
 from ape.api.networks import LOCAL_NETWORK_NAME
-from ape.exceptions import AddressError, ApeException, ContractLogicError, ProviderError
+from ape.exceptions import (
+    AddressError,
+    ApeException,
+    ContractLogicError,
+    ProviderError,
+    VirtualMachineError,
+)
 from ape.types import AddressType, RawAddress
 from eth_typing import HexAddress, HexStr
 from eth_utils import (
@@ -32,10 +38,10 @@ def get_chain_id(network_id: Union[str, int]) -> StarknetChainId:
     if isinstance(network_id, int):
         return StarknetChainId(network_id)
 
-    if network_id == LOCAL_NETWORK_NAME:
+    elif network_id == LOCAL_NETWORK_NAME:
         return StarknetChainId.TESTNET  # Use TESTNET chain ID for local network
 
-    if network_id not in NETWORKS:
+    elif network_id not in NETWORKS:
         raise ValueError(f"Unknown network '{network_id}'.")
 
     return StarknetChainId(NETWORKS[network_id][0])
@@ -87,19 +93,27 @@ def func(*args, **kwargs):
             # Don't catch ApeExceptions, let them raise as they would.
             raise
         except Exception as err:
-            err_msg = str(err)
-            if "rejected" in err_msg:
-                if "Error message: " in err_msg:
-                    err_msg = err_msg.split("Error message: ")[-1]
-                    if "Error at pc=" in err_msg:
-                        err_msg = err_msg.split("Error at pc=")[0]
-                elif "error_message=" in err_msg:
-                    err_msg = err_msg.split("error_message=")[-1].strip("'")
-
-                # Fix escaping newline issue with error message.
-                err_msg = err_msg.replace("\\n", "")
-                raise ContractLogicError(revert_message=err_msg) from err
+            vm_error = get_virtual_machine_error(err)
+            if vm_error:
+                raise vm_error from err
 
             raise  # Original exception
 
     return func
+
+
+def get_virtual_machine_error(err: Exception) -> Optional[VirtualMachineError]:
+    err_msg = str(err)
+    if "rejected" not in err_msg:
+        return None
+
+    if "Error message: " in err_msg:
+        err_msg = err_msg.split("Error message: ")[-1]
+        if "Error at pc=" in err_msg:
+            err_msg = err_msg.split("Error at pc=")[0]
+    elif "error_message=" in err_msg:
+        err_msg = err_msg.split("error_message=")[-1].strip("'")
+
+    # Fix escaping newline issue with error message.
+    err_msg = err_msg.replace("\\n", "").strip()
+    return ContractLogicError(revert_message=err_msg)

ape_starknet/provider.py

@@ -7,7 +7,7 @@
 from ape.api import BlockAPI, ProviderAPI, ReceiptAPI, SubprocessProvider, TransactionAPI
 from ape.api.networks import LOCAL_NETWORK_NAME
 from ape.contracts import ContractInstance
-from ape.exceptions import ProviderError, ProviderNotConnectedError
+from ape.exceptions import ProviderError, ProviderNotConnectedError, VirtualMachineError
 from ape.types import AddressType, BlockID, ContractLog
 from ape.utils import cached_property
 from ethpm_types import ContractType
@@ -26,6 +26,7 @@
     ALPHA_MAINNET_WL_DEPLOY_TOKEN_KEY,
     PLUGIN_NAME,
     get_chain_id,
+    get_virtual_machine_error,
     handle_client_errors,
 )
 from ape_starknet.config import StarknetConfig
@@ -241,6 +242,9 @@ def prepare_transaction(self, txn: TransactionAPI) -> TransactionAPI:
 
         return txn
 
+    def get_virtual_machine_error(self, exception: Exception) -> VirtualMachineError:
+        return get_virtual_machine_error(exception) or VirtualMachineError(base_err=exception)
+
     def _get_code(self, address: Union[str, AddressType]):
         address_int = parse_address(address)
         return self.starknet_client.get_code_sync(address_int)

ape_starknet/tokens.py

@@ -47,7 +47,8 @@ def get_balance(self, account: AddressType, token: str = "eth") -> int:
             return 0
 
         contract = self.provider.contract_at(contract_address)
-        if "balanceOf" in [m.name for m in contract._contract_type.view_methods]:
+
+        if "balanceOf" in [m.name for m in contract.contract_type.view_methods]:
             return contract.balanceOf(account)[0]
 
         # Handle proxy-implementation (not yet supported in ape-core)
@@ -69,7 +70,8 @@ def transfer(self, sender: int, receiver: int, amount: int, token: str = "eth"):
 
         contract = self.provider.contract_at(contract_address)
         sender_address = self.provider.network.ecosystem.decode_address(sender)
-        if "transfer" in [m.name for m in contract._contract_type.mutable_methods]:
+
+        if "transfer" in [m.name for m in contract.contract_type.mutable_methods]:
             return contract.transfer(receiver, amount, sender=sender_address)
 
         # Handle proxy-implementation (not yet supported in ape-core)

setup.py

@@ -68,8 +68,8 @@
         "eth-ape>=0.2.4,<0.3.0",
         "ethpm-types",  # Use same as `eth-ape`.
         "pydantic>=1.9.0,<2.0",
-        "starknet.py==0.2.2a0",
-        "starknet-devnet>=0.1.23",
+        "starknet.py>=0.2.3a0,<0.2.4",
+        "starknet-devnet>=0.2.1",
         "importlib-metadata ; python_version<'3.8'",
     ],  # NOTE: Add 3rd party libraries here
     entry_points={"ape_cli_subcommands": ["ape_starknet=ape_starknet._cli:cli"]},

tests/integration/conftest.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Optional, Union
 
 import pytest
 from ape._cli import cli
@@ -17,11 +17,14 @@ def __init__(self, cli, base_cmd: List[str]):
         self._cli = cli
         self.base_cmd = base_cmd
 
-    def invoke(self, *cmd, input=None, ensure_successful: bool = True):
+    def invoke(
+        self, *cmd, input: Optional[Union[str, List[str]]] = None, ensure_successful: bool = True
+    ):
+        input_str = "\n".join(input) if isinstance(input, list) else (input or "")
         ape_cmd = self._get_cmd(*cmd)
         catch_exceptions = not ensure_successful
         result = self.runner.invoke(
-            self._cli, ape_cmd, catch_exceptions=catch_exceptions, input=input
+            self._cli, ape_cmd, catch_exceptions=catch_exceptions, input=input_str
         )
 
         if ensure_successful:

tests/integration/test_accounts.py

@@ -61,7 +61,7 @@ def test_delete(accounts_runner, existing_key_file_account):
         EXISTING_KEY_FILE_ALIAS,
         "--network",
         "starknet:testnet",
-        input=f"{PASSWORD}\n",
+        input=PASSWORD,
     )
     assert EXISTING_KEY_FILE_ALIAS in output
     output = accounts_runner.invoke("list")
@@ -93,7 +93,7 @@ def test_delete(accounts_runner, existing_key_file_account):
         "starknet:testnet",
         "--address",
         CONTRACT_ADDRESS,
-        input=f"{PASSWORD}\n",
+        input=PASSWORD,
     )
 
 
@@ -106,15 +106,14 @@ def test_import(accounts_runner, existing_key_file_account, account_container):
         account_path.unlink()
 
     private_key = str(CONTRACT_ADDRESS)
-    valid_input = f"{private_key}\n{PASSWORD}\n{PASSWORD}"
     accounts_runner.invoke(
         "import",
         NEW_ALIAS,
         "--network",
         network,
         "--address",
         CONTRACT_ADDRESS,
-        input=valid_input,
+        input=[private_key, PASSWORD, PASSWORD],
     )
 
     # Clean-up
@@ -123,7 +122,7 @@ def test_import(accounts_runner, existing_key_file_account, account_container):
         NEW_ALIAS,
         "--network",
         network,
-        input=f"{PASSWORD}\ny\n",
+        input=[PASSWORD, "y"],
     )
 
 
@@ -140,7 +139,7 @@ def test_import_argent_x_key_file(accounts_runner, argent_x_backup, account_cont
         alias,
         "--keyfile",
         str(argent_x_backup),
-        input=f"{PASSWORD}\n",
+        input=PASSWORD,
     )
     assert "SUCCESS" in output
     account_path.unlink()
@@ -158,10 +157,8 @@ def test_core_accounts_list_all(root_accounts_runner, existing_key_file_account)
 def test_change_password(accounts_runner, existing_key_file_account):
     new_password = "321"
     assert "SUCCESS" in accounts_runner.invoke(
-        "change-password",
-        EXISTING_KEY_FILE_ALIAS,
-        input=f"{PASSWORD}\n{new_password}\n{new_password}",
+        "change-password", EXISTING_KEY_FILE_ALIAS, input=[PASSWORD, new_password, new_password]
     )
     assert "SUCCESS" in accounts_runner.invoke(
-        "change-password", EXISTING_KEY_FILE_ALIAS, input=f"{new_password}\n{PASSWORD}\n{PASSWORD}"
+        "change-password", EXISTING_KEY_FILE_ALIAS, input=[new_password, PASSWORD, PASSWORD]
     )

tests/integration/test_console.py

@@ -15,7 +15,7 @@ def test_console_accounts_object(ape_cli, console_runner, existing_key_file_acco
     # NOTE: This console connects to Eth-Tester and makes sure we can still _read_
     # starknet accounts.
     output = console_runner.invoke(
-        input=f"accounts\naccounts['{existing_key_file_account.alias}']\nexit\n"
+        input=["accounts", "accounts['{existing_key_file_account.alias}']", "exit"]
     )
     assert existing_key_file_account.contract_address in output, [
         e.name for e in networks.ecosystems