Skip to content

Latest commit

 

History

History
238 lines (190 loc) · 6.56 KB

ICollSurplusPool.md

File metadata and controls

238 lines (190 loc) · 6.56 KB
Raw

ICollSurplusPool.sol

View Source: contracts/Interfaces/ICollSurplusPool.sol

↘ Derived Contracts: CollSurplusPool

ICollSurplusPool

Events

event BorrowerOperationsAddressChanged(address  _newBorrowerOperationsAddress);
event TroveManagerAddressChanged(address  _newTroveManagerAddress);
event ActivePoolAddressChanged(address  _newActivePoolAddress);
event CollBalanceUpdated(address indexed _account, uint256  _newBalance);
event EtherSent(address  _to, uint256  _amount);

Functions

setAddresses

Called only once on init, to set addresses of other Zero contracts. Callable only by owner

function setAddresses(address _borrowerOperationsAddress, address _troveManagerAddress, address _activePoolAddress) external nonpayable

Arguments

Name Type Description
_borrowerOperationsAddress address BorrowerOperations contract address
_troveManagerAddress address TroveManager contract address
_activePoolAddress address ActivePool contract address
Source Code 
function setAddresses(
        address _borrowerOperationsAddress,
        address _troveManagerAddress,
        address _activePoolAddress
    ) external;

getETH

Not necessarily equal to the raw ether balance - ether can be forcibly sent to contracts.

function getETH() external view
returns(uint256)
Source Code 
function getETH() external view returns (uint256);

getCollateral

function getCollateral(address _account) external view
returns(uint256)

Arguments

Name Type Description
_account address account to retrieve collateral

Returns

collateral

Source Code 
function getCollateral(address _account) external view returns (uint256);

accountSurplus

adds amount to current account balance. Only callable by TroveManager.

function accountSurplus(address _account, uint256 _amount) external nonpayable

Arguments

Name Type Description
_account address account to add amount
_amount uint256 amount to add
Source Code 
function accountSurplus(address _account, uint256 _amount) external;

claimColl

claims collateral for given account. Only callable by BorrowerOperations.

function claimColl(address _account) external nonpayable

Arguments

Name Type Description
_account address account to send claimable collateral
Source Code 
function claimColl(address _account) external;

Contracts