multiversx-sdk-cli 9.12.1__tar.gz → 10.0.0__tar.gz

{multiversx_sdk_cli-9.12.1 → multiversx_sdk_cli-10.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multiversx-sdk-cli
-Version: 9.12.1
+Version: 10.0.0
 Summary: MultiversX Smart Contracts Tools
 Project-URL: Homepage, https://github.com/multiversx/mx-sdk-py-cli
 Author: MultiversX
@@ -13,12 +13,9 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Requires-Dist: argcomplete==3.2.2
 Requires-Dist: ledgercomm[hid]
-Requires-Dist: multiversx-sdk==0.19.0
-Requires-Dist: prettytable
-Requires-Dist: requests-cache
+Requires-Dist: multiversx-sdk[ledger]==1.2.0
 Requires-Dist: requests<3.0.0,>=2.32.0
 Requires-Dist: rich==13.3.4
-Requires-Dist: semver
 Requires-Dist: toml>=0.10.2
 Description-Content-Type: text/markdown
 
@@ -59,7 +56,12 @@ Install development dependencies, as well:
 pip install -r ./requirements-dev.txt --upgrade
 ```
 
-Above, `requirements.txt` should mirror the **dependencies** section of `setup.py`.
+Allow `pre-commit` to automatically run on `git commit`:
+```
+pre-commit install
+```
+
+Above, `requirements.txt` should mirror the **dependencies** section of `pyproject.toml`.
 
 If using VSCode, restart it or follow these steps:
  - `Ctrl + Shift + P`

{multiversx_sdk_cli-9.12.1 → multiversx_sdk_cli-10.0.0}/README.md

@@ -35,7 +35,12 @@ Install development dependencies, as well:
 pip install -r ./requirements-dev.txt --upgrade
 ```
 
-Above, `requirements.txt` should mirror the **dependencies** section of `setup.py`.
+Allow `pre-commit` to automatically run on `git commit`:
+```
+pre-commit install
+```
+
+Above, `requirements.txt` should mirror the **dependencies** section of `pyproject.toml`.
 
 If using VSCode, restart it or follow these steps:
  - `Ctrl + Shift + P`

multiversx_sdk_cli-10.0.0/multiversx_sdk_cli/args_validation.py

@@ -0,0 +1,71 @@
+from typing import Any
+
+from multiversx_sdk_cli.errors import InvalidArgumentsError
+
+
+def validate_transaction_args(args: Any):
+    validate_nonce_args(args)
+    validate_receiver_args(args)
+    validate_gas_limit_args(args)
+
+
+def validate_nonce_args(args: Any):
+    """If nonce is not provided, ensure that recall_nonce is provided. If recall_nonce is provided, ensure that proxy is provided."""
+    if hasattr(args, "nonce") and args.nonce is None:
+        if not args.recall_nonce:
+            raise InvalidArgumentsError("Either --nonce or --recall-nonce must be provided")
+
+        if hasattr(args, "proxy") and not args.proxy:
+            raise InvalidArgumentsError("--proxy must be provided if --recall-nonce is used")
+
+
+def validate_receiver_args(args: Any):
+    """Ensure that receiver is provided."""
+    if hasattr(args, "receiver") and not args.receiver:
+        raise InvalidArgumentsError("--receiver must be provided")
+
+
+def validate_gas_limit_args(args: Any):
+    """Ensure that gas_limit is provided."""
+    if hasattr(args, "gas_limit") and not args.gas_limit:
+        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]
+
+    if all(signing_methods):
+        raise InvalidArgumentsError(
+            "Only one of --relayer-pem, --relayer-keyfile, or --relayer-ledger must be provided"
+        )
+
+    if not any(signing_methods):
+        raise InvalidArgumentsError("One of --relayer-pem, --relayer-keyfile, or --relayer-ledger must be provided")
+
+
+def validate_broadcast_args(args: Any):
+    if args.send and args.simulate:
+        raise InvalidArgumentsError("Cannot both 'simulate' and 'send' a transaction")
+
+    if args.send or args.simulate:
+        validate_proxy_argument(args)
+
+
+def validate_chain_id_args(args: Any):
+    if not args.chain and not args.proxy:
+        raise InvalidArgumentsError("Either --chain or --proxy must be provided")
+
+
+def validate_proxy_argument(args: Any):
+    if not args.proxy:
+        raise InvalidArgumentsError("--proxy must be provided")

