WithdrawalManager (Queue)
Functions
addShares
addShares
Add shares to the withdrawal manager.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
asset
asset
Returns the address of the underlying pool asset.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
factory
factory
The address of the proxy factory.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
globals
globals
Returns the address of the globals contract.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
governor
governor
Return the address of the governor.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
implementation
implementation
The address of the implementation contract being proxied.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
isInExitWindow
isInExitWindow
Returns if a user is able to withdraw. Required for compatibility with pool managers. NOTE: Always returns true to fulfil interface requirements.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The account to check if it's in withdraw window. |
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| True if the account is in the withdraw window. |
isManualWithdrawal
isManualWithdrawal
Checks if an account is set to perform withdrawals manually.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 | `` |
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
lockedLiquidity
lockedLiquidity
Gets the total amount of funds that need to be locked to fulfill exits. NOTE: Always zero for this implementation.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The amount of locked liquidity. |
lockedShares
lockedShares
Gets the amount of locked shares for an account.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The address to check the exit for. |
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The amount of manual shares available. |
manualSharesAvailable
manualSharesAvailable
Returns the amount of shares available for manual withdrawal.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 | `` |
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
migrate
migrate
Modifies the proxy's storage by delegate-calling a migrator contract with some arguments. Access control logic critical since caller can force a selfdestruct via a malicious `migrator_` which is delegatecalled.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The address of a migrator contract. |
1 |
|
|
| Some encoded arguments to use for the migration. |
pool
pool
Returns the address of the pool contract.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
poolDelegate
poolDelegate
Returns the address of the pool delegate.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
poolManager
poolManager
Returns the address of the pool manager contract.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
previewRedeem
previewRedeem
Returns the amount of shares that can be redeemed. NOTE: The `shares` value is ignored.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
previewWithdraw
previewWithdraw
Gets the amount of shares that can be withdrawn. NOTE: Values just passed through as withdraw is not implemented.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The address to check the withdrawal for. |
1 |
|
|
| The amount of requested shares to withdraw. |
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The amount of assets that can be withdrawn. |
1 |
|
|
| The amount of shares that will be burned. |
processExit
processExit
Processes a withdrawal request. Uses the current exchange rate to calculate the amount of assets withdrawn.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
processRedemptions
processRedemptions
Processes pending redemption requests. Requests are processed in the order they were submitted. Automatic withdrawal requests will be fulfilled atomically.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
queue
queue
Returns the first and last withdrawal requests pending redemption.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Identifier of the next withdrawal request that will be processed. |
1 |
|
|
| Identifier of the last created withdrawal request. |
removeRequest
removeRequest
Removes a withdrawal request from the queue. Can only be called by the pool delegate.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
removeShares
removeShares
Removes shares from the withdrawal manager.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
requestIds
requestIds
Returns the request identifier of an account. Returns zero if the account does not have a withdrawal request.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 | `` |
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
requests
requests
Returns the owner and amount of shares associated with a withdrawal request.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
securityAdmin
securityAdmin
Returns the address of the security admin.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
setImplementation
setImplementation
Modifies the proxy's implementation address.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
|
setManualWithdrawal
setManualWithdrawal
Defines if an account will withdraw shares manually or automatically.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
|
totalShares
totalShares
Returns the total amount of shares pending redemption.
Return Values:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
upgrade
upgrade
Upgrades a contract implementation to a specific version. Access control logic critical since caller can force a selfdestruct via a malicious `migrator_` which is delegatecalled.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| |
1 |
|
|
| Some encoded arguments to use for the upgrade. |
Events
ManualSharesDecreased
ManualSharesDecreased
Emitted when a manual redemption takes place.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Address of the account. |
1 |
|
|
| Amount of shares redeemed. |
ManualSharesIncreased
ManualSharesIncreased
Emitted when a manual redemption is processed.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Address of the account. |
1 |
|
|
| Amount of shares added to the redeemable amount. |
ManualWithdrawalSet
ManualWithdrawalSet
Emitted when the withdrawal type of an account is updated.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Address of the account. |
1 |
|
|
| `true` if the withdrawal is manual, `false` if it is automatic. |
RequestCreated
RequestCreated
Emitted when a withdrawal request is created.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Identifier of the withdrawal request. |
1 |
|
|
| Address of the owner of the shares. |
2 |
|
|
| Amount of shares requested for redemption. |
RequestDecreased
RequestDecreased
Emitted when a withdrawal request is updated.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Identifier of the withdrawal request. |
1 |
|
|
| Amount of shares reduced during a redemption request. |
RequestProcessed
RequestProcessed
Emitted when a withdrawal request is processed.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Identifier of the withdrawal request. |
1 |
|
|
| The owner of the shares. |
2 |
|
|
| Amount of redeemable shares. |
3 |
|
|
| Amount of withdrawable assets. |
RequestRemoved
RequestRemoved
Emitted when a withdrawal request is removed.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| Identifier of the withdrawal request. |
Upgraded
Upgraded
The instance was upgraded.
Parameters:
Index | Name | Type | Internal Type | Description |
---|---|---|---|---|
0 |
|
|
| The new version of the loan. |
1 |
|
|
| The upgrade arguments, if any. |
Last updated