Pool
Constructor
Parameters:
Functions
BOOTSTRAP_MINT
BOOTSTRAP_MINT
The amount of shares that will be burned during the first deposit/mint.
Return Values:
DOMAIN_SEPARATOR
DOMAIN_SEPARATOR
Returns the signature domain separator.
Return Values:
PERMIT_TYPEHASH
PERMIT_TYPEHASH
Returns the permit type hash.
Return Values:
allowance
allowance
Returns the allowance that one account has given another over their tokens.
Parameters:
Return Values:
approve
approve
Function that allows one account to set the allowance of another account over their tokens. Emits an {Approval} event.
Parameters:
Return Values:
asset
asset
The address of the underlying asset used by the Vault. MUST be a contract that implements the ERC-20 standard. MUST NOT revert.
Return Values:
balanceOf
balanceOf
Returns the amount of tokens owned by a given account.
Parameters:
Return Values:
balanceOfAssets
balanceOfAssets
Returns the amount of underlying assets owned by the specified account.
Parameters:
Return Values:
convertToAssets
convertToAssets
The amount of `assets_` the `shares_` are currently equivalent to. MUST NOT be inclusive of any fees that are charged against assets in the Vault. MUST NOT reflect slippage or other on-chain conditions when performing the actual exchange. MUST NOT show any variations depending on the caller. MUST NOT revert.
Parameters:
Return Values:
convertToExitAssets
convertToExitAssets
Returns the amount of exit assets for the input amount.
Parameters:
Return Values:
convertToExitShares
convertToExitShares
Returns the amount of exit shares for the input amount.
Parameters:
Return Values:
convertToShares
convertToShares
The amount of `shares_` the `assets_` are currently equivalent to. MUST NOT be inclusive of any fees that are charged against assets in the Vault. MUST NOT reflect slippage or other on-chain conditions when performing the actual exchange. MUST NOT show any variations depending on the caller. MUST NOT revert.
Parameters:
Return Values:
decimals
decimals
Returns the decimal precision used by the token.
Return Values:
decreaseAllowance
decreaseAllowance
Function that allows one account to decrease the allowance of another account over their tokens. Emits an {Approval} event.
Parameters:
Return Values:
deposit
deposit
Mints `shares_` to `receiver_` by depositing `assets_` into the Vault. MUST emit the {Deposit} event. MUST revert if all of the assets cannot be deposited (due to insufficient approval, deposit limits, slippage, etc).
Parameters:
Return Values:
depositWithPermit
depositWithPermit
Does a ERC4626 `deposit` with a ERC-2612 `permit`.
Parameters:
Return Values:
increaseAllowance
increaseAllowance
Function that allows one account to increase the allowance of another account over their tokens. Emits an {Approval} event.
Parameters:
Return Values:
manager
manager
The address of the account that is allowed to update the vesting schedule.
Return Values:
maxDeposit
maxDeposit
Maximum amount of `assets_` that can be deposited on behalf of the `receiver_` through a `deposit` call. MUST return a limited value if the receiver is subject to any limits, or the maximum value otherwise. MUST NOT revert.
Parameters:
Return Values:
maxMint
maxMint
Maximum amount of `shares_` that can be minted on behalf of the `receiver_` through a `mint` call. MUST return a limited value if the receiver is subject to any limits, or the maximum value otherwise. MUST NOT revert.
Parameters:
Return Values:
maxRedeem
maxRedeem
Maximum amount of `shares_` that can be redeemed from the `owner_` through a `redeem` call. MUST return a limited value if the owner is subject to any limits, or the total amount of owned shares otherwise. MUST NOT revert.
Parameters:
Return Values:
maxWithdraw
maxWithdraw
Maximum amount of `assets_` that can be withdrawn from the `owner_` through a `withdraw` call. MUST return a limited value if the owner is subject to any limits, or the total amount of owned assets otherwise. MUST NOT revert.
Parameters:
Return Values:
mint
mint
Mints `shares_` to `receiver_` by depositing `assets_` into the Vault. MUST emit the {Deposit} event. MUST revert if all of shares cannot be minted (due to insufficient approval, deposit limits, slippage, etc).
Parameters:
Return Values:
mintWithPermit
mintWithPermit
Does a ERC4626 `mint` with a ERC-2612 `permit`.
Parameters:
Return Values:
name
name
Returns the name of the token.
Return Values:
nonces
nonces
Returns the nonce for the given owner.
Parameters:
Return Values:
permit
permit
Approve by signature.
Parameters:
previewDeposit
previewDeposit
Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions. MUST return as close to and no more than the exact amount of shares that would be minted in a `deposit` call in the same transaction. MUST NOT account for deposit limits like those returned from `maxDeposit` and should always act as though the deposit would be accepted.
Parameters:
Return Values:
previewMint
previewMint
Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current on-chain conditions. MUST return as close to and no fewer than the exact amount of assets that would be deposited in a `mint` call in the same transaction. MUST NOT account for mint limits like those returned from `maxMint` and should always act as though the minting would be accepted.
Parameters:
Return Values:
previewRedeem
previewRedeem
Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given current on-chain conditions. MUST return as close to and no more than the exact amount of assets that would be withdrawn in a `redeem` call in the same transaction. MUST NOT account for redemption limits like those returned from `maxRedeem` and should always act as though the redemption would be accepted.
Parameters:
Return Values:
previewWithdraw
previewWithdraw
Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given current on-chain conditions. MUST return as close to and no fewer than the exact amount of shares that would be burned in a `withdraw` call in the same transaction. MUST NOT account for withdrawal limits like those returned from `maxWithdraw` and should always act as though the withdrawal would be accepted.
Parameters:
Return Values:
redeem
redeem
Burns `shares_` from `owner_` and sends `assets_` to `receiver_`. MUST emit the {Withdraw} event. MUST revert if all of the shares cannot be redeemed (due to insufficient shares, withdrawal limits, slippage, etc).
Parameters:
Return Values:
removeShares
removeShares
Removes shares from the withdrawal mechanism, can only be called after the beginning of the withdrawal window has passed.
Parameters:
Return Values:
requestRedeem
requestRedeem
Requests a redemption of shares from the pool.
Parameters:
Return Values:
requestWithdraw
requestWithdraw
Requests a withdrawal of assets from the pool.
Parameters:
Return Values:
symbol
symbol
Returns the symbol of the token.
Return Values:
totalAssets
totalAssets
Total amount of the underlying asset that is managed by the Vault. SHOULD include compounding that occurs from any yields. MUST NOT revert.
Return Values:
totalSupply
totalSupply
Returns the total amount of tokens in existence.
Return Values:
transfer
transfer
Moves an amount of tokens from `msg.sender` to a specified account. Emits a {Transfer} event.
Parameters:
Return Values:
transferFrom
transferFrom
Moves a pre-approved amount of tokens from a sender to a specified account. Emits a {Transfer} event. Emits an {Approval} event.
Parameters:
Return Values:
unrealizedLosses
unrealizedLosses
Returns the amount unrealized losses.
Return Values:
withdraw
withdraw
Burns `shares_` from `owner_` and sends `assets_` to `receiver_`. MUST emit the {Withdraw} event. MUST revert if all of the assets cannot be withdrawn (due to insufficient assets, withdrawal limits, slippage, etc).
Parameters:
Return Values:
Events
Approval
Approval
Emitted when one account has set the allowance of another account over their tokens.
Parameters:
BootstrapMintPerformed
BootstrapMintPerformed
Initial shares amount was minted to the zero address to prevent the first depositor frontrunning exploit.
Parameters:
Deposit
Deposit
`caller_` has exchanged `assets_` for `shares_` and transferred them to `owner_`. MUST be emitted when assets are deposited via the `deposit` or `mint` methods.
Parameters:
OwnershipAccepted
OwnershipAccepted
`newOwner_` has accepted the transferral of RDT ownership from `previousOwner_`.
Parameters:
PendingOwnerSet
PendingOwnerSet
`owner_` has set the new pending owner of RDT to `pendingOwner_`.
Parameters:
RedemptionRequested
RedemptionRequested
A new redemption request has been made.
Parameters:
SharesRemoved
SharesRemoved
Shares have been removed.
Parameters:
Transfer
Transfer
Emitted when tokens have moved from one account to another.
Parameters:
Withdraw
Withdraw
`caller_` has exchanged `shares_`, owned by `owner_`, for `assets_`, and transferred them to `receiver_`. MUST be emitted when assets are withdrawn via the `withdraw` or `redeem` methods.
Parameters:
WithdrawRequested
WithdrawRequested
A new withdrawal request has been made.
Parameters:
Last updated