mxpy 5.1.0__tar.gz → 10.0.0__tar.gz

mxpy-10.0.0/.gitignore

@@ -0,0 +1,32 @@
+.eggs
+dist
+__pycache__
+*.egg-info
+*.py[cod]
+*$py.class
+.pytest_cache/
+.idea
+
+
+# mypy
+.mypy_cache/
+
+# Sphinx documentation
+docs/_build/
+
+# Tags generated by ctags
+tags
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Typings
+typings
+
+multiversx_sdk_cli/tests/testdata-out

mxpy-10.0.0/LICENSE

@@ -0,0 +1,11 @@
+## License
+
+The MIT License (MIT)
+
+Copyright (c) MultiversX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mxpy-10.0.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: mxpy
+Version: 10.0.0
+Summary: MultiversX Smart Contracts Tools
+Project-URL: Homepage, https://github.com/multiversx/mx-sdk-py-cli
+Author: MultiversX
+License-Expression: MIT
+License-File: LICENSE
+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-Dist: argcomplete==3.2.2
+Requires-Dist: ledgercomm[hid]
+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: toml>=0.10.2
+Description-Content-Type: text/markdown
+
+# Description
+Python Command Line Tools for interacting with Multivers<sup>X</sup>.
+
+## Documentation
+[docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/sdk-py/)
+
+## CLI
+[CLI](CLI.md)
+
+## Distribution
+[pipx](https://docs.multiversx.com/sdk-and-tools/sdk-py/installing-mxpy/) [(PyPi)](https://pypi.org/project/multiversx-sdk-cli/#history)
+
+## Development setup
+
+Clone this repository and cd into it:
+
+```
+git clone https://github.com/multiversx/mx-sdk-py-cli.git
+cd mx-sdk-py-cli
+```
+
+### Virtual environment
+
+Create a virtual environment and install the dependencies:
+
+```
+python3 -m venv ./venv
+source ./venv/bin/activate
+pip install -r ./requirements.txt --upgrade
+```
+
+Install development dependencies, as well:
+
+```
+pip install -r ./requirements-dev.txt --upgrade
+```
+
+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`
+ - _Select Interpreter_
+ - Choose `./venv/bin/python`.
+
+### Using your local `mxpy`
+
+If you want to test the modifications you locally made to `mxpy`, set `PYTHONPATH` with the path to your local repository path.
+
+For example, if you cloned the repository at `~/mx-sdk-py-cli`, run:
+
+```
+export PYTHONPATH="~/mx-sdk-py-cli"
+```
+
+Then `mxpy` will use the code in your local repository.

mxpy-10.0.0/README.md

@@ -0,0 +1,60 @@
+# Description
+Python Command Line Tools for interacting with Multivers<sup>X</sup>.
+
+## Documentation
+[docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/sdk-py/)
+
+## CLI
+[CLI](CLI.md)
+
+## Distribution
+[pipx](https://docs.multiversx.com/sdk-and-tools/sdk-py/installing-mxpy/) [(PyPi)](https://pypi.org/project/multiversx-sdk-cli/#history)
+
+## Development setup
+
+Clone this repository and cd into it:
+
+```
+git clone https://github.com/multiversx/mx-sdk-py-cli.git
+cd mx-sdk-py-cli
+```
+
+### Virtual environment
+
+Create a virtual environment and install the dependencies:
+
+```
+python3 -m venv ./venv
+source ./venv/bin/activate
+pip install -r ./requirements.txt --upgrade
+```
+
+Install development dependencies, as well:
+
+```
+pip install -r ./requirements-dev.txt --upgrade
+```
+
+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`
+ - _Select Interpreter_
+ - Choose `./venv/bin/python`.
+
+### Using your local `mxpy`
+
+If you want to test the modifications you locally made to `mxpy`, set `PYTHONPATH` with the path to your local repository path.
+
+For example, if you cloned the repository at `~/mx-sdk-py-cli`, run:
+
+```
+export PYTHONPATH="~/mx-sdk-py-cli"
+```
+
+Then `mxpy` will use the code in your local repository.

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

mxpy-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)

mxpy-10.0.0/multiversx_sdk_cli/cli.py

