EtherCollateralsUSD

Description

Source: contracts/EtherCollateralsUSD.sol

Structs

SynthLoanStruct

_Source

Field	Type	Description
account	address payable	TBA
collateralAmount	uint256	TBA
loanAmount	uint256	TBA
mintingFee	uint256	TBA
timeCreated	uint256	TBA
loanID	uint256	TBA
timeClosed	uint256	TBA
loanInterestRate	uint256	TBA
accruedInterest	uint256	TBA
lastInterestAccrued	uint40	TBA

Variables

COLLATERAL

_Source

Type: bytes32

accountLoanLimit

_Source

Type: uint256

accountOpenLoanCounter

_Source

Type: mapping(address => uint256)

accountsSynthLoans

_Source

Type: mapping(address => struct EtherCollateralsUSD.SynthLoanStruct[])

collateralizationRatio

_Source

Type: uint256

interestPerSecond

_Source

Type: uint256

interestRate

_Source

Type: uint256

issueFeeRate

_Source

Type: uint256

issueLimit

_Source

Type: uint256

liquidationDeadline

_Source

Type: uint256

liquidationPenalty

_Source

Type: uint256

liquidationRatio

_Source

Type: uint256

loanLiquidationOpen

_Source

Type: bool

minLoanCollateralSize

_Source

Type: uint256

totalIssuedSynths

_Source

Type: uint256

totalLoansCreated

_Source

Type: uint256

totalOpenLoanCount

_Source

Type: uint256

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, address _resolver)

Visibility

public

State Mutability

``

Views

accruedInterestOnLoan

_Source

Details

Signature

accruedInterestOnLoan(uint256 _loanAmount, uint256 _seconds) view returns (uint256 interestAmount)

Visibility

public

State Mutability

view

calculateAmountToLiquidate

_Source

Details

Signature

calculateAmountToLiquidate(uint256 debtBalance, uint256 collateral) view returns (uint256)

Visibility

public

State Mutability

view

collateralAmountForLoan

_Source

Details

Signature

collateralAmountForLoan(uint256 loanAmount) view returns (uint256)

Visibility

external

State Mutability

view

currentInterestOnLoan

_Source

Details

Signature

currentInterestOnLoan(address _account, uint256 _loanID) view returns (uint256)

Visibility

external

State Mutability

view

getContractInfo

_Source

Details

Signature

getContractInfo() view returns (uint256 _collateralizationRatio, uint256 _issuanceRatio, uint256 _interestRate, uint256 _interestPerSecond, uint256 _issueFeeRate, uint256 _issueLimit, uint256 _minLoanCollateralSize, uint256 _totalIssuedSynths, uint256 _totalLoansCreated, uint256 _totalOpenLoanCount, uint256 _ethBalance, uint256 _liquidationDeadline, bool _loanLiquidationOpen)

Visibility

external

State Mutability

view

getLoan

_Source

Details

Signature

getLoan(address _account, uint256 _loanID) view returns (address account, uint256 collateralAmount, uint256 loanAmount, uint256 timeCreated, uint256 loanID, uint256 timeClosed, uint256 accruedInterest, uint256 totalFees)

Visibility

external

State Mutability

view

getLoanCollateralRatio

_Source

Details

Signature

getLoanCollateralRatio(address _account, uint256 _loanID) view returns (uint256 loanCollateralRatio)

Visibility

external

State Mutability

view

getMintingFee

_Source

Details

Signature

getMintingFee(address _account, uint256 _loanID) view returns (uint256)

Visibility

external

State Mutability

view

issuanceRatio

_Source

Details

Signature

issuanceRatio() view returns (uint256)

Visibility

public

State Mutability

view

loanAmountFromCollateral

_Source

Details

Signature

loanAmountFromCollateral(uint256 collateralAmount) view returns (uint256)

Visibility

public

State Mutability

view

openLoanIDsByAccount

_Source

Details

Signature

openLoanIDsByAccount(address _account) view returns (uint256[])

Visibility

external

State Mutability

view

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

timeSinceInterestAccrualOnLoan

_Source

Details

Signature

timeSinceInterestAccrualOnLoan(address _account, uint256 _loanID) view returns (uint256)

Visibility

external

State Mutability

view

totalFeesOnLoan

_Source

Details

Signature

