Rework naming

Author: evgeny-stakewise

src/meta_vault/tasks.py

@@ -30,7 +30,7 @@
     graph_get_vaults,
 )
 from src.meta_vault.typings import ContractCall, SubVaultExitRequest, Vault
-from src.redemptions.tasks import get_redemption_reservations
+from src.redemptions.tasks import get_vault_to_redemption_assets_distributed
 
 logger = logging.getLogger(__name__)
 
@@ -54,7 +54,7 @@ async def process_block(self, interrupt_handler: InterruptHandler) -> None:
             return
 
         chain_head = await get_chain_latest_head()
-        meta_vault_reservations = await get_redemption_reservations(chain_head)
+        vault_to_redemption_assets = await get_vault_to_redemption_assets_distributed(chain_head)
 
         for vault in self.vaults:
             # Refresh the meta vaults map to include updates
@@ -67,7 +67,7 @@ async def process_block(self, interrupt_handler: InterruptHandler) -> None:
                 await process_meta_vault_tree(
                     vault=vault,
                     meta_vaults_map=meta_vaults_map,
-                    meta_vault_reservations=meta_vault_reservations,
+                    vault_to_redemption_assets=vault_to_redemption_assets,
                 )
             except Exception:
                 logger.exception('Failed to process meta vault tree for vault %s', vault)
@@ -76,7 +76,7 @@ async def process_block(self, interrupt_handler: InterruptHandler) -> None:
 async def process_meta_vault_tree(
     vault: ChecksumAddress,
     meta_vaults_map: dict[ChecksumAddress, Vault],
-    meta_vault_reservations: defaultdict[ChecksumAddress, Wei],
+    vault_to_redemption_assets: defaultdict[ChecksumAddress, Wei],
 ) -> None:
     """
     Process a single meta vault tree: update state and deposit to sub vaults.
@@ -116,7 +116,7 @@ async def process_meta_vault_tree(
     for meta_vault_address in reversed(meta_vault_addresses):
         await process_deposit_to_sub_vaults(
             meta_vault_address=meta_vault_address,
-            redemption_reservation=meta_vault_reservations[meta_vault_address],
+            redemption_assets=vault_to_redemption_assets[meta_vault_address],
         )
 
 
@@ -404,15 +404,15 @@ async def is_meta_vault_rewards_nonce_outdated(
 
 async def process_deposit_to_sub_vaults(
     meta_vault_address: ChecksumAddress,
-    redemption_reservation: Wei = Wei(0),
+    redemption_assets: Wei = Wei(0),
 ) -> None:
     meta_vault_contract = MetaVaultContract(
         address=meta_vault_address,
     )
     withdrawable_assets = await meta_vault_contract.withdrawable_assets()
 
     # Reserve redemption assets so they are not pushed down to sub vaults.
-    withdrawable_assets = Wei(max(0, withdrawable_assets - redemption_reservation))
+    withdrawable_assets = Wei(max(0, withdrawable_assets - redemption_assets))
 
     if settings.network in GNO_NETWORKS:
         withdrawable_assets = convert_to_mgno(withdrawable_assets)

src/redemptions/tasks.py

@@ -28,43 +28,47 @@ async def get_redemption_assets(chain_head: ChainHead) -> Wei:
     Get redemption assets for operator's vault.
     For Gno networks return value in GNO-Wei.
     """
-    post_distribute = await get_redemption_reservations(chain_head)
-    return post_distribute[settings.vault]
+    vault_to_redemption_assets = await get_vault_to_redemption_assets_distributed(chain_head)
+    return vault_to_redemption_assets[settings.vault]
 
 
-async def get_redemption_reservations(
+async def get_vault_to_redemption_assets_distributed(
     chain_head: ChainHead,
 ) -> defaultdict[ChecksumAddress, Wei]:
     """
-    Get per-vault redemption reservations after distributing meta vault assets
-    to sub-vaults. Contains only non-meta vaults.
+    Get per-vault redemption assets after distributing meta vault assets
+    across their entire sub-vault tree. Contains leaf vaults, root meta vaults,
+    and all intermediary meta sub-vaults.
 
     For Gno networks values are in GNO-Wei.
     """
-    # The contract increments nonce during setRedeemablePositions,
-    # but uses nonce - 1 for leaf hash computation during redemption.
     nonce = await os_token_redeemer_contract.nonce(chain_head.block_number)
     if nonce == 0:
-        logger.info('Zero nonce for redemption. Skipping redemption assets.')
+        logger.debug('Zero nonce for redemption. Skipping redemption assets.')
         return defaultdict(lambda: Wei(0))
 
     protocol_config = await get_protocol_config()
 
-    pre_distribute = await get_vault_to_redemption_assets(
+    # The contract increments the nonce at the end of setRedeemablePositions,
+    # so use the previous nonce for leaf hash computation.
+    vault_to_redemption_assets = await get_vault_to_redemption_assets_direct(
         chain_head=chain_head, tree_nonce=nonce - 1, protocol_config=protocol_config
     )
     return await distribute_meta_vault_redemption_assets(
-        vault_to_redemption_assets=pre_distribute,
+        vault_to_redemption_assets=vault_to_redemption_assets,
         block_number=chain_head.block_number,
     )
 
 
-async def get_vault_to_redemption_assets(
+async def get_vault_to_redemption_assets_direct(
     chain_head: ChainHead, tree_nonce: int, protocol_config: ProtocolConfig
 ) -> defaultdict[ChecksumAddress, Wei]:
     """
-    Get redemption assets per vault.
-    For Gno networks return value in GNO-Wei.
+    Get redemption assets per vault, based only on assets directly assigned
+    to each vault in the IPFS redeemable positions file. Meta vault assets are
+    not yet distributed across their sub-vault tree.
+
+    For Gno networks return value is in GNO-Wei.
     """
     ticket = await os_token_redeemer_contract.get_exit_queue_cumulative_tickets(
         block_number=chain_head.block_number

src/validators/tasks.py

@@ -20,7 +20,7 @@
     VALIDATORS_FUNDING_BATCH_SIZE,
     settings,
 )
-from src.redemptions.tasks import get_redemption_reservations
+from src.redemptions.tasks import get_redemption_assets
 from src.validators.consensus import fetch_compounding_validators_balances
 from src.validators.database import NetworkValidatorCrud
 from src.validators.exceptions import EmptyRelayerResponseException, FundingException
@@ -267,9 +267,8 @@ async def get_vault_assets(harvest_params: HarvestParams | None, chain_head: Cha
 
     # Reserve operator's vault redemption assets so that withdrawable assets are spent
     # on redemptions first, then on validator registrations / fundings.
-    post_distribute = await get_redemption_reservations(chain_head)
-    reservation = post_distribute[settings.vault]
-    vault_assets = Wei(max(0, vault_assets - reservation))
+    redemption_assets = await get_redemption_assets(chain_head)
+    vault_assets = Wei(max(0, vault_assets - redemption_assets))
 
     if settings.network in GNO_NETWORKS:
         # apply GNO -> mGNO exchange rate