PoolConfigurator
Inherits: VersionedInitializable, IPoolConfigurator, PoolConfiguratorStorage
See the documentation in {IPoolConfigurator}.
State Variables
HUNDRED_PERCENT
POOL_CONFIGURATOR_REVISION
ADDRESSES_PROVIDER
Functions
whenNotPaused
onlyAdminOrGovernor
onlyGovernor
onlyAdmin
onlyPool
constructor
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 |
initialize
The initializer function for the pool configurator (must be called directly after deployment).
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the pool addresses provider. |
|
| The address of the pool admin. |
|
| The ERC20 asset used in the lending pool. |
|
| The name of the pool token. |
|
| The symbol of the pool token. |
transferAdmin
Transfers to a new admin.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the new admin. |
setBuyer
Assigns a buyer to the pool.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the buyer for this pool. |
setValidSeller
Sets the status of a seller.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the seller. |
|
| Whether the seller is valid. |
setValidLender
Sets the status of a lender (liquidity providers).
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the lender. |
|
| Whether the lender is valid. |
setAdminFee
Sets the admin fee rate that would be applied to the pool.
Parameters
Name | Type | Description |
---|---|---|
|
| The new admin fee. |
setOpenToPublic
Sets whether the pool is open to the public (permissioned or permissionless).
Parameters
Name | Type | Description |
---|---|---|
|
| Whether the pool is open to the public. |
setMaxCoverLiquidation
Sets the max cover liquidation for the pool configurator.
Parameters
Name | Type | Description |
---|---|---|
|
| The max cover liquidation as a percentage for the pool admin. |
setMinCover
Sets the min cover required for the pool configurator.
Parameters
Name | Type | Description |
---|---|---|
|
| The min cover required for the pool admin. |
setPoolLimit
Sets the pool limit for the pool configurator.
Parameters
Name | Type | Description |
---|---|---|
|
| The size limit of the pool. |
requestFunds
Request funds from the pool and fund the loan manager.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of principal to request. |
triggerDefault
Triggers the defaults of a specific loan in the loan manager.
Parameters
Name | Type | Description |
---|---|---|
|
| The ID of the defaulted loan. |
requestRedeem
Requests to redeem shares.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of shares to redeem. |
|
| The owner of the shares. |
processRedeem
Processes the redemption of shares for a specific owner.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of shares to redeem. |
|
| The owner of the shares. |
|
| The sender of the process request. |
Returns
Name | Type | Description |
---|---|---|
|
| The amount of redeemable shares. |
|
| The corresponding amount of assets with the redeemable shares. |
removeShares
Removes shares from its withdrawal request.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of shares to remove from withdrawal. |
|
| The owner of the shares. |
Returns
Name | Type | Description |
---|---|---|
|
| The amount of shares returned. |
depositCover
Pool admin deposits pool cover.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of assets to deposit as first-loss cover. |
withdrawCover
Pool admin withdraws from pool cover.
Parameters
Name | Type | Description |
---|---|---|
|
| The amount of assets to withdraw from first-loss cover. |
|
| The address of the recipient. |
openToPublic
Returns whether the pool is open to public.
Returns
Name | Type | Description |
---|---|---|
|
| Whether the pool is open to public. |
adminFee
Returns the admin fee of the pool.
Returns
Name | Type | Description |
---|---|---|
|
| The admin fee of the pool. |
maxCoverLiquidation
Returns the max cover liquidation of the pool.
Returns
Name | Type | Description |
---|---|---|
|
| The max cover liquidation of the pool. |
minCover
Returns the min cover required for the pool configurator.
Returns
Name | Type | Description |
---|---|---|
|
| The min cover required for the pool admin. |
poolLimit
Returns the pool limit of the pool configurator.
Returns
Name | Type | Description |
---|---|---|
|
| The size limit of the pool. |
maxDeposit
Returns the max deposit amount of a receiver.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the receiver. |
Returns
Name | Type | Description |
---|---|---|
|
| The max amount of assets that can be deposited. |
maxMint
Returns the max mint amount of a receiver.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the receiver. |
Returns
Name | Type | Description |
---|---|---|
|
| The max amount of shares that can be minted. |
maxRedeem
Returns the max redeem amount of an owner.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the owner. |
Returns
Name | Type | Description |
---|---|---|
|
| The max amount of shares that can be redeemed. |
previewRedeem
Previews the amount of assets that can be redeemed for the amount of shares specified.
Parameters
Name | Type | Description |
---|---|---|
|
| The address of the owner. |
|
| The amount of shares to redeem. |
Returns
Name | Type | Description |
---|---|---|
|
| The amount of assets that would be received. |
totalAssets
Returns the total amount of assets in the pool.
Returns
Name | Type | Description |
---|---|---|
|
| The total amount of assets in the pool. |
hasSufficientCover
Returns whether the pool currently has sufficient cover.
Returns
Name | Type | Description |
---|---|---|
|
| Whether the pool currently has sufficient cover. |
unrealizedLosses
Returns the current amount of unrealized losses of the pool.
Returns
Name | Type | Description |
---|---|---|
|
| The current amount of unrealized losses of the pool. |
_totalAssets
_revertIfPaused
_revertIfNotAdmin
_revertIfNotAdminOrGovernor
_revertIfNotGovernor
_revertIfNotPool
_hasSufficientCover
_handleCover
_min
_getMaxAssets
_globals
_loanManager
_withdrawalManager
Last updated