PoolManager

Functions

HUNDRED_PERCENT

    function HUNDRED_PERCENT()
        view
        returns (
            uint256
        );

Return Values:

acceptPoolDelegate

Accepts the role of pool delegate.

    function acceptPoolDelegate()
        nonpayable;

active

Returns whether or not a pool is active.

    function active()
        view
        returns (
            bool
        );

Return Values:

addLoanManager

Adds a new loan manager.

    function addLoanManager(
        address loanManagerFactory_
    )
        nonpayable
        returns (
            address loanManager_
        );

Parameters:

Return Values:

asset

Gets the address of the funds asset.

    function asset()
        view
        returns (
            address
        );

Return Values:

canCall

Checks if a scheduled call can be executed.

    function canCall(
        bytes32 functionId_,
        address caller_,
        bytes data_
    )
        view
        returns (
            bool canCall_,
            string errorMessage_
        );

Parameters:

Return Values:

completeConfiguration

Complete the configuration.

    function completeConfiguration()
        nonpayable;

configured

Returns whether or not a pool is configured.

    function configured()
        view
        returns (
            bool
        );

Return Values:

convertToExitShares

Returns the amount of exit shares for the input amount.

    function convertToExitShares(
        uint256 assets_
    )
        view
        returns (
            uint256 shares_
        );

Parameters:

Return Values:

delegateManagementFeeRate

Gets the delegate management fee rate.

    function delegateManagementFeeRate()
        view
        returns (
            uint256
        );

Return Values:

depositCover

Deposits cover into the pool.

    function depositCover(
        uint256 amount_
    )
        nonpayable;

Parameters:

factory

The address of the proxy factory.

    function factory()
        view
        returns (
            address factory_
        );

Return Values:

finishCollateralLiquidation

Finishes the collateral liquidation

    function finishCollateralLiquidation(
        address loan_
    )
        nonpayable;

Parameters:

getEscrowParams

Gets the information of escrowed shares.

    function getEscrowParams(
        address,
        uint256 shares_
    )
        view
        returns (
            uint256 escrowShares_,
            address destination_
        );

Parameters:

Return Values:

globals

Gets the address of the globals.

    function globals()
        view
        returns (
            address globals_
        );

Return Values:

governor

Gets the address of the governor.

    function governor()
        view
        returns (
            address governor_
        );

Return Values:

hasSufficientCover

Returns if pool has sufficient cover.

    function hasSufficientCover()
        view
        returns (
            bool hasSufficientCover_
        );

Return Values:

implementation

The address of the implementation contract being proxied.

    function implementation()
        view
        returns (
            address implementation_
        );

Return Values:

isLoanManager

Returns whether or not the given address is a loan manager.

    function isLoanManager(
        address
    )
        view
        returns (
            bool
        );

Parameters:

Return Values:

liquidityCap

Gets the liquidity cap for the pool.

    function liquidityCap()
        view
        returns (
            uint256
        );

Return Values:

loanManagerList

Gets the address of the loan manager in the list.

    function loanManagerList(
        uint256
    )
        view
        returns (
            address
        );

Parameters:

Return Values:

loanManagerListLength

Returns the length of the `loanManagerList`.

    function loanManagerListLength()
        view
        returns (
            uint256 loanManagerListLength_
        );

Return Values:

maxDeposit

Gets the amount of assets that can be deposited.

    function maxDeposit(
        address receiver_
    )
        view
        returns (
            uint256 maxAssets_
        );

Parameters:

Return Values:

maxMint

Gets the amount of shares that can be minted.

    function maxMint(
        address receiver_
    )
        view
        returns (
            uint256 maxShares_
        );

Parameters:

Return Values:

maxRedeem

Gets the amount of shares that can be redeemed.

    function maxRedeem(
        address owner_
    )
        view
        returns (
            uint256 maxShares_
        );

Parameters:

Return Values:

maxWithdraw

Gets the amount of assets that can be withdrawn.

    function maxWithdraw(
        address owner_
    )
        view
        returns (
            uint256 maxAssets_
        );

Parameters:

Return Values:

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:

pendingPoolDelegate

Gets the address of the pending pool delegate.

    function pendingPoolDelegate()
        view
        returns (
            address
        );

Return Values:

pool

Gets the address of the pool.

    function pool()
        view
        returns (
            address
        );

Return Values:

poolDelegate

Gets the address of the pool delegate.

    function poolDelegate()
        view
        returns (
            address
        );

Return Values:

poolDelegateCover

Gets the address of the pool delegate cover.

    function poolDelegateCover()
        view
        returns (
            address
        );

Return Values:

poolPermissionManager

Gets the address of the pool delegate cover.

    function poolPermissionManager()
        view
        returns (
            address
        );

Return Values:

previewRedeem

Gets the amount of shares that can be redeemed.

    function previewRedeem(
        address owner_,
        uint256 shares_
    )
        view
        returns (
            uint256 assets_
        );

Parameters:

Return Values:

previewWithdraw

Gets the amount of assets that can be redeemed.

    function previewWithdraw(
        address owner_,
        uint256 assets_
    )
        view
        returns (
            uint256 shares_
        );

Parameters:

Return Values:

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:

Return Values:

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:

Return Values:

removeShares

Requests a redemption of shares from the pool.

    function removeShares(
        uint256 shares_,
        address owner_
    )
        nonpayable
        returns (
            uint256 sharesReturned_
        );

Parameters:

Return Values:

requestFunds

LoanManager can request funds from the pool via the poolManager.

    function requestFunds(
        address destination_,
        uint256 principal_
    )
        nonpayable;

Parameters:

requestRedeem

Requests a redemption of shares from the pool.

    function requestRedeem(
        uint256 shares_,
        address owner_,
        address sender_
    )
        nonpayable;

