Bondtroller
Bonded
Remastered from Compound's Bondtroller Contract
Methods
_borrowGuardianPaused
function _borrowGuardianPaused() external view returns (bool)Returns
_0
bool
undefined
_mintGuardianPaused
function _mintGuardianPaused() external view returns (bool)Returns
_0
bool
undefined
accountAssets
function accountAssets(address, uint256) external view returns (contract BToken)Per-account mapping of "assets you are in", capped by maxAssets
Parameters
_0
address
undefined
_1
uint256
undefined
Returns
_0
contract BToken
undefined
accountMembership
function accountMembership(address, address) external view returns (bool)Per-market mapping of "accounts in this asset"
Parameters
_0
address
undefined
_1
address
undefined
Returns
_0
bool
undefined
admin
function admin() external view returns (address)Administrator for this contract
Returns
_0
address
undefined
allMarkets
function allMarkets(uint256) external view returns (contract BToken)A list of all markets
Parameters
_0
uint256
undefined
Returns
_0
contract BToken
undefined
borrowAllowed
function borrowAllowed(address bToken, address borrower, uint256 borrowAmount) external nonpayable returns (uint256)Checks if the account should be allowed to borrow the underlying asset of the given market
Parameters
bToken
address
The market to verify the borrow against
borrower
address
The account which would borrow the asset
borrowAmount
uint256
The amount of underlying the account would borrow
Returns
_0
uint256
0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol)
borrowCapGuardian
function borrowCapGuardian() external view returns (address)Returns
_0
address
undefined
borrowCaps
function borrowCaps(address) external view returns (uint256)Parameters
_0
address
undefined
Returns
_0
uint256
undefined
borrowGuardianPaused
function borrowGuardianPaused(address) external view returns (bool)Parameters
_0
address
undefined
Returns
_0
bool
undefined
borrowVerify
function borrowVerify(address bToken, address borrower, uint256 borrowAmount) external nonpayableValidates borrow and reverts on rejection. May emit logs.
Parameters
bToken
address
Asset whose underlying is being borrowed
borrower
address
The address borrowing the underlying
borrowAmount
uint256
The amount of the underlying asset requested to borrow
checkMembership
function checkMembership(address account, contract BToken bToken) external view returns (bool)Returns whether the given account is entered in the given asset
Parameters
account
address
The address of the account to check
bToken
contract BToken
The bToken to check
Returns
_0
bool
True if the account is in the asset, otherwise false.
closeFactorMantissa
function closeFactorMantissa() external view returns (uint256)Multiplier used to calculate the maximum repayAmount when liquidating a borrow
Returns
_0
uint256
undefined
compAccrued
function compAccrued(address) external view returns (uint256)The COMP accrued but not yet transferred to each user
Parameters
_0
address
undefined
Returns
_0
uint256
undefined
compBorrowState
function compBorrowState(address) external view returns (uint224 index, uint32 block)The COMP market borrow state for each market
Parameters
_0
address
undefined
Returns
index
uint224
undefined
block
uint32
undefined
compBorrowerIndex
function compBorrowerIndex(address, address) external view returns (uint256)The COMP borrow index for each market for each borrower as of the last time they accrued COMP
Parameters
_0
address
undefined
_1
address
undefined
Returns
_0
uint256
undefined
compContributorSpeeds
function compContributorSpeeds(address) external view returns (uint256)The portion of COMP that each contributor receives per block
Parameters
_0
address
undefined
Returns
_0
uint256
undefined
compRate
function compRate() external view returns (uint256)The rate at which the flywheel distributes COMP, per block
Returns
_0
uint256
undefined
compSpeeds
function compSpeeds(address) external view returns (uint256)The portion of compRate that each market currently receives
Parameters
_0
address
undefined
Returns
_0
uint256
undefined
compSupplierIndex
function compSupplierIndex(address, address) external view returns (uint256)The COMP borrow index for each market for each supplier as of the last time they accrued COMP
Parameters
_0
address
undefined
_1
address
undefined
Returns
_0
uint256
undefined
compSupplyState
function compSupplyState(address) external view returns (uint224 index, uint32 block)The COMP market supply state for each market
Parameters
_0
address
undefined
Returns
index
uint224
undefined
block
uint32
undefined
enterMarket
function enterMarket(address bToken, address borrower) external nonpayable returns (enum BondtrollerErrorReporter.Error)Add asset to be included in account liquidity calculation
Parameters
bToken
address
The address of the bToken markets to be enabled
borrower
address
The address of user, which enters to market
Returns
_0
enum BondtrollerErrorReporter.Error
undefined
enterMarkets
function enterMarkets(address[] bTokens) external nonpayable returns (uint256[])Add assets to be included in account liquidity calculation
Parameters
bTokens
address[]
The list of addresses of the bToken markets to be enabled
Returns
_0
uint256[]
Success indicator for whether each corresponding market was entered
exitMarket
function exitMarket(address cTokenAddress) external nonpayable returns (uint256)Removes asset from sender's account liquidity calculation
Sender must not have an outstanding borrow balance in the asset, or be providing necessary collateral for an outstanding borrow.
Parameters
cTokenAddress
address
The address of the asset to be removed
Returns
_0
uint256
Whether or not the account successfully exited the market
getAllMarkets
function getAllMarkets() external view returns (contract BToken[])Return all of the markets
The automatic getter may be used to access an individual market.
Returns
_0
contract BToken[]
The list of market addresses
getAssetsIn
function getAssetsIn(address account) external view returns (contract BToken[])Returns the assets an account has entered
Parameters
account
address
The address of the account to pull assets for
Returns
_0
contract BToken[]
A dynamic list with the assets the account has entered
getBlockNumber
function getBlockNumber() external view returns (uint256)Returns
_0
uint256
undefined
getPrimaryIndexTokenAddress
function getPrimaryIndexTokenAddress() external view returns (address)Returns
_0
address
undefined
init
function init() external nonpayableisBondtroller
function isBondtroller() external view returns (bool)watermark that says that this is Bondtroller
Returns
_0
bool
undefined
isDeprecated
function isDeprecated(contract BToken bToken) external view returns (bool)Returns true if the given bToken market has been deprecated
All borrows in a deprecated bToken market can be immediately liquidated
Parameters
bToken
contract BToken
The market to check if deprecated
Returns
_0
bool
undefined
lastContributorBlock
function lastContributorBlock(address) external view returns (uint256)Last block at which a contributor's COMP rewards have been allocated
Parameters
_0
address
undefined
Returns
_0
uint256
undefined
liquidationIncentiveMantissa
function liquidationIncentiveMantissa() external view returns (uint256)Multiplier representing the discount on collateral that a liquidator receives
Returns
_0
uint256
undefined
markets
function markets(address) external view returns (bool isListed, uint256 collateralFactorMantissa, bool isComped)Official mapping of BTokens -> Market metadata
Parameters
_0
address
undefined
Returns
isListed
bool
undefined
collateralFactorMantissa
uint256
undefined
isComped
bool
undefined
maxAssets
function maxAssets() external view returns (uint256)Max number of assets a single account can participate in (borrow or use as collateral)
Returns
_0
uint256
undefined
mintAllowed
function mintAllowed(address bToken, address minter, uint256 mintAmount) external view returns (uint256)Checks if the account should be allowed to mint tokens in the given market
Parameters
bToken
address
The market to verify the mint against
minter
address
The account which would get the minted tokens
mintAmount
uint256
The amount of underlying being supplied to the market in exchange for tokens
Returns
_0
uint256
0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol)
mintGuardianPaused
function mintGuardianPaused(address) external view returns (bool)Parameters
_0
address
undefined
Returns
_0
bool
undefined
mintVerify
function mintVerify(address bToken, address minter, uint256 actualMintAmount, uint256 mintTokens) external nonpayableValidates mint and reverts on rejection. May emit logs.
Parameters
bToken
address
Asset being minted
minter
address
The address minting the tokens
actualMintAmount
uint256
The amount of the underlying asset being minted
mintTokens
uint256
The number of tokens being minted
oracle
function oracle() external view returns (address)Oracle which gives the price of any given asset
Returns
_0
address
undefined
pauseGuardian
function pauseGuardian() external view returns (address)The Pause Guardian can pause certain actions as a safety mechanism. Actions which allow users to remove their own assets cannot be paused. Liquidation / seizing / transfer can only be paused globally, not by market.
Returns
_0
address
undefined
primaryIndexToken
function primaryIndexToken() external view returns (address)the address of primary index token
Returns
_0
address
undefined
redeemAllowed
function redeemAllowed(address bToken, address redeemer, uint256 redeemTokens) external view returns (uint256)Checks if the account should be allowed to redeem tokens in the given market
Parameters
bToken
address
The market to verify the redeem against
redeemer
address
The account which would redeem the tokens
redeemTokens
uint256
The number of bTokens to exchange for the underlying asset in the market
Returns
_0
uint256
0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol)
redeemVerify
function redeemVerify(address bToken, address redeemer, uint256 redeemAmount, uint256 redeemTokens) external pureValidates redeem and reverts on rejection. May emit logs.
Parameters
bToken
address
Asset being redeemed
redeemer
address
The address redeeming the tokens
redeemAmount
uint256
The amount of the underlying asset being redeemed
redeemTokens
uint256
The number of tokens being redeemed
repayBorrowAllowed
function repayBorrowAllowed(address bToken, address payer, address borrower, uint256 repayAmount) external view returns (uint256)Checks if the account should be allowed to repay a borrow in the given market
Parameters
bToken
address
The market to verify the repay against
payer
address
The account which would repay the asset
borrower
address
The account which would borrowed the asset
repayAmount
uint256
The amount of the underlying asset the account would repay
Returns
_0
uint256
0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol)
repayBorrowVerify
function repayBorrowVerify(address bToken, address payer, address borrower, uint256 actualRepayAmount, uint256 borrowerIndex) external nonpayableValidates repayBorrow and reverts on rejection. May emit logs.
Parameters
bToken
address
Asset being repaid
payer
address
The address repaying the borrow
borrower
address
The address of the borrower
actualRepayAmount
uint256
The amount of underlying being repaid
borrowerIndex
uint256
undefined
seizeGuardianPaused
function seizeGuardianPaused() external view returns (bool)Returns
_0
bool
undefined
setBorrowCapGuardian
function setBorrowCapGuardian(address newBorrowCapGuardian) external nonpayableAdmin function to change the Borrow Cap Guardian
Parameters
newBorrowCapGuardian
address
The address of the new Borrow Cap Guardian
setBorrowPaused
function setBorrowPaused(contract BToken bToken, bool state) external nonpayable returns (bool)Parameters
bToken
contract BToken
undefined
state
bool
undefined
Returns
_0
bool
undefined
setMarketBorrowCaps
function setMarketBorrowCaps(contract BToken[] bTokens, uint256[] newBorrowCaps) external nonpayableSet the given borrow caps for the given bToken markets. Borrowing that brings total borrows to or above borrow cap will revert.
Admin or borrowCapGuardian function to set the borrow caps. A borrow cap of 0 corresponds to unlimited borrowing.
Parameters
bTokens
contract BToken[]
The addresses of the markets (tokens) to change the borrow caps for
newBorrowCaps
uint256[]
The new borrow cap values in underlying to be set. A value of 0 corresponds to unlimited borrowing.
setMintPaused
function setMintPaused(contract BToken bToken, bool state) external nonpayable returns (bool)Parameters
bToken
contract BToken
undefined
state
bool
undefined
Returns
_0
bool
undefined
setPauseGuardian
function setPauseGuardian(address newPauseGuardian) external nonpayable returns (uint256)Admin function to change the Pause Guardian
Parameters
newPauseGuardian
address
The address of the new Pause Guardian
Returns
_0
uint256
uint 0=success, otherwise a failure. (See enum Error for details)
setPriceOracle
function setPriceOracle(address newOracle) external nonpayable returns (uint256)Sets a new price oracle for the bondtroller
Admin function to set a new price oracle
Parameters
newOracle
address
undefined
Returns
_0
uint256
uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
setPrimaryIndexTokenAddress
function setPrimaryIndexTokenAddress(address _newPrimaryIndexToken) external nonpayable returns (uint256)Parameters
_newPrimaryIndexToken
address
undefined
Returns
_0
uint256
undefined
setSeizePaused
function setSeizePaused(bool state) external nonpayable returns (bool)Parameters
state
bool
undefined
Returns
_0
bool
undefined
setTransferPaused
function setTransferPaused(bool state) external nonpayable returns (bool)Parameters
state
bool
undefined
Returns
_0
bool
undefined
supportMarket
function supportMarket(contract BToken bToken) external nonpayable returns (uint256)Add the market to the markets mapping and set it as listed
Admin function to set isListed and add support for the market
Parameters
bToken
contract BToken
The address of the market (token) to list
Returns
_0
uint256
uint 0=success, otherwise a failure. (See enum Error for details)
transferAllowed
function transferAllowed(address bToken, address src, address dst, uint256 transferTokens) external nonpayable returns (uint256)Checks if the account should be allowed to transfer tokens in the given market
Parameters
bToken
address
The market to verify the transfer against
src
address
The account which sources the tokens
dst
address
The account which receives the tokens
transferTokens
uint256
The number of bTokens to transfer
Returns
_0
uint256
0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol)
transferGuardianPaused
function transferGuardianPaused() external view returns (bool)Returns
_0
bool
undefined
transferVerify
function transferVerify(address bToken, address src, address dst, uint256 transferTokens) external nonpayableValidates transfer and reverts on rejection. May emit logs.
Parameters
bToken
address
Asset being transferred
src
address
The account which sources the tokens
dst
address
The account which receives the tokens
transferTokens
uint256
The number of bTokens to transfer
Events
ActionPaused
event ActionPaused(contract BToken bToken, string action, bool pauseState)Emitted when an action is paused globally
Parameters
bToken
contract BToken
undefined
action
string
undefined
pauseState
bool
undefined
CompGranted
event CompGranted(address recipient, uint256 amount)Emitted when COMP is granted by admin
Parameters
recipient
address
undefined
amount
uint256
undefined
Failure
event Failure(uint256 error, uint256 info, uint256 detail)Parameters
error
uint256
undefined
info
uint256
undefined
detail
uint256
undefined
MarketEntered
event MarketEntered(contract BToken bToken, address account)Emitted when an account enters a market
Parameters
bToken
contract BToken
undefined
account
address
undefined
MarketExited
event MarketExited(contract BToken bToken, address account)Emitted when an account exits a market
Parameters
bToken
contract BToken
undefined
account
address
undefined
MarketListed
event MarketListed(contract BToken bToken)Emitted when an admin supports a market
Parameters
bToken
contract BToken
undefined
NewBorrowCap
event NewBorrowCap(contract BToken indexed bToken, uint256 newBorrowCap)Emitted when borrow cap for a bToken is changed
Parameters
bToken indexed
contract BToken
undefined
newBorrowCap
uint256
undefined
NewBorrowCapGuardian
event NewBorrowCapGuardian(address oldBorrowCapGuardian, address newBorrowCapGuardian)Emitted when borrow cap guardian is changed
Parameters
oldBorrowCapGuardian
address
undefined
newBorrowCapGuardian
address
undefined
NewPauseGuardian
event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian)Emitted when pause guardian is changed
Parameters
oldPauseGuardian
address
undefined
newPauseGuardian
address
undefined
NewPriceOracle
event NewPriceOracle(address oldPriceOracle, address newPriceOracle)Emitted when price oracle is changed
Parameters
oldPriceOracle
address
undefined
newPriceOracle
address
undefined
NewPrimaryIndexToken
event NewPrimaryIndexToken(address oldPrimaryIndexToken, address newPrimaryIndexToken)Parameters
oldPrimaryIndexToken
address
undefined
newPrimaryIndexToken
address
undefined
Last updated