Add nile-account flag to set Nile artifacts path (#315)

* add nile-account flag

* add overriding path to get_class_hash

* add overriding_path to tests

* fix docstring

* add try/except to execute_call

* fix path to locate nile artifacts

* add _get_contracts_data test

* remove unused var

* add unregister for accounts

* add watch_mode to account inits

* unregister account upon account deploy rejection

* remove duplicate func

* fix formatting

* add declare account test

* fix formatting

* remove unused variables

* add unregister tests, add indent to accounts.json

* add unregister test with wrong address

* consolidate abi to contract path logic, fix tests

* add assertion error message

* Update src/nile/core/account.py

Co-authored-by: Eric Nordelo <[email protected]>

* add nile root path constants

* fix deploy test

* fix formatting

* define NILE_ARTIFACTS_PATH as constant

* rename test_accounts.py

Co-authored-by: Eric Nordelo <[email protected]>

src/nile/accounts.py

@@ -23,7 +23,23 @@ def register(pubkey, address, index, alias, network):
             "alias": alias,
         }
     with open(file, "w") as file:
-        json.dump(accounts, file)
+        json.dump(accounts, file, indent=2)
+
+
+def unregister(address, network):
+    """Unregister an account."""
+    file = f"{network}.{ACCOUNTS_FILENAME}"
+
+    with open(file, "r") as fp:
+        accounts = json.load(fp)
+        to_delete = None
+        for pubkey, data in accounts.items():
+            if address == data["address"]:
+                to_delete = pubkey
+        accounts.pop(to_delete, None)
+
+    with open(file, "w") as file:
+        json.dump(accounts, file, indent=2)
 
 
 def exists(pubkey, network):

src/nile/cli.py

@@ -129,7 +129,7 @@ async def deploy(
 ):
     """Deploy a StarkNet smart contract."""
     if not ignore_account:
-        account = await Account(signer, network)
+        account = await Account(signer, network, watch_mode=watch_mode)
         await account.deploy_contract(
             contract_name,
             salt,
@@ -159,6 +159,7 @@ async def deploy(
 @click.option("--max_fee", nargs=1)
 @click.option("--alias")
 @click.option("--overriding_path")
+@click.option("--nile_account", is_flag=True)
 @network_option
 @mainnet_token_option
 @watch_option
@@ -171,16 +172,18 @@ async def declare(
     alias,
     overriding_path,
     token,
+    nile_account,
 ):
     """Declare a StarkNet smart contract through an Account."""
-    account = await Account(signer, network)
+    account = await Account(signer, network, watch_mode=watch_mode)
     await account.declare(
         contract_name,
         alias=alias,
         max_fee=max_fee,
         overriding_path=overriding_path,
         mainnet_token=token,
         watch_mode=watch_mode,
+        nile_account=nile_account,
     )
 
 
@@ -228,7 +231,7 @@ async def send(
     watch_mode,
 ):
     """Invoke a contract's method through an Account."""
-    account = await Account(signer, network)
+    account = await Account(signer, network, watch_mode=watch_mode)
     print(
         "Calling {} on {} with params: {}".format(
             method, address_or_alias, [x for x in params]

src/nile/common.py

@@ -9,11 +9,14 @@
 
 from nile.utils import normalize_number, str_to_felt
 
-pt = os.path.dirname(os.path.realpath(__file__)).replace("/core", "")
 CONTRACTS_DIRECTORY = "contracts"
 BUILD_DIRECTORY = "artifacts"
 TEMP_DIRECTORY = ".temp"
 ABIS_DIRECTORY = f"{BUILD_DIRECTORY}/abis"
+NILE_ROOT_PATH = os.path.dirname(os.path.realpath(__file__)).replace("/core", "")
+NILE_BUILD_DIR = f"{NILE_ROOT_PATH}/{BUILD_DIRECTORY}"
+NILE_ABIS_DIR = f"{NILE_ROOT_PATH}/{ABIS_DIRECTORY}"
+NILE_ARTIFACTS_PATH = (NILE_BUILD_DIR, NILE_ABIS_DIR)
 DEPLOYMENTS_FILENAME = "deployments.txt"
 DECLARATIONS_FILENAME = "declarations.txt"
 ACCOUNTS_FILENAME = "accounts.json"
@@ -22,7 +25,7 @@
 TRANSACTION_VERSION = 1
 QUERY_VERSION_BASE = 2**128
 QUERY_VERSION = QUERY_VERSION_BASE + TRANSACTION_VERSION
-ETH_TOKEN_ABI = f"{pt}/artifacts/abis/ERC20.json"
+ETH_TOKEN_ABI = f"{NILE_ABIS_DIR}/ERC20.json"
 ETH_TOKEN_ADDRESS = "0x49D36570D4E46F48E99674BD3FCC84644DDD6B96F7C741B1562B82F9E004DC7"
 UNIVERSAL_DEPLOYER_ADDRESS = (
     # subject to change
@@ -147,8 +150,7 @@ def get_class_hash(contract_name, overriding_path=None):
 
 def get_account_class_hash(contract="Account"):
     """Return the class_hash of an Account contract."""
-    pt = os.path.dirname(os.path.realpath(__file__)).replace("/core", "")
-    overriding_path = (f"{pt}/artifacts", f"{pt}/artifacts/abis")
+    overriding_path = (NILE_BUILD_DIR, NILE_ABIS_DIR)
     return get_class_hash(contract, overriding_path=overriding_path)
 
 

src/nile/core/account.py

@@ -9,6 +9,7 @@
 
 from nile import accounts, deployments
 from nile.common import (
+    NILE_ARTIFACTS_PATH,
     QUERY_VERSION,
     TRANSACTION_VERSION,
     UNIVERSAL_DEPLOYER_ADDRESS,
@@ -106,8 +107,7 @@ async def __init__(
     async def deploy(self, salt=None, max_fee=None, query_type=None, watch_mode=None):
         """Deploy an Account contract for the given private key."""
         index = accounts.current_index(self.network)
-        pt = os.path.dirname(os.path.realpath(__file__)).replace("/core", "")
-        overriding_path = (f"{pt}/artifacts", f"{pt}/artifacts/abis")
+        overriding_path = NILE_ARTIFACTS_PATH
 
         class_hash = get_account_class_hash("Account")
         salt = 0 if salt is None else normalize_number(salt)
@@ -152,10 +152,15 @@ async def declare(
         overriding_path=None,
         mainnet_token=None,
         watch_mode=None,
+        nile_account=False,
     ):
         """Declare a contract through an Account."""
         max_fee, nonce, _ = await self._process_arguments(max_fee, nonce)
 
+        if nile_account:
+            assert overriding_path is None, "Cannot override path to Nile account."
+            overriding_path = NILE_ARTIFACTS_PATH
+
         contract_class = get_contract_class(
             contract_name=contract_name, overriding_path=overriding_path
         )

src/nile/core/deploy.py

@@ -7,7 +7,7 @@
 )
 from starkware.starknet.services.api.gateway.transaction import DeployAccount
 
-from nile import deployments
+from nile import accounts, deployments
 from nile.common import (
     ABIS_DIRECTORY,
     BUILD_DIRECTORY,
@@ -182,6 +182,7 @@ async def deploy_account(
         tx_status = await status(tx_hash, network, watch_mode)
         if tx_status.status.is_rejected:
             deployments.unregister(address, network, alias, abi=register_abi)
+            accounts.unregister(address, network)
             return
 
     return address, tx_hash, register_abi

src/nile/utils/debug.py

@@ -50,14 +50,18 @@ async def debug_message(error_message, tx_hash, network, contracts_file=None):
 
 def _get_contracts_data(contracts_file, network, addresses):
     file = contracts_file or f"{network}.{DEPLOYMENTS_FILENAME}"
-    # contracts_file should already link to compiled contracts and not ABIs
-    to_contract = (lambda x: x) if contracts_file else _abi_to_build_path
+    to_contract = (lambda x: x) if contracts_file else _abi_to_path
     contracts = _locate_error_lines_with_abis(file, addresses, to_contract)
     return contracts
 
 
-def _abi_to_build_path(filename):
-    return os.path.join(BUILD_DIRECTORY, os.path.basename(filename))
+def _abi_to_path(filename):
+    build_path = os.path.join(BUILD_DIRECTORY, os.path.basename(filename))
+    if os.path.isfile(build_path):
+        return build_path
+    else:
+        pt = os.path.dirname(os.path.realpath(__file__)).replace("/utils", "/artifacts")
+        return os.path.join(pt, os.path.basename(filename))
 
 
 def _locate_error_lines_with_abis(file, addresses, to_contract):

tests/commands/test_account.py

@@ -7,6 +7,9 @@
 from nile.common import (
     ABIS_DIRECTORY,
     BUILD_DIRECTORY,
+    NILE_ABIS_DIR,
+    NILE_ARTIFACTS_PATH,
+    NILE_BUILD_DIR,
     QUERY_VERSION,
     TRANSACTION_VERSION,
     UNIVERSAL_DEPLOYER_ADDRESS,
@@ -66,13 +69,8 @@ async def test_account_init_bad_key(caplog):
 @patch("nile.core.account.Signer.sign_deployment", return_value=SIGNATURE)
 @patch("nile.core.account.os.path.dirname")
 async def test_deploy(mock_path, mock_signer, mock_hash, mock_deploy):
-    test_path = "/overriding_path"
-    overriding_path = (
-        f"{test_path}/artifacts",
-        f"{test_path}/artifacts/abis",
-    )
-
-    mock_path.return_value.replace.return_value = test_path
+    # overriding_path is set to Nile's root path for Nile Account deployments.
+    nile_root_path = NILE_BUILD_DIR, NILE_ABIS_DIR
 
     account = await Account(KEY, NETWORK, salt=SALT, max_fee=MAX_FEE)
     calldata = [account.signer.public_key]
@@ -84,7 +82,7 @@ async def test_deploy(mock_path, mock_signer, mock_hash, mock_deploy):
         signature=SIGNATURE,
         max_fee=MAX_FEE,
         query_type=None,
-        overriding_path=overriding_path,
+        overriding_path=nile_root_path,
         watch_mode=None,
     )
 
@@ -159,6 +157,41 @@ async def test_declare(mock_declare, mock_get_class, mock_hash, mock_deploy):
     )
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "nile_account, overriding_path", [(False, None), (True, NILE_ARTIFACTS_PATH)]
+)
+@patch("nile.core.account.deploy_account", return_value=(MOCK_ADDRESS, MOCK_INDEX))
+@patch("nile.core.account.get_account_class_hash", return_value=CLASS_HASH)
+@patch("nile.core.account.get_contract_class", return_value="ContractClass")
+@patch("nile.core.account.declare")
+async def test_declare_account(
+    mock_declare, mock_get_class, mock_hash, mock_deploy, nile_account, overriding_path
+):
+    account = await Account(KEY, NETWORK)
+
+    signature = [999, 888]
+    nonce = 4
+    contract_name = "Account"
+
+    account.signer.sign_declare = MagicMock(return_value=signature)
+
+    args = {
+        "contract_name": contract_name,
+        "nonce": nonce,
+    }
+
+    if nile_account:
+        args["nile_account"] = True
+
+    await account.declare(**args)
+
+    # Check 'get_contract_class' call
+    mock_get_class.assert_called_once_with(
+        contract_name=contract_name, overriding_path=overriding_path
+    )
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("deployer_address", [None, 0xDE0])
 @pytest.mark.parametrize("watch_mode", [None, "debug"])

tests/commands/test_status.py

@@ -6,8 +6,12 @@
 
 import pytest
 
-from nile.common import BUILD_DIRECTORY
-from nile.utils.debug import _abi_to_build_path, _locate_error_lines_with_abis
+from nile.common import BUILD_DIRECTORY, DEPLOYMENTS_FILENAME
+from nile.utils.debug import (
+    _abi_to_path,
+    _get_contracts_data,
+    _locate_error_lines_with_abis,
+)
 from nile.utils.status import status
 
 MOCK_HASH = 1234
@@ -18,6 +22,7 @@
 MOCK_FILE = 123
 ACCEPTED_OUT = b'{"tx_status": "ACCEPTED_ON_L2"}'
 REJECTED_OUT = b'{"tx_failure_reason": {"error_message": "E"}, "tx_status": "REJECTED"}'
+ADDRESSES = {0x123, 0x456}
 
 
 @pytest.fixture(autouse=True)
@@ -26,10 +31,11 @@ def tmp_working_dir(monkeypatch, tmp_path):
     return tmp_path
 
 
-def test__abi_to_build_path():
+def test__abi_to_path():
     Path(BUILD_DIRECTORY).mkdir()
-    filename = "contract"
-    assert f"{BUILD_DIRECTORY}/{filename}" == _abi_to_build_path(filename)
+    open(f"{BUILD_DIRECTORY}/contract.json", "w")
+
+    assert f"{BUILD_DIRECTORY}/contract.json" == _abi_to_path("contract.json")
 
 
 @pytest.mark.parametrize(
@@ -39,7 +45,7 @@ def test__abi_to_build_path():
         ([f"{DEBUG_ADDRESS}:{ABI_PATH}:{ALIAS}"], [int(DEBUG_ADDRESS, 16)]),
     ],
 )
-@patch("nile.utils.debug._abi_to_build_path", return_value=ABI_PATH)
+@patch("nile.utils.debug._abi_to_path", return_value=ABI_PATH)
 def test__locate_error_lines_with_abis_with_and_without_alias(
     mock_path, file, address_set
 ):
@@ -53,7 +59,7 @@ def test__locate_error_lines_with_abis_with_and_without_alias(
         assert return_array == [f"{DEBUG_ADDRESS}:{ABI_PATH}"]
 
 
-@patch("nile.utils.debug._abi_to_build_path", return_value=ABI_PATH)
+@patch("nile.utils.debug._abi_to_path", return_value=ABI_PATH)
 def test__locate_error_lines_with_abis_misformatted_line(mock_path, caplog):
     logging.getLogger().setLevel(logging.INFO)
 
@@ -87,3 +93,23 @@ async def test_status_feedback_with_message(mock_output, output, expected, caplo
     await status(MOCK_HASH, NETWORK, "debug")
 
     assert expected in caplog.text
+
+
+@pytest.mark.parametrize(
+    "contracts_file, expected",
+    [
+        (None, _abi_to_path),
+        ("contracts_file.json", "contracts_file.json"),
+    ],
+)
+@patch("nile.utils.debug._locate_error_lines_with_abis")
+def test__get_contracts_data(mock_locate, contracts_file, expected):
+    _get_contracts_data(contracts_file, NETWORK, ADDRESSES)
+
+    if not contracts_file:
+        mock_locate.assert_called_once_with(
+            f"{NETWORK}.{DEPLOYMENTS_FILENAME}", ADDRESSES, expected
+        )
+    else:
+        _contracts_file = mock_locate.call_args[0][0]
+        assert _contracts_file == expected