wip: implement address config

Author: popenta

multiversx_sdk_cli/address.py

@@ -0,0 +1,137 @@
+from functools import cache
+from pathlib import Path
+from typing import Any
+
+from multiversx_sdk_cli.errors import (
+    AliasAlreadyExistsError,
+    AliasProtectedError,
+    InvalidAddressConfigValue,
+    UnknownAddressAliasError,
+)
+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]:
+    return {
+        "kind": "",
+        "path": "",
+        "index": "",
+        "password": "",
+        "passwordPath": "",
+    }
+
+
+@cache
+def get_value(name: str) -> str:
+    _guard_valid_name(name)
+    data = get_active_address()
+    default_value = get_defaults()[name]
+    value = data.get(name, default_value)
+    assert isinstance(value, str)
+    return value
+
+
+def _guard_valid_name(name: str):
+    if name not in get_defaults().keys():
+        raise InvalidAddressConfigValue(f"Key is not present in address config: [{name}]")
+
+
+def get_active_address() -> dict[str, str]:
+    data = read_address_config_file()
+    addresses: dict[str, Any] = data.get("addresses", {})
+    active_address: str = data.get("active", "default")
+    result: dict[str, str] = addresses.get(active_address, {})
+
+    return result
+
+
+@cache
+def read_address_config_file() -> dict[str, Any]:
+    config_path = resolve_address_config_path()
+    if config_path.exists():
+        data: dict[str, Any] = read_json_file(config_path)
+        return data
+    return dict()
+
+
+def resolve_address_config_path() -> Path:
+    if LOCAL_ADDRESS_CONFIG_PATH.is_file():
+        return LOCAL_ADDRESS_CONFIG_PATH
+    return GLOBAL_ADDRESS_CONFIG_PATH
+
+
+def set_value(name: str, value: Any):
+    _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)
+
+
+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):
+    data = read_address_config_file()
+    _guard_valid_address_name(data, name)
+    data["active"] = name
+    write_file(data)
+
+
+def _guard_valid_address_name(env: Any, name: str):
+    envs = env.get("addresses", {})
+    if name not in envs:
+        raise UnknownAddressAliasError(name)
+
+
+def create_new_address_config(name: str, template: str):
+    data = read_address_config_file()
+    _guard_alias_unique(data, name)
+    new_address = {}
+    if template:
+        _guard_valid_address_name(data, template)
+        new_address = data["addresses"][template]
+
+    data["active"] = name
+    data.setdefault("addresses", {})
+    data["addresses"][name] = new_address
+    write_file(data)
+
+
+def _guard_alias_unique(env: Any, name: str):
+    envs = env.get("addresses", {})
+    if name in envs:
+        raise AliasAlreadyExistsError(name)
+
+
+def delete_config_value(name: str):
+    """Deletes a key-value pair of the active address config."""
+    _guard_valid_alias_deletion(name)
+    data = read_address_config_file()
+    active_env = data.get("active", "default")
+    data.setdefault("addresses", {})
+    data["addresses"].setdefault(active_env, {})
+    del data["addresses"][active_env][name]
+    write_file(data)
+
+
+def delete_alias(name: str):
+    _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)
+
+
+def _guard_valid_alias_deletion(name: str):
+    if name == "default":
+        raise AliasProtectedError(name)

multiversx_sdk_cli/cli.py

@@ -9,6 +9,7 @@
 from multiversx_sdk import LibraryConfig
 from rich.logging import RichHandler
 
+import multiversx_sdk_cli.cli_address
 import multiversx_sdk_cli.cli_config
 import multiversx_sdk_cli.cli_contracts
 import multiversx_sdk_cli.cli_data
@@ -112,6 +113,7 @@ def setup_parser(args: list[str]):
     subparsers = parser.add_subparsers()
     commands: list[Any] = []
 
+    commands.append(multiversx_sdk_cli.cli_address.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_contracts.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_transactions.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_validators.setup_parser(args, subparsers))

multiversx_sdk_cli/cli_address.py