Parameters:

requestWithdraw

Requests a withdrawal of assets from the pool.

    function requestWithdraw(
        uint256 shares_,
        uint256 assets_,
        address owner_,
        address sender_
    )
        nonpayable;

Parameters:

setActive

Sets a the pool to be active or inactive.

    function setActive(
        bool active_
    )
        nonpayable;

Parameters:

setDelegateManagementFeeRate

Sets the value for the delegate management fee rate.

    function setDelegateManagementFeeRate(
        uint256 delegateManagementFeeRate_
    )
        nonpayable;

Parameters:

setImplementation

Modifies the proxy's implementation address.

    function setImplementation(
        address implementation_
    )
        nonpayable;

Parameters:

setIsLoanManager

Sets if the loanManager is valid in the isLoanManager mapping.

    function setIsLoanManager(
        address loanManager_,
        bool isLoanManager_
    )
        nonpayable;

Parameters:

setLiquidityCap

Sets the value for liquidity cap.

    function setLiquidityCap(
        uint256 liquidityCap_
    )
        nonpayable;

Parameters:

setPendingPoolDelegate

Sets an address as the pending pool delegate.

    function setPendingPoolDelegate(
        address pendingPoolDelegate_
    )
        nonpayable;

Parameters:

setPoolPermissionManager

Sets the address of the pool permission manager.

    function setPoolPermissionManager(
        address poolPermissionManager_
    )
        nonpayable;

Parameters:

setWithdrawalManager

Sets the address of the withdrawal manager.

    function setWithdrawalManager(
        address withdrawalManager_
    )
        nonpayable;

Parameters:

totalAssets

Returns the amount of total assets.

    function totalAssets()
        view
        returns (
            uint256 totalAssets_
        );

Return Values:

triggerDefault

Triggers the default of a loan.

    function triggerDefault(
        address loan_,
        address liquidatorFactory_
    )
        nonpayable;

Parameters:

unrealizedLosses

Returns the amount unrealized losses.

    function unrealizedLosses()
        view
        returns (
            uint256 unrealizedLosses_
        );

Return Values:

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:

withdrawalManager

Gets the address of the withdrawal manager.

    function withdrawalManager()
        view
        returns (
            address
        );

Return Values:

withdrawCover

Withdraws cover from the pool.

    function withdrawCover(
        uint256 amount_,
        address recipient_
    )
        nonpayable;

Parameters:

Events

CollateralLiquidationFinished

Emitted when a collateral liquidations is finished.

    event CollateralLiquidationFinished(
        address loan_,
        uint256 unrealizedLosses_
    );

Parameters:

CollateralLiquidationTriggered

Emitted when a collateral liquidations is triggered.

    event CollateralLiquidationTriggered(
        address loan_
    );

Parameters:

CoverDeposited

Emitted when cover is deposited.

    event CoverDeposited(
        uint256 amount_
    );

Parameters:

CoverLiquidated

Emitted when cover is liquidated in the case of a loan defaulting.

    event CoverLiquidated(
        uint256 toTreasury_,
        uint256 toPool_
    );

Parameters:

CoverWithdrawn

Emitted when cover is withdrawn.

    event CoverWithdrawn(
        uint256 amount_
    );

Parameters:

DelegateManagementFeeRateSet

Emitted when a new management fee rate is set.

    event DelegateManagementFeeRateSet(
        uint256 managementFeeRate_
    );

Parameters:

IsLoanManagerSet

Emitted when a loan manager is set as valid.

    event IsLoanManagerSet(
        address loanManager_,
        bool isLoanManager_
    );

Parameters:

LiquidityCapSet

Emitted when a new liquidity cap is set.

    event LiquidityCapSet(
        uint256 liquidityCap_
    );

Parameters:

LoanManagerAdded

Emitted when a new loan manager is added.

    event LoanManagerAdded(
        address loanManager_
    );

Parameters:

PendingDelegateAccepted

Emitted when the pending pool delegate accepts the ownership transfer.

    event PendingDelegateAccepted(
        address previousDelegate_,
        address newDelegate_
    );

Parameters:

PendingDelegateSet

Emitted when the pending pool delegate is set.

    event PendingDelegateSet(
        address previousDelegate_,
        address newDelegate_
    );

Parameters:

PoolConfigurationComplete

Emitted when the pool configuration is marked as complete.

    event PoolConfigurationComplete();

PoolPermissionManagerSet

Emitted when the pool permission manager is set.

    event PoolPermissionManagerSet(
        address poolPermissionManager_
    );

Parameters:

RedeemProcessed

Emitted when a redemption of shares from the pool is processed.

    event RedeemProcessed(
        address owner_,
        uint256 redeemableShares_,
        uint256 resultingAssets_
    );

Parameters:

RedeemRequested

Emitted when a redemption of shares from the pool is requested.

    event RedeemRequested(
        address owner_,
        uint256 shares_
    );

Parameters:

SetAsActive

Emitted when a pool is sets to be active or inactive.

    event SetAsActive(
        bool active_
    );

Parameters:

SharesRemoved

Emitted when shares are removed from the pool.

    event SharesRemoved(
        address owner_,
        uint256 shares_
    );

Parameters:

Upgraded

The instance was upgraded.

    event Upgraded(
        uint256 toVersion_,
        bytes arguments_
    );

Parameters:

WithdrawalManagerSet

Emitted when the withdrawal manager is set.

    event WithdrawalManagerSet(
        address withdrawalManager_
    );

Parameters:

WithdrawalProcessed

Emitted when withdrawal of assets from the pool is processed.

    event WithdrawalProcessed(
        address owner_,
        uint256 redeemableShares_,
        uint256 resultingAssets_
    );

Parameters:

Last updated