refactor(common): optimize addresses refunding

Author: mkoura

cardano_node_tests/tests/common.py

@@ -336,48 +336,44 @@ def get_conway_address_deposit(cluster_obj: clusterlib.ClusterLib) -> int:
     return stake_deposit_amt
 
 
-def get_payment_addrs(
-    name_template: str,
+def _get_funded_addresses(
     cluster_manager: cluster_management.ClusterManager,
     cluster_obj: clusterlib.ClusterLib,
-    num: int,
+    create_func: tp.Callable[[], list],
     fund_idx: list[int] | None = None,
     caching_key: str = "",
-    fund_just_once: bool = False,
     amount: int | None = None,
-) -> list[clusterlib.AddressRecord]:
-    """Create new payment addresses."""
-    if num < 1:
-        err = f"Number of addresses must be at least 1, got: {num}"
-        raise ValueError(err)
-
-    def _create_addrs() -> list[clusterlib.AddressRecord]:
-        addrs = clusterlib_utils.create_payment_addr_records(
-            *[f"{name_template}_fund_addr_{i}" for i in range(1, num + 1)],
-            cluster_obj=cluster_obj,
-        )
-        return addrs
+) -> list:
+    """Create and fund addresses."""
+    # Initially fund the addresses with more funds, so the funds don't need to be
+    # added for each and every test.
+    init_amount = 250_000_000
+    # Refund the addresses if the amount is lower than this
+    min_amount = 50_000_000
 
     if caching_key:
-        fixture_cache: cluster_management.FixtureCache[list[clusterlib.AddressRecord] | None]
+        fixture_cache: cluster_management.FixtureCache[list | None]
         with cluster_manager.cache_fixture(key=caching_key) as fixture_cache:
             if fixture_cache.value is None:
-                addrs = _create_addrs()
+                addrs = create_func()
+                amount = amount or init_amount
                 fixture_cache.value = addrs
             else:
                 addrs = fixture_cache.value
-                if fund_just_once:
+                # If amount was passed, fund the addresses only initially
+                if amount:
                     return addrs
+
     else:
-        addrs = _create_addrs()
+        addrs = create_func()
+        amount = amount or init_amount
 
     # Fund source addresses
-    fund_addresses = addrs if fund_idx is None else [addrs[i] for i in fund_idx]
-    if fund_addresses:
-        if amount is None:
-            amount = 200_000_000
+    fund_addrs = addrs if fund_idx is None else [addrs[i] for i in fund_idx]
+    if fund_addrs:
+        amount = amount or min_amount
         clusterlib_utils.fund_from_faucet(
-            *fund_addresses,
+            *fund_addrs,
             cluster_obj=cluster_obj,
             all_faucets=cluster_manager.cache.addrs_data,
             amount=amount,
@@ -386,12 +382,42 @@ def _create_addrs() -> list[clusterlib.AddressRecord]:
     return addrs
 
 
+def get_payment_addrs(
+    name_template: str,
+    cluster_manager: cluster_management.ClusterManager,
+    cluster_obj: clusterlib.ClusterLib,
+    num: int,
+    fund_idx: list[int] | None = None,
+    caching_key: str = "",
+    amount: int | None = None,
+) -> list[clusterlib.AddressRecord]:
+    """Create new payment addresses."""
+    if num < 1:
+        err = f"Number of addresses must be at least 1, got: {num}"
+        raise ValueError(err)
+
+    def _create_addrs() -> list[clusterlib.AddressRecord]:
+        addrs = clusterlib_utils.create_payment_addr_records(
+            *[f"{name_template}_fund_addr_{i}" for i in range(1, num + 1)],
+            cluster_obj=cluster_obj,
+        )
+        return addrs
+
+    return _get_funded_addresses(
+        cluster_manager=cluster_manager,
+        cluster_obj=cluster_obj,
+        create_func=_create_addrs,
+        fund_idx=fund_idx,
+        caching_key=caching_key,
+        amount=amount,
+    )
+
+
 def get_payment_addr(
     name_template: str,
     cluster_manager: cluster_management.ClusterManager,
     cluster_obj: clusterlib.ClusterLib,
     caching_key: str = "",
-    fund_just_once: bool = False,
     amount: int | None = None,
 ) -> clusterlib.AddressRecord:
     """Create a single new payment address."""
@@ -401,7 +427,6 @@ def get_payment_addr(
         cluster_obj=cluster_obj,
         num=1,
         caching_key=caching_key,
-        fund_just_once=fund_just_once,
         amount=amount,
     )[0]
 
@@ -413,7 +438,6 @@ def get_pool_users(
     num: int,
     fund_idx: list[int] | None = None,
     caching_key: str = "",
-    fund_just_once: bool = False,
     amount: int | None = None,
 ) -> list[clusterlib.PoolUser]:
     """Create new pool users."""
@@ -429,41 +453,21 @@ def _create_pool_users() -> list[clusterlib.PoolUser]:
         )
         return users
 
