Dev

[matteoettam09]

Summary by CodeRabbit

• New Features

  • Enhanced minibatch processing with progress tracking for improved efficiency and reliability of large batch operations.
  • Added configurable controls for vault redeem fulfillment management.

• Chores

  • Version bumped to 2.5.0.
  • Updated development dependencies and build tooling.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 36de948f-1e2b-44ba-98f4-c28d8e23115b

📥 Commits

Reviewing files that changed from the base of the PR and between 64c25c3 and 723d066.

📒 Files selected for processing (4)

• contracts/interfaces/ILiquidityOrchestrator.sol
• contracts/test/LiquidityOrchestratorHarness.sol
• contracts/test/MockERC4626WithSettableDecimals.sol
• contracts/test/MockNoDecimalsAsset.sol

💤 Files with no reviewable changes (4)

• contracts/test/MockNoDecimalsAsset.sol
• contracts/test/LiquidityOrchestratorHarness.sol
• contracts/interfaces/ILiquidityOrchestrator.sol
• contracts/test/MockERC4626WithSettableDecimals.sol

---

📝 Walkthrough

Walkthrough

LiquidityOrchestrator adds a resume cursor to track progress within sell/buy minibatch windows, refactors minibatch execution into a unified resumable handler with failure recording, extends VaultState with a processRedeem flag to conditionally gate redeem fulfillment per vault, relaxes configuration constraints for mid-epoch maintenance, removes test mock contracts, and bumps package version to 2.5.0 with updated dependencies.

Changes

Resume Cursor & Conditional Redeem Fulfillment

Layer / File(s)	Summary
Resume cursor state and interface contracts/LiquidityOrchestrator.sol, contracts/interfaces/ILiquidityOrchestrator.sol	Public completedInCurrentMinibatch state variable tracks intra-minibatch progress, with a new external view getter exposing resume position within the active sell/buy window.
Resume cursor lifecycle resets contracts/LiquidityOrchestrator.sol	Cursor resets to zero at upkeep epoch start, epoch state commitment seal, and vault-operation minibatch completion.
Unified minibatch leg processing with resume support contracts/LiquidityOrchestrator.sol	Refactored _processMinibatchLeg consolidates sell/buy logic into a single resumable handler that computes bounded windows, increments cursor on successful execution, records failures without advancing cursor, and drives phase transitions via _finalizeMinibatchLeg.
VaultState processRedeem control field contracts/interfaces/ILiquidityOrchestrator.sol	Removes VaultStateData struct; extends VaultState with bool processRedeem to signal per-vault redeem fulfillment control.
Conditional redeem fulfillment implementation contracts/LiquidityOrchestrator.sol, contracts/test/LiquidityOrchestratorHarness.sol, test/VaultDecommissioning.test.ts	Routes processRedeem flag through _processSingleVaultOperations and gates redeem execution to if (processRedeem && pendingRedeem > 0), leaving deposit fulfillments unaffected. Test harness and existing tests updated to pass the new parameter.

Configuration, Maintenance, & Cleanup

Layer / File(s)	Summary
Configuration and upgrade adjustments contracts/LiquidityOrchestrator.sol, contracts/interfaces/ILiquidityOrchestrator.sol, contracts/test/LiquidityOrchestratorHarness.sol	Minibatch size configuration now requires system idle only when changing non-zero values; updateVerifier directly assigns and emits without state guard; updateVKey removes system-idle check for mid-epoch flexibility. Interface documentation updated for coordinated verifier replacement and new vKey validation. Storage gap adjusted from 47 to 46.
Test mock contract removals contracts/test/MockERC4626WithSettableDecimals.sol	Removed test mocks for runtime-configurable token decimals and reverting decimals calls.
Package version and development dependencies package.json	Version bumped to 2.5.0; Hardhat upgraded to 3.8.0; Nomicfoundation tooling suite, TypeScript ESLint, and pnpm overrides updated.

Sequence Diagram

sequenceDiagram
  participant Caller as Upkeep Caller
  participant Orchestrator as LiquidityOrchestrator
  participant MinibatchLeg as _processMinibatchLeg
  participant Finalize as _finalizeMinibatchLeg
  participant VaultOps as _processSingleVaultOperations

  Caller->>Orchestrator: continueUpkeepEpoch()
  Orchestrator->>MinibatchLeg: _processMinibatchSell/Buy(leg)
  MinibatchLeg->>MinibatchLeg: compute window [currentIndex + completedInCurrentMinibatch, endIndex]
  loop for each token in window
    MinibatchLeg->>MinibatchLeg: execute swap/transfer
    alt success
      MinibatchLeg->>MinibatchLeg: completedInCurrentMinibatch++
    else failure
      MinibatchLeg->>MinibatchLeg: record failed token, refresh commitment
    end
  end
  alt leg complete
    Orchestrator->>Finalize: _finalizeMinibatchLeg()
    Finalize->>Orchestrator: advance phase, accrue buy fees
  end
  Orchestrator->>VaultOps: _processSingleVaultOperations(vault, processRedeem=true/false, ...)
  alt processRedeem && pendingRedeem > 0
    VaultOps->>VaultOps: fulfill redemptions
  else
    VaultOps->>VaultOps: skip redeem (deposit unaffected)
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• OrionFinanceAI/protocol#230: Both PRs modify _processSingleVaultOperations—this PR adds a processRedeem parameter and gate, while #230 updates decommission-finalization logic in the same function.
• OrionFinanceAI/protocol#91: This PR's processRedeem gating of redeem fulfillment relates to #91's refactoring of the order in which deposit and redeem fulfillments are processed.
• OrionFinanceAI/protocol#228: Both PRs adjust __gap storage layout in LiquidityOrchestrator to accommodate new state variables.

