use sender from config file

Author: popenta

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/cli_contracts.py

@@ -18,7 +18,6 @@
 
 from multiversx_sdk_cli import cli_shared, utils
 from multiversx_sdk_cli.args_validation import (
-    ensure_wallet_args_are_provided,
     validate_broadcast_args,
     validate_chain_id_args,
     validate_proxy_argument,
@@ -381,7 +380,6 @@ def deploy(args: Any):
     cli_shared.set_proxy_from_config_if_not_provided(args, cli_config)
 
     validate_transaction_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 
@@ -433,7 +431,6 @@ def call(args: Any):
     cli_shared.set_proxy_from_config_if_not_provided(args, cli_config)
 
     validate_transaction_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 
@@ -478,7 +475,6 @@ def upgrade(args: Any):
     cli_shared.set_proxy_from_config_if_not_provided(args, cli_config)
 
     validate_transaction_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 

multiversx_sdk_cli/cli_delegation.py

@@ -12,7 +12,6 @@
 
 from multiversx_sdk_cli import cli_shared, errors, utils
 from multiversx_sdk_cli.args_validation import (
-    ensure_wallet_args_are_provided,
     validate_broadcast_args,
     validate_chain_id_args,
     validate_nonce_args,
@@ -390,7 +389,6 @@ def _add_common_arguments(args: list[str], sub: Any):
 def validate_arguments(args: Any):
     validate_nonce_args(args)
     validate_receiver_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 

multiversx_sdk_cli/cli_shared.py

@@ -17,7 +17,12 @@
     Transaction,
 )
 
-from multiversx_sdk_cli import config, errors, utils
+from multiversx_sdk_cli import config, utils
+from multiversx_sdk_cli.address import (
+    get_active_address,
+    read_address_config_file,
+    resolve_address_config_path,
+)
 from multiversx_sdk_cli.cli_output import CLIOutputBuilder
 from multiversx_sdk_cli.cli_password import (
     load_guardian_password,
@@ -31,9 +36,13 @@
 )
 from multiversx_sdk_cli.env import MxpyEnv, get_address_hrp
 from multiversx_sdk_cli.errors import (
+    AddressConfigFileError,
     ArgumentsNotProvidedError,
     BadUsage,
     IncorrectWalletError,
+    InvalidAddressConfigValue,
+    NoWalletProvided,
+    UnknownAddressAliasError,
 )
 from multiversx_sdk_cli.guardian_relayer_data import GuardianRelayerData
 from multiversx_sdk_cli.interfaces import IAccount
@@ -155,6 +164,7 @@ def add_tx_args(
 
 
 def add_wallet_args(args: list[str], sub: Any):
+    sub.add_argument("--sender", type=str, help="the alias of the wallet set in the address config")
     sub.add_argument(
         "--pem",
         required=False,
@@ -309,8 +319,64 @@ def prepare_account(args: Any):
         )
     elif args.ledger:
         return LedgerAccount(address_index=args.sender_wallet_index)
+    elif args.sender:
+        file_path = resolve_address_config_path()
+        if not file_path.is_file():
+            raise AddressConfigFileError("The address config file was not found")
+
+        file = read_address_config_file()
+        if file == dict():
+            raise AddressConfigFileError("Address config file is empty")
+
+        addresses: dict[str, Any] = file["addresses"]
+        wallet = addresses.get(args.sender, None)
+        if not wallet:
+            raise UnknownAddressAliasError(args.sender)
+
+        logger.info(f"Using sender [{args.sender}] from address config.")
+        return _load_wallet_from_address_config(wallet=wallet, hrp=hrp)
+    else:
+        active_address = get_active_address()
+        if active_address == dict():
+            logger.info("No default wallet found in address config.")
+            raise NoWalletProvided()
+
+        alias_of_default_wallet = read_address_config_file().get("active", "")
+        logger.info(f"Using sender [{alias_of_default_wallet}] from address config.")
+
+        return _load_wallet_from_address_config(wallet=active_address, hrp=hrp)
+
+
+def _load_wallet_from_address_config(wallet: dict[str, str], hrp: str) -> Account:
+    kind = wallet.get("kind", None)
+    if not kind:
+        raise AddressConfigFileError("'kind' field must be set in the address config")
+
+    if kind not in ["pem", "keystore"]:
+        raise InvalidAddressConfigValue("'kind' must be 'pem' or 'keystore'")
+
+    path = wallet.get("path", None)
+    if not path:
+        raise AddressConfigFileError("'path' field must be set in the address config")
+    path = Path(path)
+
+    index = int(wallet.get("index", 0))
+
+    if kind == "pem":
+        return Account.new_from_pem(file_path=path, index=index, hrp=hrp)
     else:
-        raise errors.NoWalletProvided()
+        password = wallet.get("password", "")
+        password_path = wallet.get("passwordPath", None)
+
+        if not password and not password_path:
+            raise AddressConfigFileError(
+                "'password' or 'passwordPath' must be set in the address config for keystore wallets"
+            )
+
+        if password_path:
+            password = Path(password_path).read_text().splitlines()[0].strip()
+
+        return Account.new_from_keystore(file_path=path, password=password, address_index=index, hrp=hrp)
 
 
 def _get_address_hrp(args: Any) -> str:

multiversx_sdk_cli/cli_transactions.py

@@ -14,7 +14,6 @@
 from multiversx_sdk_cli import cli_shared, utils
 from multiversx_sdk_cli.args_validation import (
     ensure_relayer_wallet_args_are_provided,
-    ensure_wallet_args_are_provided,
     validate_broadcast_args,
     validate_chain_id_args,
     validate_nonce_args,
@@ -120,7 +119,6 @@ def create_transaction(args: Any):
 
     validate_nonce_args(args)
     validate_receiver_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 

multiversx_sdk_cli/cli_validators.py

@@ -5,7 +5,6 @@
 
 from multiversx_sdk_cli import cli_shared, utils
 from multiversx_sdk_cli.args_validation import (
-    ensure_wallet_args_are_provided,
     validate_broadcast_args,
     validate_chain_id_args,
     validate_nonce_args,
@@ -149,7 +148,6 @@ def _add_nodes_arg(sub: Any):
 def validate_args(args: Any) -> None:
     validate_nonce_args(args)
     validate_receiver_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 

multiversx_sdk_cli/cli_wallet.py

@@ -180,11 +180,13 @@ def wallet_new(args: Any):
     if format == WALLET_FORMAT_RAW_MNEMONIC:
         outfile.write_text(mnemonic.get_text())
     elif format == WALLET_FORMAT_KEYSTORE_MNEMONIC:
-        password = getpass.getpass("Enter a new password (for keystore):")
+        password = _request_password()
+
         wallet = UserWallet.from_mnemonic(mnemonic.get_text(), password)
         wallet.save(outfile)
     elif format == WALLET_FORMAT_KEYSTORE_SECRET_KEY:
-        password = getpass.getpass("Enter a new password (for keystore):")
+        password = _request_password()
+
         secret_key = mnemonic.derive_key()
         wallet = UserWallet.from_secret_key(secret_key, password)
         wallet.save(outfile, address_hrp)
@@ -200,6 +202,15 @@ def wallet_new(args: Any):
     logger.info(f"Wallet ({format}) saved: {outfile}")
 
 
+def _request_password() -> str:
+    password = ""
+    while not len(password):
+        password = getpass.getpass("Enter a new password (for keystore):")
+        if not len(password):
+            logger.warning("No password provided")
+    return password
+
+
 def _generate_mnemonic_with_shard_constraint(shard: int) -> Mnemonic:
     if shard not in CURRENT_SHARDS:
         raise BadUserInput(f"Wrong shard provided. Choose between {CURRENT_SHARDS}")

multiversx_sdk_cli/dns.py

@@ -10,7 +10,6 @@
 
 from multiversx_sdk_cli import cli_shared
 from multiversx_sdk_cli.args_validation import (
-    ensure_wallet_args_are_provided,
     validate_broadcast_args,
     validate_chain_id_args,
     validate_transaction_args,
@@ -62,7 +61,6 @@ def validate_name(name: str, shard_id: int, proxy: INetworkProvider):
 
 def register(args: Any):
     validate_transaction_args(args)
-    ensure_wallet_args_are_provided(args)
     validate_broadcast_args(args)
     validate_chain_id_args(args)
 

multiversx_sdk_cli/errors.py

@@ -196,3 +196,8 @@ def __init__(self, name: str):
 class InvalidAddressConfigValue(KnownError):
     def __init__(self, message: str):
         super().__init__(message)
+
+
+class AddressConfigFileError(KnownError):
+    def __init__(self, message: str):
+        super().__init__(message)