Process redeemer by cyc60 · Pull Request #664 · stakewise/v3-operator

cyc60 · 2026-02-18T16:20:40Z

No description provided.

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Signed-off-by: cyc60 <avsysoev60@gmail.com> # Conflicts: # poetry.lock

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Copilot

Pull request overview

Adds an internal CLI command to process the OsToken redeemer (exit-queue checkpoints + automatic redemption execution), while generalizing harvest/withdrawable-asset helpers to work with arbitrary vault addresses (needed for multi-vault/meta-vault flows).

Changes:

Parameterize get_harvest_params and get_withdrawable_assets with an explicit vault address and update call sites accordingly.
Introduce process_redeemer internal command to process exit queue and redeem eligible OsToken positions (with multiproof + multicall).
Skip redemption-position iteration when merkle_root is zero (no active set) and extend typings to track available_shares / shares_to_redeem.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/withdrawals/assets.py	Updates harvest-param fetch to pass explicit vault address.
src/validators/tasks.py	Updates harvest/withdrawable calls to new vault-parameterized signatures.
src/validators/execution.py	Makes `get_withdrawable_assets` accept a `vault` argument.
src/reward_splitter/tasks.py	Updates harvest-param fetch to pass explicit vault address.
src/redemptions/typings.py	Extends `OsTokenPosition` with redemption-tracking fields.
src/redemptions/tasks.py	Adds `ZERO_MERKLE_ROOT` guard to skip empty redeemable sets.
src/main.py	Registers the new internal `process_redeemer` CLI command.
src/harvest/tasks.py	Updates harvest-param fetch to pass explicit vault address.
src/common/startup_check.py	Updates harvest/withdrawable calls to new vault-parameterized signatures.
src/common/harvest.py	Makes `get_harvest_params` accept a `vault` argument.
src/common/contracts.py	Adds OsToken redeemer wrapper methods (queued shares, exit queue processing, sub-vault redemption, etc.).
src/commands/internal/process_redeemer.py	New command implementing redemption selection + multiproof redemption + exit queue processing.
src/commands/tests/test_internal/test_process_redeemer.py	New unit tests for the redeemer processing logic.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/commands/internal/process_redeemer.py

Copilot · 2026-03-04T20:56:33Z

src/commands/internal/process_redeemer.py

+    vault_positions_shares = Wei(sum(p.available_shares for p in positions))
+    vault_positions_assets = os_token_converter.to_assets(vault_positions_shares)
+
+    if vault_positions_assets <= withdrawable_assets or not await is_meta_vault(vault_address):
+        return withdrawable_assets
+
+    logger.info('Vault %s is a meta-vault with insufficient withdrawable assets.', vault_address)
+    additional_assets_needed = Wei(vault_positions_assets - withdrawable_assets)


_try_redeem_sub_vaults decides how much to redeem from sub-vaults using the sum of all available_shares in the vault. Since the overall redemption in this run is capped by queued_shares, this can trigger an on-chain redeemSubVaultsAssets for assets that will never be redeemed in this round (e.g., when queued_shares is smaller than total vault position shares or gets exhausted on earlier vaults). Consider limiting the required shares/assets to the maximum that could actually be redeemed for this vault in the current round (based on remaining queued shares / selection), or move sub-vault redemption to after positions are selected.

Suggested change

vault_positions_shares = Wei(sum(p.available_shares for p in positions))

vault_positions_assets = os_token_converter.to_assets(vault_positions_shares)

if vault_positions_assets <= withdrawable_assets or not await is_meta_vault(vault_address):

return withdrawable_assets

logger.info('Vault %s is a meta-vault with insufficient withdrawable assets.', vault_address)

additional_assets_needed = Wei(vault_positions_assets - withdrawable_assets)

# Use the shares that are actually intended to be redeemed in this round for this vault.

# Prefer `shares_to_redeem` when present; fall back to `available_shares` otherwise.

requested_shares = Wei(

sum(

(getattr(p, 'shares_to_redeem', None) or p.available_shares)

for p in positions

)

)

if requested_shares == 0:

# Nothing to redeem for this vault in the current round.

return withdrawable_assets

requested_assets = os_token_converter.to_assets(requested_shares)

if requested_assets <= withdrawable_assets or not await is_meta_vault(vault_address):

return withdrawable_assets

