PoolManager
Functions
HUNDRED_PERCENT
HUNDRED_PERCENT
function HUNDRED_PERCENT()
view
returns (
uint256
);
Return Values:
0
uint256
uint256
acceptPoolDelegate
acceptPoolDelegate
Accepts the role of pool delegate.
function acceptPoolDelegate()
nonpayable;
active
active
Returns whether or not a pool is active.
function active()
view
returns (
bool
);
Return Values:
0
bool
bool
addStrategy
addStrategy
Adds a new strategy. NOTE: The PoolManager address is encoded and prepended to the extraDeploymentData.
function addStrategy(
address strategyFactory_,
bytes extraDeploymentData_
)
nonpayable
returns (
address strategy_
);
Parameters:
0
strategyFactory_
address
address
The address of the strategy factory to use.
1
extraDeploymentData_
bytes
bytes
The data to construct the strategy.
Return Values:
0
strategy_
address
address
The address of the new strategy.
asset
asset
Gets the address of the funds asset.
function asset()
view
returns (
address
);
Return Values:
0
address
address
canCall
canCall
Checks if a scheduled call can be executed.
function canCall(
bytes32 functionId_,
address caller_,
bytes data_
)
view
returns (
bool canCall_,
string errorMessage_
);
Parameters:
0
functionId_
bytes32
bytes32
The function to check.
1
caller_
address
address
The address of the caller.
2
data_
bytes
bytes
The data of the call.
Return Values:
0
canCall_
bool
bool
True if the call can be executed, false otherwise.
1
errorMessage_
string
string
The error message if the call cannot be executed.
completeConfiguration
completeConfiguration
Complete the configuration.
function completeConfiguration()
nonpayable;
configured
configured
Returns whether or not a pool is configured.
function configured()
view
returns (
bool
);
Return Values:
0
bool
bool
convertToExitShares
convertToExitShares
Returns the amount of exit shares for the input amount.
function convertToExitShares(
uint256 assets_
)
view
returns (
uint256 shares_
);
Parameters:
0
assets_
uint256
uint256
Return Values:
0
shares_
uint256
uint256
Amount of shares able to be exited.
delegateManagementFeeRate
delegateManagementFeeRate
Gets the delegate management fee rate.
function delegateManagementFeeRate()
view
returns (
uint256
);
Return Values:
0
uint256
uint256
depositCover
depositCover
Deposits cover into the pool.
function depositCover(
uint256 amount_
)
nonpayable;
Parameters:
0
amount_
uint256
uint256
The amount of cover to deposit.
factory
factory
The address of the proxy factory.
function factory()
view
returns (
address factory_
);
Return Values:
0
factory_
address
address
finishCollateralLiquidation
finishCollateralLiquidation
Finishes the collateral liquidation
function finishCollateralLiquidation(
address loan_
)
nonpayable;
Parameters:
0
loan_
address
address
Loan that had its collateral liquidated.
getEscrowParams
getEscrowParams
Gets the information of escrowed shares.
function getEscrowParams(
address,
uint256 shares_
)
view
returns (
uint256 escrowShares_,
address destination_
);
Parameters:
0
``
address
address
1
shares_
uint256
uint256
The amount of shares to get the information of.
Return Values:
0
escrowShares_
uint256
uint256
The amount of escrowed shares.
1
destination_
address
address
The address of the destination.
globals
globals
Gets the address of the globals.
function globals()
view
returns (
address globals_
);
Return Values:
0
globals_
address
address
The address of the globals.
governor
governor
Gets the address of the governor.
function governor()
view
returns (
address governor_
);
Return Values:
0
governor_
address
address
The address of the governor.
hasSufficientCover
hasSufficientCover
Returns if pool has sufficient cover.
function hasSufficientCover()
view
returns (
bool hasSufficientCover_
);
Return Values:
0
hasSufficientCover_
bool
bool
True if pool has sufficient cover.
implementation
implementation
The address of the implementation contract being proxied.
function implementation()
view
returns (
address implementation_
);
Return Values:
0
implementation_
address
address
isStrategy
isStrategy
Returns whether or not the given address is a strategy.
function isStrategy(
address
)
view
returns (
bool
);
Parameters:
0
``
address
address
Return Values:
0
bool
bool
liquidityCap
liquidityCap
Gets the liquidity cap for the pool.
function liquidityCap()
view
returns (
uint256
);
Return Values:
0
uint256
uint256
maxDeposit
maxDeposit
Gets the amount of assets that can be deposited.
function maxDeposit(
address receiver_
)
view
returns (
uint256 maxAssets_
);
Parameters:
0
receiver_
address
address
The address to check the deposit for.
Return Values:
0
maxAssets_
uint256
uint256
maxMint
maxMint
Gets the amount of shares that can be minted.
function maxMint(
address receiver_
)
view
returns (
uint256 maxShares_
);
Parameters:
0
receiver_
address
address
The address to check the mint for.
Return Values:
0
maxShares_
uint256
uint256
maxRedeem
maxRedeem
Gets the amount of shares that can be redeemed.
function maxRedeem(
address owner_
)
view
returns (
uint256 maxShares_
);
Parameters:
0
owner_
address
address
The address to check the redemption for.
Return Values:
0
maxShares_
uint256
uint256
maxWithdraw
maxWithdraw
Gets the amount of assets that can be withdrawn.
function maxWithdraw(
address owner_
)
view
returns (
uint256 maxAssets_
);
Parameters:
0
owner_
address
address
The address to check the withdraw for.
Return Values:
0
maxAssets_
uint256
uint256
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.
function migrate(
address migrator_,
bytes arguments_
)
nonpayable;
Parameters:
0
migrator_
address
address
The address of a migrator contract.
1
arguments_
bytes
bytes
Some encoded arguments to use for the migration.
pendingPoolDelegate
pendingPoolDelegate
Gets the address of the pending pool delegate.
function pendingPoolDelegate()
view
returns (
address
);
Return Values:
0
address
address
pool
pool
Gets the address of the pool.
function pool()
view
returns (
address
);
Return Values:
0
address
address
poolDelegate
poolDelegate
Gets the address of the pool delegate.
function poolDelegate()
view
returns (
address
);
Return Values:
0
address
address
poolDelegateCover
poolDelegateCover
Gets the address of the pool delegate cover.
function poolDelegateCover()
view
returns (
address
);
Return Values:
0
address
address
poolPermissionManager
poolPermissionManager
Gets the address of the pool delegate cover.
function poolPermissionManager()
view
returns (
address
);
Return Values:
0
address
address
previewRedeem
previewRedeem
Gets the amount of shares that can be redeemed.
function previewRedeem(
address owner_,
uint256 shares_
)
view
returns (
uint256 assets_
);
Parameters:
0
owner_
address
address
The address to check the redemption for.
1
shares_
uint256
uint256
The amount of requested shares to redeem.
Return Values:
0
assets_
uint256
uint256
The amount of assets that will be returned for `shares_`.
previewWithdraw
previewWithdraw
Gets the amount of assets that can be redeemed.
function previewWithdraw(
address owner_,
uint256 assets_
)
view
returns (
uint256 shares_
);
Parameters:
0
owner_
address
address
The address to check the redemption for.
1
assets_
uint256
uint256
The amount of requested shares to redeem.
Return Values:
0
shares_
uint256
uint256
The amount of assets that will be returned for `assets_`.
processRedeem
processRedeem
Processes a redemptions of shares for assets from the pool.
function processRedeem(
uint256 shares_,
address owner_,
address sender_
)
nonpayable
returns (
uint256 redeemableShares_,
uint256 resultingAssets_
);
Parameters:
0
shares_
uint256
uint256
The amount of shares to redeem.
1
owner_
address
address
The address of the owner of the shares.
2
sender_
address
address
The address of the sender of the redeem call.
Return Values:
0
redeemableShares_
uint256
uint256
The amount of shares redeemed.
1
resultingAssets_
uint256
uint256
The amount of assets withdrawn.
processWithdraw
processWithdraw
Processes a redemptions of shares for assets from the pool.
function processWithdraw(
uint256 assets_,
address owner_,
address sender_
)
nonpayable
returns (
uint256 redeemableShares_,
uint256 resultingAssets_
);
Parameters:
0
assets_
uint256
uint256
The amount of assets to withdraw.
1
owner_
address
address
The address of the owner of the shares.
2
sender_
address
address
The address of the sender of the withdraw call.
Return Values:
0
redeemableShares_
uint256
uint256
The amount of shares redeemed.
1
resultingAssets_
uint256
uint256
The amount of assets withdrawn.
removeShares
removeShares
Requests a redemption of shares from the pool.
function removeShares(
uint256 shares_,
address owner_
)
nonpayable
returns (
uint256 sharesReturned_
);
Parameters:
0
shares_
uint256
uint256
The amount of shares to redeem.
1
owner_
address
address
The address of the owner of the shares.
Return Values:
0
sharesReturned_
uint256
uint256
The amount of shares withdrawn.
requestFunds
requestFunds
Strategy can request funds from the pool via the poolManager.
function requestFunds(
address destination_,
uint256 principal_
)
nonpayable;
Parameters:
0
destination_
address
address
The address to send the funds to.
1
principal_
uint256
uint256
The principal amount to fund the strategy with.
requestRedeem
requestRedeem
Requests a redemption of shares from the pool.
function requestRedeem(
uint256 shares_,
address owner_,
address sender_
)
nonpayable;
Parameters:
0
shares_
uint256
uint256
The amount of shares to redeem.
1
owner_
address
address
The address of the owner of the shares.
2
sender_
address
address
The address of the sender of the shares.
requestWithdraw
requestWithdraw
Requests a withdrawal of assets from the pool.
function requestWithdraw(
uint256 shares_,
uint256 assets_,
address owner_,
address sender_
)
nonpayable;
Parameters:
0
shares_
uint256
uint256
The amount of shares to redeem.
1
assets_
uint256
uint256
The amount of assets to withdraw.
2
owner_
address
address
The address of the owner of the shares.
3
sender_
address
address
The address of the sender of the shares.
setActive
setActive
Sets a the pool to be active or inactive.
function setActive(
bool active_
)
nonpayable;
Parameters:
0
active_
bool
bool
Whether the pool is active.
setDelegateManagementFeeRate
setDelegateManagementFeeRate
Sets the value for the delegate management fee rate.
function setDelegateManagementFeeRate(
uint256 delegateManagementFeeRate_
)
nonpayable;
Parameters:
0
delegateManagementFeeRate_
uint256
uint256
The value for the delegate management fee rate.
setImplementation
setImplementation
Modifies the proxy's implementation address.
function setImplementation(
address implementation_
)
nonpayable;
Parameters:
0
implementation_
address
address
setIsStrategy
setIsStrategy
Sets if the strategy is valid in the isStrategy mapping.
function setIsStrategy(
address strategy_,
bool isStrategy_
)
nonpayable;
Parameters:
0
strategy_
address
address
The address of the strategy
1
isStrategy_
bool
bool
Whether the strategy is valid.
setLiquidityCap
setLiquidityCap
Sets the value for liquidity cap.
function setLiquidityCap(
uint256 liquidityCap_
)
nonpayable;
Parameters:
0
liquidityCap_
uint256
uint256
The value for liquidity cap.
setPendingPoolDelegate
setPendingPoolDelegate
Sets an address as the pending pool delegate.
function setPendingPoolDelegate(
address pendingPoolDelegate_
)
nonpayable;
Parameters:
0
pendingPoolDelegate_
address
address
The address of the new pool delegate.
setPoolPermissionManager
setPoolPermissionManager
Sets the address of the pool permission manager.
function setPoolPermissionManager(
address poolPermissionManager_
)
nonpayable;
Parameters:
0
poolPermissionManager_
address
address
setWithdrawalManager
setWithdrawalManager
Sets the address of the withdrawal manager.
function setWithdrawalManager(
address withdrawalManager_
)
nonpayable;
Parameters:
0
withdrawalManager_
address
address
The address of the withdrawal manager.
strategyList
strategyList
Gets the address of the strategy in the list.
function strategyList(
uint256
)
view
returns (
address
);
Parameters:
0
``
uint256
uint256
Return Values:
0
address
address
strategyListLength
strategyListLength
Returns the length of the `strategyList`.
function strategyListLength()
view
returns (
uint256 strategyListLength_
);
Return Values:
0
strategyListLength_
uint256
uint256
The length of the `strategyList`.
totalAssets
totalAssets
Returns the amount of total assets.
function totalAssets()
view
returns (
uint256 totalAssets_
);
Return Values:
0
totalAssets_
uint256
uint256
Amount of of total assets.
triggerDefault
triggerDefault
Triggers the default of a loan.
function triggerDefault(
address loan_,
address liquidatorFactory_
)
nonpayable;
Parameters:
0
loan_
address
address
Loan to trigger the default.
1
liquidatorFactory_
address
address
Factory used to deploy the liquidator.
unrealizedLosses
unrealizedLosses
Returns the amount unrealized losses.
function unrealizedLosses()
view
returns (
uint256 unrealizedLosses_
);
Return Values:
0
unrealizedLosses_
uint256
uint256
Amount of unrealized losses.
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.
function upgrade(
uint256 version_,
bytes arguments_
)
nonpayable;
Parameters:
0
version_
uint256
uint256
1
arguments_
bytes
bytes
Some encoded arguments to use for the upgrade.
withdrawalManager
withdrawalManager
Gets the address of the withdrawal manager.
function withdrawalManager()
view
returns (
address
);
Return Values:
0
address
address
withdrawCover
withdrawCover
Withdraws cover from the pool.
function withdrawCover(
uint256 amount_,
address recipient_
)
nonpayable;
Parameters:
0
amount_
uint256
uint256
The amount of cover to withdraw.
1
recipient_
address
address
The address of the recipient.
Events
CollateralLiquidationFinished
CollateralLiquidationFinished
Emitted when a collateral liquidations is finished.
event CollateralLiquidationFinished(
address loan_,
uint256 unrealizedLosses_
);
Parameters:
0
loan_
address
address
The address of the loan.
1
unrealizedLosses_
uint256
uint256
The amount of unrealized losses.
CollateralLiquidationTriggered
CollateralLiquidationTriggered
Emitted when a collateral liquidations is triggered.
event CollateralLiquidationTriggered(
address loan_
);
Parameters:
0
loan_
address
address
The address of the loan.
CoverDeposited
CoverDeposited
Emitted when cover is deposited.
event CoverDeposited(
uint256 amount_
);
Parameters:
0
amount_
uint256
uint256
The amount of cover deposited.
CoverLiquidated
CoverLiquidated
Emitted when cover is liquidated in the case of a loan defaulting.
event CoverLiquidated(
uint256 toTreasury_,
uint256 toPool_
);
Parameters:
0
toTreasury_
uint256
uint256
The amount of cover sent to the Treasury.
1
toPool_
uint256
uint256
The amount of cover sent to the Pool.
CoverWithdrawn
CoverWithdrawn
Emitted when cover is withdrawn.
event CoverWithdrawn(
uint256 amount_
);
Parameters:
0
amount_
uint256
uint256
The amount of cover withdrawn.
DelegateManagementFeeRateSet
DelegateManagementFeeRateSet
Emitted when a new management fee rate is set.
event DelegateManagementFeeRateSet(
uint256 managementFeeRate_
);
Parameters:
0
managementFeeRate_
uint256
uint256
The amount of management fee rate.
IsStrategySet
IsStrategySet
Emitted when a strategy is set as valid.
event IsStrategySet(
address strategy_,
bool isStrategy_
);
Parameters:
0
strategy_
address
address
The address of the strategy.
1
isStrategy_
bool
bool
Whether the strategy is valid.
LiquidityCapSet
LiquidityCapSet
Emitted when a new liquidity cap is set.
event LiquidityCapSet(
uint256 liquidityCap_
);
Parameters:
0
liquidityCap_
uint256
uint256
The value of liquidity cap.
PendingDelegateAccepted
PendingDelegateAccepted
Emitted when the pending pool delegate accepts the ownership transfer.
event PendingDelegateAccepted(
address previousDelegate_,
address newDelegate_
);
Parameters:
0
previousDelegate_
address
address
The address of the previous delegate.
1
newDelegate_
address
address
The address of the new delegate.
PendingDelegateSet
PendingDelegateSet
Emitted when the pending pool delegate is set.
event PendingDelegateSet(
address previousDelegate_,
address newDelegate_
);
Parameters:
0
previousDelegate_
address
address
The address of the previous delegate.
1
newDelegate_
address
address
The address of the new delegate.
PoolConfigurationComplete
PoolConfigurationComplete
Emitted when the pool configuration is marked as complete.
event PoolConfigurationComplete();
PoolPermissionManagerSet
PoolPermissionManagerSet
Emitted when the pool permission manager is set.
event PoolPermissionManagerSet(
address poolPermissionManager_
);
Parameters:
0
poolPermissionManager_
address
address
The address of the pool permission manager.
RedeemProcessed
RedeemProcessed
Emitted when a redemption of shares from the pool is processed.
event RedeemProcessed(
address owner_,
uint256 redeemableShares_,
uint256 resultingAssets_
);
Parameters:
0
owner_
address
address
The owner of the shares.
1
redeemableShares_
uint256
uint256
The amount of redeemable shares.
2
resultingAssets_
uint256
uint256
The amount of assets redeemed.
RedeemRequested
RedeemRequested
Emitted when a redemption of shares from the pool is requested.
event RedeemRequested(
address owner_,
uint256 shares_
);
Parameters:
0
owner_
address
address
The owner of the shares.
1
shares_
uint256
uint256
The amount of redeemable shares.
SetAsActive
SetAsActive
Emitted when a pool is sets to be active or inactive.
event SetAsActive(
bool active_
);
Parameters:
0
active_
bool
bool
Whether the pool is active.
SharesRemoved
SharesRemoved
Emitted when shares are removed from the pool.
event SharesRemoved(
address owner_,
uint256 shares_
);
Parameters:
0
owner_
address
address
The address of the owner of the shares.
1
shares_
uint256
uint256
The amount of shares removed.
StrategyAdded
StrategyAdded
Emitted when a new strategy is added.
event StrategyAdded(
address strategy_
);
Parameters:
0
strategy_
address
address
The address of the new strategy.
Upgraded
Upgraded
The instance was upgraded.
event Upgraded(
uint256 toVersion_,
bytes arguments_
);
Parameters:
0
toVersion_
uint256
uint256
The new version of the loan.
1
arguments_
bytes
bytes
The upgrade arguments, if any.
WithdrawalManagerSet
WithdrawalManagerSet
Emitted when the withdrawal manager is set.
event WithdrawalManagerSet(
address withdrawalManager_
);
Parameters:
0
withdrawalManager_
address
address
The address of the withdrawal manager.
WithdrawalProcessed
WithdrawalProcessed
Emitted when withdrawal of assets from the pool is processed.
event WithdrawalProcessed(
address owner_,
uint256 redeemableShares_,
uint256 resultingAssets_
);
Parameters:
0
owner_
address
address
The owner of the assets.
1
redeemableShares_
uint256
uint256
The amount of redeemable shares.
2
resultingAssets_
uint256
uint256
The amount of assets redeemed.
Last updated