multiversx_sdk_cli-10.0.0/multiversx_sdk_cli/base_transactions_controller.py

@@ -0,0 +1,86 @@
+from typing import Optional, Union
+
+from multiversx_sdk import LedgerAccount, Transaction, TransactionComputer
+
+from multiversx_sdk_cli.constants import (
+    EXTRA_GAS_LIMIT_FOR_GUARDED_TRANSACTIONS,
+    EXTRA_GAS_LIMIT_FOR_RELAYED_TRANSACTIONS,
+)
+from multiversx_sdk_cli.cosign_transaction import cosign_transaction
+from multiversx_sdk_cli.interfaces import IAccount
+
+
+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:
+            transaction.signature = sender.sign_transaction(transaction)
+
+        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:
+            transaction.guardian_signature = guardian.sign_transaction(transaction)
+        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:
+            transaction.relayer_signature = relayer.sign_transaction(transaction)

{multiversx_sdk_cli-9.12.1 → multiversx_sdk_cli-10.0.0}/multiversx_sdk_cli/cli.py

@@ -3,13 +3,12 @@ import argparse
 import logging
 import sys
 from argparse import ArgumentParser
-from typing import Any, List
+from typing import Any
 
 import argcomplete
 from multiversx_sdk import LibraryConfig
 from rich.logging import RichHandler
 
-import multiversx_sdk_cli.cli_accounts
 import multiversx_sdk_cli.cli_config
 import multiversx_sdk_cli.cli_contracts
 import multiversx_sdk_cli.cli_data
@@ -20,6 +19,7 @@ import multiversx_sdk_cli.cli_faucet
 import multiversx_sdk_cli.cli_ledger
 import multiversx_sdk_cli.cli_localnet
 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
@@ -28,7 +28,7 @@ from multiversx_sdk_cli import config, errors, utils, ux
 logger = logging.getLogger("cli")
 
 
-def main(cli_args: List[str] = sys.argv[1:]):
+def main(cli_args: list[str] = sys.argv[1:]):
     try:
         _do_main(cli_args)
     except errors.KnownError as err:
@@ -41,7 +41,7 @@ def main(cli_args: List[str] = sys.argv[1:]):
     return 0
 
 
-def _do_main(cli_args: List[str]):
+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)
@@ -49,9 +49,18 @@ def _do_main(cli_args: List[str]):
     args = parser.parse_args(argv_with_config_args)
 
     if args.verbose:
-        logging.basicConfig(level="DEBUG", force=True, format='%(name)s: %(message)s', handlers=[RichHandler(show_time=False, rich_tracebacks=True)])
+        logging.basicConfig(
+            level="DEBUG",
+            force=True,
+            format="%(name)s: %(message)s",
+            handlers=[RichHandler(show_time=False, rich_tracebacks=True)],
+        )
     else:
