Skip to main content

For AI agents: the complete documentation index is at llms.txt. Markdown versions of pages are available by appending .md to the URL or sending Accept: text/markdown.

EventsLib

EventsLib​

Centralized library of events emitted throughout the Orion protocol.

WhitelistedAssetAdded​

event WhitelistedAssetAdded(address asset)

A new asset has been whitelisted for protocol usage.

Parameters​

NameTypeDescription
assetaddressThe address of the whitelisted asset.

WhitelistedAssetRemoved​

event WhitelistedAssetRemoved(address asset)

An asset has been removed from the whitelist.

Parameters​

NameTypeDescription
assetaddressThe address of the removed asset.

AssetDecommissioningInitiated​

event AssetDecommissioningInitiated(address asset)

Asset marked for decommissioning (stays whitelisted until completeAssetRemoval).

Parameters​

NameTypeDescription
assetaddressThe address of the asset marked for decommissioning.

OrionVaultAdded​

event OrionVaultAdded(address vault)

A new Orion Vault has been registered in the protocol.

Parameters​

NameTypeDescription
vaultaddressThe address of the added vault.

RiskFreeRateUpdated​

event RiskFreeRateUpdated(uint16 riskFreeRate)

The risk-free rate has been updated.

Parameters​

NameTypeDescription
riskFreeRateuint16The new risk-free rate in basis points.

MinDepositAmountUpdated​

event MinDepositAmountUpdated(uint256 minDepositAmount)

The minimum deposit amount has been updated.

Parameters​

NameTypeDescription
minDepositAmountuint256The new minimum deposit amount.

MinRedeemAmountUpdated​

event MinRedeemAmountUpdated(uint256 minRedeemAmount)

The minimum redeem amount has been updated.

Parameters​

NameTypeDescription
minRedeemAmountuint256The new minimum redeem amount.

FeeChangeCooldownDurationUpdated​

event FeeChangeCooldownDurationUpdated(uint256 newCooldownDuration)

The fee change cooldown duration has been updated.

Parameters​

NameTypeDescription
newCooldownDurationuint256The new cooldown duration in seconds.

MaxFulfillBatchSizeUpdated​

event MaxFulfillBatchSizeUpdated(uint256 maxFulfillBatchSize)

The maximum fulfill batch size has been updated.

Parameters​

NameTypeDescription
maxFulfillBatchSizeuint256The new maximum fulfill batch size.

VaultFeeChangeScheduled​

event VaultFeeChangeScheduled(uint8 feeType, uint16 performanceFee, uint16 managementFee, uint256 newFeeRatesTimestamp)

A vault fee model change has been scheduled.

Parameters​

NameTypeDescription
feeTypeuint8The new fee type.
performanceFeeuint16The new performance fee.
managementFeeuint16The new management fee.
newFeeRatesTimestampuint256The timestamp when the new fee rates become effective.

ProtocolFeeChangeScheduled​

event ProtocolFeeChangeScheduled(uint16 nettingFeeCoefficient, uint16 rsFeeCoefficient, uint256 newProtocolFeeRatesTimestamp)

A protocol fee change has been scheduled.

Parameters​

NameTypeDescription
nettingFeeCoefficientuint16The new netting fee coefficient (bps of netted rebalance volume).
rsFeeCoefficientuint16The new revenue share fee coefficient.
newProtocolFeeRatesTimestampuint256The timestamp when the new protocol fee rates become effective.

GuardianUpdated​

event GuardianUpdated(address guardian)

The guardian address has been updated.

Parameters​

NameTypeDescription
guardianaddressThe new guardian address.

ProtocolPaused​

event ProtocolPaused(address pauser)

The protocol has been paused.

Parameters​

NameTypeDescription
pauseraddressThe address that triggered the pause.

ProtocolUnpaused​

event ProtocolUnpaused(address unpauser)

The protocol has been unpaused.

Parameters​

NameTypeDescription
unpauseraddressThe address that triggered the unpause.

ManagerAdded​

event ManagerAdded(address manager)

A manager has been added to the whitelist.

Parameters​

NameTypeDescription
manageraddressThe address of the manager that was added.

ManagerRemoved​

event ManagerRemoved(address manager)

A manager has been removed from the whitelist.

Parameters​

NameTypeDescription
manageraddressThe address of the manager that was removed.

OrderSubmitted​