logger.info('Vault %s is a meta-vault with insufficient withdrawable assets.', vault_address)

additional_assets_needed = Wei(requested_assets - withdrawable_assets)

src/commands/internal/process_redeemer.py

src/common/contracts.py

evgeny-stakewise

Added comments

src/commands/internal/process_redeemer.py

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-06T18:43:55Z

src/common/harvest.py

    last_rewards = await keeper_contract.get_last_rewards_update(block_number)
    if last_rewards is None:
-        return None
+        return {vault: None for vault in vaults}
+
+    ipfs_data = await ipfs_fetch_client.fetch_json(last_rewards.ipfs_hash)
+
+    for vault in vaults:
+        if not await keeper_contract.can_harvest(vault, block_number):
+            results[vault] = None


get_multiple_harvest_params now fetches IPFS data (ipfs_fetch_client.fetch_json) before checking can_harvest for any vaults. This regresses the previous behavior where non-harvestable vaults would return early without an IPFS fetch, and can now cause unnecessary IPFS load or even crash the caller when IPFS is unavailable despite can_harvest being false. Consider checking can_harvest first (for all vaults) and only fetching IPFS data if at least one vault is harvestable, or restoring the early-return behavior in get_harvest_params for the single-vault case.

src/commands/internal/process_redeemer.py

src/common/tests/test_harvest.py

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/redemptions/tasks.py

src/common/contracts.py

Copilot · 2026-03-09T09:26:46Z

src/common/harvest.py

+    """Get harvest params for multiple vaults.
+
+    Checks can_harvest for all vaults first, then fetches IPFS data only
+    if at least one vault is harvestable.
+    """
+    if not vaults:
+        return {}

    last_rewards = await keeper_contract.get_last_rewards_update(block_number)
    if last_rewards is None:
-        return None
+        return {vault: None for vault in vaults}


The docstring says can_harvest is checked for all vaults before fetching remote data, but the implementation calls keeper_contract.get_last_rewards_update() first. This adds an extra (potentially expensive) chain log lookup even when no vault is harvestable. Consider checking can_harvest for the provided vaults first and only then fetching last rewards/IPFS (or update the docstring if the order is intentional).

src/common/harvest.py

src/commands/internal/process_redeemer.py

Signed-off-by: cyc60 <avsysoev60@gmail.com>

evgeny-stakewise

Added comments part 2

src/commands/internal/process_redeemer.py

evgeny-stakewise · 2026-03-10T11:37:06Z

src/commands/internal/process_redeemer.py

+
+    logger.info('Vault %s is a meta-vault with insufficient withdrawable assets.', vault_address)
+    try:
+        tx_hash = await os_token_redeemer_contract.redeem_sub_vaults_assets(vault_address, deficit)


Probably you have to redeem nested meta vaults as well.

nested meta vaults handled in contact code

src/commands/internal/process_redeemer.py

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/redemptions/tasks.py

src/commands/internal/process_redeemer.py

Copilot · 2026-03-10T15:33:28Z

src/commands/internal/process_redeemer.py

+    if queued_assets < min_queued_assets:
+        logger.info(
+            'Queued assets %s below threshold %s. Skipping to next interval.',
+            Web3.from_wei(queued_assets, 'ether'),
+            Web3.from_wei(min_queued_assets, 'ether'),
+        )


min_queued_assets is parsed as a Gwei value (see main(... min_queued_assets=Gwei(min_queued_assets_gwei))), but here it's treated as Wei: queued_assets is in Wei and Web3.from_wei(min_queued_assets, 'ether') also expects Wei. This makes the threshold comparison/logging incorrect by 1e9. Convert min_queued_assets_gwei to Wei once (e.g., min_queued_assets_wei = Web3.to_wei(..., 'gwei')) and consistently compare/log in Wei units.

src/commands/internal/process_redeemer.py

Copilot · 2026-03-10T15:33:28Z

src/common/harvest.py

    last_rewards = await keeper_contract.get_last_rewards_update(block_number)
    if last_rewards is None:
-        return None
+        return {vault: None for vault in vaults}
+
+    harvestable_vaults: list[ChecksumAddress] = [
+        vault for vault in vaults if await keeper_contract.can_harvest(vault, block_number)
+    ]
+
+    if not harvestable_vaults:
+        return {vault: None for vault in vaults}
+