totalFeesOnLoan(address _account, uint256 _loanID) view returns (uint256 interestAmount, uint256 mintingFee)

Visibility

external

State Mutability

view

Restricted Functions

setAccountLoanLimit

_Source

Details

Signature

setAccountLoanLimit(uint256 _loanLimit)

Visibility

external

State Mutability

``

Requires

• require(..., "Owner cannot set higher than ACCOUNT_LOAN_LIMIT_CAP")

Modifiers

• onlyOwner

Emits

• AccountLoanLimitUpdated

setCollateralizationRatio

_Source

Details

Signature

setCollateralizationRatio(uint256 ratio)

Visibility

external

State Mutability

``

Requires

• require(..., "Too high")

• require(..., "Too low")

Modifiers

• onlyOwner

Emits

• CollateralizationRatioUpdated

setInterestRate

_Source

Details

Signature

setInterestRate(uint256 _interestRate)

Visibility

external

State Mutability

``

Requires

• require(..., "Interest rate cannot be less that the SECONDS_IN_A_YEAR")

• require(..., "Interest cannot be more than 100% APR")

Modifiers

• onlyOwner

Emits

• InterestRateUpdated

setIssueFeeRate

_Source

Details

Signature

setIssueFeeRate(uint256 _issueFeeRate)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• IssueFeeRateUpdated

setIssueLimit

_Source

Details

Signature

setIssueLimit(uint256 _issueLimit)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• IssueLimitUpdated

setLiquidationRatio

_Source

Details

Signature

setLiquidationRatio(uint256 _liquidationRatio)

Visibility

external

State Mutability

``

Requires

• require(..., "Ratio less than 100%")

Modifiers

• onlyOwner

Emits

• LiquidationRatioUpdated

setLoanLiquidationOpen

_Source

Details

Signature

setLoanLiquidationOpen(bool _loanLiquidationOpen)

Visibility

external

State Mutability

``

Requires

• require(..., "Before liquidation deadline")

Modifiers

• onlyOwner

Emits

• LoanLiquidationOpenUpdated

setMinLoanCollateralSize

_Source

Details

Signature

setMinLoanCollateralSize(uint256 _minLoanCollateralSize)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• MinLoanCollateralSizeUpdated

Internal Functions

_checkLoanIsOpen

_Source

Details

Signature

_checkLoanIsOpen(struct EtherCollateralsUSD.SynthLoanStruct _synthLoan) pure

Visibility

internal

State Mutability

pure

Requires

• require(..., "Loan does not exist")

• require(..., "Loan already closed")

_loanCollateralRatio

_Source

Details

Signature

_loanCollateralRatio(struct EtherCollateralsUSD.SynthLoanStruct _loan) view returns (uint256 loanCollateralRatio, uint256 collateralValue, uint256 interestAmount)

Visibility

internal

State Mutability

view

_processInterestAndLoanPayment

_Source

Details

Signature

_processInterestAndLoanPayment(uint256 interestPaid, uint256 loanAmountPaid)

Visibility

internal

State Mutability

``

_splitInterestLoanPayment

_Source

Details

Signature

_splitInterestLoanPayment(uint256 _paymentAmount, uint256 _accruedInterest, uint256 _loanAmount) pure returns (uint256 interestPaid, uint256 loanAmountPaid, uint256 accruedInterestAfter, uint256 loanAmountAfter)

Visibility

internal

State Mutability

pure

exchangeRates

_Source

Details

Signature

exchangeRates() view returns (contract IExchangeRates)

Visibility

internal

State Mutability

view

feePool

_Source

Details

Signature

feePool() view returns (contract IFeePool)

Visibility

internal

State Mutability

view

synthsUSD

_Source

Details

Signature

synthsUSD() view returns (contract ISynth)

Visibility

internal

State Mutability

view

systemStatus

_Source

Details

Signature

systemStatus() view returns (contract ISystemStatus)

Visibility

internal

State Mutability

view

External Functions

closeLoan

_Source

Details

Signature

closeLoan(uint256 loanID)

Visibility

external

State Mutability

``

Modifiers

• nonReentrant

• ETHRateNotInvalid

depositCollateral

_Source

Details

Signature

depositCollateral(address account, uint256 loanID) payable

Visibility

external

State Mutability

payable

Requires

