Globals
\
Functions
HUNDRED_PERCENT
HUNDRED_PERCENT
Return Values:
0
uint256
uint256
\
acceptGovernor
acceptGovernor
Accepts the governorship if the caller is the `pendingGovernor`.
\
activatePoolManager
activatePoolManager
Activates the pool manager.
Parameters:
0
poolManager_
address
address
The address of the pool manager to activate.
\
admin
admin
Returns the proxy's admin address.
Return Values:
0
admin_
address
address
The address of the admin.
\
bootstrapMint
bootstrapMint
Gets the virtualized first mint that acts as as offset to `totalAssets` and `totalSupply` for a given pool asset.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
canDeploy
canDeploy
Gets whether a caller account can deploy from the factory calling this function.
Parameters:
0
caller_
address
address
The address of the account calling the factory.
Return Values:
0
canDeploy_
bool
bool
Whether the account can deploy from the factory.
\
canDeployFrom
canDeployFrom
Gets whether a caller account can deploy from a factory.
Parameters:
0
factory_
address
address
The address of the factory.
1
caller_
address
address
The address of the account calling the factory.
Return Values:
0
canDeployFrom_
bool
bool
Whether the account can deploy from the factory.
\
defaultTimelockParameters
defaultTimelockParameters
Gets the default timelock parameters.
Return Values:
0
delay
uint128
uint128
The default timelock delay.
1
duration
uint128
uint128
The default timelock duration.
\
getLatestPrice
getLatestPrice
Gets the latest price for an asset.
Parameters:
0
asset_
address
address
The address of the asset to query.
Return Values:
0
latestPrice_
uint256
uint256
The latest price for the asset.
\
governor
governor
Gets governor address.
Return Values:
0
governor_
address
address
The address of the governor.
\
implementation
implementation
Returns the proxy's implementation address.
Return Values:
0
implementation_
address
address
The address of the implementation.
\
isBorrower
isBorrower
Gets the validity of a borrower.
Parameters:
0
``
address
address
Return Values:
0
bool
bool
\
isCollateralAsset
isCollateralAsset
Gets the validity of a collateral asset.
Parameters:
0
``
address
address
Return Values:
0
bool
bool
\
isContractPaused
isContractPaused
Gets whether a contract is uniquely paused.
Parameters:
0
``
address
address
Return Values:
0
bool
bool
\
isFactory
isFactory
Gets the validity of a factory.
Parameters:
0
factoryId_
bytes32
bytes32
The address of the factory to query.
1
factory_
address
address
The address of the factory to query.
Return Values:
0
isFactory_
bool
bool
A boolean indicating the validity of the factory.
\
isFunctionPaused
isFunctionPaused
Gets whether a contract's function is paused.
Parameters:
0
sig_
bytes4
bytes4
The function signature within the contract.
Return Values:
0
functionIsPaused_
bool
bool
Whether the contract's function is paused.
\
isFunctionPaused
isFunctionPaused
Gets whether a contract's function is paused.
Parameters:
0
contract_
address
address
The address of a contract in the protocol.
1
sig_
bytes4
bytes4
The function signature within the contract.
Return Values:
0
functionIsPaused_
bool
bool
Whether the contract's function is paused.
\
isFunctionUnpaused
isFunctionUnpaused
Gets whether a contract's function is uniquely unpaused. A false does not imply it is paused.
Parameters:
0
``
address
address
1
``
bytes4
bytes4
Return Values:
0
bool
bool
\
isInstanceOf
isInstanceOf
Gets wether an instance is of some instance key.
Parameters:
0
``
bytes32
bytes32
1
``
address
address
Return Values:
0
bool
bool
\
isPoolAsset
isPoolAsset
Gets the validity of a pool asset.
Parameters:
0
``
address
address
Return Values:
0
bool
bool
\
isPoolDelegate
isPoolDelegate
Gets the validity of a pool delegate.
Parameters:
0
account_
address
address
The address of the account to query.
Return Values:
0
isPoolDelegate_
bool
bool
A boolean indicating the validity of the pool delegate.
\
isPoolDeployer
isPoolDeployer
Gets the validity of a pool deployer.
Parameters:
0
caller_
address
address
Return Values:
0
isPoolDeployer_
bool
bool
A boolean indicating the validity of the pool deployer.
\
isValidScheduledCall
isValidScheduledCall
Checks if a call is scheduled.
Parameters:
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:
0
isValid_
bool
bool
True if the call is scheduled, false otherwise.
\
manualOverridePrice
manualOverridePrice
Gets the manual override price for an asset.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
mapleTreasury
mapleTreasury
Gets maple treasury address.
Return Values:
0
address
address
\
maxCoverLiquidationPercent
maxCoverLiquidationPercent
Gets the maximum cover liquidation percent for a given pool manager.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
migrationAdmin
migrationAdmin
Gets the migration admin address.
Return Values:
0
address
address
\
minCoverAmount
minCoverAmount
Gets the minimum cover amount for a given pool manager.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
operationalAdmin
operationalAdmin
Gets the operational admin address.
Return Values:
0
address
address
\
ownedPoolManager
ownedPoolManager
Gets the address of the owner pool manager.
Parameters:
0
account_
address
address
The address of the account to query.
Return Values:
0
poolManager_
address
address
The address of the pool manager.
\
pendingGovernor
pendingGovernor
Gets the pending governor address.
Return Values:
0
address
address
\
platformManagementFeeRate
platformManagementFeeRate
Gets the platform management fee rate for a given pool manager.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
platformOriginationFeeRate
platformOriginationFeeRate
Gets the platform origination fee rate for a given pool manager.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
platformServiceFeeRate
platformServiceFeeRate
Gets the platform service fee rate for a given pool manager.
Parameters:
0
``
address
address
Return Values:
0
uint256
uint256
\
poolDelegates
poolDelegates
Gets pool delegate address information.
Parameters:
0
``
address
address
Return Values:
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
priceOracleOf
Gets the address and maximum delay of the oracle for the given asset.
Parameters:
0
``
address
address
Return Values:
0
oracle
address
address
The address of the oracle.
1
maxDelay
uint96
uint96
The maximum delay of the oracle.
\
protocolPaused
protocolPaused
Gets the status of the protocol pause.
Return Values:
0
bool
bool
\
scheduleCall
scheduleCall
Schedules a call to be executed.
Parameters:
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
scheduledCalls
Gets the schedule calls for the parameters.
Parameters:
0
``
address
address
1
``
address
address
2
``
bytes32
bytes32
Return Values:
0
timestamp
uint256
uint256
The timestamp of the next scheduled call.
1
dataHash
bytes32
bytes32
The hash of data fot the scheduled call.
\
securityAdmin
securityAdmin
Gets security admin address.
Return Values:
0
address
address
\
setBootstrapMint
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.
Parameters:
0
asset_
address
address
The address of the pool asset.
1
amount_
uint256
uint256
\
setCanDeployFrom
setCanDeployFrom
Sets whether an account can deploying an instance from a particular factory.
Parameters:
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
setContractPause
Sets whether a contract is uniquely paused.
Parameters:
0
contract_
address
address
The address of a contract in the protocol.
1
contractPaused_
bool
bool
Whether the contract is uniquely paused.
\
setDefaultTimelockParameters
setDefaultTimelockParameters
Sets the default time lock parameters.
Parameters:
0
defaultTimelockDelay_
uint128
uint128
The default time lock delay.
1
defaultTimelockDuration_
uint128
uint128
The default time lock duration.
\
setFunctionUnpause
setFunctionUnpause
Sets whether a contract's function is uniquely unpaused. A false does not imply it is paused.
Parameters:
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
setManualOverridePrice
Sets the manual override price of the asset.
Parameters:
0
asset_
address
address
The address of the asset to set the price for.
1
price_
uint256
uint256
The price of the asset.
\
setMapleTreasury
setMapleTreasury
Sets the address of the Maple treasury.
Parameters:
0
mapleTreasury_
address
address
The address of the Maple treasury.
\
setMaxCoverLiquidationPercent
setMaxCoverLiquidationPercent
Sets the maximum cover liquidation percent for the given pool manager.
Parameters:
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
setMigrationAdmin
Sets the address of the migration admin.
Parameters:
0
migrationAdmin_
address
address
The address of the migration admin.
\
setMinCoverAmount
setMinCoverAmount
Sets the minimum cover amount for the given pool manager.
Parameters:
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
setOperationalAdmin
Sets the address of the operational admin.
Parameters:
0
operationalAdmin_
address
address
The address of the operational admin.
\
setPendingGovernor
setPendingGovernor
Sets the pending governor.
Parameters:
0
pendingGovernor_
address
address
The new pending governor.
\
setPlatformManagementFeeRate
setPlatformManagementFeeRate
Sets the platform management fee rate for the given pool manager.
Parameters:
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
setPlatformOriginationFeeRate
Sets the platform origination fee rate for the given pool manager.
Parameters:
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
setPlatformServiceFeeRate
Sets the platform service fee rate for the given pool manager.
Parameters:
0
poolManager_
address
address
The address of the pool manager to set the fee for.
1
platformServiceFeeRate_
uint256
uint256
The platform service fee rate.
\
setPriceOracle
setPriceOracle
Sets the price oracle for the given asset.
Parameters:
0
asset_
address
address
The address of the asset to set the oracle for.
1
oracle_
address
address
The address of the oracle to set for the asset.
2
maxDelay_
uint96
uint96
Maximum delay set to check for stale price.
\
setProtocolPause
setProtocolPause
Sets the protocol pause.
Parameters:
0
protocolPaused_
bool
bool
A boolean indicating the status of the protocol pause.
\
setSecurityAdmin
setSecurityAdmin
Sets the address of the security admin.
Parameters:
0
securityAdmin_
address
address
The address of the security admin.
\
setTimelockWindow
setTimelockWindow
Sets the timelock for the given contract.
Parameters:
0
contract_
address
address
The address of the contract to add.
1
functionId_
bytes32
bytes32
The id of the function.
2
delay_
uint128
uint128
The delay for the timelock window.
3
duration_
uint128
uint128
The duration for the timelock window.
\
setTimelockWindows
setTimelockWindows
Sets the timelock for the many function ids in a contract.
Parameters:
0
contract_
address
address
The address of the contract to add.
1
functionIds_
bytes32[]
bytes32[]
The ids of the functions.
2
delays_
uint128[]
uint128[]
The delays for the timelock window.
3
durations_
uint128[]
uint128[]
The durations for the timelock window.
\
setValidBorrower
setValidBorrower
Sets the validity of the borrower.
Parameters:
0
borrower_
address
address
The address of the borrower to set the validity for.
1
isValid_
bool
bool
A boolean indicating the validity of the borrower.
\
setValidCollateralAsset
setValidCollateralAsset
Sets the validity of a collateral asset.
Parameters:
0
collateralAsset_
address
address
The address of the collateral asset to set the validity for.
1
isValid_
bool
bool
A boolean indicating the validity of the collateral asset.
\
setValidInstanceOf
setValidInstanceOf
Sets the validity of the instance.
Parameters:
0
instanceKey_
bytes32
bytes32
The key of the instance to set the validity for.
1
instance_
address
address
The address of the instance to set the validity for.
2
isValid_
bool
bool
Boolean indicating the validity of the instance.
\
setValidPoolAsset
setValidPoolAsset
Sets the validity of the pool asset.
Parameters:
0
poolAsset_
address
address
The address of the pool asset to set the validity for.
1
isValid_
bool
bool
A boolean indicating the validity of the pool asset.
\
setValidPoolDelegate
setValidPoolDelegate
Sets the validity of the pool delegate.
Parameters:
0
account_
address
address
1
isValid_
bool
bool
A boolean indicating the validity of the pool delegate.
\
setValidPoolDeployer
setValidPoolDeployer
Sets the validity of the pool deployer.
Parameters:
0
account_
address
address
The address of the pool deployer to set the validity for.
1
isPoolDeployer_
bool
bool
A boolean indicating the validity of the pool deployer.
\
timelockParametersOf
timelockParametersOf
Gets the time lock parameters for a given contract and function.
Parameters:
0
``
address
address
1
``
bytes32
bytes32
Return Values:
0
delay
uint128
uint128
The time lock delay.
1
duration
uint128
uint128
The time lock duration.
\
transferOwnedPoolManager
transferOwnedPoolManager
Transfer the ownership of the pool manager.
Parameters:
0
fromPoolDelegate_
address
address
The address of the pool delegate to transfer ownership from.
1
toPoolDelegate_
address
address
The address of the pool delegate to transfer ownership to.
\
unscheduleCall
unscheduleCall
Unschedules a call to be executed.
Parameters:
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.
\
unscheduleCall
unscheduleCall
Unschedules a call to be executed.
Parameters:
0
caller_
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.
\
Events
BootstrapMintSet
BootstrapMintSet
A virtualized first mint that acts as as offset to `totalAssets` and `totalSupply`.
Parameters:
0
asset_
address
address
The address of the pool asset.
1
bootstrapMint_
uint256
uint256
The amount of shares that will offset `totalAssets` and `totalSupply`.
\
CallScheduled
CallScheduled
A time locked call has been scheduled.
Parameters:
0
caller_
address
address
The address of the function caller.
1
contract_
address
address
The contract to execute the call on.
2
functionId_
bytes32
bytes32
The id of the function to execute.
3
dataHash_
bytes32
bytes32
The hash of the parameters to pass to the function.
4
timestamp_
uint256
uint256
The timestamp of the schedule.
\
CallUnscheduled
CallUnscheduled
A time locked call has been unscheduled.
Parameters:
0
caller_
address
address
The address of the function caller.
1
contract_
address
address
The contract to execute the call on.
2
functionId_
bytes32
bytes32
The id of the function to execute.
3
dataHash_
bytes32
bytes32
The hash of the parameters to pass to the function.
4
timestamp_
uint256
uint256
The timestamp of the schedule.
\
CanDeployFromSet
CanDeployFromSet
An account has been allowed/disallowed from deploying an instance from a particular factory.
Parameters:
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 from the factory.
\
ContractPauseSet
ContractPauseSet
The paused state for a given protocol contract was set.
Parameters:
0
caller_
address
address
The address of the security admin or governor that performed the action.
1
contract_
address
address
The address of a contract in the protocol.
2
contractPaused_
bool
bool
Whether the contract is uniquely paused.
\
DefaultTimelockParametersSet
DefaultTimelockParametersSet
The default parameters for the time lock has been set.
Parameters:
0
previousDelay_
uint256
uint256
The previous required delay.
1
currentDelay_
uint256
uint256
The newly set required delay.
2
previousDuration_
uint256
uint256
The previous required duration.
3
currentDuration_
uint256
uint256
The newly set required duration.
\
FunctionUnpauseSet
FunctionUnpauseSet
The paused state for a function of a given protocol contract was set.
Parameters:
0
caller_
address
address
The address of the security admin or governor that performed the action.
1
contract_
address
address
The address of a contract in the protocol.
2
sig_
bytes4
bytes4
The function signature within the contract.
3
functionUnpaused_
bool
bool
Whether the contract's function is uniquely unpaused.
\
GovernorshipAccepted
GovernorshipAccepted
The governorship has been accepted.
Parameters:
0
previousGovernor_
address
address
The previous governor.
1
currentGovernor_
address
address
The new governor.
\
ManualOverridePriceSet
ManualOverridePriceSet
The price for an asset has been set.
Parameters:
0
asset_
address
address
The address of the asset.
1
price_
uint256
uint256
The manually set price of the asset.
\
MapleTreasurySet
MapleTreasurySet
The address for the Maple treasury has been set.
Parameters:
0
previousMapleTreasury_
address
address
The previous treasury.
1
currentMapleTreasury_
address
address
The new treasury.
\
MaxCoverLiquidationPercentSet
MaxCoverLiquidationPercentSet
The max liquidation percent for the given pool manager has been set.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
maxCoverLiquidationPercent_
uint256
uint256
The new value for the cover liquidation percent.
\
MigrationAdminSet
MigrationAdminSet
The migration admin has been set.
Parameters:
0
previousMigrationAdmin_
address
address
The previous migration admin.
1
nextMigrationAdmin_
address
address
The new migration admin.
\
MinCoverAmountSet
MinCoverAmountSet
The minimum cover amount for the given pool manager has been set.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
minCoverAmount_
uint256
uint256
The new value for the minimum cover amount.
\
OperationalAdminSet
OperationalAdminSet
The operational admin was set.
Parameters:
0
previousOperationalAdmin_
address
address
The address of the previous operational admin.
1
currentOperationalAdmin_
address
address
The address of the new operational admin.
\
PendingGovernorSet
PendingGovernorSet
The pending governor has been set.
Parameters:
0
pendingGovernor_
address
address
The new pending governor.
\
PlatformManagementFeeRateSet
PlatformManagementFeeRateSet
The platform management fee rate for the given pool manager has been set.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
platformManagementFeeRate_
uint256
uint256
The new value for the platform management fee rate.
\
PlatformOriginationFeeRateSet
PlatformOriginationFeeRateSet
The platform origination fee rate for the given pool manager has been set.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
platformOriginationFeeRate_
uint256
uint256
The new value for the origination fee rate.
\
PlatformServiceFeeRateSet
PlatformServiceFeeRateSet
The platform service fee rate for the given pool manager has been set.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
platformServiceFeeRate_
uint256
uint256
The new value for the platform service fee rate.
\
PoolManagerActivated
PoolManagerActivated
The pool manager was activated.
Parameters:
0
poolManager_
address
address
The address of the pool manager.
1
poolDelegate_
address
address
The address of the pool delegate.
\
PoolManagerOwnershipTransferred
PoolManagerOwnershipTransferred
The ownership of the pool manager was transferred.
Parameters:
0
fromPoolDelegate_
address
address
The address of the previous pool delegate.
1
toPoolDelegate_
address
address
The address of the new pool delegate.
2
poolManager_
address
address
The address of the pool manager.
\
PriceOracleSet
PriceOracleSet
The oracle for an asset has been set.
Parameters:
0
asset_
address
address
The address of the asset.
1
oracle_
address
address
The address of the oracle.
2
maxDelay_
uint96
uint96
The maximum delay of the oracle.
\
ProtocolPauseSet
ProtocolPauseSet
The protocol pause was set to a new state.
Parameters:
0
caller_
address
address
The address of the security admin or governor that performed the action.
1
protocolPaused_
bool
bool
The protocol paused state.
\
SecurityAdminSet
SecurityAdminSet
The security admin was set.
Parameters:
0
previousSecurityAdmin_
address
address
The address of the previous security admin.
1
currentSecurityAdmin_
address
address
The address of the new security admin.
\
TimelockWindowSet
TimelockWindowSet
A new timelock window was set.
Parameters:
0
contract_
address
address
The contract to execute the call on.
1
functionId_
bytes32
bytes32
The id of the function to execute.
2
delay_
uint128
uint128
The delay of the timelock window.
3
duration_
uint128
uint128
The duration of the timelock window.
\
ValidBorrowerSet
ValidBorrowerSet
A valid borrower was set.
Parameters:
0
borrower_
address
address
The address of the borrower.
1
isValid_
bool
bool
The validity of the borrower.
\
ValidCollateralAssetSet
ValidCollateralAssetSet
A valid asset was set.
Parameters:
0
collateralAsset_
address
address
The address of the collateral asset.
1
isValid_
bool
bool
The validity of the collateral asset.
\
ValidInstanceSet
ValidInstanceSet
A valid instance was set.
Parameters:
0
instanceKey_
bytes32
bytes32
The key of the instance.
1
instance_
address
address
The address of the instance.
2
isValid_
bool
bool
The validity of the instance.
\
ValidPoolAssetSet
ValidPoolAssetSet
A valid asset was set.
Parameters:
0
poolAsset_
address
address
The address of the asset.
1
isValid_
bool
bool
The validity of the asset.
\
ValidPoolDelegateSet
ValidPoolDelegateSet
A valid pool delegate was set.
Parameters:
0
account_
address
address
The address the account.
1
isValid_
bool
bool
The validity of the asset.
\
ValidPoolDeployerSet
ValidPoolDeployerSet
A valid pool deployer was set.
Parameters:
0
poolDeployer_
address
address
The address the account.
1
isValid_
bool
bool
The validity of the asset.
\
Last updated