← Back to contracts

Code

Structs & Types

Caps

struct Caps {
    uint256 allocation;
    uint128 absoluteCap;
    uint128 relativeCap;
}

External Functions

deposit

function deposit(uint256 assets, address onBehalf) external returns (uint256)

Deposits assets of the underlying token to mint vault shares for onBehalf.

Parameters:

Return Values:

mint

function mint(uint256 shares, address onBehalf) external returns (uint256)

Mints exactly shares vault shares for onBehalf by depositing the required amount of the underlying token.

Parameters:

Return Values:

withdraw

function withdraw(uint256 assets, address receiver, address onBehalf) public returns (uint256)

Withdraws assets of the underlying token by burning shares from onBehalf and sends them to receiver.

Parameters:

Return Values:

redeem

function redeem(uint256 shares, address receiver, address onBehalf) external returns (uint256)

Burns exactly shares vault shares from onBehalf and sends the corresponding amount of underlying assets to receiver.

Parameters:

Return Values:

forceDeallocate

function forceDeallocate(address adapter, bytes memory data, uint256 assets, address onBehalf) external returns (uint256)

Forcibly deallocates assets from a specific adapter to the vault's idle pool. A penalty is taken from onBehalf's shares to disincentivize misuse. This function is permissionless and serves as an in-kind redemption mechanism.

Parameters:

Return Values:

accrueInterest

function accrueInterest() public

Accrues interest for the vault by querying adapters for their current assets and updating totalAssets. This function is called by most state-changing functions.

accrueInterestView

function accrueInterestView() public view returns (uint256, uint256, uint256)

Returns the view version of interest accrual without updating state.

Return Values:

previewDeposit

function previewDeposit(uint256 assets) public view returns (uint256)

Returns previewed minted shares for a given asset amount.

Parameters:

Return Values:

previewMint

function previewMint(uint256 shares) public view returns (uint256)

Returns previewed deposited assets for a given share amount.

Parameters:

Return Values:

previewWithdraw

function previewWithdraw(uint256 assets) public view returns (uint256)

Returns previewed redeemed shares for a given asset amount.

Parameters:

Return Values:

previewRedeem

function previewRedeem(uint256 shares) public view returns (uint256)

Returns previewed withdrawn assets for a given share amount.

Parameters:

Return Values:

convertToShares

function convertToShares(uint256 assets) external view returns (uint256)

Returns corresponding shares (rounded down) for a given asset amount. Takes into account performance and management fees.

Parameters:

Return Values:

convertToAssets

function convertToAssets(uint256 shares) external view returns (uint256)

Returns corresponding assets (rounded down) for a given share amount. Takes into account performance and management fees.

Parameters:

Return Values:

maxDeposit

function maxDeposit(address) external pure returns (uint256)

Returns the maximum amount of assets that can be deposited. Always returns 0 due to gate complexity.

maxMint

function maxMint(address) external pure returns (uint256)

Returns the maximum amount of shares that can be minted. Always returns 0 due to gate complexity.

maxWithdraw

function maxWithdraw(address) external pure returns (uint256)

Returns the maximum amount of assets that can be withdrawn. Always returns 0 due to gate complexity.

maxRedeem

function maxRedeem(address) external pure returns (uint256)

Returns the maximum amount of shares that can be redeemed. Always returns 0 due to gate complexity.

multicall

function multicall(bytes[] calldata data) external

Useful for EOAs to batch admin calls. Does not return anything, because accounts who would use the return data would be contracts, which can do the multicall themselves.

Parameters:

Owner Functions

setOwner

function setOwner(address newOwner) external

Transfers ownership of the vault to newOwner. Only callable by the current owner.

setCurator

function setCurator(address newCurator) external

Sets the vault's Curator. Only callable by the owner.

setIsSentinel

function setIsSentinel(address account, bool newIsSentinel) external

Grants or revokes the Sentinel role for an account. Only callable by the owner.

setName

function setName(string memory newName) external

Sets the vault's name. Only callable by the owner.

setSymbol

function setSymbol(string memory newSymbol) external

Sets the vault's symbol. Only callable by the owner.

Curator Functions

The following functions are only callable by the Curator. Some are subject to a timelock while others are instant. The timelock process is:

1. Curator calls submit(bytes calldata data) with the ABI-encoded function call.
2. After the timelock expires, anyone can execute the function directly.

abdicate

function abdicate(bytes4 selector) external

Irreversibly disables the ability to submit a specific type of action.

Parameters:

addAdapter

function addAdapter(address account) external