Poem

🐰 A cursor hops through minibatch rows,
remembering where each leg flow goes—
resume on fail, no state is lost!
Redeems now dance to vault's own cost.
The gap shrinks tight, the code leaps free. ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The PR title 'Dev' is vague and non-descriptive, failing to convey any meaningful information about the substantial changes in the changeset.	Replace the title with a concise, descriptive summary of the main change, such as 'Add resume cursor and vault operation flag for minibatch processing' or similar that captures the core intent.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dev

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

contracts/LiquidityOrchestrator.sol (1)

477-480: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Seed bufferAmount only on the first entry into the sell leg.

If minibatch 0 partially succeeds and a later slot fails, completedInCurrentMinibatch preserves the resume point, but this block overwrites bufferAmount again on the retry. That drops the realized execution delta from the already-filled slots and leaves the persisted buffer accounting behind the actual balances.

Suggested fix

-            if (currentMinibatchIndex == 0) {
+            if (currentMinibatchIndex == 0 && completedInCurrentMinibatch == 0) {
                 bufferAmount = states.bufferAmount;
                 _pendingEpochProtocolFees = states.epochProtocolFees;
             }

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@contracts/LiquidityOrchestrator.sol` around lines 477 - 480, The code
currently re-seeds bufferAmount (and _pendingEpochProtocolFees) whenever
currentMinibatchIndex == 0, which can overwrite already-realized execution
deltas on retry; change the guard so these values are initialized only when
entering the sell leg for the first time by requiring
completedInCurrentMinibatch == 0 as well (i.e., use if (currentMinibatchIndex ==
0 && completedInCurrentMinibatch == 0) before assigning bufferAmount =
states.bufferAmount and _pendingEpochProtocolFees = states.epochProtocolFees) so
resumed retries do not reset persisted buffer accounting.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@contracts/test/ConfigurableExecutionAdapter.sol`:
- Around line 49-60: The buy function currently only pulls UNDERLYING from the
caller and returns buyReturnAmount but never sends the purchased asset back;
update the buy implementation (function buy, variables UNDERLYING,
buyReturnAmount, buyCallCount, buyShouldRevert) to transfer the purchased asset
to the caller before returning — e.g., after taking allowance but before
returning executionUnderlyingAmount, call the token transfer for the purchased
asset (use the same SafeERC20 helpers used elsewhere, e.g.
IERC20(asset).safeTransfer(msg.sender, buyReturnAmount)) and ensure the contract
holds enough of the asset to cover the transfer.

In `@package.json`:
- Around line 40-50: The project is pulling Hardhat v2 via the
`@openzeppelin/hardhat-upgrades` package; update or replace that package so the
dependency graph resolves only Hardhat v3. Specifically, either upgrade
"`@openzeppelin/hardhat-upgrades`" to a Hardhat-3-compatible release (or switch to
an alternative upgrades plugin that supports Hardhat 3) in package.json, remove
any pinned/override entries that force hardhat@2, then regenerate the lockfile
(pnpm install) and confirm via the lockfile that no package (e.g.,
"`@openzeppelin/hardhat-upgrades`") still resolves hardhat@2.28.6; run the repo's
test/CI to ensure everything works with hardhat@3.x.

In `@test/StatesStruct.test.ts`:
- Line 18: The tests import STATES_STRUCT_TYPE from
../scripts/decode-states-struct but that module/file doesn't exist; create a
module that exports STATES_STRUCT_TYPE (or update the import to point to the
correct existing module). Locate the failing import in test/StatesStruct.test.ts
referencing STATES_STRUCT_TYPE and either (a) add a new
scripts/decode-states-struct.ts that exports the expected constant/type
(matching the shape used by the tests), or (b) change the import to the actual
module that defines the states struct; ensure the exported identifier name is
exactly STATES_STRUCT_TYPE so the test import resolves.

---

Outside diff comments:
In `@contracts/LiquidityOrchestrator.sol`:
- Around line 477-480: The code currently re-seeds bufferAmount (and
_pendingEpochProtocolFees) whenever currentMinibatchIndex == 0, which can
overwrite already-realized execution deltas on retry; change the guard so these
values are initialized only when entering the sell leg for the first time by
requiring completedInCurrentMinibatch == 0 as well (i.e., use if
(currentMinibatchIndex == 0 && completedInCurrentMinibatch == 0) before
assigning bufferAmount = states.bufferAmount and _pendingEpochProtocolFees =
states.epochProtocolFees) so resumed retries do not reset persisted buffer
accounting.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4671ed97-bc0c-424d-9e67-e3d469629fc8

📥 Commits

Reviewing files that changed from the base of the PR and between 557e9f7 and 64c25c3.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (7)

• contracts/LiquidityOrchestrator.sol
• contracts/interfaces/ILiquidityOrchestrator.sol
• contracts/test/ConfigurableExecutionAdapter.sol
• contracts/test/LiquidityOrchestratorHarness.sol
• package.json
• test/StatesStruct.test.ts
• test/VaultDecommissioning.test.ts