Skip to main content

IVaultWithdrawHandler

IVaultWithdrawHandler

Addresses

ChainAddress

Functions

withdraw

Withdraw assets to receiver by burning shares from account. Reverts unless

  • instantWithdrawAvailable() == true
  • OR account has a WithdrawRequest with at least shares available.

See EIP-4626 withdraw().

function withdraw(
uint256 assets,
address receiver,
address account,
Shares maxShares
) external returns (
Shares shares
)

Parameters

NameTypeDescription
assetsuint256Collateral units to withdraw
receiveraddressSend withdrawn collateral to this address
accountaddressAddress from which to burn shares. msg.sender must be that address or its manager
maxSharesSharesSlippage control. Ignored if zero. If nonzero, revert if more than maxShares would be burnt to make this withdrawal

Return Values

NameTypeDescription
sharesSharesdfUSDC burnt from account to make the withdrawal

redeem

Redeem shares from account, and send the resulting collateral to receiver. Reverts unless

  • instantWithdrawAvailable() == true
  • OR account has a WithdrawRequest with at least shares available.

See EIP-4626 withdraw().

function redeem(
Shares shares,
address receiver,
address account,
uint256 minAssets
) external returns (
uint256 assets
)

Parameters

NameTypeDescription
sharesSharesdfUSDC to burn from account
receiveraddressSend collateral to this address
accountaddressAddress from which to burn shares. msg.sender must be that address or its manager
minAssetsuint256Slippage control. Ignored if zero. If nonzero, revert unless the redemption yields at least minAssets

Return Values

NameTypeDescription
assetsuint256collateral sent to receiver

VaultWithdrawDelegate

Addresses

ChainAddress

Functions

withdraw

Withdraw assets to receiver by burning shares from account. Reverts unless

  • instantWithdrawAvailable() == true
  • OR account has a WithdrawRequest with at least shares available.

See EIP-4626 withdraw().

function withdraw(
contract IVaultWithdrawHandler handler,
uint256 assets,
address receiver,
address account,
Shares maxShares
) internal returns (
Shares shares
)

Parameters

NameTypeDescription
handlercontract IVaultWithdrawHandler
assetsuint256Collateral units to withdraw
receiveraddressSend withdrawn collateral to this address
accountaddressAddress from which to burn shares. msg.sender must be that address or its manager
maxSharesSharesSlippage control. Ignored if zero. If nonzero, revert if more than maxShares would be burnt to make this withdrawal

Return Values

NameTypeDescription
sharesSharesdfUSDC burnt from account to make the withdrawal

redeem

Redeem shares from account, and send the resulting collateral to receiver. Reverts unless

  • instantWithdrawAvailable() == true
  • OR account has a WithdrawRequest with at least shares available.

See EIP-4626 withdraw().

function redeem(
contract IVaultWithdrawHandler handler,
Shares shares,
address receiver,
address account,
uint256 minAssets
) internal returns (
uint256 assets
)

Parameters

NameTypeDescription
handlercontract IVaultWithdrawHandler
sharesSharesdfUSDC to burn from account
receiveraddressSend collateral to this address
accountaddressAddress from which to burn shares. msg.sender must be that address or its manager
minAssetsuint256Slippage control. Ignored if zero. If nonzero, revert unless the redemption yields at least minAssets

Return Values

NameTypeDescription
assetsuint256collateral sent to receiver