Merge branch 'feat/next' into set-log-level

Author: popenta

CLI.md.sh

@@ -207,7 +207,7 @@ generate() {
 
     group "Get" "get"
     command "Get.Account" "get account"
-    command "Get.Keys" "get keys"
+    command "Get.Storage" "get storage"
     command "Get.StorageEntry" "get storage-entry"
     command "Get.Token" "get token"
     command "Get.Transaction" "get transaction"

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_get.py

@@ -1,22 +1,17 @@
 import logging
 from typing import Any, Optional
 
-from multiversx_sdk import Address, ProxyNetworkProvider, Token, TokenComputer
+from multiversx_sdk import Address
+from multiversx_sdk import NetworkProviderError as SDKNetworkProviderError
+from multiversx_sdk import ProxyNetworkProvider, Token, TokenComputer
 
 from multiversx_sdk_cli import cli_shared
-from multiversx_sdk_cli.address import (
-    get_active_address,
-    read_address_config_file,
-    resolve_address_config_path,
-)
 from multiversx_sdk_cli.config import get_config_for_network_providers
 from multiversx_sdk_cli.env import MxpyEnv
 from multiversx_sdk_cli.errors import (
-    AddressConfigFileError,
     ArgumentsNotProvidedError,
     BadUsage,
-    NoWalletProvided,
-    UnknownAddressAliasError,
+    NetworkProviderError,
 )
 from multiversx_sdk_cli.utils import dump_out_json
 
@@ -41,12 +36,12 @@ def setup_parser(subparsers: Any) -> Any:
     sub.set_defaults(func=get_account)
 
     sub = cli_shared.add_command_subparser(
-        subparsers, "get", "keys", "Get the storage (key-value pairs) of an account."
+        subparsers, "get", "storage", "Get the storage (key-value pairs) of an account."
     )
     _add_alias_arg(sub)
     _add_address_arg(sub)
     _add_proxy_arg(sub)
-    sub.set_defaults(func=get_keys)
+    sub.set_defaults(func=get_storage)
 
     sub = cli_shared.add_command_subparser(
         subparsers, "get", "storage-entry", "Get a specific storage entry (key-value pair) of an account."
@@ -74,6 +69,21 @@ def setup_parser(subparsers: Any) -> Any:
     sub.add_argument("--hash", type=str, required=True, help="the transaction hash")
     sub.set_defaults(func=get_transaction)
 
+    sub = cli_shared.add_command_subparser(subparsers, "get", "network-config", "Get the network configuration.")
+    _add_proxy_arg(sub)
+    sub.set_defaults(func=get_network_config)
+
+    sub = cli_shared.add_command_subparser(subparsers, "get", "network-status", "Get the network status.")
+    _add_proxy_arg(sub)
+    sub.add_argument(
+        "--shard",
+        type=int,
+        choices=[0, 1, 2, 4294967295],
+        default=4294967295,
+        help="the shard to get the status for (default: %(default)s, which is methachain)",
+    )
+    sub.set_defaults(func=get_network_status)
+
     parser.epilog = cli_shared.build_group_epilog(subparsers)
     return subparsers
 
@@ -111,7 +121,7 @@ def get_account(args: Any):
         dump_out_json(response.raw)
 
 
-def get_keys(args: Any):
+def get_storage(args: Any):
     if args.alias and args.address:
         raise BadUsage("Provide either '--alias' or '--address'")
 
@@ -142,7 +152,10 @@ def get_key(args: Any):
     proxy = _get_proxy(args)
 
     logger.info(f"Fetching details about {address.to_bech32()}")
-    response = proxy.get_account_storage_entry(address, args.key)
+    try:
+        response = proxy.get_account_storage_entry(address, args.key)
+    except SDKNetworkProviderError as e:
+        raise NetworkProviderError(e.url, e.data)
 
     dump_out_json(response.raw)
 
@@ -173,39 +186,36 @@ def get_token(args: Any):
 
 def get_transaction(args: Any):
     proxy = _get_proxy(args)
-    response = proxy.get_transaction(args.hash)
+    try:
+        response = proxy.get_transaction(args.hash)
+    except SDKNetworkProviderError as e:
+        raise NetworkProviderError(e.url, e.data)
+    except Exception as e:
+        raise NetworkProviderError("", str(e))
 
     dump_out_json(response.raw)
 
 
-def _get_address_from_alias_or_config(alias: Optional[str], hrp: str) -> Address:
-    if alias:
-        file_path = resolve_address_config_path()
-        if not file_path.is_file():
-            raise AddressConfigFileError("The address config file was not found")
+def get_network_config(args: Any):
+    proxy = _get_proxy(args)
+    config = proxy.get_network_config()
 
-        file = read_address_config_file()
-        if file == dict():
-            raise AddressConfigFileError("Address config file is empty")
+    dump_out_json(config.raw)
 
-        addresses: dict[str, Any] = file["addresses"]
-        wallet = addresses.get(alias, None)
-        if not wallet:
-            raise UnknownAddressAliasError(alias)
 
-        logger.info(f"Using address of [{alias}] from address config.")
-        account = cli_shared.load_wallet_from_address_config(wallet=wallet, hrp=hrp)
-        return account.address
-    else:
-        active_address = get_active_address()
-        if active_address == dict():
-            logger.info("No default wallet found in address config.")
-            raise NoWalletProvided()
+def get_network_status(args: Any):
+    proxy = _get_proxy(args)
+    status = proxy.get_network_status()
+
+    dump_out_json(status.raw)
 
-        alias_of_default_wallet = read_address_config_file().get("active", "")
-        logger.info(f"Using address of [{alias_of_default_wallet}] from address config.")
 
-        account = cli_shared.load_wallet_from_address_config(wallet=active_address, hrp=hrp)
+def _get_address_from_alias_or_config(alias: Optional[str], hrp: str) -> Address:
+    if alias:
+        account = cli_shared.load_wallet_by_alias(alias=alias, hrp=hrp)
+        return account.address
+    else:
+        account = cli_shared.load_default_wallet(hrp=hrp)
         return account.address
 
 

multiversx_sdk_cli/cli_multisig.py

@@ -189,7 +189,7 @@ def setup_parser(args: list[str], subparsers: Any) -> Any:
     sub.add_argument(
         "--opt-gas-limit",
         type=int,
-        help="the size of the new quorum (number of signatures required to approve a proposal)",
+        help="optional gas limit for the async call",
     )
     sub.add_argument("--contract-abi", type=str, help="the ABI file of the contract to call")
     sub.add_argument("--function", type=str, help="the function to call")
@@ -208,7 +208,7 @@ def setup_parser(args: list[str], subparsers: Any) -> Any:
     sub.add_argument(
         "--opt-gas-limit",
         type=int,
-        help="the size of the new quorum (number of signatures required to approve a proposal)",
+        help="optional gas limit for the async call",
     )
     sub.add_argument("--contract-abi", type=str, help="the ABI file of the contract to call")
     sub.add_argument("--function", type=str, help="the function to call")
@@ -227,7 +227,7 @@ def setup_parser(args: list[str], subparsers: Any) -> Any:
     sub.add_argument(
         "--opt-gas-limit",
         type=int,
-        help="the size of the new quorum (number of signatures required to approve a proposal)",
+        help="optional gas limit for the async call",
     )
     sub.add_argument("--contract-abi", type=str, help="the ABI file of the contract to call")
     sub.add_argument("--function", type=str, help="the function to call")

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: ")