Merge pull request #478 from multiversx/transaction-refactoring

Transactions creation refactoring & fixes

Author: popenta

multiversx_sdk_cli/base_transactions_controller.py

@@ -0,0 +1,74 @@
+from typing import Optional, Union
+
+from multiversx_sdk import LedgerAccount, Transaction, TransactionComputer
+
+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: str = "",
+        guardian_2fa_code: str = "",
+    ):
+        """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 _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: str,
+        guardian_2fa_code: str,
+    ) -> 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/cli_contracts.py

@@ -2,7 +2,7 @@
 import logging
 import os
 from pathlib import Path
-from typing import Any, Union
+from typing import Any
 
 from multiversx_sdk import (
     Address,
@@ -19,10 +19,8 @@
 from multiversx_sdk_cli.constants import NUMBER_OF_SHARDS
 from multiversx_sdk_cli.contract_verification import trigger_contract_verification
 from multiversx_sdk_cli.contracts import SmartContract
-from multiversx_sdk_cli.cosign_transaction import cosign_transaction
 from multiversx_sdk_cli.docker import is_docker_installed, run_docker
 from multiversx_sdk_cli.errors import DockerMissingError
-from multiversx_sdk_cli.interfaces import IAccount
 from multiversx_sdk_cli.ux import show_warning
 
 logger = logging.getLogger("cli.contracts")
@@ -338,13 +336,13 @@ def build(args: Any):
 
 def deploy(args: Any):
     logger.debug("deploy")
-    cli_shared.check_guardian_and_options_args(args)
+    cli_shared.check_guardian_args(args)
     cli_shared.check_broadcast_args(args)
     cli_shared.prepare_chain_id_in_args(args)
 
     sender = cli_shared.prepare_account(args)
 
-    if not args.nonce:
+    if args.nonce is None:
         nonce = cli_shared.get_current_nonce_for_address(sender.address, args.proxy)
     else:
         nonce = int(args.nonce)
@@ -375,11 +373,13 @@ def deploy(args: Any):
         nonce=nonce,
         version=int(args.version),
         options=int(args.options),
-        guardian=guardian_address,
-        relayer=relayer_address,
+        guardian_account=guardian,
+        guardian_address=guardian_address,
+        relayer_account=relayer,
+        relayer_address=relayer_address,
+        guardian_service_url=args.guardian_service_url,
+        guardian_2fa_code=args.guardian_2fa_code,
     )
-    tx = _sign_guarded_tx_if_guardian(guardian, args, tx)
-    _sign_relayed_tx_if_relayer(relayer, tx)
 
     address_computer = AddressComputer(NUMBER_OF_SHARDS)
     contract_address = address_computer.compute_contract_address(deployer=sender.address, deployment_nonce=tx.nonce)
@@ -390,29 +390,15 @@ def deploy(args: Any):
     _send_or_simulate(tx, contract_address, args)
 
 
-def _sign_guarded_tx_if_guardian(guardian: Union[IAccount, None], args: Any, tx: Transaction) -> Transaction:
-    if guardian:
-        tx.guardian_signature = guardian.sign_transaction(tx)
-    elif tx.guardian and args.guardian_service_url and args.guardian_2fa_code:
-        tx = cosign_transaction(tx, args.guardian_service_url, args.guardian_2fa_code)
-
-    return tx
-
-
-def _sign_relayed_tx_if_relayer(relayer: Union[IAccount, None], tx: Transaction):
-    if relayer and tx.relayer:
-        tx.relayer_signature = relayer.sign_transaction(tx)
-
-
 def call(args: Any):
     logger.debug("call")
-    cli_shared.check_guardian_and_options_args(args)
+    cli_shared.check_guardian_args(args)
     cli_shared.check_broadcast_args(args)
     cli_shared.prepare_chain_id_in_args(args)
 
     sender = cli_shared.prepare_account(args)
 
-    if not args.nonce:
+    if args.nonce is None:
         nonce = cli_shared.get_current_nonce_for_address(sender.address, args.proxy)
     else:
         nonce = int(args.nonce)
@@ -442,24 +428,26 @@ def call(args: Any):
         nonce=nonce,
         version=int(args.version),
         options=int(args.options),
-        guardian=guardian_address,
-        relayer=relayer_address,
+        guardian_account=guardian,
+        guardian_address=guardian_address,
+        relayer_account=relayer,
+        relayer_address=relayer_address,
+        guardian_service_url=args.guardian_service_url,
+        guardian_2fa_code=args.guardian_2fa_code,
     )
-    tx = _sign_guarded_tx_if_guardian(guardian, args, tx)
-    _sign_relayed_tx_if_relayer(relayer, tx)
 
     _send_or_simulate(tx, contract_address, args)
 
 
 def upgrade(args: Any):
     logger.debug("upgrade")
-    cli_shared.check_guardian_and_options_args(args)
+    cli_shared.check_guardian_args(args)
     cli_shared.check_broadcast_args(args)
     cli_shared.prepare_chain_id_in_args(args)
 
     sender = cli_shared.prepare_account(args)
 
-    if not args.nonce:
+    if args.nonce is None:
         nonce = cli_shared.get_current_nonce_for_address(sender.address, args.proxy)
     else:
         nonce = int(args.nonce)
@@ -492,11 +480,13 @@ def upgrade(args: Any):
         nonce=nonce,
         version=int(args.version),
         options=int(args.options),
-        guardian=guardian_address,
-        relayer=relayer_address,
+        guardian_account=guardian,
+        guardian_address=guardian_address,
+        relayer_account=relayer,
+        relayer_address=relayer_address,
+        guardian_service_url=args.guardian_service_url,
+        guardian_2fa_code=args.guardian_2fa_code,
     )
-    tx = _sign_guarded_tx_if_guardian(guardian, args, tx)
-    _sign_relayed_tx_if_relayer(relayer, tx)
 
     _send_or_simulate(tx, contract_address, args)
 

multiversx_sdk_cli/cli_delegation.py

@@ -363,7 +363,7 @@ def _add_common_arguments(args: List[str], sub: Any):
 
 
 def ensure_arguments_are_provided_and_prepared(args: Any):
-    cli_shared.check_guardian_and_options_args(args)
+    cli_shared.check_guardian_args(args)
     cli_shared.check_broadcast_args(args)
     cli_shared.prepare_chain_id_in_args(args)
     cli_shared.prepare_nonce_in_args(args)