• require(..., "Deposit amount must be greater than 0")

• require(..., "Loans are now being liquidated")

Modifiers

• notPaused

Emits

• CollateralDeposited

liquidateLoan

_Source

Details

Signature

liquidateLoan(address _loanCreatorsAddress, uint256 _loanID, uint256 _debtToCover)

Visibility

external

State Mutability

``

Requires

• require(..., "Not enough sUSD balance")

• require(..., "Collateral ratio above liquidation ratio")

Modifiers

• nonReentrant

• ETHRateNotInvalid

Emits

• LoanPartiallyLiquidated

liquidateUnclosedLoan

_Source

Details

Signature

liquidateUnclosedLoan(address _loanCreatorsAddress, uint256 _loanID)

Visibility

external

State Mutability

``

Requires

• require(..., "Liquidation is not open")

Modifiers

• nonReentrant

• ETHRateNotInvalid

Emits

• LoanLiquidated

openLoan

_Source

Details

Signature

openLoan(uint256 _loanAmount) payable returns (uint256 loanID)

Visibility

external

State Mutability

payable

Requires

• require(..., "Not enough ETH to create this loan. Please see the minLoanCollateralSize")

• require(..., "Loans are now being liquidated")

• require(..., "Each account is limited to 50 loans")

• require(..., "Loan amount exceeds max borrowing power")

• require(..., "Loan Amount exceeds the supply cap.")

Modifiers

• notPaused

• nonReentrant

• ETHRateNotInvalid

Emits

• LoanCreated

repayLoan

_Source

Details

Signature

repayLoan(address _loanCreatorsAddress, uint256 _loanID, uint256 _repayAmount)

Visibility

external

State Mutability

``

Requires

• require(..., "Not enough sUSD balance")

Modifiers

• ETHRateNotInvalid

Emits

• LoanRepaid

withdrawCollateral

_Source

Details

Signature

withdrawCollateral(uint256 loanID, uint256 withdrawAmount)

Visibility

external

State Mutability

``

Requires

• require(..., "Amount to withdraw must be greater than 0")

• require(..., "Loans are now being liquidated")

• require(..., "Collateral ratio below liquidation after withdraw")

Modifiers

• notPaused

• nonReentrant

• ETHRateNotInvalid

Emits

• CollateralWithdrawn

Modifiers

ETHRateNotInvalid

_Source

Events

AccountLoanLimitUpdated

_Source

Signature: AccountLoanLimitUpdated(uint256 loanLimit)

CollateralDeposited

_Source

Signature: CollateralDeposited(address account, uint256 loanID, uint256 collateralAmount, uint256 collateralAfter)

CollateralWithdrawn

_Source

Signature: CollateralWithdrawn(address account, uint256 loanID, uint256 amountWithdrawn, uint256 collateralAfter)

CollateralizationRatioUpdated

_Source

Signature: CollateralizationRatioUpdated(uint256 ratio)

InterestRateUpdated

_Source

Signature: InterestRateUpdated(uint256 interestRate)

IssueFeeRateUpdated

_Source

Signature: IssueFeeRateUpdated(uint256 issueFeeRate)

IssueLimitUpdated

_Source

Signature: IssueLimitUpdated(uint256 issueLimit)

LiquidationRatioUpdated

_Source

Signature: LiquidationRatioUpdated(uint256 ratio)

LoanClosed

_Source

Signature: LoanClosed(address account, uint256 loanID, uint256 feesPaid)

LoanCreated

_Source

Signature: LoanCreated(address account, uint256 loanID, uint256 amount)

LoanLiquidated

_Source

Signature: LoanLiquidated(address account, uint256 loanID, address liquidator)

LoanLiquidationOpenUpdated

_Source

Signature: LoanLiquidationOpenUpdated(bool loanLiquidationOpen)

LoanPartiallyLiquidated

_Source

Signature: LoanPartiallyLiquidated(address account, uint256 loanID, address liquidator, uint256 liquidatedAmount, uint256 liquidatedCollateral)

LoanRepaid

_Source

Signature: LoanRepaid(address account, uint256 loanID, uint256 repaidAmount, uint256 newLoanAmount)

MinLoanCollateralSizeUpdated

_Source

Signature: MinLoanCollateralSizeUpdated(uint256 minLoanCollateralSize)