Events

List of most common events.

DepositLimitUpdated

event DepositLimitUpdated(uint256 limit)

Emitted when the vault's deposit limit is updated.

Parameters

Name	Type	Indexed	Description
limit	uint256	false	The new maximum amount of assets allowed in the vault.

PeriodConfiguration

event PeriodConfigurationAdded(struct PeriodConfiguration periodConfiguration)

Parameters

Name	Type	Indexed	Description
periodconfiguration	struct PeriodConfiguration	false	The details of the newly added periodConfiguration.

WithdrawRequest

event WithdrawRequest(address indexed sender, address indexed receiver, address indexed owner, uint256 period, uint256 assets, uint256 shares)

Emitted when a withdrawal request is created by a user.

Parameters

Name	Type	Indexed	Description
sender	address	true	The caller who initiated the withdrawal request.
reciever	address	true	The address that will receive the assets in the next period.
owner	address	true	The address whose shares are being redeemed, using allowance.
period	uint256	false	The period when the withdrawal will be available.
assets	uint256	false	The amount of assets to be withdrawn.
shares	uint256	false	The number of shares burned for the withdrawal.

CompleteWithdraw

event CompleteWithdraw(address indexed receiver, uint256 assets, uint256 period)

Emitted when a user successfully claims a withdrawal for a given period.

Parameters

Name	Type	Indexed	Description
receiver	address	true	The address that received the withdrawn assets.
assets	uint256	false	The amount of assets withdrawn.
period	uint256	false	The period for which the withdrawal was claimed.

SharesRescuedFromBlocklisted

event WithdrawRescuedFromBlocklisted(address from, address to, uint256[] periods, uint256[] rescuedShares)

Emitted when a user with RESCUER_ROLE successfully rescues a pending withdrawal from blocklisted address.

Parameters

Name	Type	Indexed	Description
from	address	false	The blocklisted address.
to	address	false	The beneficiary of the rescued withdrawals.
periods	uint256[]	false	The array of periods rescued.
rescuedShares	uint256[]	false	The array of pending shares from withdrawals rescued for each period.