event OrderSubmitted(address strategist, address[] assets, uint256[] weights)

A new order has been submitted.

Parameters​

NameTypeDescription
strategistaddressThe address of the strategist who submitted the order.
assetsaddress[]Array of token addresses in the order.
weightsuint256[]Array of weights in the order (parallel to assets array).

VaultStateUpdated​

event VaultStateUpdated(uint256 newTotalAssets, uint256 totalSupply, uint256 currentSharePrice, uint256 highWaterMark, address[] tokens, uint256[] shares)

The vault's state has been updated with complete portfolio information.

Parameters​

NameTypeDescription
newTotalAssetsuint256The new total assets value for the vault.
totalSupplyuint256The total supply of the vault.
currentSharePriceuint256The current share price of the vault.
highWaterMarkuint256The new high watermark value for the vault.
tokensaddress[]Array of token addresses in the portfolio.
sharesuint256[]Array of shares per asset (parallel to tokens array).

ConfidentialOrderSubmitted​

event ConfidentialOrderSubmitted(address strategist)

A confidential intent ciphertext was submitted.

Parameters​

NameTypeDescription
strategistaddressThe strategist who submitted the intent.

ConfidentialVaultStateUpdated​

event ConfidentialVaultStateUpdated(uint256 newTotalAssets, uint256 totalSupply, uint256 currentSharePrice, uint256 highWaterMark)

The vault's state has been updated without portfolio information.

Parameters​

NameTypeDescription
newTotalAssetsuint256The new total assets value for the vault.
totalSupplyuint256The total supply of the vault.
currentSharePriceuint256The current share price of the vault.
highWaterMarkuint256The new high watermark value for the vault.

AutomationRegistryUpdated​

event AutomationRegistryUpdated(address newAutomationRegistry)

The automation registry address has been updated.

Parameters​

NameTypeDescription
newAutomationRegistryaddressThe address of the new automation registry.

SP1VerifierUpdated​

event SP1VerifierUpdated(address newVerifier)

The SP1 verifier contract address has been updated.

Parameters​

NameTypeDescription
newVerifieraddressThe address of the new SP1 verifier contract.

VKeyUpdated​

event VKeyUpdated(bytes32 vKey)

The internal state orchestrator verification key has been updated.

Parameters​

NameTypeDescription
vKeybytes32The new verification key.

EpochStart​

event EpochStart(uint256 epochCounter, address[] assets, uint256[] prices)

A new epoch has started.

Parameters​

NameTypeDescription
epochCounteruint256The current epoch counter.
assetsaddress[]Array of asset addresses.
pricesuint256[]Array of asset prices (parallel to assets array).

EpochStateCommitted​

event EpochStateCommitted(uint256 epochCounter, bytes32 epochStateCommitment)

The epoch state commitment has been committed.

Parameters​

NameTypeDescription
epochCounteruint256The current epoch counter.
epochStateCommitmentbytes32The epoch state commitment.

EpochProtocolStateHashed​

event EpochProtocolStateHashed(uint256 epochCounter, bytes32 protocolStateHash, uint256 loBalanceUnderlying)

Protocol state hash built for this epoch.

Parameters​

NameTypeDescription
epochCounteruint256Current epoch.
protocolStateHashbytes32Result of _buildProtocolStateHash.
loBalanceUnderlyinguint256Mid-tx LO.balanceOf(underlying).

EpochEnd​

event EpochEnd(uint256 epochCounter, uint256 nettedRebalanceVolumeUnderlying)

The portfolio has been rebalanced.

Parameters​

NameTypeDescription
epochCounteruint256The epoch that has just completed.
nettedRebalanceVolumeUnderlyinguint256Zk-reported netted rebalance volume in underlying (from StatesStruct).

EpochSellExecuted​

event EpochSellExecuted(uint256 epochCounter, address asset, uint256 executionUnderlyingAmount, uint256 sharesAmount, uint256 estimatedUnderlyingAmount)

Sell leg executed during upkeep: vault shares swapped to underlying via the execution adapter.

Parameters​

NameTypeDescription
epochCounteruint256Epoch id at execution time (EpochEnd increments after the batch that uses this counter).
assetaddressasset shares sold through the adapter.
executionUnderlyingAmountuint256Underlying actually received (adapter.sell return).
sharesAmountuint256Share tokens sold into the adapter.
estimatedUnderlyingAmountuint256Upkeep estimate before routing to the adapter.

EpochBuyExecuted​

event EpochBuyExecuted(uint256 epochCounter, address asset, uint256 executionUnderlyingAmount, uint256 sharesAmount, uint256 estimatedUnderlyingAmount)

Buy leg executed during upkeep: underlying spent for vault shares via the execution adapter.

Parameters​

NameTypeDescription
epochCounteruint256Epoch id at execution time (EpochEnd increments after the batch that uses this counter).
assetaddressasset shares purchased from the adapter.
executionUnderlyingAmountuint256Underlying actually spent (adapter.buy return).
sharesAmountuint256Share tokens acquired from the adapter.
estimatedUnderlyingAmountuint256Upkeep estimate before routing to the adapter.

PriceAdapterSet​

event PriceAdapterSet(address asset, address adapter)

A price adapter has been set for an asset.

Parameters​

NameTypeDescription
assetaddressThe address of the asset.
adapteraddressThe address of the price adapter.

ExecutionAdapterSet​

event ExecutionAdapterSet(address asset, address adapter)

An execution adapter has been set for an asset.

Parameters​

NameTypeDescription
assetaddressThe address of the asset.
adapteraddressThe address of the execution adapter.

ProtocolFeesAccrued​

event ProtocolFeesAccrued(uint256 epochProtocolFees)

Protocol fees have been accrued.

Parameters​

NameTypeDescription
epochProtocolFeesuint256The amount of protocol fees accrued for the current epoch.

ProtocolFeesClaimed​

event ProtocolFeesClaimed(uint256 amount)

Protocol fees have been claimed.

Parameters​

NameTypeDescription
amountuint256The amount of protocol fees claimed.

LiquidityDeposited​

event LiquidityDeposited(address depositor, uint256 amount)

Liquidity has been deposited to the protocol buffer.

Parameters​

NameTypeDescription
depositoraddressThe address of the depositor.
amountuint256The amount of liquidity deposited.

LiquidityWithdrawn​

event LiquidityWithdrawn(address withdrawer, uint256 amount)

Liquidity has been withdrawn from the protocol buffer.

Parameters​

NameTypeDescription
withdraweraddressThe address of the withdrawer.
amountuint256The amount of liquidity withdrawn.

VaultType​

Enumeration of available vault types.

enum VaultType {
Transparent,
Encrypted
}

OrionVaultCreated​

event OrionVaultCreated(address vault, address manager, address strategist, string name, string symbol, uint8 feeType, uint16 performanceFee, uint16 managementFee, address depositAccessControl, address holderAccessControl, address transferAccessControl, enum EventsLib.VaultType vaultType)

A new Orion Vault has been created.

Parameters​

NameTypeDescription
vaultaddressThe address of the newly created vault.
manageraddressThe address of the vault's manager.
strategistaddressThe address of the vault's strategist.
namestringThe name of the vault.
symbolstringThe symbol of the vault.
feeTypeuint8The fee type of the vault.
performanceFeeuint16The performance fee of the vault.
managementFeeuint16The management fee of the vault.
depositAccessControladdressThe address of the deposit access control contract (address(0) = permissionless).
holderAccessControladdressThe address of the holder access control contract (address(0) = permissionless).
transferAccessControladdressThe address of the transfer access control contract (address(0) = permissionless).
vaultTypeenum EventsLib.VaultTypeThe type of vault that was created (Transparent or Encrypted).

VaultDecommissioningInitiated​

event VaultDecommissioningInitiated(address vault)

Decommissioning process for a vault has been initiated.

Parameters​

NameTypeDescription
vaultaddressThe address of the vault being decommissioned.

OrionVaultDecommissioned​

event OrionVaultDecommissioned(address vault)

An Orion Vault has been decommissioned.

Parameters​

NameTypeDescription
vaultaddressThe address of the decommissioned vault.

VaultBeaconUpdated​

event VaultBeaconUpdated(address newBeacon)

The vault beacon has been updated.

Parameters​

NameTypeDescription
newBeaconaddressThe address of the new vault beacon.

UpgradeTimelockSet​

event UpgradeTimelockSet(address proxy, address timelock)

The upgrade timelock address has been set on an upgradeable contract.

Parameters​

NameTypeDescription
proxyaddressThe proxy whose timelock was updated.
timelockaddressThe new upgrade timelock address (an OZ TimelockController).