Adds a new adapter to the vault.

Parameters:

decreaseAbsoluteCap

function decreaseAbsoluteCap(bytes memory idData, uint256 newAbsoluteCap) external

Decreases the absolute cap for an id.

Instant Action (also callable by a Sentinel)

Parameters:

decreaseRelativeCap

function decreaseRelativeCap(bytes memory idData, uint256 newRelativeCap) external

Decreases the relative cap for an id.

Instant Action (also callable by a Sentinel)

Parameters:

decreaseTimelock

function decreaseTimelock(bytes4 selector, uint256 newDuration) external

Decreases a function's timelock duration (this action itself has a 3-week timelock).

Parameters:

increaseAbsoluteCap

function increaseAbsoluteCap(bytes memory idData, uint256 newAbsoluteCap) external

Increases the absolute cap for an id.

Parameters:

increaseRelativeCap

function increaseRelativeCap(bytes memory idData, uint256 newRelativeCap) external

Increases the relative cap for an id.

Parameters:

increaseTimelock

function increaseTimelock(bytes4 selector, uint256 newDuration) external

Increases a function's timelock duration.

Parameters:

removeAdapter

function removeAdapter(address account) external

Removes an adapter from the vault.

Parameters:

revoke

function revoke(bytes calldata data) external

Revokes a pending timelocked action.

Instant Action (also callable by a Sentinel)

Parameters:

setAdapterRegistry

function setAdapterRegistry(address newAdapterRegistry) external

Sets the adapter registry contract. The no-op will revert if the registry now returns false for an already added adapter.

Parameters:

setForceDeallocatePenalty

function setForceDeallocatePenalty(address adapter, uint256 newForceDeallocatePenalty) external

Sets the penalty for using forceDeallocate on a specific adapter.

Parameters:

setIsAllocator

function setIsAllocator(address account, bool newIsAllocator) external

Grants or revokes the Allocator role for an account.

Parameters:

setManagementFee

function setManagementFee(uint256 newManagementFee) external

Sets the vault's management fee.

Parameters:

setManagementFeeRecipient

function setManagementFeeRecipient(address newManagementFeeRecipient) external

Sets the management fee recipient.

Parameters:

setPerformanceFee

function setPerformanceFee(uint256 newPerformanceFee) external

Sets the vault's performance fee.

Parameters:

setPerformanceFeeRecipient

function setPerformanceFeeRecipient(address newPerformanceFeeRecipient) external

Sets the performance fee recipient.

Parameters:

setReceiveAssetsGate

function setReceiveAssetsGate(address newReceiveAssetsGate) external

Sets the contract for gating asset receipts.

Parameters:

setReceiveSharesGate

function setReceiveSharesGate(address newReceiveSharesGate) external

Sets the contract for gating share receipts.

Parameters:

setSendAssetsGate

function setSendAssetsGate(address newSendAssetsGate) external

Sets the contract for gating asset sends.

Parameters:

setSendSharesGate

function setSendSharesGate(address newSendSharesGate) external

Sets the contract for gating share sends.

Parameters:

submit

function submit(bytes calldata data) external

Submits a timelocked action for execution after the timelock period expires.

Parameters:

Allocator Functions

allocate

function allocate(address adapter, bytes memory data, uint256 assets) external

Allocates assets from the vault's idle pool to a specific adapter.

deallocate

function deallocate(address adapter, bytes memory data, uint256 assets) external

Deallocates assets from an adapter back to the vault's idle pool. Also callable by a Sentinel.

setLiquidityAdapterAndData

function setLiquidityAdapterAndData(address newLiquidityAdapter, bytes memory newLiquidityData) external

Sets the default adapter for handling user deposits and withdrawals.

Parameters:

setMaxRate

function setMaxRate(uint256 newMaxRate) external

Sets the maximum rate at which totalAssets can grow.

Parameters:

Gating Functions

canReceiveShares

function canReceiveShares(address account) public view returns (bool)

Checks if an account can receive shares based on the receive shares gate.

Parameters:

Return Values:

canSendShares

function canSendShares(address account) public view returns (bool)

Checks if an account can send shares based on the send shares gate.

Parameters:

Return Values:

canReceiveAssets

function canReceiveAssets(address account) public view returns (bool)

Checks if an account can receive assets based on the receive assets gate. The vault itself is always allowed.

Parameters:

Return Values:

canSendAssets

function canSendAssets(address account) public view returns (bool)

Checks if an account can send assets based on the send assets gate.

Parameters:

Return Values: