multiversx-sdk-cli 10.2.0__tar.gz → 11.0.0__tar.gz

{multiversx_sdk_cli-10.2.0 → multiversx_sdk_cli-11.0.0}/.gitignore

@@ -30,3 +30,5 @@ venv.bak/
 typings
 
 multiversx_sdk_cli/tests/testdata-out
+
+.DS_store

{multiversx_sdk_cli-10.2.0 → multiversx_sdk_cli-11.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multiversx-sdk-cli
-Version: 10.2.0
+Version: 11.0.0
 Summary: MultiversX Smart Contracts Tools
 Project-URL: Homepage, https://github.com/multiversx/mx-sdk-py-cli
 Author: MultiversX
@@ -10,10 +10,10 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: argcomplete==3.2.2
 Requires-Dist: ledgercomm[hid]
-Requires-Dist: multiversx-sdk[ledger]==1.2.0
+Requires-Dist: multiversx-sdk[ledger]==1.6.2
 Requires-Dist: requests<3.0.0,>=2.32.0
 Requires-Dist: rich==13.3.4
 Requires-Dist: toml>=0.10.2

{multiversx_sdk_cli-10.2.0 → multiversx_sdk_cli-11.0.0}/multiversx_sdk_cli/args_validation.py

@@ -29,16 +29,6 @@ def validate_gas_limit_args(args: Any):
         raise InvalidArgumentsError("--gas-limit must be provided")
 
 
-def ensure_wallet_args_are_provided(args: Any):
-    signing_methods = [args.pem, args.keyfile, args.ledger]
-
-    if all(signing_methods):
-        raise InvalidArgumentsError("Only one of --pem, --keyfile, or --ledger must be provided")
-
-    if not any(signing_methods):
-        raise InvalidArgumentsError("One of --pem, --keyfile, or --ledger must be provided")
-
-
 def ensure_relayer_wallet_args_are_provided(args: Any):
     signing_methods = [args.relayer_pem, args.relayer_keyfile, args.relayer_ledger]
 

multiversx_sdk_cli-11.0.0/multiversx_sdk_cli/base_transactions_controller.py

@@ -0,0 +1,172 @@
+import logging
+from typing import Any, Optional, Union
+
+from multiversx_sdk import Address, LedgerAccount, Transaction, TransactionComputer
+from multiversx_sdk.abi import (
+    AddressValue,
+    BigUIntValue,
+    BoolValue,
+    BytesValue,
+    StringValue,
+)
+
+from multiversx_sdk_cli.config_env import get_address_hrp
+from multiversx_sdk_cli.constants import (
+    ADDRESS_PREFIX,
+    EXTRA_GAS_LIMIT_FOR_GUARDED_TRANSACTIONS,
+    EXTRA_GAS_LIMIT_FOR_RELAYED_TRANSACTIONS,
+    FALSE_STR_LOWER,
+    HEX_PREFIX,
+    MAINCHAIN_ADDRESS_HRP,
+    STR_PREFIX,
+    TRUE_STR_LOWER,
+)
+from multiversx_sdk_cli.cosign_transaction import cosign_transaction
+from multiversx_sdk_cli.errors import BadUserInput, TransactionSigningError
+from multiversx_sdk_cli.guardian_relayer_data import GuardianRelayerData
+from multiversx_sdk_cli.interfaces import IAccount
+
+logger = logging.getLogger("base_controller")
+
+
+class BaseTransactionsController:
+    def __init__(self) -> None:
+        pass
+
+    def sign_transaction(
+        self,
+        transaction: Transaction,
+        sender: Optional[IAccount] = None,
+        guardian: Optional[IAccount] = None,
+        relayer: Optional[IAccount] = None,
+        guardian_service_url: Optional[str] = None,
+        guardian_2fa_code: Optional[str] = None,
+    ):
+        """Signs the transaction using the sender's account and, if required, additionally signs with the guardian's and relayer's accounts. Ensures the appropriate transaction options are set as needed."""
+        self._set_options_for_guarded_transaction_if_needed(transaction)
+        self._set_options_for_hash_signing_if_needed(transaction, sender, guardian, relayer)
+
+        if sender:
+            try:
+                transaction.signature = sender.sign_transaction(transaction)
+            except Exception as e:
+                raise TransactionSigningError(f"Could not sign transaction: {str(e)}")
+
+        self._sign_guarded_transaction_if_guardian(
+            transaction,
+            guardian,
+            guardian_service_url,
+            guardian_2fa_code,
+        )
+        self._sign_relayed_transaction_if_relayer(transaction, relayer)
+
+    def add_extra_gas_limit_if_required(self, transaction: Transaction):
+        """In case of guarded or relayed transactions, extra gas limit is added."""
+        if transaction.guardian:
+            transaction.gas_limit += EXTRA_GAS_LIMIT_FOR_GUARDED_TRANSACTIONS
+
+        if transaction.relayer:
+            transaction.gas_limit += EXTRA_GAS_LIMIT_FOR_RELAYED_TRANSACTIONS
+
+    def _set_options_for_guarded_transaction_if_needed(self, transaction: Transaction):
+        if transaction.guardian:
+            transaction_computer = TransactionComputer()
+            transaction_computer.apply_guardian(transaction, transaction.guardian)
+
+    def _set_options_for_hash_signing_if_needed(
+        self,
+        transaction: Transaction,
+        sender: Union[IAccount, None],
+        guardian: Union[IAccount, None],
+        relayer: Union[IAccount, None],
+    ):
+        if (
+            isinstance(sender, LedgerAccount)
+            or isinstance(guardian, LedgerAccount)
+            or isinstance(relayer, LedgerAccount)
+        ):
+            transaction_computer = TransactionComputer()
+            transaction_computer.apply_options_for_hash_signing(transaction)
+
+    def _sign_guarded_transaction_if_guardian(
+        self,
+        transaction: Transaction,
+        guardian: Union[IAccount, None],
+        guardian_service_url: Union[str, None],
+        guardian_2fa_code: Union[str, None],
+    ) -> Transaction:
+        #  If the guardian account is provided, we sign locally. Otherwise, we reach for the trusted cosign service.
+        if guardian:
+            try:
+                transaction.guardian_signature = guardian.sign_transaction(transaction)
+            except Exception as e:
+                raise TransactionSigningError(f"Could not sign transaction: {str(e)}")
+        elif transaction.guardian and guardian_service_url and guardian_2fa_code:
+            cosign_transaction(transaction, guardian_service_url, guardian_2fa_code)
+
+        return transaction
+
+    def _sign_relayed_transaction_if_relayer(self, transaction: Transaction, relayer: Union[IAccount, None]):
+        if relayer and transaction.relayer:
+            try:
+                transaction.relayer_signature = relayer.sign_transaction(transaction)
+            except Exception as e:
+                raise TransactionSigningError(f"Could not sign transaction: {str(e)}")
+
+    def _convert_args_to_typed_values(self, arguments: list[str]) -> list[Any]:
+        args: list[Any] = []
+
+        for arg in arguments:
+            if arg.startswith(HEX_PREFIX):
+                args.append(BytesValue(self._hex_to_bytes(arg)))
+            elif arg.isnumeric():
+                args.append(BigUIntValue(int(arg)))
+            elif arg.startswith(ADDRESS_PREFIX):
+                args.append(AddressValue.new_from_address(Address.new_from_bech32(arg[len(ADDRESS_PREFIX) :])))
+            elif arg.startswith(MAINCHAIN_ADDRESS_HRP):
+                # this flow will be removed in the future
+                logger.warning(
+                    "Address argument has no prefix. This flow will be removed in the future. Please provide each address using the `addr:` prefix. (e.g. --arguments addr:erd1...)"
+                )
+                args.append(AddressValue.new_from_address(Address.new_from_bech32(arg)))
+            elif arg.startswith(get_address_hrp()):
+                args.append(AddressValue.new_from_address(Address.new_from_bech32(arg)))
+            elif arg.lower() == FALSE_STR_LOWER:
+                args.append(BoolValue(False))
+            elif arg.lower() == TRUE_STR_LOWER:
+                args.append(BoolValue(True))
+            elif arg.startswith(STR_PREFIX):
+                args.append(StringValue(arg[len(STR_PREFIX) :]))
+            else:
+                raise BadUserInput(
+                    f"Unknown argument type for argument: `{arg}`. Use `mxpy contract <sub-command> --help` to check all supported arguments"
+                )
+
+        return args
+
+    def _hex_to_bytes(self, arg: str):
+        argument = arg[len(HEX_PREFIX) :]
+        argument = argument.upper()
+        argument = self.ensure_even_length(argument)
+        return bytes.fromhex(argument)
+
+    def ensure_even_length(self, string: str) -> str:
+        if len(string) % 2 == 1:
+            return "0" + string
+        return string
+
+    def _set_transaction_fields(
+        self,
+        transaction: Transaction,
+        nonce: int,
+        version: int,
+        options: int,
+        gas_price: int,
+        guardian_and_relayer_data: GuardianRelayerData,
+    ):
+        transaction.nonce = nonce
+        transaction.version = version
+        transaction.options = options
+        transaction.gas_price = gas_price
+        transaction.guardian = guardian_and_relayer_data.guardian_address
+        transaction.relayer = guardian_and_relayer_data.relayer_address

{multiversx_sdk_cli-10.2.0 → multiversx_sdk_cli-11.0.0}/multiversx_sdk_cli/cli.py

@@ -10,20 +10,28 @@ from multiversx_sdk import LibraryConfig
 from rich.logging import RichHandler
 
 import multiversx_sdk_cli.cli_config
+import multiversx_sdk_cli.cli_config_env
+import multiversx_sdk_cli.cli_config_wallet
 import multiversx_sdk_cli.cli_contracts
 import multiversx_sdk_cli.cli_data
 import multiversx_sdk_cli.cli_delegation
 import multiversx_sdk_cli.cli_deps
 import multiversx_sdk_cli.cli_dns
 import multiversx_sdk_cli.cli_faucet
+import multiversx_sdk_cli.cli_get
+import multiversx_sdk_cli.cli_governance
 import multiversx_sdk_cli.cli_ledger
 import multiversx_sdk_cli.cli_localnet
+import multiversx_sdk_cli.cli_multisig
 import multiversx_sdk_cli.cli_transactions
 import multiversx_sdk_cli.cli_validator_wallet
 import multiversx_sdk_cli.cli_validators
 import multiversx_sdk_cli.cli_wallet
 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.config_env import get_address_hrp
+from multiversx_sdk_cli.constants import LOG_LEVELS, SDK_PATH
 
 logger = logging.getLogger("cli")
 
@@ -42,11 +50,12 @@ def main(cli_args: list[str] = sys.argv[1:]):
 
 
 def _do_main(cli_args: list[str]):
-    utils.ensure_folder(config.SDK_PATH)
-    argv_with_config_args = config.add_config_args(cli_args)
-    parser = setup_parser(argv_with_config_args)
+    utils.ensure_folder(SDK_PATH)
+    parser = setup_parser(cli_args)
     argcomplete.autocomplete(parser)
-    args = parser.parse_args(argv_with_config_args)
+
+    _handle_global_arguments(cli_args)
+    args = parser.parse_args(cli_args)
 
     if args.verbose:
         logging.basicConfig(
@@ -56,22 +65,21 @@ def _do_main(cli_args: list[str]):
             handlers=[RichHandler(show_time=False, rich_tracebacks=True)],
         )
     else:
+        level: str = args.log_level
         logging.basicConfig(
-            level="INFO",
+            level=level.upper(),
             format="%(name)s: %(message)s",
             handlers=[RichHandler(show_time=False, rich_tracebacks=True)],
         )
 
     verify_deprecated_entries_in_config_file()
-    default_hrp = config.get_address_hrp()
+    default_hrp = get_address_hrp()
     LibraryConfig.default_address_hrp = default_hrp
 
-    if hasattr(args, "recall_nonce") and args.recall_nonce:
-        logger.warning("The --recall-nonce flag is DEPRECATED. The nonce is fetched from the network by default.")
-
     if not hasattr(args, "func"):
         parser.print_help()
     else:
+        set_proxy_from_config_if_not_provided(args)
         args.func(args)
 
 
@@ -105,10 +113,18 @@ See:
         version=f"MultiversX Python CLI (mxpy) {version}",
     )
     parser.add_argument("--verbose", action="store_true", default=False)
+    parser.add_argument(
+        "--log-level",
+        type=str,
+        default=config.get_log_level_from_config(),
+        choices=LOG_LEVELS,
+        help="default: %(default)s",
+    )
 
     subparsers = parser.add_subparsers()
     commands: list[Any] = []
 
+    commands.append(multiversx_sdk_cli.cli_config_wallet.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))
@@ -122,6 +138,10 @@ See:
     commands.append(multiversx_sdk_cli.cli_delegation.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_dns.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_faucet.setup_parser(args, subparsers))
+    commands.append(multiversx_sdk_cli.cli_multisig.setup_parser(args, subparsers))
+    commands.append(multiversx_sdk_cli.cli_governance.setup_parser(args, subparsers))
+    commands.append(multiversx_sdk_cli.cli_config_env.setup_parser(subparsers))
+    commands.append(multiversx_sdk_cli.cli_get.setup_parser(subparsers))
 
     parser.epilog = """
 ----------------------
@@ -147,6 +167,26 @@ def verify_deprecated_entries_in_config_file():
     ux.show_warning(message.rstrip("\n"))
 
 
+def _handle_global_arguments(args: list[str]):
+    """
+    Handle global arguments like --verbose and --log-level.
+    """
+    log_level_arg = "--log-level"
+    if log_level_arg in args:
+        index = args.index(log_level_arg)
+        if index + 1 >= len(args):
+            raise ValueError(f"Argument {log_level_arg} must be followed by a log level value.")
+
+        log_arg = args.pop(index)
+        log_value = args.pop(index)
+        args.insert(0, log_value)
+        args.insert(0, log_arg)
+
+    if "--verbose" in args:
+        args.remove("--verbose")
+        args.insert(0, "--verbose")
+
+
 if __name__ == "__main__":
     ret = main(sys.argv[1:])
     sys.exit(ret)

{multiversx_sdk_cli-10.2.0 → multiversx_sdk_cli-11.0.0}/multiversx_sdk_cli/cli_config.py

@@ -10,10 +10,10 @@ logger = logging.getLogger("cli.config")
 
 
 def setup_parser(subparsers: Any) -> Any:
-    parser = cli_shared.add_group_subparser(subparsers, "config", "Configure multiversx-sdk (default values etc.)")
+    parser = cli_shared.add_group_subparser(subparsers, "config", "Configure MultiversX CLI (default values etc.)")
     subparsers = parser.add_subparsers()
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "dump", "Dumps configuration.")
+    sub = cli_shared.add_command_subparser(subparsers, "config", "dump", "Dumps the active configuration.")
     sub.add_argument(
         "--defaults",
         required=False,
@@ -22,20 +22,28 @@ def setup_parser(subparsers: Any) -> Any:
     )
     sub.set_defaults(func=dump)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "get", "Gets a configuration value.")
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config", "get", "Gets a configuration value from the active configuration."
+    )
     _add_name_arg(sub)
     sub.set_defaults(func=get_value)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "set", "Sets a configuration value.")
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config", "set", "Sets a configuration value for the active configuration."
+    )
     _add_name_arg(sub)
     sub.add_argument("value", help="the new value")
     sub.set_defaults(func=set_value)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "delete", "Deletes a configuration value.")
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config", "delete", "Deletes a configuration value from the active configuration."
+    )
     _add_name_arg(sub)
     sub.set_defaults(func=delete_value)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "new", "Creates a new configuration.")
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config", "new", "Creates a new configuration and sets it as the active configuration."
+    )
     _add_name_arg(sub)
     sub.add_argument(
         "--template",
@@ -44,7 +52,7 @@ def setup_parser(subparsers: Any) -> Any:
     )
     sub.set_defaults(func=new_config)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "switch", "Switch to a different config")
+    sub = cli_shared.add_command_subparser(subparsers, "config", "switch", "Switch to a different config.")
     _add_name_arg(sub)
     sub.set_defaults(func=switch_config)
 

multiversx_sdk_cli-11.0.0/multiversx_sdk_cli/cli_config_env.py

@@ -0,0 +1,160 @@
+import logging
+import os
+from typing import Any
+
+from multiversx_sdk_cli import cli_shared
+from multiversx_sdk_cli.config_env import (
+    create_new_env,
+    delete_env,
+    delete_value,
+    get_active_env,
+    get_defaults,
+    get_value,
+    read_env_file,
+    resolve_env_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.config_env")
+
+
+def setup_parser(subparsers: Any) -> Any:
+    parser = cli_shared.add_group_subparser(
+        subparsers, "config-env", "Configure MultiversX CLI to use specific environment values."
+    )
+    subparsers = parser.add_subparsers()
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config-env", "new", "Creates a new environment and sets it as the active environment."
+    )
+    sub.add_argument("name", type=str, help="the name of the new environment")
+    sub.add_argument(
+        "--template",
+        required=False,
+        help="an environment from which to create the new environment",
+    )
+    sub.set_defaults(func=new_env)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config-env", "get", "Gets an env value from the specified environment."
+    )
+    _add_name_arg(sub)
+    _add_env_arg(sub)
+    sub.set_defaults(func=get_env_value)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config-env", "set", "Sets an env value for the specified environment."
+    )
+    _add_name_arg(sub)
+    sub.add_argument("value", type=str, help="the new value")
+    _add_env_arg(sub)
+    sub.set_defaults(func=set_env_value)
+
+    sub = cli_shared.add_command_subparser(subparsers, "config-env", "dump", "Dumps the active environment.")
+    sub.add_argument(
+        "--default",
+        required=False,
+        help="dumps the default environment instead of the active one.",
+        action="store_true",
+    )
+    sub.set_defaults(func=dump)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers, "config-env", "delete", "Deletes an env value from the specified environment."
+    )
+    _add_name_arg(sub)
+    _add_env_arg(sub)
+    sub.set_defaults(func=delete_env_value)
+
+    sub = cli_shared.add_command_subparser(subparsers, "config-env", "switch", "Switch to a different environment.")
+    _add_env_arg(sub)
+    sub.set_defaults(func=switch_env)
+
+    sub = cli_shared.add_command_subparser(subparsers, "config-env", "list", "List available environments")
+    sub.set_defaults(func=list_envs)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers,
+        "config-env",
+        "remove",
+        "Deletes an environment from the env file. Use `mxpy config-env switch` to switch to another env.",
+    )
+    _add_env_arg(sub)
+    sub.set_defaults(func=remove_env_entry)
+
+    sub = cli_shared.add_command_subparser(
+        subparsers,
+        "config-env",
+        "reset",
+        "Deletes the environment file. Default env will be used.",
+    )
+    sub.set_defaults(func=delete_env_file)
+
+    parser.epilog = cli_shared.build_group_epilog(subparsers)
+    return subparsers
+
+
+def _add_name_arg(sub: Any):
+    sub.add_argument("name", type=str, help="the name of the configuration entry")
+
+
+def _add_env_arg(sub: Any):
+    sub.add_argument("--env", required=True, type=str, help="the name of the environment to operate on")
+
+
+def dump(args: Any):
+    if args.default:
+        dump_out_json(get_defaults())
+    else:
+        dump_out_json(get_active_env())
+
+
+def get_env_value(args: Any):
+    value = get_value(args.name, args.env)
+    print(value)
+
+
+def set_env_value(args: Any):
+    set_value(args.name, args.value, args.env)
+
+
+def delete_env_value(args: Any):
+    delete_value(args.name, args.env)
+
+
+def new_env(args: Any):
+    create_new_env(name=args.name, template=args.template)
+    dump_out_json(get_active_env())
+
+
+def switch_env(args: Any):
+    set_active(args.env)
+    dump_out_json(get_active_env())
+
+
+def list_envs(args: Any):
+    data = read_env_file()
+    dump_out_json(data)
+
+
+def remove_env_entry(args: Any):
+    envs_file = resolve_env_path()
+    if not envs_file.is_file():
+        logger.info("Environment file not found. Aborting...")
+        return
+
+    delete_env(args.env)
+
+
+def delete_env_file(args: Any):
+    envs_file = resolve_env_path()
+    if not envs_file.is_file():
+        logger.info("Environment file not found. Aborting...")
+        return
+
+    confirm_continuation(f"The file `{str(envs_file)}` will be deleted. Do you want to continue? (y/n)")
+    os.remove(envs_file)
+    logger.info("Successfully deleted the environment file.")