-        logging.basicConfig(level="INFO", format='%(name)s: %(message)s', handlers=[RichHandler(show_time=False, rich_tracebacks=True)])
+        logging.basicConfig(
+            level="INFO",
+            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()
@@ -63,7 +72,7 @@ def _do_main(cli_args: List[str]):
         args.func(args)
 
 
-def setup_parser(args: List[str]):
+def setup_parser(args: list[str]):
     parser = ArgumentParser(
         prog="mxpy",
         usage="mxpy [-h] [-v] [--verbose] COMMAND-GROUP [-h] COMMAND ...",
@@ -80,24 +89,29 @@ See:
  - https://docs.multiversx.com/sdk-and-tools/sdk-py
  - https://docs.multiversx.com/sdk-and-tools/sdk-py/mxpy-cli
         """,
-        formatter_class=argparse.RawDescriptionHelpFormatter
+        formatter_class=argparse.RawDescriptionHelpFormatter,
     )
 
     parser._positionals.title = "COMMAND GROUPS"
     parser._optionals.title = "TOP-LEVEL OPTIONS"
     version = multiversx_sdk_cli.version.get_version()
-    parser.add_argument("-v", "--version", action="version", version=f"MultiversX Python CLI (mxpy) {version}")
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"MultiversX Python CLI (mxpy) {version}",
+    )
     parser.add_argument("--verbose", action="store_true", default=False)
 
     subparsers = parser.add_subparsers()
-    commands: List[Any] = []
+    commands: list[Any] = []
 
     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))
-    commands.append(multiversx_sdk_cli.cli_accounts.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_ledger.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_wallet.setup_parser(args, subparsers))
+    commands.append(multiversx_sdk_cli.cli_validator_wallet.setup_parser(args, subparsers))
     commands.append(multiversx_sdk_cli.cli_deps.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_config.setup_parser(subparsers))
     commands.append(multiversx_sdk_cli.cli_localnet.setup_parser(args, subparsers))
@@ -112,7 +126,7 @@ COMMAND GROUPS summary
 ----------------------
 """
     for choice, sub in subparsers.choices.items():
-        parser.epilog += (f"{choice.ljust(30)} {sub.description}\n")
+        parser.epilog += f"{choice.ljust(30)} {sub.description}\n"
 
     return parser
 
@@ -127,7 +141,7 @@ def verify_deprecated_entries_in_config_file():
     for entry in deprecated_keys:
         message += f"-> {entry} \n"
 
-    ux.show_warning(message.rstrip('\n'))
+    ux.show_warning(message.rstrip("\n"))
 
 
 if __name__ == "__main__":

{multiversx_sdk_cli-9.12.1 → multiversx_sdk_cli-10.0.0}/multiversx_sdk_cli/cli_config.py

@@ -14,7 +14,12 @@ def setup_parser(subparsers: Any) -> Any:
     subparsers = parser.add_subparsers()
 
     sub = cli_shared.add_command_subparser(subparsers, "config", "dump", "Dumps configuration.")
-    sub.add_argument('--defaults', required=False, help='dump defaults instead of local config', action='store_true')
+    sub.add_argument(
+        "--defaults",
+        required=False,
+        help="dump defaults instead of local config",
+        action="store_true",
+    )
     sub.set_defaults(func=dump)
 
     sub = cli_shared.add_command_subparser(subparsers, "config", "get", "Gets a configuration value.")
@@ -32,7 +37,11 @@ def setup_parser(subparsers: Any) -> Any:
 
     sub = cli_shared.add_command_subparser(subparsers, "config", "new", "Creates a new configuration.")
     _add_name_arg(sub)
-    sub.add_argument("--template", required=False, help="template from which to create the new config")
+    sub.add_argument(
+        "--template",
+        required=False,
+        help="template from which to create the new config",
+    )
     sub.set_defaults(func=new_config)
 
     sub = cli_shared.add_command_subparser(subparsers, "config", "switch", "Switch to a different config")
@@ -42,7 +51,12 @@ def setup_parser(subparsers: Any) -> Any:
     sub = cli_shared.add_command_subparser(subparsers, "config", "list", "List available configs")
     sub.set_defaults(func=list_configs)
 
-    sub = cli_shared.add_command_subparser(subparsers, "config", "reset", "Deletes the config file. Default config will be used.")
+    sub = cli_shared.add_command_subparser(
+        subparsers,
+        "config",
+        "reset",
+        "Deletes the config file. Default config will be used.",
+    )
     sub.set_defaults(func=delete_config)
 
     parser.epilog = cli_shared.build_group_epilog(subparsers)
@@ -93,7 +107,7 @@ def switch_config(args: Any):
 
 def list_configs(args: Any):
     data = config.read_file()
-    configurations = data.get('configurations', {})
+    configurations = data.get("configurations", {})
     for config_name in configurations.keys():
         if config_name == data.get("active", "default"):
             config_name += "*"