get_multiple_harvest_params calls keeper_contract.can_harvest(...) sequentially for each vault (await inside the list comprehension). For many vaults (as in the new redeemer flow) this adds avoidable latency. Consider issuing these calls concurrently with asyncio.gather and then filtering based on the results.

src/common/contracts.py

src/common/tests/test_harvest.py

Signed-off-by: cyc60 <avsysoev60@gmail.com>

cyc60 and others added 30 commits January 9, 2026 00:40

Add update redeemable positions command

7e82e70

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Cleanup

488c6bc

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Update api client

fac0134

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Check arbitrum balance, add min shares arg

cc6010f

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Check boosted shares via subgraph

743f179

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add vault proportions

f314a01

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Merge branch 'master' into redeemable-positions

096b2ea

Add logs

bf5d407

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Small refactoring

baf4d2f

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add API rate limits

6c85b19

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Update comment

503c959

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Merge branch 'master' into redeemable-positions

eb4f195

Signed-off-by: cyc60 <avsysoev60@gmail.com> # Conflicts: # poetry.lock

Rename var

6600e0e

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Fix typo

14465fc

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Merge branch 'master' into redeemable-positions

8437f4b

Add tests

248a9be

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Review fixes

5d4eea4

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Review fixes #2

dc38e91

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Merge branch 'master' into redeemable-positions

73899a3

Review fixes #3

89bd7fa

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add merkle root

cb7308d

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add progress bar

625c0ba

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Simplify boosted filters

c455880

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Fetch oseth from graph

1e861b2

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add OsTokenConverter

06e8f81

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add tests

32546bb

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Install multiproof

921dcd2

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add process-redeemer command

ff10073

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Review fixes

1e71e0f

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Rm OS_TOKEN_VAULT_CONTROLLER_CONTRACT_ADDRESS

93b2f65

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Copilot AI reviewed Mar 4, 2026

View reviewed changes

evgeny-stakewise reviewed Mar 4, 2026

View reviewed changes

src/commands/internal/process_redeemer.py Outdated Show resolved Hide resolved

src/commands/internal/process_redeemer.py Show resolved Hide resolved

src/commands/internal/process_redeemer.py Outdated Show resolved Hide resolved

cyc60 added 9 commits March 5, 2026 10:29

Merge branch 'v5-release' into process-redeemer

8bef13b

Use sw utils

03102ed

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Fix redeemable_assets filter

774c62b

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Extract fetch_harvest_params_by_vault from select_positions

f28c964

Refactoring

f4874ac

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add get_multiple_harvest_params

a5efdbe

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Fix nonce

bb35ee1

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Refactor

c434029

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add tests

37dae63

Signed-off-by: cyc60 <avsysoev60@gmail.com>

cyc60 requested a review from Copilot March 6, 2026 18:37

Copilot started reviewing on behalf of cyc60 March 6, 2026 18:37 View session

Copilot AI reviewed Mar 6, 2026

View reviewed changes

cyc60 added 3 commits March 6, 2026 22:05

Refactor get_multiple_harvest_params

acf74df

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Single _try_redeem_meta_vault call

22e846c

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Refactoring

1899d73

Signed-off-by: cyc60 <avsysoev60@gmail.com>

cyc60 requested a review from Copilot March 9, 2026 09:20

Copilot started reviewing on behalf of cyc60 March 9, 2026 09:20 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

cyc60 added 2 commits March 9, 2026 13:03

Handle zero nonce

1f32663

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Fix tests

8c97ae3

Signed-off-by: cyc60 <avsysoev60@gmail.com>

evgeny-stakewise reviewed Mar 10, 2026

View reviewed changes

cyc60 added 3 commits March 10, 2026 16:46

Review fixes #1

88dcdfb

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Add min-queued-assets option

8c2a97c

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Update tests

1d8c5d9

Signed-off-by: cyc60 <avsysoev60@gmail.com>

cyc60 requested a review from Copilot March 10, 2026 15:26

Copilot started reviewing on behalf of cyc60 March 10, 2026 15:27 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Rm double comparison

a4d4608

Signed-off-by: cyc60 <avsysoev60@gmail.com>

Conversation

cyc60 commented Feb 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

evgeny-stakewise left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evgeny-stakewise left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evgeny-stakewise Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

cyc60 Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants