WithdrawalManager
Inherits: WithdrawalManagerStorage, IWithdrawalManager, VersionedInitializable
State Variables
WITHDRAWAL_MANAGER_REVISION
ADDRESSES_PROVIDER
Functions
onlyPoolAdmin
onlyPoolConfigurator
whenProtocolNotPaused
getRevision
Returns the revision number of the contract
Needs to be defined in the inherited class as a constant.
Returns
Name | Type | Description |
---|---|---|
|
| The revision number |
constructor
initialize
Initializes the Withdrawal Manager.
Function is invoked by the proxy contract when the Withdrawal Manager Contract is added to the PoolAddressesProvider of the market
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the PoolAddressesProvider |
|
| The total duration of a withdrawal cycle |
|
| The duration of the withdrawal window |
setExitConfig
Pool admin sets a new configuration for the withdrawal manager
Parameters
Name | Type | Description |
---|---|---|
|
| The total duration of a withdrawal cycle |
|
| The total duration of a withdrawal window |
addShares
Add more shares for withdrawal
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of shares to add |
|
| The owner of the shares |
removeShares
Remove shares from withdrawal
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of shares to remove from withdrawal |
|
| The owner of the shares |
processExit
Process the exit of requested shares of a owner
isInExitWindow
Checks if the owner has a withdrawal request in the exit window
Parameters
Name | Type | Description |
---|---|---|
|
| The owner address to check |
Returns
Name | Type | Description |
---|---|---|
|
| True if the owner has a withdrawal request in the exit window |
lockedLiquidity
Gets the total amount of liquidity locked in the current cycle
Returns
Name | Type | Description |
---|---|---|
|
| The total amount of liquidity locked in the current cycle |
previewRedeem
Previews the amount of shares and assets that can be redeemed
Parameters
Name | Type | Description |
---|---|---|
|
| The owner of the shares |
|
| The amount of shares to redeem |
Returns
Name | Type | Description |
---|---|---|
|
| The amount of redeemable shares |
|
| The corresponding amount of assets with the redeemable shares |
getCycleConfig
Gets the configuration of a config id
Parameters
Name | Type | Description |
---|---|---|
|
| The id of the config |
Returns
Name | Type | Description |
---|---|---|
|
| The config |
getConfigAtId
Gets the configuration of a given cycle id
Parameters
Name | Type | Description |
---|---|---|
|
| The cycle id |
Returns
Name | Type | Description |
---|---|---|
|
| The configuration used at the cycle id |
getCurrentConfig
Gets the configuration of the current cycle id
Returns
Name | Type | Description |
---|---|---|
|
| The configuration used at the current cycle id |
getCurrentCycleId
Gets the current cycle id
Returns
Name | Type | Description |
---|---|---|
|
| The id of the current cycle |
getWindowStart
Gets the starting time of a window for a given cycle id
Parameters
Name | Type | Description |
---|---|---|
|
| The id of the cycle |
Returns
Name | Type | Description |
---|---|---|
|
| The starting time of the window |
getWindowAtId
Gets the start and end time of a window for a given cycle id
Parameters
Name | Type | Description |
---|---|---|
|
| The id of the cycle |
Returns
Name | Type | Description |
---|---|---|
|
| The starting time of the window |
|
| The ending time of the window |
getRedeemableAmounts
_poolConfigurator
_poolAdmin
_globals
_asset
_pool
_emitUpdate
_emitProcess
_revertIfNotPoolAdmin
_revertIfNotPoolConfigurator
Last updated