Merge branch 'feat/next' into get-commands

Author: popenta

multiversx_sdk_cli/address.py multiversx_sdk_cli/address_config.pymultiversx_sdk_cli/address.py renamed to multiversx_sdk_cli/address_config.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from typing import Any
 
+from multiversx_sdk_cli.constants import SDK_PATH
 from multiversx_sdk_cli.errors import (
     AliasAlreadyExistsError,
     AliasProtectedError,
@@ -10,18 +11,38 @@
 )
 from multiversx_sdk_cli.utils import read_json_file, write_json_file
 
-SDK_PATH = Path("~/multiversx-sdk").expanduser().resolve()
 LOCAL_ADDRESS_CONFIG_PATH = Path("addresses.mxpy.json").resolve()
 GLOBAL_ADDRESS_CONFIG_PATH = SDK_PATH / "addresses.mxpy.json"
 
 
 def get_defaults() -> dict[str, str]:
+    """
+    Not all values are required for a config to be valid.
+
+    Valid config for PEM wallets:
+    ```
+    {
+        "kind": "pem",
+        "path": "/path/to/wallet.pem",
+        "index": "0"  # optional, defaults to 0
+    }
+    ```
+
+    Valid config for KEYSTORE wallets:
+    ```
+    {
+        "kind": "keystore",
+        "path": "/path/to/wallet.json",
+        "index": "0"  # optional, defaults to 0
+    }
+    ```
+
+    For keystore wallets, you'll be prompted to enter the password when using the wallet.
+    """
     return {
         "kind": "",
         "path": "",
         "index": "",
-        "password": "",
-        "passwordPath": "",
     }
 
 
@@ -41,6 +62,7 @@ def _guard_valid_name(name: str):
 
 
 def get_active_address() -> dict[str, str]:
+    """Returns the active address configuration."""
     data = read_address_config_file()
     addresses: dict[str, Any] = data.get("addresses", {})
     active_address: str = data.get("active", "default")
@@ -65,25 +87,27 @@ def resolve_address_config_path() -> Path:
 
 
 def set_value(name: str, value: Any):
+    """Sets a key-value pair in the active address config."""
     _guard_valid_name(name)
     data = read_address_config_file()
     active_env = data.get("active", "default")
     data.setdefault("addresses", {})
     data["addresses"].setdefault(active_env, {})
     data["addresses"][active_env][name] = value
-    write_file(data)
+    _write_file(data)
 
 
-def write_file(data: dict[str, Any]):
+def _write_file(data: dict[str, Any]):
     env_path = resolve_address_config_path()
     write_json_file(str(env_path), data)
 
 
 def set_active(name: str):
+    """Switches to the address configuration with the given name."""
     data = read_address_config_file()
     _guard_valid_address_name(data, name)
     data["active"] = name
-    write_file(data)
+    _write_file(data)
 
 
 def _guard_valid_address_name(env: Any, name: str):
@@ -93,6 +117,7 @@ def _guard_valid_address_name(env: Any, name: str):
 
 
 def create_new_address_config(name: str, template: str):
+    """Creates a new address config with the given name and optional template."""
     data = read_address_config_file()
     _guard_alias_unique(data, name)
     new_address = {}
@@ -103,7 +128,7 @@ def create_new_address_config(name: str, template: str):
     data["active"] = name
     data.setdefault("addresses", {})
     data["addresses"][name] = new_address
-    write_file(data)
+    _write_file(data)
 
 
 def _guard_alias_unique(env: Any, name: str):
@@ -120,16 +145,17 @@ def delete_config_value(name: str):
     data.setdefault("addresses", {})
     data["addresses"].setdefault(active_env, {})
     del data["addresses"][active_env][name]
-    write_file(data)
+    _write_file(data)
 
 
 def delete_alias(name: str):
+    """Deletes the address configuration with the given name."""
     _guard_valid_alias_deletion(name)
     data = read_address_config_file()
     data["addresses"].pop(name, None)
     if data["active"] == name:
         data["active"] = "default"
-    write_file(data)
+    _write_file(data)
 
 
 def _guard_valid_alias_deletion(name: str):

multiversx_sdk_cli/cli.py

@@ -30,6 +30,7 @@
 import multiversx_sdk_cli.version
 from multiversx_sdk_cli import config, errors, utils, ux
 from multiversx_sdk_cli.cli_shared import set_proxy_from_config_if_not_provided
+from multiversx_sdk_cli.constants import SDK_PATH
 from multiversx_sdk_cli.env import get_address_hrp
 
 logger = logging.getLogger("cli")
@@ -49,7 +50,7 @@ def main(cli_args: list[str] = sys.argv[1:]):
 
 
 def _do_main(cli_args: list[str]):
-    utils.ensure_folder(config.SDK_PATH)
+    utils.ensure_folder(SDK_PATH)
     parser = setup_parser(cli_args)
     argcomplete.autocomplete(parser)
 

multiversx_sdk_cli/cli_address.py

@@ -3,7 +3,7 @@
 from typing import Any
 
 from multiversx_sdk_cli import cli_shared
-from multiversx_sdk_cli.address import (
+from multiversx_sdk_cli.address_config import (
     create_new_address_config,
     delete_alias,
     delete_config_value,

multiversx_sdk_cli/cli_password.py

@@ -1,23 +1,35 @@
+import logging
 from getpass import getpass
 from typing import Any
 
+logger = logging.getLogger("cli.password")
+
 
 def load_password(args: Any) -> str:
     if args.passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")
 
 
 def load_guardian_password(args: Any) -> str:
     if args.guardian_passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.guardian_passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")
 
 
 def load_relayer_password(args: Any) -> str:
     if args.relayer_passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.relayer_passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")

multiversx_sdk_cli/cli_shared.py

@@ -5,6 +5,7 @@
 import sys
 from argparse import FileType
 from functools import cache
+from getpass import getpass
 from pathlib import Path
 from typing import Any, Optional, Text, Union, cast
 
@@ -21,7 +22,7 @@
 )
 
 from multiversx_sdk_cli import config, utils
-from multiversx_sdk_cli.address import (
+from multiversx_sdk_cli.address_config import (
     get_active_address,
     read_address_config_file,
     resolve_address_config_path,
@@ -47,6 +48,7 @@
     LedgerError,
     NoWalletProvided,
     UnknownAddressAliasError,
+    WalletError,
 )
 from multiversx_sdk_cli.guardian_relayer_data import GuardianRelayerData
 from multiversx_sdk_cli.interfaces import IAccount
@@ -181,7 +183,7 @@ def add_wallet_args(args: list[str], sub: Any):
     )
     sub.add_argument(
         "--passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--ledger",
@@ -225,7 +227,7 @@ def add_guardian_wallet_args(args: list[str], sub: Any):
     )
     sub.add_argument(
         "--guardian-passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--guardian-ledger",
@@ -246,7 +248,7 @@ def add_relayed_v3_wallet_args(args: list[str], sub: Any):
     sub.add_argument("--relayer-keyfile", help="🔑 a JSON keyfile, if PEM not provided")
     sub.add_argument(
         "--relayer-passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--relayer-ledger",
@@ -357,12 +359,10 @@ def prepare_account(args: Any):
         password = load_password(args)
         index = args.sender_wallet_index if args.sender_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(Path(args.keyfile), password=password, address_index=index, hrp=hrp)
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.ledger:
         try:
             return LedgerAccount(address_index=args.sender_wallet_index)
@@ -377,11 +377,11 @@ def prepare_account(args: Any):
 def load_wallet_by_alias(alias: str, hrp: str) -> Account:
     file_path = resolve_address_config_path()
     if not file_path.is_file():
-        raise AddressConfigFileError("The address config file was not found")
+        raise AddressConfigFileError("The address config file was not found.")
 
     file = read_address_config_file()
     if file == dict():
-        raise AddressConfigFileError("Address config file is empty")
+        raise AddressConfigFileError("Address config file is empty.")
 
     addresses: dict[str, Any] = file["addresses"]
     wallet = addresses.get(alias, None)
@@ -407,33 +407,28 @@ def load_default_wallet(hrp: str) -> Account:
 def _load_wallet_from_address_config(wallet: dict[str, str], hrp: str) -> Account:
     kind = wallet.get("kind", None)
     if not kind:
-        raise AddressConfigFileError("'kind' field must be set in the address config")
+        raise AddressConfigFileError("'kind' field must be set in the address config.")
 
     if kind not in ["pem", "keystore"]:
         raise InvalidAddressConfigValue("'kind' must be 'pem' or 'keystore'")
 
-    path = wallet.get("path", None)
-    if not path:
-        raise AddressConfigFileError("'path' field must be set in the address config")
-    path = Path(path)
+    wallet_path = wallet.get("path", None)
+    if not wallet_path:
+        raise AddressConfigFileError("'path' field must be set in the address config.")
+    path = Path(wallet_path)
 
     index = int(wallet.get("index", 0))
 
     if kind == "pem":
         return Account.new_from_pem(file_path=path, index=index, hrp=hrp)
     else:
-        password = wallet.get("password", "")
-        password_path = wallet.get("passwordPath", None)
-
-        if not password and not password_path:
-            raise AddressConfigFileError(
-                "'password' or 'passwordPath' must be set in the address config for keystore wallets"
-            )
-
-        if password_path:
-            password = Path(password_path).read_text().splitlines()[0].strip()
-
-        return Account.new_from_keystore(file_path=path, password=password, address_index=index, hrp=hrp)
+        logger.info("Using keystore wallet.")
+        password = getpass("Please enter the wallet password: ")
+        logger.info(f"Loading keystore wallet from path: {path}")
+        try:
+            return Account.new_from_keystore(file_path=path, password=password, address_index=index, hrp=hrp)
+        except Exception as e:
+            raise WalletError(str(e))
 
 
 def _get_address_hrp(args: Any) -> str:
@@ -480,12 +475,15 @@ def load_guardian_account(args: Any) -> Union[IAccount, None]:
         password = load_guardian_password(args)
         index = args.guardian_wallet_index if args.guardian_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.guardian_keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(
+                Path(args.guardian_keyfile),
+                password=password,
+                address_index=index,
+                hrp=hrp,
+            )
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.guardian_ledger:
         try:
             return LedgerAccount(address_index=args.guardian_wallet_index)
@@ -614,12 +612,15 @@ def load_relayer_account(args: Any) -> Union[IAccount, None]:
         password = load_relayer_password(args)
         index = args.relayer_wallet_index if args.relayer_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.relayer_keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(
+                Path(args.relayer_keyfile),
+                password=password,
+                address_index=index,
+                hrp=hrp,
+            )
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.relayer_ledger:
         try:
             return LedgerAccount(address_index=args.relayer_wallet_index)

multiversx_sdk_cli/cli_transactions.py

@@ -162,7 +162,8 @@ def sign_transaction(args: Any):
 
     try:
         sender = cli_shared.prepare_account(args)
-    except NoWalletProvided:
+    except:
+        logger.info("No sender wallet provided. Will not sign for the sender.")
         sender = None
 
     if sender and sender.address != tx.sender:

multiversx_sdk_cli/config.py

@@ -6,8 +6,8 @@
 from multiversx_sdk import NetworkProviderConfig
 
 from multiversx_sdk_cli import errors, utils
+from multiversx_sdk_cli.constants import SDK_PATH
 
-SDK_PATH = Path("~/multiversx-sdk").expanduser().resolve()
 LOCAL_CONFIG_PATH = Path("mxpy.json").resolve()
 GLOBAL_CONFIG_PATH = SDK_PATH / "mxpy.json"
 

multiversx_sdk_cli/constants.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 VM_TYPE_SYSTEM = "0001"
 VM_TYPE_WASM_VM = "0500"
 SC_HEX_PUBKEY_PREFIX = "0" * 16
@@ -26,3 +28,5 @@
 STR_PREFIX = "str:"
 ADDRESS_PREFIX = "addr:"
 MAINCHAIN_ADDRESS_HRP = "erd"
+
+SDK_PATH = Path("~/multiversx-sdk").expanduser().resolve()