Merge pull request #2994 from IntersectMBO/imp_address_funding

Improve address funding

Author: mkoura

cardano_node_tests/tests/common.py

@@ -344,39 +344,44 @@ def _get_funded_addresses(
     caching_key: str = "",
     amount: int | None = None,
 ) -> 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
+    """Create and fund addresses.
+
+    If `amount` is provided, fund once and never re-fund.
+    If `amount` is not provided, re-fund when balance drops below `min_amount`.
+    """
+    fund_amount = amount or 150_000_000
+    # Re-fund the addresses if the amount is lower than this
     min_amount = 50_000_000
 
     if caching_key:
         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_func()
-                amount = amount or init_amount
                 fixture_cache.value = addrs
             else:
                 addrs = fixture_cache.value
-                # If amount was passed, fund the addresses only initially
+                # If amount is explicitly specified, skip re-funding
                 if amount:
                     return addrs
 
     else:
         addrs = create_func()
-        amount = amount or init_amount
 
     # Fund source addresses
-    fund_addrs = addrs if fund_idx is None else [addrs[i] for i in fund_idx]
+    selected_addrs = addrs if fund_idx is None else [addrs[i] for i in fund_idx]
+    # The `selected_addrs` can be both `AddressRecord`s or `PoolUser`s
+    payment_addrs = ((sa.payment if hasattr(sa, "payment") else sa) for sa in selected_addrs)
+    fund_addrs: list[clusterlib.AddressRecord] = [
+        a for a in payment_addrs if cluster_obj.g_query.get_address_balance(a.address) < min_amount
+    ]
     if fund_addrs:
-        amount = amount or min_amount
         clusterlib_utils.fund_from_faucet(
             *fund_addrs,
             cluster_obj=cluster_obj,
             all_faucets=cluster_manager.cache.addrs_data,
-            amount=amount,
+            amount=fund_amount,
+            force=True,
         )
 
     return addrs

cardano_node_tests/tests/test_delegation.py

@@ -280,7 +280,7 @@ def _get_pool_users(
 
         # Fund payment addresses
         clusterlib_utils.fund_from_faucet(
-            *pool_users,
+            *[u.payment for u in pool_users],
             cluster_obj=cluster,
             all_faucets=cluster_manager.cache.addrs_data,
             amount=200_000_000,

cardano_node_tests/tests/test_staking_no_rewards.py

@@ -157,7 +157,7 @@ def test_no_reward_unmet_pledge1(
             # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
             # are deducted
             clusterlib_utils.fund_from_faucet(
-                pool_owner,
+                pool_owner.payment,
                 cluster_obj=cluster,
                 all_faucets=cluster_manager.cache.addrs_data,
                 amount=900_000_000,
@@ -317,7 +317,7 @@ def test_no_reward_unmet_pledge2(
 
             # Fund user address so it has enough funds for fees etc.
             clusterlib_utils.fund_from_faucet(
-                delegation_out.pool_user,
+                delegation_out.pool_user.payment,
                 cluster_obj=cluster,
                 all_faucets=cluster_manager.cache.addrs_data,
                 amount=900_000_000,
@@ -499,7 +499,7 @@ def test_no_reward_deregistered_stake_addr(
             # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
             # are deducted
             clusterlib_utils.fund_from_faucet(
-                pool_owner,
+                pool_owner.payment,
                 cluster_obj=cluster,
                 all_faucets=cluster_manager.cache.addrs_data,
                 amount=900_000_000,
@@ -695,7 +695,7 @@ def test_no_reward_deregistered_reward_addr(
             # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
             # are deducted
             clusterlib_utils.fund_from_faucet(
-                pool_reward,
+                pool_reward.payment,
                 cluster_obj=cluster,
                 all_faucets=cluster_manager.cache.addrs_data,
                 amount=900_000_000,
@@ -861,7 +861,7 @@ def test_deregister_reward_addr_retire_pool(
             # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
             # are deducted
             clusterlib_utils.fund_from_faucet(
-                pool_owner,
+                pool_owner.payment,
                 cluster_obj=cluster,
                 all_faucets=cluster_manager.cache.addrs_data,
                 amount=900_000_000,

cardano_node_tests/tests/test_staking_rewards.py

@@ -663,7 +663,7 @@ def test_reward_addr_delegation(  # noqa: C901
         # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
         # are deducted
         clusterlib_utils.fund_from_faucet(
-            pool_owner,
+            pool_owner.payment,
             cluster_obj=cluster,
             all_faucets=cluster_manager.cache.addrs_data,
             amount=900_000_000,
@@ -1189,7 +1189,7 @@ def test_2_pools_same_reward_addr(  # noqa: C901
         # Fund pool owner's addresses so balance keeps higher than pool pledge after fees etc.
         # are deducted
         clusterlib_utils.fund_from_faucet(
-            pool2_owner,
+            pool2_owner.payment,
             cluster_obj=cluster,
             all_faucets=cluster_manager.cache.addrs_data,
             amount=900_000_000,

cardano_node_tests/tests/tests_conway/test_drep.py

@@ -1960,7 +1960,7 @@ def _check_records() -> list[blockers.GH]:
             no_of_addr=2,
         )
         clusterlib_utils.fund_from_faucet(
-            *drep_users,
+            *[d.payment for d in drep_users],
             cluster_obj=cluster,
             faucet_data=cluster_manager.cache.addrs_data["faucet"],
             # Add a lot of funds so no action can be ratified without the new DReps

cardano_node_tests/utils/faucet.py

@@ -13,7 +13,7 @@
 
 
 def fund_from_faucet(
-    *dst_addrs: clusterlib.AddressRecord | clusterlib.PoolUser,
+    *dst_addrs: clusterlib.AddressRecord,
     cluster_obj: clusterlib.ClusterLib,
     faucet_data: dict | None = None,
     all_faucets: dict[str, dict] | None = None,
@@ -27,16 +27,12 @@ def fund_from_faucet(
         msg = "Either `faucet_data` or `all_faucets` must be provided."
         raise AssertionError(msg)
 
-    # Get payment AddressRecord out of PoolUser
-    dst_addr_records: list[clusterlib.AddressRecord] = [
-        (r.payment if hasattr(r, "payment") else r) for r in dst_addrs
-    ]
     if isinstance(amount, int):
-        amount = [amount] * len(dst_addr_records)
+        amount = [amount] * len(dst_addrs)
 
     fund_txouts = [
         clusterlib.TxOut(address=d.address, amount=a)
-        for d, a in zip(dst_addr_records, amount)
+        for d, a in zip(dst_addrs, amount)
         if force or cluster_obj.g_query.get_address_balance(d.address) < a
     ]
     if not fund_txouts:

cardano_node_tests/utils/governance_setup.py

@@ -109,7 +109,7 @@ def create_vote_stake(
 
     # Fund the payment address with some ADA
     clusterlib_utils.fund_from_faucet(
-        *pool_users,
+        *[u.payment for u in pool_users],
         cluster_obj=cluster_obj,
         faucet_data=cluster_manager.cache.addrs_data["faucet"],
         amount=500_000_000_000,