MorphoStakingVaultAdapter
Inherits: AccessControl, ReentrancyGuard, IExternalStakingVault
Title: MorphoStakingVaultAdapter
Generic external vault adapter for Morpho-like third-party vaults.
State Variables
GOVERNANCE_ROLE
bytes32 public constant GOVERNANCE_ROLE = keccak256("GOVERNANCE_ROLE")
VAULT_MANAGER_ROLE
bytes32 public constant VAULT_MANAGER_ROLE = keccak256("VAULT_MANAGER_ROLE")
USDC
IERC20 public immutable USDC
morphoVault
IMockMorphoVault public morphoVault
yieldShift
IYieldShift public yieldShift
yieldVaultId
uint256 public yieldVaultId
principalDeposited
uint256 public principalDeposited
Functions
constructor
Initializes Morpho adapter dependencies and roles.
Configures governance/operator roles and immutable USDC reference.
Notes:
-
security: Validates non-zero dependency addresses and vault id.
-
validation: Reverts on zero address or zero
yieldVaultId_. -
state-changes: Initializes role assignments and adapter dependency pointers.
-
events: No events emitted by constructor.
-
errors: Reverts with
ZeroAddressorInvalidVaulton invalid inputs. -
reentrancy: Not applicable - constructor only.
-
access: Public constructor.
-
oracle: No oracle dependencies.
constructor(address admin, address usdc_, address morphoVault_, address yieldShift_, uint256 yieldVaultId_) ;
Parameters
| Name | Type | Description |
|---|---|---|
admin | address | Admin address granted governance and manager roles. |
usdc_ | address | USDC token address. |
morphoVault_ | address | Mock Morpho vault address. |
yieldShift_ | address | YieldShift contract address. |
yieldVaultId_ | uint256 | YieldShift vault id used when routing harvested yield. |
depositUnderlying
Deposits USDC into the configured Morpho vault.
Pulls USDC from caller, deposits to Morpho, and increases tracked principal.
Notes:
-
security: Restricted to
VAULT_MANAGER_ROLE; protected by nonReentrant. -
validation: Reverts on zero amount or zero-share deposit outcome.
-
state-changes: Increases
principalDepositedand updates vault position. -
events: Emits downstream transfer/deposit events from dependencies.
-
errors: Reverts on transfer/approval/deposit failures.
-
reentrancy: Protected by
nonReentrant. -
access: Restricted to vault manager role.
-
oracle: No oracle dependencies.
function depositUnderlying(uint256 usdcAmount)
external
override
onlyRole(VAULT_MANAGER_ROLE)
nonReentrant
returns (uint256 sharesReceived);
Parameters
| Name | Type | Description |
|---|---|---|
usdcAmount | uint256 | Amount of USDC to deposit (6 decimals). |
Returns
| Name | Type | Description |
|---|---|---|
sharesReceived | uint256 | Morpho vault shares received for the deposit. |
withdrawUnderlying
Withdraws USDC principal from the configured Morpho vault.
Caps withdrawal to tracked principal, redeems from Morpho, then returns USDC to caller.
Notes:
-
security: Restricted to
VAULT_MANAGER_ROLE; protected by nonReentrant. -
validation: Reverts on zero amount or when no principal is tracked.
-
state-changes: Decreases
principalDepositedand updates vault position. -
events: Emits downstream transfer/withdrawal events from dependencies.
-
errors: Reverts on withdrawal mismatch or transfer failures.
-
reentrancy: Protected by
nonReentrant. -
access: Restricted to vault manager role.
-
oracle: No oracle dependencies.
function withdrawUnderlying(uint256 usdcAmount)
external
override
onlyRole(VAULT_MANAGER_ROLE)
nonReentrant
returns (uint256 usdcWithdrawn);
Parameters
| Name | Type | Description |
|---|---|---|
usdcAmount | uint256 | Requested USDC withdrawal amount (6 decimals). |
Returns
| Name | Type | Description |
|---|---|---|
usdcWithdrawn | uint256 | Actual USDC withdrawn and transferred to caller. |
harvestYield
Harvests accrued yield from Morpho and routes it to YieldShift.
Withdraws only the amount above tracked principal, then forwards to YieldShift.
Notes:
-
security: Restricted to
VAULT_MANAGER_ROLE; protected by nonReentrant. -
validation: Reverts only on downstream failures; returns zero when no yield is available.
-
state-changes: Leaves principal unchanged and routes yield through YieldShift.
-
events: Emits downstream transfer/yield events from dependencies.
-
errors: Reverts on downstream withdrawal, approval, or addYield failures.
-
reentrancy: Protected by
nonReentrant. -
access: Restricted to vault manager role.
-
oracle: No oracle dependencies.
function harvestYield()
external
override
onlyRole(VAULT_MANAGER_ROLE)
nonReentrant
returns (uint256 harvestedYield);
Returns
| Name | Type | Description |
|---|---|---|
harvestedYield | uint256 | USDC yield harvested and routed (6 decimals). |
totalUnderlying
Returns current underlying balance controlled by this adapter.
Read helper used by QuantillonVault for exposure accounting.
Notes:
-
security: Read-only helper.
-
validation: No input validation required.
-
state-changes: No state changes.
-
events: No events emitted.
-
errors: May revert if downstream vault read fails.
-
reentrancy: Not applicable for view function.
-
access: Public view.
-
oracle: No oracle dependencies.
function totalUnderlying() external view override returns (uint256 underlyingBalance);
Returns
| Name | Type | Description |
|---|---|---|
underlyingBalance | uint256 | Underlying USDC-equivalent balance in Morpho. |
setMorphoVault
Updates the configured Morpho vault endpoint.
Governance maintenance hook for swapping vault implementation/address.
Notes:
-
security: Restricted to
GOVERNANCE_ROLE. -
validation: Reverts on zero address input.
-
state-changes: Updates
morphoVaultpointer. -
events: Emits
MorphoVaultUpdated. -
errors: Reverts with
ZeroAddressfor invalid input. -
reentrancy: No external calls after state change.
-
access: Restricted to governance role.
-
oracle: No oracle dependencies.
function setMorphoVault(address newMorphoVault) external onlyRole(GOVERNANCE_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
newMorphoVault | address | New Morpho vault address. |
setYieldShift
Updates YieldShift destination contract.
Governance maintenance hook for yield routing dependency changes.
Notes:
-
security: Restricted to
GOVERNANCE_ROLE. -
validation: Reverts on zero address input.
-
state-changes: Updates
yieldShiftdependency pointer. -
events: Emits
YieldShiftUpdated. -
errors: Reverts with
ZeroAddressfor invalid input. -
reentrancy: No external calls after state change.
-
access: Restricted to governance role.
-
oracle: No oracle dependencies.
function setYieldShift(address newYieldShift) external onlyRole(GOVERNANCE_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
newYieldShift | address | New YieldShift contract address. |
setYieldVaultId
Updates destination vault id used when routing harvested yield.
Governance maintenance hook aligning adapter output with YieldShift vault mapping.
Notes:
-
security: Restricted to
GOVERNANCE_ROLE. -
validation: Reverts when
newYieldVaultIdis zero. -
state-changes: Updates
yieldVaultId. -
events: Emits
YieldVaultIdUpdated. -
errors: Reverts with
InvalidVaultfor zero id. -
reentrancy: No external calls after state change.
-
access: Restricted to governance role.
-
oracle: No oracle dependencies.
function setYieldVaultId(uint256 newYieldVaultId) external onlyRole(GOVERNANCE_ROLE);
Parameters
| Name | Type | Description |
|---|---|---|
newYieldVaultId | uint256 | New YieldShift vault id. |
Events
MorphoVaultUpdated
event MorphoVaultUpdated(address indexed oldVault, address indexed newVault);
YieldShiftUpdated
event YieldShiftUpdated(address indexed oldYieldShift, address indexed newYieldShift);
YieldVaultIdUpdated
event YieldVaultIdUpdated(uint256 indexed oldVaultId, uint256 indexed newVaultId);