IOrionVault
IOrionVault
Interface for Orion vaults
SynchronousCallDisabled
error SynchronousCallDisabled()
External synchronous calls are disabled in the current context.
DepositRequest
event DepositRequest(address sender, uint256 assets)
A deposit request has been made by a user.
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | The address of the user making the deposit request. |
| assets | uint256 | The amount of assets being deposited. |
DepositRequestCancelled
event DepositRequestCancelled(address user, uint256 amount)
A deposit request has been cancelled.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user whose deposit request was cancelled. |
| amount | uint256 | The amount of assets that were requested for deposit. |
RedeemRequest
event RedeemRequest(address sender, uint256 shares)
A redemption request has been made by a user.
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | The address of the user making the redemption request. |
| shares | uint256 | The number of shares being redeemed. |
RedeemRequestCancelled
event RedeemRequestCancelled(address user, uint256 shares)
A redemption request has been cancelled.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user whose redemption request was cancelled. |
| shares | uint256 | The number of shares that were requested for redemption. |
StrategistUpdated
event StrategistUpdated(address newStrategist)
The strategist has been updated.
Parameters
| Name | Type | Description |
|---|---|---|
| newStrategist | address | The new strategist address. |
VaultFeeModelUpdated
event VaultFeeModelUpdated(uint8 mode, uint16 performanceFee, uint16 managementFee)
The fee model has been updated.
Parameters
| Name | Type | Description |
|---|---|---|
| mode | uint8 | The new calculation mode. |
| performanceFee | uint16 | The new performance fee in basis points. |
| managementFee | uint16 | The new management fee in basis points. |
Redeem
event Redeem(address user, uint256 redeemAmount, uint256 sharesBurned)
A redemption request has been fulfilled.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user whose redemption was fulfilled. |
| redeemAmount | uint256 | The amount of assets redeemed by the user. |
| sharesBurned | uint256 | The number of shares burned for the user. |
VaultWhitelistUpdated
event VaultWhitelistUpdated(address[] assets)
The vault whitelist has been updated.
Parameters
| Name | Type | Description |
|---|---|---|
| assets | address[] | The new whitelist of assets. |
VaultFeesAccrued
event VaultFeesAccrued(uint256 managementFee, uint256 performanceFee)
Fees have been accrued.
Parameters
| Name | Type | Description |
|---|---|---|
| managementFee | uint256 | The amount of management fees accrued. |
| performanceFee | uint256 | The amount of performance fees accrued. |
VaultFeesClaimed
event VaultFeesClaimed(address manager, uint256 feeAmount)
Fees have been claimed.
Parameters
| Name | Type | Description |
|---|---|---|
| manager | address | The address of the manager who claimed the fees. |
| feeAmount | uint256 | The amount of fees claimed. |
DepositAccessControlUpdated
event DepositAccessControlUpdated(address newDepositAccessControl)
The deposit access control contract has been updated.
Parameters
| Name | Type | Description |
|---|---|---|
| newDepositAccessControl | address | The new deposit access control contract address (address(0) = permissionless). |
config
function config() external view returns (contract IOrionConfig)
Orion config getter
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | contract IOrionConfig | The Orion config contract address |
manager
function manager() external view returns (address)
Manager getter
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | address | The manager address |
strategist
function strategist() external view returns (address)
Strategist getter
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | address | The strategist address |
pendingVaultFees
function pendingVaultFees() external view returns (uint256)
Pending vault fees getter
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | Pending vault fees amount |
convertToAssetsWithPITTotalAssets
function convertToAssetsWithPITTotalAssets(uint256 shares, uint256 pointInTimeTotalAssets, enum Math.Rounding rounding) external view returns (uint256)
Convert shares to assets with point in time total assets.
Parameters
| Name | Type | Description |
|---|---|---|
| shares | uint256 | The amount of shares to convert. |
| pointInTimeTotalAssets | uint256 | The point in time total assets. |
| rounding | enum Math.Rounding | The rounding mode. |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | The amount of assets. |
implementation
function implementation() external view returns (address)
Returns the implementation address of this proxy contract
This function enables third-party protocol integrations to verify that the implementation address has not been modified unexpectedly. It reads the beacon address from the ERC-1967 storage slot and returns the implementation address from the beacon.
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | address | The address of the implementation contract |
overrideIntentForDecommissioning
function overrideIntentForDecommissioning() external
Override intent to 100% underlying asset for decommissioning
Can only be called by the OrionConfig contract
requestDeposit
function requestDeposit(uint256 assets) external
Submit an asynchronous deposit request.
No share tokens are minted immediately. The specified amount of underlying tokens is transferred to the liquidity orchestrator for centralized liquidity management.
Parameters
| Name | Type | Description |
|---|---|---|
| assets | uint256 | The amount of the underlying asset to deposit. |
cancelDepositRequest
function cancelDepositRequest(uint256 amount) external
Cancel a previously submitted deposit request.
Allows LPs to withdraw their funds before any share tokens are minted. The request must still have enough balance remaining to cover the cancellation. Funds are returned from the liquidity orchestrator to the LP.
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of funds to withdraw. |
requestRedeem
function requestRedeem(uint256 shares) external
Submit a redemption request.
No share tokens are burned immediately. The specified amount of share tokens is transferred to the vault.
Parameters
| Name | Type | Description |
|---|---|---|
| shares | uint256 | The amount of the share tokens to withdraw. |
cancelRedeemRequest
function cancelRedeemRequest(uint256 shares) external
Cancel a previously submitted redemption request.
Allows LPs to recover their share tokens before any burning occurs. The request must still have enough shares remaining to cover the cancellation. Share tokens are returned from the vault.
Parameters
| Name | Type | Description |
|---|---|---|
| shares | uint256 | The amount of share tokens to recover. |
updateStrategist
function updateStrategist(address newStrategist) external
Update the strategist address
The strategist is responsible for setting allocation logic for the vault's assets. This function enables managers to update the strategist. Strategist can be a smart contract or an address. It is the FULL responsibility of the manager to ensure the strategist is capable of performing its duties.
Parameters
| Name | Type | Description |
|---|---|---|
| newStrategist | address | The new strategist address. |
updateVaultWhitelist
function updateVaultWhitelist(address[] assets) external
Update the vault whitelist
Parameters
| Name | Type | Description |
|---|---|---|
| assets | address[] | The new whitelist of assets. |
vaultWhitelist
function vaultWhitelist() external view returns (address[])
Get the vault whitelist
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | address[] | The array of whitelisted asset addresses for this vault. |
updateFeeModel
function updateFeeModel(uint8 mode, uint16 performanceFee, uint16 managementFee) external
Update the fee model parameters
Parameters
| Name | Type | Description |
|---|---|---|
| mode | uint8 | The calculation mode for fees |
| performanceFee | uint16 | The performance fee |
| managementFee | uint16 | The management fee |
claimVaultFees
function claimVaultFees(uint256 amount) external
Claim accrued vault fees
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | The amount of vault fees to claim |
setDepositAccessControl
function setDepositAccessControl(address newDepositAccessControl) external
Set deposit access control contract
Only callable by vault manager It is the FULL responsibility of the vault manager to ensure the deposit access control is capable of performing its duties.
Parameters
| Name | Type | Description |
|---|---|---|
| newDepositAccessControl | address | Address of the new access control contract (address(0) = permissionless) |
pendingDeposit
function pendingDeposit(uint256 fulfillBatchSize) external view returns (uint256)
Get total pending deposit amount across all users
This returns asset amounts, not share amounts
Parameters
| Name | Type | Description |
|---|---|---|
| fulfillBatchSize | uint256 | The maximum number of requests to process per fulfill call |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | Total pending deposits denominated in underlying asset units (e.g., USDC, ETH) |
pendingRedeem
function pendingRedeem(uint256 fulfillBatchSize) external view returns (uint256)
Get total pending redemption shares across all users
This returns share amounts, not underlying asset amounts
Parameters
| Name | Type | Description |
|---|---|---|
| fulfillBatchSize | uint256 | The maximum number of requests to process per fulfill call |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | Total pending redemptions denominated in vault share units |
vaultFee
function vaultFee(uint256 totalAssets) external view returns (uint256 managementFee, uint256 performanceFee)
Calculate the vault's fee based on total assets
Warning: Calling this function mid-epoch may return inaccurate results since fees are calculated based on the full epoch duration
Parameters
| Name | Type | Description |
|---|---|---|
| totalAssets | uint256 | The total assets under management |
Return Values
| Name | Type | Description |
|---|---|---|
| managementFee | uint256 | The management fee amount in underlying asset units |
| performanceFee | uint256 | The performance fee amount in underlying asset units |
fulfillDeposit
function fulfillDeposit(uint256 depositTotalAssets) external
Process all pending deposit requests and mint shares to depositors
Parameters
| Name | Type | Description |
|---|---|---|
| depositTotalAssets | uint256 | The total assets associated with the deposit requests |
fulfillRedeem
function fulfillRedeem(uint256 redeemTotalAssets) external
Process all pending redemption requests and burn shares from redeemers
Parameters
| Name | Type | Description |
|---|---|---|
| redeemTotalAssets | uint256 | The total assets associated with the redemption requests |
accrueVaultFees
function accrueVaultFees(uint256 managementFee, uint256 performanceFee) external
Accrue vault fees for a specific epoch
Parameters
| Name | Type | Description |
|---|---|---|
| managementFee | uint256 | The amount of management fees to accrue in underlying asset units |
| performanceFee | uint256 | The amount of performance fees to accrue in underlying asset units |