Globals

Functions

HUNDRED_PERCENT

    function HUNDRED_PERCENT()
        view
        returns (
            uint256
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

acceptGovernor

Accepts the governorship if the caller is the `pendingGovernor`.

    function acceptGovernor()
        nonpayable;

activatePoolManager

Activates the pool manager.

    function activatePoolManager(
        address poolManager_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager to activate.

admin

Returns the proxy's admin address.

    function admin()
        view
        returns (
            address admin_
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

admin_

address

address

The address of the admin.

bootstrapMint

Gets the virtualized first mint that acts as as offset to `totalAssets` and `totalSupply` for a given pool asset.

    function bootstrapMint(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

canDeploy

Gets whether a caller account can deploy from the factory calling this function.

    function canDeploy(
        address caller_
    )
        view
        returns (
            bool canDeploy_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

caller_

address

address

The address of the account calling the factory.

Return Values:

IndexNameTypeInternal TypeDescription

0

canDeploy_

bool

bool

Whether the account can deploy from the factory.

canDeployFrom

Gets whether a caller account can deploy from a factory.

    function canDeployFrom(
        address factory_,
        address caller_
    )
        view
        returns (
            bool canDeployFrom_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

factory_

address

address

The address of the factory.

1

caller_

address

address

The address of the account calling the factory.

Return Values:

IndexNameTypeInternal TypeDescription

0

canDeployFrom_

bool

bool

Whether the account can deploy from the factory.

defaultTimelockParameters

Gets the default timelock parameters.

    function defaultTimelockParameters()
        view
        returns (
            uint128 delay,
            uint128 duration
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

delay

uint128

uint128

The default timelock delay.

1

duration

uint128

uint128

The default timelock duration.

getLatestPrice

Gets the latest price for an asset.

    function getLatestPrice(
        address asset_
    )
        view
        returns (
            uint256 latestPrice_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

asset_

address

address

The address of the asset to query.

Return Values:

IndexNameTypeInternal TypeDescription

0

latestPrice_

uint256

uint256

The latest price for the asset.

governor

Gets governor address.

    function governor()
        view
        returns (
            address governor_
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

governor_

address

address

The address of the governor.

implementation

Returns the proxy's implementation address.

    function implementation()
        view
        returns (
            address implementation_
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

implementation_

address

address

The address of the implementation.

isBorrower

Gets the validity of a borrower.

    function isBorrower(
        address
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isCollateralAsset

Gets the validity of a collateral asset.

    function isCollateralAsset(
        address
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isContractPaused

Gets whether a contract is uniquely paused.

    function isContractPaused(
        address
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isFactory

Gets the validity of a factory.

    function isFactory(
        bytes32 factoryId_,
        address factory_
    )
        view
        returns (
            bool isFactory_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

factoryId_

bytes32

bytes32

The address of the factory to query.

1

factory_

address

address

The address of the factory to query.

Return Values:

IndexNameTypeInternal TypeDescription

0

isFactory_

bool

bool

A boolean indicating the validity of the factory.

isFunctionPaused

Gets whether a contract's function is paused.

    function isFunctionPaused(
        bytes4 sig_
    )
        view
        returns (
            bool functionIsPaused_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

sig_

bytes4

bytes4

The function signature within the contract.

Return Values:

IndexNameTypeInternal TypeDescription

0

functionIsPaused_

bool

bool

Whether the contract's function is paused.

isFunctionPaused

Gets whether a contract's function is paused.

    function isFunctionPaused(
        address contract_,
        bytes4 sig_
    )
        view
        returns (
            bool functionIsPaused_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

contract_

address

address

The address of a contract in the protocol.

1

sig_

bytes4

bytes4

The function signature within the contract.

Return Values:

IndexNameTypeInternal TypeDescription

0

functionIsPaused_

bool

bool

Whether the contract's function is paused.

isFunctionUnpaused

Gets whether a contract's function is uniquely unpaused. A false does not imply it is paused.

    function isFunctionUnpaused(
        address,
        bytes4
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

1

``

bytes4

bytes4

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isInstanceOf

Gets wether an instance is of some instance key.

    function isInstanceOf(
        bytes32,
        address
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

bytes32

bytes32

1

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isPoolAsset

Gets the validity of a pool asset.

    function isPoolAsset(
        address
    )
        view
        returns (
            bool
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

isPoolDelegate

Gets the validity of a pool delegate.

    function isPoolDelegate(
        address account_
    )
        view
        returns (
            bool isPoolDelegate_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

account_

address

address

The address of the account to query.

Return Values:

IndexNameTypeInternal TypeDescription

0

isPoolDelegate_

bool

bool

A boolean indicating the validity of the pool delegate.

isPoolDeployer

Gets the validity of a pool deployer.

    function isPoolDeployer(
        address caller_
    )
        view
        returns (
            bool isPoolDeployer_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

caller_

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

isPoolDeployer_

bool

bool

A boolean indicating the validity of the pool deployer.

isValidScheduledCall

Checks if a call is scheduled.

    function isValidScheduledCall(
        address caller_,
        address contract_,
        bytes32 functionId_,
        bytes callData_
    )
        view
        returns (
            bool isValid_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

caller_

address

address

The contract to execute the call on.

1

contract_

address

address

The contract to execute the call on.

2

functionId_

bytes32

bytes32

The id of the function to execute.

3

callData_

bytes

bytes

The of the parameters to pass to the function.

Return Values:

IndexNameTypeInternal TypeDescription

0

isValid_

bool

bool

True if the call is scheduled, false otherwise.

manualOverridePrice

Gets the manual override price for an asset.

    function manualOverridePrice(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

mapleTreasury

Gets maple treasury address.

    function mapleTreasury()
        view
        returns (
            address
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

address

address

maxCoverLiquidationPercent

Gets the maximum cover liquidation percent for a given pool manager.

    function maxCoverLiquidationPercent(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

migrationAdmin

Gets the migration admin address.

    function migrationAdmin()
        view
        returns (
            address
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

address

address

minCoverAmount

Gets the minimum cover amount for a given pool manager.

    function minCoverAmount(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

operationalAdmin

Gets the operational admin address.

    function operationalAdmin()
        view
        returns (
            address
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

address

address

ownedPoolManager

Gets the address of the owner pool manager.

    function ownedPoolManager(
        address account_
    )
        view
        returns (
            address poolManager_
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

account_

address

address

The address of the account to query.

Return Values:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager.

pendingGovernor

Gets the pending governor address.

    function pendingGovernor()
        view
        returns (
            address
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

address

address

platformManagementFeeRate

Gets the platform management fee rate for a given pool manager.

    function platformManagementFeeRate(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

platformOriginationFeeRate

Gets the platform origination fee rate for a given pool manager.

    function platformOriginationFeeRate(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

platformServiceFeeRate

Gets the platform service fee rate for a given pool manager.

    function platformServiceFeeRate(
        address
    )
        view
        returns (
            uint256
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

uint256

uint256

poolDelegates

Gets pool delegate address information.

    function poolDelegates(
        address
    )
        view
        returns (
            address ownedPoolManager,
            bool isPoolDelegate
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

ownedPoolManager

address

address

The address of the pool manager owned by the pool delegate.

1

isPoolDelegate

bool

bool

A boolean indication weather or not the address passed is a current pool delegate.

priceOracleOf

Gets the address and maximum delay of the oracle for the given asset.

    function priceOracleOf(
        address
    )
        view
        returns (
            address oracle,
            uint96 maxDelay
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

Return Values:

IndexNameTypeInternal TypeDescription

0

oracle

address

address

The address of the oracle.

1

maxDelay

uint96

uint96

The maximum delay of the oracle.

protocolPaused

Gets the status of the protocol pause.

    function protocolPaused()
        view
        returns (
            bool
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

bool

bool

scheduleCall

Schedules a call to be executed.

    function scheduleCall(
        address contract_,
        bytes32 functionId_,
        bytes callData_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

contract_

address

address

The contract to execute the call on.

1

functionId_

bytes32

bytes32

The id of the function to execute.

2

callData_

bytes

bytes

The of the parameters to pass to the function.

scheduledCalls

Gets the schedule calls for the parameters.

    function scheduledCalls(
        address,
        address,
        bytes32
    )
        view
        returns (
            uint256 timestamp,
            bytes32 dataHash
        );

Parameters:

IndexNameTypeInternal TypeDescription

0

``

address

address

1

``

address

address

2

``

bytes32

bytes32

Return Values:

IndexNameTypeInternal TypeDescription

0

timestamp

uint256

uint256

The timestamp of the next scheduled call.

1

dataHash

bytes32

bytes32

The hash of data fot the scheduled call.

securityAdmin

Gets security admin address.

    function securityAdmin()
        view
        returns (
            address
        );

Return Values:

IndexNameTypeInternal TypeDescription

0

address

address

setBootstrapMint

Sets the virtualized first mint that acts as as offset to `totalAssets` and `totalSupply` to prevent an MEV-exploit vector against the first pool depositor.

    function setBootstrapMint(
        address asset_,
        uint256 amount_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

asset_

address

address

The address of the pool asset.

1

amount_

uint256

uint256

setCanDeployFrom

Sets whether an account can deploying an instance from a particular factory.

    function setCanDeployFrom(
        address factory_,
        address account_,
        bool canDeployFrom_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

factory_

address

address

The address of the factory.

1

account_

address

address

The address of the account.

2

canDeployFrom_

bool

bool

Whether the account can deploy or not from the factory.

setContractPause

Sets whether a contract is uniquely paused.

    function setContractPause(
        address contract_,
        bool contractPaused_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

contract_

address

address

The address of a contract in the protocol.

1

contractPaused_

bool

bool

Whether the contract is uniquely paused.

setDefaultTimelockParameters

Sets the default time lock parameters.

    function setDefaultTimelockParameters(
        uint128 defaultTimelockDelay_,
        uint128 defaultTimelockDuration_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

defaultTimelockDelay_

uint128

uint128

The default time lock delay.

1

defaultTimelockDuration_

uint128

uint128

The default time lock duration.

setFunctionUnpause

Sets whether a contract's function is uniquely unpaused. A false does not imply it is paused.

    function setFunctionUnpause(
        address contract_,
        bytes4 sig_,
        bool functionUnpaused_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

contract_

address

address

The address of a contract in the protocol.

1

sig_

bytes4

bytes4

The function signature within the contract.

2

functionUnpaused_

bool

bool

Whether the contract's function is uniquely unpaused.

setManualOverridePrice

Sets the manual override price of the asset.

    function setManualOverridePrice(
        address asset_,
        uint256 price_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

asset_

address

address

The address of the asset to set the price for.

1

price_

uint256

uint256

The price of the asset.

setMapleTreasury

Sets the address of the Maple treasury.

    function setMapleTreasury(
        address mapleTreasury_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

mapleTreasury_

address

address

The address of the Maple treasury.

setMaxCoverLiquidationPercent

Sets the maximum cover liquidation percent for the given pool manager.

    function setMaxCoverLiquidationPercent(
        address poolManager_,
        uint256 maxCoverLiquidationPercent_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager to set the maximum cover liquidation percent for.

1

maxCoverLiquidationPercent_

uint256

uint256

The maximum cover liquidation percent.

setMigrationAdmin

Sets the address of the migration admin.

    function setMigrationAdmin(
        address migrationAdmin_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

migrationAdmin_

address

address

The address of the migration admin.

setMinCoverAmount

Sets the minimum cover amount for the given pool manager.

    function setMinCoverAmount(
        address poolManager_,
        uint256 minCoverAmount_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager to set the minimum cover amount for.

1

minCoverAmount_

uint256

uint256

The minimum cover amount.

setOperationalAdmin

Sets the address of the operational admin.

    function setOperationalAdmin(
        address operationalAdmin_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

operationalAdmin_

address

address

The address of the operational admin.

setPendingGovernor

Sets the pending governor.

    function setPendingGovernor(
        address pendingGovernor_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

pendingGovernor_

address

address

The new pending governor.

setPlatformManagementFeeRate

Sets the platform management fee rate for the given pool manager.

    function setPlatformManagementFeeRate(
        address poolManager_,
        uint256 platformManagementFeeRate_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager to set the fee for.

1

platformManagementFeeRate_

uint256

uint256

The platform management fee rate.

setPlatformOriginationFeeRate

Sets the platform origination fee rate for the given pool manager.

    function setPlatformOriginationFeeRate(
        address poolManager_,
        uint256 platformOriginationFeeRate_
    )
        nonpayable;

Parameters:

IndexNameTypeInternal TypeDescription

0

poolManager_

address

address

The address of the pool manager to set the fee for.

1

platformOriginationFeeRate_

uint256

uint256

The platform origination fee rate.

setPlatformServiceFeeRate

Sets the platform service fee rate for the given pool manager.

    function setPlatformServiceFeeRate(
        address poolManager_,
        uint256 platformServiceFeeRate_
    )