-    if caching_key:
-        fixture_cache: cluster_management.FixtureCache[list[clusterlib.PoolUser] | None]
-        with cluster_manager.cache_fixture(key=caching_key) as fixture_cache:
-            if fixture_cache.value is None:
-                users = _create_pool_users()
-                fixture_cache.value = users
-            else:
-                users = fixture_cache.value
-                if fund_just_once:
-                    return users
-
-    else:
-        users = _create_pool_users()
-
-    # Fund source addresses
-    fund_users = users if fund_idx is None else [users[i] for i in fund_idx]
-    if fund_users:
-        if amount is None:
-            amount = 200_000_000
-        clusterlib_utils.fund_from_faucet(
-            *fund_users,
-            cluster_obj=cluster_obj,
-            all_faucets=cluster_manager.cache.addrs_data,
-            amount=amount,
-        )
-
-    return users
+    return _get_funded_addresses(
+        cluster_manager=cluster_manager,
+        cluster_obj=cluster_obj,
+        create_func=_create_pool_users,
+        fund_idx=fund_idx,
+        caching_key=caching_key,
+        amount=amount,
+    )
 
 
 def get_pool_user(
     name_template: str,
     cluster_manager: cluster_management.ClusterManager,
     cluster_obj: clusterlib.ClusterLib,
     caching_key: str = "",
-    fund_just_once: bool = False,
     amount: int | None = None,
 ) -> clusterlib.PoolUser:
     """Create a single new pool user."""
@@ -473,7 +477,6 @@ def get_pool_user(
         cluster_obj=cluster_obj,
         num=1,
         caching_key=caching_key,
-        fund_just_once=fund_just_once,
         amount=amount,
     )[0]
 
@@ -483,7 +486,6 @@ def get_registered_pool_user(
     cluster_manager: cluster_management.ClusterManager,
     cluster_obj: clusterlib.ClusterLib,
     caching_key: str = "",
-    fund_just_once: bool = False,
     amount: int | None = None,
 ) -> clusterlib.PoolUser:
     """Create new registered pool users."""
@@ -492,7 +494,6 @@ def get_registered_pool_user(
         cluster_manager=cluster_manager,
         cluster_obj=cluster_obj,
         caching_key=caching_key,
-        fund_just_once=fund_just_once,
         amount=amount,
     )
 

cardano_node_tests/tests/test_pools.py

@@ -1897,7 +1897,6 @@ def pool_users(
             num=2,
             fund_idx=[0],
             caching_key=helpers.get_current_line_str(),
-            fund_just_once=True,
             amount=600_000_000,
         )
         return created_users

cardano_node_tests/tests/test_scripts.py

@@ -836,7 +836,6 @@ def payment_addrs(
             num=10,
             fund_idx=[0],
             caching_key=helpers.get_current_line_str(),
-            fund_just_once=True,
         )
         return addrs
 

cardano_node_tests/tests/test_tx_basic.py

@@ -1173,7 +1173,6 @@ def payment_addrs(
             num=201,
             fund_idx=[0],
             caching_key=helpers.get_current_line_str(),
-            fund_just_once=True,
             amount=90_000_000_000,
         )
         return addrs

cardano_node_tests/tests/test_tx_many_utxos.py

@@ -47,7 +47,6 @@ def payment_addrs(
             cluster_obj=cluster,
             num=3,
             fund_idx=[0],
-            fund_just_once=True,
             amount=800_000_000_000,
         )
         return addrs

cardano_node_tests/tests/test_tx_negative.py

@@ -77,7 +77,6 @@ def pool_users(
             cluster_obj=cluster,
             num=3,
             caching_key=helpers.get_current_line_str(),
-            fund_just_once=True,
         )
         return created_users
 

cardano_node_tests/tests/test_update_proposals.py

@@ -368,7 +368,6 @@ def payment_addr(
             cluster_manager=cluster_manager,
             cluster_obj=cluster,
             caching_key=helpers.get_current_line_str(),
-            fund_just_once=True,
         )
         return addr