Merge pull request #529 from multiversx/remove-password-file

Deprecate password file cli argument

Author: popenta

multiversx_sdk_cli/address_config.py

@@ -16,33 +16,33 @@
 
 
 def get_defaults() -> dict[str, str]:
-    """Not all values are required for a config to be valid.
-
-        Valid config for PEM wallets:
+    """
+    Not all values are required for a config to be valid.
 
+    Valid config for PEM wallets:
+    ```
     {
-                "kind": "pem",
-                "path": "/path/to/wallet.pem",
-                "index": "0",  # optional, defaults to 0
+        "kind": "pem",
+        "path": "/path/to/wallet.pem",
+        "index": "0"  # optional, defaults to 0
     }
+    ```
 
-        Valid config for KEYSTORE wallets:
-
+    Valid config for KEYSTORE wallets:
+    ```
     {
-                "kind": "keystore",
-                "path": "/path/to/wallet.json",
-                "password": "somePassword",  # if not set, passwordPath must be set
-                "passwordPath": "/path/to/password.txt",  # if not set, password must be set
-                "index": "0",  # optional, defaults to 0
+        "kind": "keystore",
+        "path": "/path/to/wallet.json",
+        "index": "0"  # optional, defaults to 0
     }
+    ```
 
+    For keystore wallets, you'll be prompted to enter the password when using the wallet.
     """
     return {
         "kind": "",
         "path": "",
         "index": "",
-        "password": "",
-        "passwordPath": "",
     }
 
 

multiversx_sdk_cli/cli_password.py

@@ -1,23 +1,35 @@
+import logging
 from getpass import getpass
 from typing import Any
 
+logger = logging.getLogger("cli.password")
+
 
 def load_password(args: Any) -> str:
     if args.passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")
 
 
 def load_guardian_password(args: Any) -> str:
     if args.guardian_passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.guardian_passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")
 
 
 def load_relayer_password(args: Any) -> str:
     if args.relayer_passfile:
+        logger.warning(
+            "Using a password file is DEPRECATED and will be removed in a future version. Instead, you'll be prompted to enter the password when using keystore wallets."
+        )
         with open(args.relayer_passfile) as pass_file:
             return pass_file.read().strip()
     return getpass("Keyfile's password: ")

multiversx_sdk_cli/cli_shared.py

@@ -5,6 +5,7 @@
 import sys
 from argparse import FileType
 from functools import cache
+from getpass import getpass
 from pathlib import Path
 from typing import Any, Optional, Text, Union, cast
 
@@ -47,6 +48,7 @@
     LedgerError,
     NoWalletProvided,
     UnknownAddressAliasError,
+    WalletError,
 )
 from multiversx_sdk_cli.guardian_relayer_data import GuardianRelayerData
 from multiversx_sdk_cli.interfaces import IAccount
@@ -181,7 +183,7 @@ def add_wallet_args(args: list[str], sub: Any):
     )
     sub.add_argument(
         "--passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--ledger",
@@ -225,7 +227,7 @@ def add_guardian_wallet_args(args: list[str], sub: Any):
     )
     sub.add_argument(
         "--guardian-passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--guardian-ledger",
@@ -246,7 +248,7 @@ def add_relayed_v3_wallet_args(args: list[str], sub: Any):
     sub.add_argument("--relayer-keyfile", help="🔑 a JSON keyfile, if PEM not provided")
     sub.add_argument(
         "--relayer-passfile",
-        help="🔑 a file containing keyfile's password, if keyfile provided. If not provided, you'll be prompted to enter the password.",
+        help="DEPRECATED, do not use it anymore. Instead, you'll be prompted to enter the password.",
     )
     sub.add_argument(
         "--relayer-ledger",
@@ -357,12 +359,10 @@ def prepare_account(args: Any):
         password = load_password(args)
         index = args.sender_wallet_index if args.sender_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(Path(args.keyfile), password=password, address_index=index, hrp=hrp)
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.ledger:
         try:
             return LedgerAccount(address_index=args.sender_wallet_index)
@@ -414,18 +414,13 @@ def _load_wallet_from_address_config(wallet: dict[str, str], hrp: str) -> Accoun
     if kind == "pem":
         return Account.new_from_pem(file_path=path, index=index, hrp=hrp)
     else:
-        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)
+        logger.info("Using keystore wallet.")
+        password = getpass("Please enter the wallet password: ")
+        logger.info(f"Loading keystore wallet from path: {path}")
+        try:
+            return Account.new_from_keystore(file_path=path, password=password, address_index=index, hrp=hrp)
+        except Exception as e:
+            raise WalletError(str(e))
 
 
 def _get_address_hrp(args: Any) -> str:
@@ -472,12 +467,15 @@ def load_guardian_account(args: Any) -> Union[IAccount, None]:
         password = load_guardian_password(args)
         index = args.guardian_wallet_index if args.guardian_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.guardian_keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(
+                Path(args.guardian_keyfile),
+                password=password,
+                address_index=index,
+                hrp=hrp,
+            )
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.guardian_ledger:
         try:
             return LedgerAccount(address_index=args.guardian_wallet_index)
@@ -606,12 +604,15 @@ def load_relayer_account(args: Any) -> Union[IAccount, None]:
         password = load_relayer_password(args)
         index = args.relayer_wallet_index if args.relayer_wallet_index != 0 else None
 
-        return Account.new_from_keystore(
-            file_path=Path(args.relayer_keyfile),
-            password=password,
-            address_index=index,
-            hrp=hrp,
-        )
+        try:
+            return Account.new_from_keystore(
+                Path(args.relayer_keyfile),
+                password=password,
+                address_index=index,
+                hrp=hrp,
+            )
+        except Exception as e:
+            raise WalletError(str(e))
     elif args.relayer_ledger:
         try:
             return LedgerAccount(address_index=args.relayer_wallet_index)

multiversx_sdk_cli/errors.py

@@ -211,3 +211,8 @@ def __init__(self, message: str):
 class AddressConfigFileError(KnownError):
     def __init__(self, message: str):
         super().__init__(message)
+
+
+class WalletError(KnownError):
+    def __init__(self, message: str):
+        super().__init__(message)

multiversx_sdk_cli/tests/test_cli_default_wallet.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from typing import Any
 
+from multiversx_sdk_cli import cli_shared
 from multiversx_sdk_cli.cli import main
 
 
@@ -247,6 +248,8 @@ def test_incomplete_address_config(capsys: Any, monkeypatch: Any, tmp_path: Path
     monkeypatch.setattr(multiversx_sdk_cli.address_config, "LOCAL_ADDRESS_CONFIG_PATH", test_file)
     multiversx_sdk_cli.address_config.read_address_config_file.cache_clear()
 
+    monkeypatch.setattr(cli_shared, "getpass", lambda *args, **kwargs: "")
+
     return_code = main(
         [
             "tx",
@@ -255,6 +258,10 @@ def test_incomplete_address_config(capsys: Any, monkeypatch: Any, tmp_path: Path
             "erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx",
             "--gas-limit",
             "50000",
+            "--nonce",
+            "0",
+            "--chain",
+            "D",
         ]
     )
     assert return_code

multiversx_sdk_cli/tests/test_cli_multisig.py

@@ -503,7 +503,7 @@ def test_transfer_and_execute_esdt(capsys: Any):
     data = base64.b64decode(data).decode()
     assert (
         data
-        == "proposeTransferExecuteEsdt@0000000000000000050049bff963bdfa3ea02713362095df32e3d708eaccfc57@0000000c414c4943452d3536323766310000000000000000000000010a@0100000000004c4b40@3634363937333734373236393632373537343635"
+        == "proposeTransferExecuteEsdt@0000000000000000050049bff963bdfa3ea02713362095df32e3d708eaccfc57@0000000c414c4943452d3536323766310000000000000000000000010a@0100000000004c4b40@64697374726962757465"
     )
 
 

pyproject.toml

@@ -25,7 +25,7 @@ dependencies = [
   "ledgercomm[hid]",
   "rich==13.3.4",
   "argcomplete==3.2.2",
-  "multiversx-sdk[ledger]==1.6.0"
+  "multiversx-sdk[ledger]==1.6.1"
 ]
 
 [project.scripts]

requirements.txt

@@ -6,4 +6,4 @@ ledgercomm[hid]
 rich==13.3.4
 argcomplete==3.2.2
 
-multiversx-sdk[ledger]==1.6.0
+multiversx-sdk[ledger]==1.6.1