// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;abstractcontractComptrollerInterface{
/// @notice Indicator that this is a Comptroller contract (for inspection)boolpublicconstant isComptroller =true;
/*** Assets You Are In ***/functionenterMarkets(address[] calldata mTokens
) externalvirtualreturns (uint[] memory);
functionexitMarket(address mToken) externalvirtualreturns (uint);
/*** Policy Hooks ***/functionmintAllowed(address mToken,
address minter,
uint mintAmount
) externalvirtualreturns (uint);
functionredeemAllowed(address mToken,
address redeemer,
uint redeemTokens
) externalvirtualreturns (uint);
// Do not remove, still used by MTokenfunctionredeemVerify(address mToken,
address redeemer,
uint redeemAmount,
uint redeemTokens
) externalpurevirtual;
functionborrowAllowed(address mToken,
address borrower,
uint borrowAmount
) externalvirtualreturns (uint);
functionrepayBorrowAllowed(address mToken,
address payer,
address borrower,
uint repayAmount
) externalvirtualreturns (uint);
functionliquidateBorrowAllowed(address mTokenBorrowed,
address mTokenCollateral,
address liquidator,
address borrower,
uint repayAmount
) externalviewvirtualreturns (uint);
functionseizeAllowed(address mTokenCollateral,
address mTokenBorrowed,
address liquidator,
address borrower,
uint seizeTokens
) externalvirtualreturns (uint);
functiontransferAllowed(address mToken,
address src,
address dst,
uint transferTokens
) externalvirtualreturns (uint);
/*** Liquidity/Liquidation Calculations ***/functionliquidateCalculateSeizeTokens(address mTokenBorrowed,
address mTokenCollateral,
uint repayAmount
) externalviewvirtualreturns (uint, uint);
}
// The hooks that were patched out of the comptroller to make room for the supply caps, if we need themabstractcontractComptrollerInterfaceWithAllVerificationHooksisComptrollerInterface{
functionmintVerify(address mToken,
address minter,
uint mintAmount,
uint mintTokens
) externalvirtual;
// Included in ComptrollerInterface already// function redeemVerify(address mToken, address redeemer, uint redeemAmount, uint redeemTokens) virtual external;functionborrowVerify(address mToken,
address borrower,
uint borrowAmount
) externalvirtual;
functionrepayBorrowVerify(address mToken,
address payer,
address borrower,
uint repayAmount,
uint borrowerIndex
) externalvirtual;
functionliquidateBorrowVerify(address mTokenBorrowed,
address mTokenCollateral,
address liquidator,
address borrower,
uint repayAmount,
uint seizeTokens
) externalvirtual;
functionseizeVerify(address mTokenCollateral,
address mTokenBorrowed,
address liquidator,
address borrower,
uint seizeTokens
) externalvirtual;
functiontransferVerify(address mToken,
address src,
address dst,
uint transferTokens
) externalvirtual;
}
Contract Source Code
File 2 of 6: EIP20NonStandardInterface.sol
// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;/**
* @title EIP20NonStandardInterface
* @dev Version of ERC20 with no return values for `transfer` and `transferFrom`
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca
*/interfaceEIP20NonStandardInterface{
/**
* @notice Get the total number of tokens in circulation
* @return The supply of tokens
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @notice Gets the balance of the specified address
* @param owner The address from which the balance will be retrieved
* @return balance The balance
*/functionbalanceOf(address owner) externalviewreturns (uint256 balance);
////// !!!!!!!!!!!!!!/// !!! NOTICE !!! `transfer` does not return a value, in violation of the ERC-20 specification/// !!!!!!!!!!!!!!////**
* @notice Transfer `amount` tokens from `msg.sender` to `dst`
* @param dst The address of the destination account
* @param amount The number of tokens to transfer
*/functiontransfer(address dst, uint256 amount) external;
////// !!!!!!!!!!!!!!/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the ERC-20 specification/// !!!!!!!!!!!!!!////**
* @notice Transfer `amount` tokens from `src` to `dst`
* @param src The address of the source account
* @param dst The address of the destination account
* @param amount The number of tokens to transfer
*/functiontransferFrom(address src, address dst, uint256 amount) external;
/**
* @notice Approve `spender` to transfer up to `amount` from `src`
* @dev This will overwrite the approval amount for `spender`
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve)
* @param spender The address of the account which may transfer tokens
* @param amount The number of tokens that are approved
* @return success Whether or not the approval succeeded
*/functionapprove(address spender,
uint256 amount
) externalreturns (bool success);
/**
* @notice Get the current allowance from `owner` for `spender`
* @param owner The address of the account which owns the tokens to be spent
* @param spender The address of the account which may transfer tokens
* @return remaining The number of tokens allowed to be spent
*/functionallowance(address owner,
address spender
) externalviewreturns (uint256 remaining);
eventTransfer(addressindexedfrom, addressindexed to, uint256 amount);
eventApproval(addressindexed owner,
addressindexed spender,
uint256 amount
);
}
Contract Source Code
File 3 of 6: ErrorReporter.sol
// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;contractComptrollerErrorReporter{
enumError {
NO_ERROR,
UNAUTHORIZED,
COMPTROLLER_MISMATCH,
INSUFFICIENT_SHORTFALL,
INSUFFICIENT_LIQUIDITY,
INVALID_CLOSE_FACTOR,
INVALID_COLLATERAL_FACTOR,
INVALID_LIQUIDATION_INCENTIVE,
MARKET_NOT_ENTERED, // no longer possible
MARKET_NOT_LISTED,
MARKET_ALREADY_LISTED,
MATH_ERROR,
NONZERO_BORROW_BALANCE,
PRICE_ERROR,
REJECTION,
SNAPSHOT_ERROR,
TOO_MANY_ASSETS,
TOO_MUCH_REPAY
}
enumFailureInfo {
ACCEPT_ADMIN_PENDING_ADMIN_CHECK,
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK,
EXIT_MARKET_BALANCE_OWED,
EXIT_MARKET_REJECTION,
SET_CLOSE_FACTOR_OWNER_CHECK,
SET_CLOSE_FACTOR_VALIDATION,
SET_COLLATERAL_FACTOR_OWNER_CHECK,
SET_COLLATERAL_FACTOR_NO_EXISTS,
SET_COLLATERAL_FACTOR_VALIDATION,
SET_COLLATERAL_FACTOR_WITHOUT_PRICE,
SET_IMPLEMENTATION_OWNER_CHECK,
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK,
SET_LIQUIDATION_INCENTIVE_VALIDATION,
SET_MAX_ASSETS_OWNER_CHECK,
SET_PENDING_ADMIN_OWNER_CHECK,
SET_PENDING_IMPLEMENTATION_OWNER_CHECK,
SET_PRICE_ORACLE_OWNER_CHECK,
SUPPORT_MARKET_EXISTS,
SUPPORT_MARKET_OWNER_CHECK,
SET_PAUSE_GUARDIAN_OWNER_CHECK,
SET_GAS_AMOUNT_OWNER_CHECK
}
/**
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary
* contract-specific code that enables us to report opaque error codes from upgradeable contracts.
**/eventFailure(uinterror, uint info, uint detail);
/**
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator
*/functionfail(Error err, FailureInfo info) internalreturns (uint) {
emit Failure(uint(err), uint(info), 0);
returnuint(err);
}
/**
* @dev use this when reporting an opaque error from an upgradeable collaborator contract
*/functionfailOpaque(Error err,
FailureInfo info,
uint opaqueError
) internalreturns (uint) {
emit Failure(uint(err), uint(info), opaqueError);
returnuint(err);
}
}
contractTokenErrorReporter{
enumError {
NO_ERROR,
UNAUTHORIZED,
BAD_INPUT,
COMPTROLLER_REJECTION,
COMPTROLLER_CALCULATION_ERROR,
INTEREST_RATE_MODEL_ERROR,
INVALID_ACCOUNT_PAIR,
INVALID_CLOSE_AMOUNT_REQUESTED,
INVALID_COLLATERAL_FACTOR,
MATH_ERROR,
MARKET_NOT_FRESH,
MARKET_NOT_LISTED,
TOKEN_INSUFFICIENT_ALLOWANCE,
TOKEN_INSUFFICIENT_BALANCE,
TOKEN_INSUFFICIENT_CASH,
TOKEN_TRANSFER_IN_FAILED,
TOKEN_TRANSFER_OUT_FAILED
}
/*
* Note: FailureInfo (but not Error) is kept in alphabetical order
* This is because FailureInfo grows significantly faster, and
* the order of Error has some meaning, while the order of FailureInfo
* is entirely arbitrary.
*/enumFailureInfo {
ACCEPT_ADMIN_PENDING_ADMIN_CHECK,
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED,
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED,
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED,
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED,
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED,
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED,
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED,
BORROW_ACCRUE_INTEREST_FAILED,
BORROW_CASH_NOT_AVAILABLE,
BORROW_FRESHNESS_CHECK,
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED,
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED,
BORROW_MARKET_NOT_LISTED,
BORROW_COMPTROLLER_REJECTION,
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED,
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED,
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK,
LIQUIDATE_COMPTROLLER_REJECTION,
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED,
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX,
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO,
LIQUIDATE_FRESHNESS_CHECK,
LIQUIDATE_LIQUIDATOR_IS_BORROWER,
LIQUIDATE_REPAY_BORROW_FRESH_FAILED,
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED,
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED,
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION,
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER,
LIQUIDATE_SEIZE_TOO_MUCH,
MINT_ACCRUE_INTEREST_FAILED,
MINT_COMPTROLLER_REJECTION,
MINT_EXCHANGE_CALCULATION_FAILED,
MINT_EXCHANGE_RATE_READ_FAILED,
MINT_FRESHNESS_CHECK,
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED,
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED,
MINT_TRANSFER_IN_FAILED,
MINT_TRANSFER_IN_NOT_POSSIBLE,
REDEEM_ACCRUE_INTEREST_FAILED,
REDEEM_COMPTROLLER_REJECTION,
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED,
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED,
REDEEM_EXCHANGE_RATE_READ_FAILED,
REDEEM_FRESHNESS_CHECK,
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED,
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED,
REDEEM_TRANSFER_OUT_NOT_POSSIBLE,
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED,
REDUCE_RESERVES_ADMIN_CHECK,
REDUCE_RESERVES_CASH_NOT_AVAILABLE,
REDUCE_RESERVES_FRESH_CHECK,
REDUCE_RESERVES_VALIDATION,
REPAY_BEHALF_ACCRUE_INTEREST_FAILED,
REPAY_BORROW_ACCRUE_INTEREST_FAILED,
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED,
REPAY_BORROW_COMPTROLLER_REJECTION,
REPAY_BORROW_FRESHNESS_CHECK,
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED,
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED,
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE,
SET_COLLATERAL_FACTOR_OWNER_CHECK,
SET_COLLATERAL_FACTOR_VALIDATION,
SET_COMPTROLLER_OWNER_CHECK,
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED,
SET_INTEREST_RATE_MODEL_FRESH_CHECK,
SET_INTEREST_RATE_MODEL_OWNER_CHECK,
SET_MAX_ASSETS_OWNER_CHECK,
SET_ORACLE_MARKET_NOT_LISTED,
SET_PENDING_ADMIN_OWNER_CHECK,
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED,
SET_RESERVE_FACTOR_ADMIN_CHECK,
SET_RESERVE_FACTOR_FRESH_CHECK,
SET_RESERVE_FACTOR_BOUNDS_CHECK,
TRANSFER_COMPTROLLER_REJECTION,
TRANSFER_NOT_ALLOWED,
TRANSFER_NOT_ENOUGH,
TRANSFER_TOO_MUCH,
ADD_RESERVES_ACCRUE_INTEREST_FAILED,
ADD_RESERVES_FRESH_CHECK,
ADD_RESERVES_TRANSFER_IN_NOT_POSSIBLE,
SET_PROTOCOL_SEIZE_SHARE_ACCRUE_INTEREST_FAILED,
SET_PROTOCOL_SEIZE_SHARE_OWNER_CHECK,
SET_PROTOCOL_SEIZE_SHARE_FRESH_CHECK
}
/**
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary
* contract-specific code that enables us to report opaque error codes from upgradeable contracts.
**/eventFailure(uinterror, uint info, uint detail);
/**
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator
*/functionfail(Error err, FailureInfo info) internalreturns (uint) {
emit Failure(uint(err), uint(info), 0);
returnuint(err);
}
/**
* @dev use this when reporting an opaque error from an upgradeable collaborator contract
*/functionfailOpaque(Error err,
FailureInfo info,
uint opaqueError
) internalreturns (uint) {
emit Failure(uint(err), uint(info), opaqueError);
returnuint(err);
}
}
Contract Source Code
File 4 of 6: InterestRateModel.sol
// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;/**
* @title Moonwell's InterestRateModel Interface
* @author Moonwell
*/abstractcontractInterestRateModel{
/// @notice Indicator that this is an InterestRateModel contract (for inspection)boolpublicconstant isInterestRateModel =true;
/**
* @notice Calculates the current borrow interest rate per timestamp
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @return The borrow rate per timestamp (as a percentage, and scaled by 1e18)
*/functiongetBorrowRate(uint cash,
uint borrows,
uint reserves
) externalviewvirtualreturns (uint);
/**
* @notice Calculates the current supply interest rate per timestamp
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @param reserveFactorMantissa The current reserve factor the market has
* @return The supply rate per timestamp (as a percentage, and scaled by 1e18)
*/functiongetSupplyRate(uint cash,
uint borrows,
uint reserves,
uint reserveFactorMantissa
) externalviewvirtualreturns (uint);
}
Contract Source Code
File 5 of 6: MErc20Delegator.sol
// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;import"./MTokenInterfaces.sol";
/**
* @title Moonwell's MErc20Delegator Contract
* @notice MTokens which wrap an EIP-20 underlying and delegate to an implementation
* @author Moonwell
*/contractMErc20DelegatorisMTokenInterface,
MErc20Interface,
MDelegatorInterface{
/**
* @notice Construct a new money market
* @param underlying_ The address of the underlying asset
* @param comptroller_ The address of the Comptroller
* @param interestRateModel_ The address of the interest rate model
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18
* @param name_ ERC-20 name of this token
* @param symbol_ ERC-20 symbol of this token
* @param decimals_ ERC-20 decimal precision of this token
* @param admin_ Address of the administrator of this token
* @param implementation_ The address of the implementation the contract delegates to
* @param becomeImplementationData The encoded args for becomeImplementation
*/constructor(address underlying_,
ComptrollerInterface comptroller_,
InterestRateModel interestRateModel_,
uint initialExchangeRateMantissa_,
stringmemory name_,
stringmemory symbol_,
uint8 decimals_,
addresspayable admin_,
address implementation_,
bytesmemory becomeImplementationData
) {
// Creator of the contract is admin during initialization
admin =payable(msg.sender);
// First delegate gets to initialize the delegator (i.e. storage contract)
delegateTo(
implementation_,
abi.encodeWithSignature(
"initialize(address,address,address,uint256,string,string,uint8)",
underlying_,
comptroller_,
interestRateModel_,
initialExchangeRateMantissa_,
name_,
symbol_,
decimals_
)
);
// New implementations always get set via the settor (post-initialize)
_setImplementation(implementation_, false, becomeImplementationData);
// Set the proper admin now that initialization is done
admin = admin_;
}
/**
* @notice Called by the admin to update the implementation of the delegator
* @param implementation_ The address of the new implementation for delegation
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation
*/function_setImplementation(address implementation_,
bool allowResign,
bytesmemory becomeImplementationData
) publicoverride{
require(
msg.sender== admin,
"MErc20Delegator::_setImplementation: Caller must be admin"
);
if (allowResign) {
delegateToImplementation(
abi.encodeWithSignature("_resignImplementation()")
);
}
address oldImplementation = implementation;
implementation = implementation_;
delegateToImplementation(
abi.encodeWithSignature(
"_becomeImplementation(bytes)",
becomeImplementationData
)
);
emit NewImplementation(oldImplementation, implementation);
}
/**
* @notice Sender supplies assets into the market and receives mTokens in exchange
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param mintAmount The amount of the underlying asset to supply
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionmint(uint mintAmount) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("mint(uint256)", mintAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Supply assets but without a 2-step approval process, EIP-2612
* @dev Simply calls the underlying token's `permit()` function and then assumes things worked
* @param mintAmount The amount of the underlying asset to supply
* @param deadline The amount of the underlying asset to supply
* @param v ECDSA recovery id for the signature
* @param r ECDSA r parameter for the signature
* @param s ECDSA s parameter for the signature
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionmintWithPermit(uint mintAmount,
uint deadline,
uint8 v,
bytes32 r,
bytes32 s
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"mintWithPermit(uint256,uint256,uint8,bytes32,bytes32)",
mintAmount,
deadline,
v,
r,
s
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sender redeems mTokens in exchange for the underlying asset
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param redeemTokens The number of mTokens to redeem into underlying
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionredeem(uint redeemTokens) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("redeem(uint256)", redeemTokens)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sender redeems mTokens in exchange for a specified amount of underlying asset
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param redeemAmount The amount of underlying to redeem
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionredeemUnderlying(uint redeemAmount
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("redeemUnderlying(uint256)", redeemAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sender borrows assets from the protocol to their own address
* @param borrowAmount The amount of the underlying asset to borrow
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionborrow(uint borrowAmount) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("borrow(uint256)", borrowAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sender repays their own borrow
* @param repayAmount The amount to repay, or uint.max for the full outstanding amount
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionrepayBorrow(uint repayAmount) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("repayBorrow(uint256)", repayAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sender repays a borrow belonging to borrower
* @param borrower the account with the debt being payed off
* @param repayAmount The amount to repay, or uint.max for the full outstanding amount
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionrepayBorrowBehalf(address borrower,
uint repayAmount
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"repayBorrowBehalf(address,uint256)",
borrower,
repayAmount
)
);
returnabi.decode(data, (uint));
}
/**
* @notice The sender liquidates the borrowers collateral.
* The collateral seized is transferred to the liquidator.
* @param borrower The borrower of this mToken to be liquidated
* @param mTokenCollateral The market in which to seize collateral from the borrower
* @param repayAmount The amount of the underlying borrowed asset to repay
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionliquidateBorrow(address borrower,
uint repayAmount,
MTokenInterface mTokenCollateral
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"liquidateBorrow(address,uint256,address)",
borrower,
repayAmount,
mTokenCollateral
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Transfer `amount` tokens from `msg.sender` to `dst`
* @param dst The address of the destination account
* @param amount The number of tokens to transfer
* @return Whether or not the transfer succeeded
*/functiontransfer(address dst,
uint amount
) externaloverridereturns (bool) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("transfer(address,uint256)", dst, amount)
);
returnabi.decode(data, (bool));
}
/**
* @notice Transfer `amount` tokens from `src` to `dst`
* @param src The address of the source account
* @param dst The address of the destination account
* @param amount The number of tokens to transfer
* @return Whether or not the transfer succeeded
*/functiontransferFrom(address src,
address dst,
uint256 amount
) externaloverridereturns (bool) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"transferFrom(address,address,uint256)",
src,
dst,
amount
)
);
returnabi.decode(data, (bool));
}
/**
* @notice Approve `spender` to transfer up to `amount` from `src`
* @dev This will overwrite the approval amount for `spender`
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve)
* @param spender The address of the account which may transfer tokens
* @param amount The number of tokens that are approved (uint.max means infinite)
* @return Whether or not the approval succeeded
*/functionapprove(address spender,
uint256 amount
) externaloverridereturns (bool) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("approve(address,uint256)", spender, amount)
);
returnabi.decode(data, (bool));
}
/**
* @notice Get the current allowance from `owner` for `spender`
* @param owner The address of the account which owns the tokens to be spent
* @param spender The address of the account which may transfer tokens
* @return The number of tokens allowed to be spent (uint.max means infinite)
*/functionallowance(address owner,
address spender
) externalviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature(
"allowance(address,address)",
owner,
spender
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Get the token balance of the `owner`
* @param owner The address of the account to query
* @return The number of tokens owned by `owner`
*/functionbalanceOf(address owner) externalviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("balanceOf(address)", owner)
);
returnabi.decode(data, (uint));
}
/**
* @notice Get the underlying balance of the `owner`
* @dev This also accrues interest in a transaction
* @param owner The address of the account to query
* @return The amount of underlying owned by `owner`
*/functionbalanceOfUnderlying(address owner
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("balanceOfUnderlying(address)", owner)
);
returnabi.decode(data, (uint));
}
/**
* @notice Get a snapshot of the account's balances, and the cached exchange rate
* @dev This is used by comptroller to more efficiently perform liquidity checks.
* @param account Address of the account to snapshot
* @return (possible error, token balance, borrow balance, exchange rate mantissa)
*/functiongetAccountSnapshot(address account
) externalviewoverridereturns (uint, uint, uint, uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("getAccountSnapshot(address)", account)
);
returnabi.decode(data, (uint, uint, uint, uint));
}
/**
* @notice Returns the current per-timestamp borrow interest rate for this mToken
* @return The borrow interest rate per timestamp, scaled by 1e18
*/functionborrowRatePerTimestamp() externalviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("borrowRatePerTimestamp()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Returns the current per-timestamp supply interest rate for this mToken
* @return The supply interest rate per timestamp, scaled by 1e18
*/functionsupplyRatePerTimestamp() externalviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("supplyRatePerTimestamp()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Returns the current total borrows plus accrued interest
* @return The total borrows with interest
*/functiontotalBorrowsCurrent() externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("totalBorrowsCurrent()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex
* @param account The address whose balance should be calculated after updating borrowIndex
* @return The calculated balance
*/functionborrowBalanceCurrent(address account
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("borrowBalanceCurrent(address)", account)
);
returnabi.decode(data, (uint));
}
/**
* @notice Return the borrow balance of account based on stored data
* @param account The address whose balance should be calculated
* @return The calculated balance
*/functionborrowBalanceStored(address account
) publicviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("borrowBalanceStored(address)", account)
);
returnabi.decode(data, (uint));
}
/**
* @notice Accrue interest then return the up-to-date exchange rate
* @return Calculated exchange rate scaled by 1e18
*/functionexchangeRateCurrent() publicoverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("exchangeRateCurrent()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Calculates the exchange rate from the underlying to the MToken
* @dev This function does not accrue interest before calculating the exchange rate
* @return Calculated exchange rate scaled by 1e18
*/functionexchangeRateStored() publicviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("exchangeRateStored()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Get cash balance of this mToken in the underlying asset
* @return The quantity of underlying asset owned by this contract
*/functiongetCash() externalviewoverridereturns (uint) {
bytesmemory data = delegateToViewImplementation(
abi.encodeWithSignature("getCash()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Applies accrued interest to total borrows and reserves.
* @dev This calculates interest accrued from the last checkpointed block
* up to the current block and writes new checkpoint to storage.
*/functionaccrueInterest() publicoverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("accrueInterest()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Transfers collateral tokens (this market) to the liquidator.
* @dev Will fail unless called by another mToken during the process of liquidation.
* Its absolutely critical to use msg.sender as the borrowed mToken and not a parameter.
* @param liquidator The account receiving seized collateral
* @param borrower The account having collateral seized
* @param seizeTokens The number of mTokens to seize
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/functionseize(address liquidator,
address borrower,
uint seizeTokens
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"seize(address,address,uint256)",
liquidator,
borrower,
seizeTokens
)
);
returnabi.decode(data, (uint));
}
/**
* @notice A public function to sweep accidental ERC-20 transfers to this contract. Tokens are sent to admin (timelock)
* @param token The address of the ERC-20 token to sweep
*/functionsweepToken(EIP20NonStandardInterface token) externaloverride{
delegateToImplementation(
abi.encodeWithSignature("sweepToken(address)", token)
);
}
/*** Admin Functions ***//**
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer.
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer.
* @param newPendingAdmin New pending admin.
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_setPendingAdmin(addresspayable newPendingAdmin
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"_setPendingAdmin(address)",
newPendingAdmin
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Sets a new comptroller for the market
* @dev Admin function to set a new comptroller
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_setComptroller(
ComptrollerInterface newComptroller
) publicoverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("_setComptroller(address)", newComptroller)
);
returnabi.decode(data, (uint));
}
/**
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh
* @dev Admin function to accrue interest and set a new reserve factor
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_setReserveFactor(uint newReserveFactorMantissa
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"_setReserveFactor(uint256)",
newReserveFactorMantissa
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin
* @dev Admin function for pending admin to accept role and update admin
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_acceptAdmin() externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("_acceptAdmin()")
);
returnabi.decode(data, (uint));
}
/**
* @notice Accrues interest and adds reserves by transferring from admin
* @param addAmount Amount of reserves to add
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_addReserves(uint addAmount) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("_addReserves(uint256)", addAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Accrues interest and reduces reserves by transferring to admin
* @param reduceAmount Amount of reduction to reserves
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_reduceReserves(uint reduceAmount
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature("_reduceReserves(uint256)", reduceAmount)
);
returnabi.decode(data, (uint));
}
/**
* @notice Accrues interest and updates the interest rate model using _setInterestRateModelFresh
* @dev Admin function to accrue interest and update the interest rate model
* @param newInterestRateModel the new interest rate model to use
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_setInterestRateModel(
InterestRateModel newInterestRateModel
) publicoverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"_setInterestRateModel(address)",
newInterestRateModel
)
);
returnabi.decode(data, (uint));
}
/**
* @notice accrues interest and sets a new protocol seize share for the protocol using _setProtocolSeizeShareFresh
* @dev Admin function to accrue interest and set a new protocol seize share
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
*/function_setProtocolSeizeShare(uint newProtocolSeizeShareMantissa
) externaloverridereturns (uint) {
bytesmemory data = delegateToImplementation(
abi.encodeWithSignature(
"_setProtocolSeizeShare(uint256)",
newProtocolSeizeShareMantissa
)
);
returnabi.decode(data, (uint));
}
/**
* @notice Internal method to delegate execution to another contract
* @dev It returns to the external caller whatever the implementation returns or forwards reverts
* @param callee The contract to delegatecall
* @param data The raw data to delegatecall
* @return The returned bytes from the delegatecall
*/functiondelegateTo(address callee,
bytesmemory data
) internalreturns (bytesmemory) {
(bool success, bytesmemory returnData) = callee.delegatecall(data);
assembly {
ifeq(success, 0) {
revert(add(returnData, 0x20), returndatasize())
}
}
return returnData;
}
/**
* @notice Delegates execution to the implementation contract
* @dev It returns to the external caller whatever the implementation returns or forwards reverts
* @param data The raw data to delegatecall
* @return The returned bytes from the delegatecall
*/functiondelegateToImplementation(bytesmemory data
) publicreturns (bytesmemory) {
return delegateTo(implementation, data);
}
/**
* @notice Delegates execution to an implementation contract
* @dev It returns to the external caller whatever the implementation returns or forwards reverts
* There are an additional 2 prefix uints from the wrapper returndata, which we ignore since we make an extra hop.
* @param data The raw data to delegatecall
* @return The returned bytes from the delegatecall
*/functiondelegateToViewImplementation(bytesmemory data
) publicviewreturns (bytesmemory) {
(bool success, bytesmemory returnData) =address(this).staticcall(
abi.encodeWithSignature("delegateToImplementation(bytes)", data)
);
assembly {
ifeq(success, 0) {
revert(add(returnData, 0x20), returndatasize())
}
}
returnabi.decode(returnData, (bytes));
}
/**
* @notice Delegates execution to an implementation contract
* @dev It returns to the external caller whatever the implementation returns or forwards reverts
*/fallback() externalpayable{
require(
msg.value==0,
"MErc20Delegator:fallback: cannot send value to fallback"
);
// delegate all other functions to current implementation
(bool success, ) = implementation.delegatecall(msg.data);
assembly {
let free_mem_ptr :=mload(0x40)
returndatacopy(free_mem_ptr, 0, returndatasize())
switch success
case0 {
revert(free_mem_ptr, returndatasize())
}
default {
return(free_mem_ptr, returndatasize())
}
}
}
}
Contract Source Code
File 6 of 6: MTokenInterfaces.sol
// SPDX-License-Identifier: BSD-3-Clausepragmasolidity 0.8.19;import"./ComptrollerInterface.sol";
import"./irm/InterestRateModel.sol";
import"./EIP20NonStandardInterface.sol";
import"./ErrorReporter.sol";
contractMTokenStorage{
/// @dev Guard variable for re-entrancy checksboolinternal _notEntered;
/// @notice EIP-20 token name for this tokenstringpublic name;
/// @notice EIP-20 token symbol for this tokenstringpublic symbol;
/// @notice EIP-20 token decimals for this tokenuint8public decimals;
/// @notice Maximum borrow rate that can ever be applied (.0005% / block)uintinternalconstant borrowRateMaxMantissa =0.0005e16;
// @notice Maximum fraction of interest that can be set aside for reservesuintinternalconstant reserveFactorMaxMantissa =1e18;
/// @notice Administrator for this contractaddresspayablepublic admin;
/// @notice Pending administrator for this contractaddresspayablepublic pendingAdmin;
/// @notice Contract which oversees inter-mToken operations
ComptrollerInterface public comptroller;
/// @notice Model which tells what the current interest rate should be
InterestRateModel public interestRateModel;
// @notice Initial exchange rate used when minting the first MTokens (used when totalSupply = 0)uintinternal initialExchangeRateMantissa;
/// @notice Fraction of interest currently set aside for reservesuintpublic reserveFactorMantissa;
/// @notice Block number that interest was last accrued atuintpublic accrualBlockTimestamp;
/// @notice Accumulator of the total earned interest rate since the opening of the marketuintpublic borrowIndex;
/// @notice Total amount of outstanding borrows of the underlying in this marketuintpublic totalBorrows;
/// @notice Total amount of reserves of the underlying held in this marketuintpublic totalReserves;
/// @notice Total number of tokens in circulationuintpublic totalSupply;
/// @notice Official record of token balances for each accountmapping(address=>uint) internal accountTokens;
/// @notice Approved token transfer amounts on behalf of othersmapping(address=>mapping(address=>uint)) internal transferAllowances;
/**
* @notice Container for borrow balance information
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action
* @member interestIndex Global borrowIndex as of the most recent balance-changing action
*/structBorrowSnapshot {
uint principal;
uint interestIndex;
}
// @notice Mapping of account addresses to outstanding borrow balancesmapping(address=> BorrowSnapshot) internal accountBorrows;
/// @notice Share of seized collateral that is added to reservesuintpublic protocolSeizeShareMantissa;
}
abstractcontractMTokenInterfaceisMTokenStorage{
/// @notice Indicator that this is a MToken contract (for inspection)boolpublicconstant isMToken =true;
/*** Market Events ***//// @notice Event emitted when interest is accruedeventAccrueInterest(uint cashPrior,
uint interestAccumulated,
uint borrowIndex,
uint totalBorrows
);
/// @notice Event emitted when tokens are mintedeventMint(address minter, uint mintAmount, uint mintTokens);
/// @notice Event emitted when tokens are redeemedeventRedeem(address redeemer, uint redeemAmount, uint redeemTokens);
/// @notice Event emitted when underlying is borrowedeventBorrow(address borrower,
uint borrowAmount,
uint accountBorrows,
uint totalBorrows
);
/// @notice Event emitted when a borrow is repaideventRepayBorrow(address payer,
address borrower,
uint repayAmount,
uint accountBorrows,
uint totalBorrows
);
/// @notice Event emitted when a borrow is liquidatedeventLiquidateBorrow(address liquidator,
address borrower,
uint repayAmount,
address mTokenCollateral,
uint seizeTokens
);
/*** Admin Events ***//// @notice Event emitted when pendingAdmin is changedeventNewPendingAdmin(address oldPendingAdmin, address newPendingAdmin);
/// @notice Event emitted when pendingAdmin is accepted, which means admin is updatedeventNewAdmin(address oldAdmin, address newAdmin);
/// @notice Event emitted when comptroller is changedeventNewComptroller(
ComptrollerInterface oldComptroller,
ComptrollerInterface newComptroller
);
/// @notice Event emitted when interestRateModel is changedeventNewMarketInterestRateModel(
InterestRateModel oldInterestRateModel,
InterestRateModel newInterestRateModel
);
/// @notice Event emitted when the reserve factor is changedeventNewReserveFactor(uint oldReserveFactorMantissa,
uint newReserveFactorMantissa
);
/// @notice Event emitted when the protocol seize share is changedeventNewProtocolSeizeShare(uint oldProtocolSeizeShareMantissa,
uint newProtocolSeizeShareMantissa
);
/// @notice Event emitted when the reserves are addedeventReservesAdded(address benefactor,
uint addAmount,
uint newTotalReserves
);
/// @notice Event emitted when the reserves are reducedeventReservesReduced(address admin,
uint reduceAmount,
uint newTotalReserves
);
/// @notice EIP20 Transfer eventeventTransfer(addressindexedfrom, addressindexed to, uint amount);
/// @notice EIP20 Approval eventeventApproval(addressindexed owner, addressindexed spender, uint amount);
/*** User Interface ***/functiontransfer(address dst, uint amount) externalvirtualreturns (bool);
functiontransferFrom(address src,
address dst,
uint amount
) externalvirtualreturns (bool);
functionapprove(address spender,
uint amount
) externalvirtualreturns (bool);
functionallowance(address owner,
address spender
) externalviewvirtualreturns (uint);
functionbalanceOf(address owner) externalviewvirtualreturns (uint);
functionbalanceOfUnderlying(address owner) externalvirtualreturns (uint);
functiongetAccountSnapshot(address account
) externalviewvirtualreturns (uint, uint, uint, uint);
functionborrowRatePerTimestamp() externalviewvirtualreturns (uint);
functionsupplyRatePerTimestamp() externalviewvirtualreturns (uint);
functiontotalBorrowsCurrent() externalvirtualreturns (uint);
functionborrowBalanceCurrent(address account
) externalvirtualreturns (uint);
functionborrowBalanceStored(address account
) externalviewvirtualreturns (uint);
functionexchangeRateCurrent() externalvirtualreturns (uint);
functionexchangeRateStored() externalviewvirtualreturns (uint);
functiongetCash() externalviewvirtualreturns (uint);
functionaccrueInterest() externalvirtualreturns (uint);
functionseize(address liquidator,
address borrower,
uint seizeTokens
) externalvirtualreturns (uint);
/*** Admin Functions ***/function_setPendingAdmin(addresspayable newPendingAdmin
) externalvirtualreturns (uint);
function_acceptAdmin() externalvirtualreturns (uint);
function_setComptroller(
ComptrollerInterface newComptroller
) externalvirtualreturns (uint);
function_setReserveFactor(uint newReserveFactorMantissa
) externalvirtualreturns (uint);
function_reduceReserves(uint reduceAmount) externalvirtualreturns (uint);
function_setInterestRateModel(
InterestRateModel newInterestRateModel
) externalvirtualreturns (uint);
function_setProtocolSeizeShare(uint newProtocolSeizeShareMantissa
) externalvirtualreturns (uint);
}
contractMErc20Storage{
/// @notice Underlying asset for this MTokenaddresspublic underlying;
}
abstractcontractMErc20InterfaceisMErc20Storage{
/*** User Interface ***/functionmint(uint mintAmount) externalvirtualreturns (uint);
functionmintWithPermit(uint mintAmount,
uint deadline,
uint8 v,
bytes32 r,
bytes32 s
) externalvirtualreturns (uint);
functionredeem(uint redeemTokens) externalvirtualreturns (uint);
functionredeemUnderlying(uint redeemAmount
) externalvirtualreturns (uint);
functionborrow(uint borrowAmount) externalvirtualreturns (uint);
functionrepayBorrow(uint repayAmount) externalvirtualreturns (uint);
functionrepayBorrowBehalf(address borrower,
uint repayAmount
) externalvirtualreturns (uint);
functionliquidateBorrow(address borrower,
uint repayAmount,
MTokenInterface mTokenCollateral
) externalvirtualreturns (uint);
functionsweepToken(EIP20NonStandardInterface token) externalvirtual;
/*** Admin Functions ***/function_addReserves(uint addAmount) externalvirtualreturns (uint);
}
contractMDelegationStorage{
/// @notice Implementation address for this contractaddresspublic implementation;
}
abstractcontractMDelegatorInterfaceisMDelegationStorage{
/// @notice Emitted when implementation is changedeventNewImplementation(address oldImplementation,
address newImplementation
);
/**
* @notice Called by the admin to update the implementation of the delegator
* @param implementation_ The address of the new implementation for delegation
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation
*/function_setImplementation(address implementation_,
bool allowResign,
bytesmemory becomeImplementationData
) externalvirtual;
}
abstractcontractMDelegateInterfaceisMDelegationStorage{
/**
* @notice Called by the delegator on a delegate to initialize it for duty
* @dev Should revert if any issues arise which make it unfit for delegation
* @param data The encoded bytes data for any initialization
*/function_becomeImplementation(bytesmemory data) externalvirtual;
/// @notice Called by the delegator on a delegate to forfeit its responsibilityfunction_resignImplementation() externalvirtual;
}