@@ -0,0 +1,149 @@
+# PYTHON_ARGCOMPLETE_OK
+import argparse
+import logging
+import sys
+from argparse import ArgumentParser
+from typing import Any
+
+import argcomplete
+from multiversx_sdk import LibraryConfig
+from rich.logging import RichHandler
+
+import multiversx_sdk_cli.cli_config
+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_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
+from multiversx_sdk_cli import config, errors, utils, ux
+
+logger = logging.getLogger("cli")
+
+
+def main(cli_args: list[str] = sys.argv[1:]):
+    try:
+        _do_main(cli_args)
+    except errors.KnownError as err:
+        logger.critical(err.get_pretty())
+        ux.show_critical_error(err.get_pretty())
+        return 1
+    except KeyboardInterrupt:
+        print("process killed by user.")
+        return 1
+    return 0
+
+
+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)
+    argcomplete.autocomplete(parser)
+    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)],
+        )
+    else:
+        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()
+    LibraryConfig.default_address_hrp = default_hrp
+
+    if not hasattr(args, "func"):
+        parser.print_help()
+    else:
+        args.func(args)
+
+
+def setup_parser(args: list[str]):
+    parser = ArgumentParser(
+        prog="mxpy",
+        usage="mxpy [-h] [-v] [--verbose] COMMAND-GROUP [-h] COMMAND ...",
+        description="""
+-----------
+DESCRIPTION
+-----------
+mxpy is part of the multiversx-sdk and consists of Command Line Tools and Python SDK
+for interacting with the Blockchain (in general) and with Smart Contracts (in particular).
+
+mxpy targets a broad audience of users and developers.
+
+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,
+    )
+
+    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("--verbose", action="store_true", default=False)
+
+    subparsers = parser.add_subparsers()
+    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_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))
+    commands.append(multiversx_sdk_cli.cli_data.setup_parser(subparsers))
+    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))
+
+    parser.epilog = """
+----------------------
+COMMAND GROUPS summary
+----------------------
+"""
+    for choice, sub in subparsers.choices.items():
+        parser.epilog += f"{choice.ljust(30)} {sub.description}\n"
+
+    return parser
+
+
+def verify_deprecated_entries_in_config_file():
+    deprecated_keys = config.get_deprecated_entries_in_config_file()
+    if len(deprecated_keys) == 0:
+        return
+
+    config_path = config.resolve_config_path()
+    message = f"The following config entries are deprecated. Please access `{str(config_path)}` and remove them. \n"
+    for entry in deprecated_keys:
+        message += f"-> {entry} \n"
+
+    ux.show_warning(message.rstrip("\n"))
+
+
+if __name__ == "__main__":
+    ret = main(sys.argv[1:])
+    sys.exit(ret)

mxpy-10.0.0/multiversx_sdk_cli/cli_config.py

@@ -0,0 +1,125 @@
+import logging
+import os
+import sys
+from typing import Any
+
+from multiversx_sdk_cli import cli_shared, config, utils
+from multiversx_sdk_cli.ux import confirm_continuation
+
+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.)")
+    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.set_defaults(func=dump)
+
+    sub = cli_shared.add_command_subparser(subparsers, "config", "get", "Gets a configuration value.")
+    _add_name_arg(sub)
+    sub.set_defaults(func=get_value)
+
+    sub = cli_shared.add_command_subparser(subparsers, "config", "set", "Sets a configuration value.")
+    _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.")
+    _add_name_arg(sub)
+    sub.set_defaults(func=delete_value)
+
+    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.set_defaults(func=new_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)
+
+    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.set_defaults(func=delete_config)
+
+    parser.epilog = cli_shared.build_group_epilog(subparsers)
+    return subparsers
+
+
+def _add_name_arg(sub: Any):
+    sub.add_argument("name", help="the name of the configuration entry")
+
+
+def dump(args: Any):
+    if args.defaults:
+        _dump_defaults()
+    else:
+        _dump_active()
+
+
+def _dump_defaults():
+    utils.dump_out_json(config.get_defaults(), sys.stdout)
+
+
+def _dump_active():
+    utils.dump_out_json(config.get_active(), sys.stdout)
+
+
+def get_value(args: Any):
+    value = config.get_value(args.name)
+    print(value)
+
+
+def set_value(args: Any):
+    config.set_value(args.name, args.value)
+
+
+def delete_value(args: Any):
+    config.delete_value(args.name)
+
+
+def new_config(args: Any):
+    config.create_new_config(name=args.name, template=args.template)
+    _dump_active()
+
+
+def switch_config(args: Any):
+    config.set_active(args.name)
+    _dump_active()
+
+
+def list_configs(args: Any):
+    data = config.read_file()
+    configurations = data.get("configurations", {})
+    for config_name in configurations.keys():
+        if config_name == data.get("active", "default"):
+            config_name += "*"
+        print(config_name)
+
+
+def delete_config(args: Any):
+    config_file = config.resolve_config_path()
+    if not config_file.is_file():
+        logger.info("Config file not found. Aborting...")
+        return
+
+    confirm_continuation(f"The file `{str(config_file)}` will be deleted. Do you want to continue? (y/n)")
+    os.remove(config_file)
+    logger.info("Successfully deleted the config file")