Solidity API

ILiquidityOrchestrator

Interface for the liquidity orchestrator

LiquidityUpkeepPhase

Upkeep phase enum for liquidity orchestration

enum LiquidityUpkeepPhase {
  Idle,
  SellingLeg,
  BuyingLeg,
  FulfillRedeem
}

currentPhase

function currentPhase() external view returns (enum ILiquidityOrchestrator.LiquidityUpkeepPhase)

Returns the current upkeep phase

Return Values

Name	Type	Description
[0]	enum ILiquidityOrchestrator.LiquidityUpkeepPhase	The current LiquidityUpkeepPhase

targetBufferRatio

function targetBufferRatio() external view returns (uint256)

Returns the target buffer ratio

Return Values

Name	Type	Description
[0]	uint256	The target buffer ratio

updateExecutionMinibatchSize

function updateExecutionMinibatchSize(uint8 _executionMinibatchSize) external

Updates the execution minibatch size

Parameters

Name	Type	Description
_executionMinibatchSize	uint8	The new execution minibatch size

updateAutomationRegistry

function updateAutomationRegistry(address newAutomationRegistry) external

Updates the Chainlink Automation Registry address

Parameters

Name	Type	Description
newAutomationRegistry	address	The new automation registry address

setInternalStatesOrchestrator

function setInternalStatesOrchestrator(address _internalStatesOrchestrator) external

Sets the internal states orchestrator address

Can only be called by the contract owner

Parameters

Name	Type	Description
_internalStatesOrchestrator	address	The address of the internal states orchestrator

setSlippageBound

function setSlippageBound(uint256 _slippageBound) external

Sets the slippage bound

Parameters

Name	Type	Description
_slippageBound	uint256	The new slippage bound

claimProtocolFees

function claimProtocolFees(uint256 amount) external

Claim protocol fees with specified amount

Called by the Owner to claim a specific amount of protocol fees

Parameters

Name	Type	Description
amount	uint256	The amount of protocol fees to claim

setExecutionAdapter

function setExecutionAdapter(address asset, contract IExecutionAdapter adapter) external

Register or replace the execution adapter for an asset.

Can only be called by the Orion Config contract.

Parameters

Name	Type	Description
asset	address	The address of the asset.
adapter	contract IExecutionAdapter	The execution adapter for the asset.

unsetExecutionAdapter

function unsetExecutionAdapter(address asset) external

Unregister the execution adapter for an asset.

Can only be called by the Orion Config contract.

Parameters

Name	Type	Description
asset	address	The address of the asset.

returnDepositFunds

function returnDepositFunds(address user, uint256 amount) external

Return deposit funds to a user who cancelled their deposit request

Called by vault contracts when users cancel deposit requests

Parameters

Name	Type	Description
user	address	The user to return funds to
amount	uint256	The amount to return

transferCuratorFees

function transferCuratorFees(uint256 amount) external

Transfer pending curator fees to a vault owner

Called by vault contracts when vault owners claim their fees

Parameters

Name	Type	Description
amount	uint256	The amount of fees to transfer

transferRedemptionFunds

function transferRedemptionFunds(address user, uint256 amount) external

Transfer redemption funds to a user after shares are burned

Called by vault contracts when processing redemption requests

Parameters

Name	Type	Description
user	address	The user to transfer funds to
amount	uint256	The amount of underlying assets to transfer