@@ -0,0 +1,150 @@
+import logging
+import os
+from typing import Any
+
+from multiversx_sdk_cli import cli_shared
+from multiversx_sdk_cli.address import (
+    create_new_address_config,
+    delete_alias,
+    delete_config_value,
+    get_active_address,
+    get_value,
+    read_address_config_file,
+    resolve_address_config_path,
+    set_active,
+    set_value,
+)
+from multiversx_sdk_cli.utils import dump_out_json
+from multiversx_sdk_cli.ux import confirm_continuation
+
+logger = logging.getLogger("cli.address")
+
+
+def setup_parser(subparsers: Any) -> Any:
+    parser = cli_shared.add_group_subparser(subparsers, "address", "Configure MultiversX CLI to use a default wallet.")
+    subparsers = parser.add_subparsers()
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "address", "new", "Creates a new address config and sets it as the active address."
+    )
+    _add_alias_arg(sub)
+    sub.add_argument(
+        "--template",
+        required=False,
+        help="an address config from which to create the new address",
+    )
+    sub.set_defaults(func=new_address_config)
+
+    sub = cli_shared.add_command_subparser(subparsers, "address", "list", "List available addresses")
+    sub.set_defaults(func=list_addresses)
+
+    sub = cli_shared.add_command_subparser(subparsers, "address", "dump", "Dumps the active address.")
+    sub.set_defaults(func=dump)
+
+    sub = cli_shared.add_command_subparser(subparsers, "address", "get", "Gets a config value from the active address.")
+    sub.add_argument("value", type=str, help="the value to get from the active address (e.g. path)")
+    sub.set_defaults(func=get_address_config_value)
+
+    sub = cli_shared.add_command_subparser(subparsers, "address", "set", "Sets a config value for the active address.")
+    sub.add_argument("key", type=str, help="the key to set for the active address (e.g. index)")
+    sub.add_argument("value", type=str, help="the value to set for the specified key")
+    sub.set_defaults(func=set_address_config_value)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "address", "delete", "Deletes a config value from the active address."
+    )
+    sub.add_argument("value", type=str, help="the value to delete for the active address")
+    sub.set_defaults(func=delete_address_config_value)
+
+    sub = cli_shared.add_command_subparser(subparsers, "address", "switch", "Switch to a different address.")
+    _add_alias_arg(sub)
+    sub.set_defaults(func=switch_address)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers,
+        "address",
+        "remove",
+        "Deletes an address using the alias. No default address will be set. Use `address switch` to set a new address.",
+    )
+    _add_alias_arg(sub)
+    sub.set_defaults(func=remove_address)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers,
+        "address",
+        "reset",
+        "Deletes the config file. No default address will be set.",
+    )
+    sub.set_defaults(func=delete_address_config_file)
+
+    parser.epilog = cli_shared.build_group_epilog(subparsers)
+    return subparsers
+
+
+def _add_alias_arg(sub: Any):
+    sub.add_argument("alias", type=str, help="the alias of the wallet")
+
+
+def new_address_config(args: Any):
+    create_new_address_config(name=args.alias, template=args.template)
+    dump_out_json(get_active_address())
+
+
+def list_addresses(args: Any):
+    _ensure_address_config_file_exists()
+
+    data = read_address_config_file()
+    dump_out_json(data)
+
+
+def dump(args: Any):
+    _ensure_address_config_file_exists()
+    dump_out_json(get_active_address())
+
+
+def get_address_config_value(args: Any):
+    _ensure_address_config_file_exists()
+    value = get_value(args.value)
+    print(value)
+
+
+def set_address_config_value(args: Any):
+    _ensure_address_config_file_exists()
+    set_value(args.key, args.value)
+
+
+def delete_address_config_value(args: Any):
+    _ensure_address_config_file_exists()
+
+    delete_config_value(args.value)
+    dump_out_json(get_active_address())
+
+
+def switch_address(args: Any):
+    _ensure_address_config_file_exists()
+
+    set_active(args.alias)
+    dump_out_json(get_active_address())
+
+
+def remove_address(args: Any):
+    _ensure_address_config_file_exists()
+    delete_alias(args.alias)
+
+
+def delete_address_config_file(args: Any):
+    address_file = resolve_address_config_path()
+    if not address_file.is_file():
+        logger.info("Address config file not found. Aborting...")
+        return
+
+    confirm_continuation(f"The file `{str(address_file)}` will be deleted. Do you want to continue? (y/n)")
+    os.remove(address_file)
+    logger.info("Successfully deleted the address config file.")
+
+
+def _ensure_address_config_file_exists():
+    address_file = resolve_address_config_path()
+    if not address_file.is_file():
+        logger.info("Address config file not found. Aborting...")
+        exit(1)

multiversx_sdk_cli/errors.py

@@ -176,3 +176,23 @@ def __init__(self, name: str):
 class EnvironmentAlreadyExistsError(KnownError):
     def __init__(self, name: str):
         super().__init__(f"Environment entry already exists: {name}.")
+
+
+class UnknownAddressAliasError(KnownError):
+    def __init__(self, name: str):
+        super().__init__(f"Alias is not known: {name}.")
+
+
+class AliasAlreadyExistsError(KnownError):
+    def __init__(self, name: str):
+        super().__init__(f"Alias already exists: {name}.")
+
+
+class AliasProtectedError(KnownError):
+    def __init__(self, name: str):
+        super().__init__(f"This environment name is protected: {name}.")
+
+
+class InvalidAddressConfigValue(KnownError):
+    def __init__(self, message: str):
+        super().__init__(message)