Collateral

Description

Source: contracts/Collateral.sol

Variables

canOpenLoans

_Source

Type: bool

collateralKey

_Source

Type: bytes32

issueFeeRate

_Source

Type: uint256

loans

_Source

Type: mapping(uint256 => struct ICollateralLoan.Loan)

manager

_Source

Type: contract ICollateralManager

minCollateral

_Source

Type: uint256

minCratio

_Source

Type: uint256

shortingRewards

_Source

Type: mapping(bytes32 => address)

synths

_Source

Type: bytes32[]

synthsByKey

_Source

Type: mapping(bytes32 => bytes32)

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, contract ICollateralManager _manager, address _resolver, bytes32 _collateralKey, uint256 _minCratio, uint256 _minCollateral)

Visibility

public

State Mutability

``

Views

areSynthsAndCurrenciesSet

_Source

Details

Signature

areSynthsAndCurrenciesSet(bytes32[] _synthNamesInResolver, bytes32[] _synthKeys) view returns (bool)

Visibility

external

State Mutability

view

collateralRatio

_Source

Details

Signature

collateralRatio(uint256 id) view returns (uint256 cratio)

Visibility

public

State Mutability

view

liquidationAmount

_Source

Details

Signature

liquidationAmount(uint256 id) view returns (uint256 liqAmount)

Visibility

public

State Mutability

view

maxLoan

_Source

Details

Signature

maxLoan(uint256 amount, bytes32 currency) view returns (uint256 max)

Visibility

public

State Mutability

view

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

Restricted Functions

addRewardsContracts

_Source

Details

Signature

addRewardsContracts(address rewardsContract, bytes32 synth)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

addSynths

_Source

Details

Signature

addSynths(bytes32[] _synthNamesInResolver, bytes32[] _synthKeys)

Visibility

external

State Mutability

``

Requires

• require(..., "Array length mismatch")

Modifiers

• onlyOwner

setCanOpenLoans

_Source

Details

Signature

setCanOpenLoans(bool _canOpenLoans)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• CanOpenLoansUpdated

setIssueFeeRate

_Source

Details

Signature

setIssueFeeRate(uint256 _issueFeeRate)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• IssueFeeRateUpdated

setMinCollateral

_Source

Details

Signature

setMinCollateral(uint256 _minCollateral)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• MinCollateralUpdated

Internal Functions

_accrueInterest

_Source

Details

Signature

_accrueInterest(struct ICollateralLoan.Loan loan)

Visibility

internal

State Mutability

``

_checkLoanAvailable

_Source

Details

Signature

_checkLoanAvailable(struct ICollateralLoan.Loan loan) view

Visibility

internal

State Mutability

view

Requires

• require(..., "Recently interacted")

_checkLoanRatio

_Source

Details

Signature

_checkLoanRatio(struct ICollateralLoan.Loan loan) view

Visibility

internal

State Mutability

view

Requires

• require(..., "Cratio too low")

_checkSynthBalance

_Source

Details

Signature

_checkSynthBalance(address payer, bytes32 key, uint256 amount) view

Visibility

internal

State Mutability

view

Requires

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

_close

_Source

Details

Signature

_close(address borrower, uint256 id) returns (uint256 amount, uint256 collateral)

Visibility

internal

State Mutability

``

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• LoanClosed

_closeByLiquidation

_Source

Details

Signature

_closeByLiquidation(address borrower, address liquidator, struct ICollateralLoan.Loan loan) returns (uint256 amount, uint256 collateral)

Visibility

internal

State Mutability

``

Emits

• LoanClosedByLiquidation

_closeLoan

_Source

Details

Signature

_closeLoan(address borrower, address liquidator, struct ICollateralLoan.Loan loan) returns (uint256 amount, uint256 collateral)

Visibility

internal

State Mutability

``

_collateralUtil

_Source

Details

Signature

_collateralUtil() view returns (contract ICollateralUtil)

Visibility

internal

State Mutability

view

_deposit

_Source

Details

Signature

_deposit(address account, uint256 id, uint256 amount) returns (uint256, uint256)

Visibility

internal

State Mutability

``

Requires

• require(..., "Deposit must be above 0")

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• CollateralDeposited

_draw

_Source

Details

Signature

_draw(uint256 id, uint256 amount) returns (uint256, uint256)

Visibility

internal

State Mutability

``

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• LoanDrawnDown

_exchangeRates

_Source

Details

Signature

_exchangeRates() view returns (contract IExchangeRates)

Visibility

internal

State Mutability

view

_exchanger

_Source

Details

Signature

_exchanger() view returns (contract IExchanger)

Visibility

internal

State Mutability

view

_feePool

_Source

Details

Signature

_feePool() view returns (contract IFeePool)

Visibility

internal

State Mutability

view

_getLoanAndAccrueInterest

_Source

Details

Signature

_getLoanAndAccrueInterest(uint256 id, address owner) returns (struct ICollateralLoan.Loan loan)

Visibility

internal

State Mutability

``

Requires

• require(..., "Must be borrower")

_isLoanOpen

_Source

Details

Signature

_isLoanOpen(uint256 interestIndex) pure

Visibility

internal

State Mutability

pure

Requires

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

_liquidate

_Source

Details

Signature

_liquidate(address borrower, uint256 id, uint256 payment) returns (uint256 collateralLiquidated)

Visibility

internal

State Mutability

``

Requires

• require(..., "Payment must be above 0")

• require(..., "Cratio above liq ratio")

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• LoanPartiallyLiquidated

_open

_Source

Details

Signature

_open(uint256 collateral, uint256 amount, bytes32 currency, bool short) returns (uint256 id)

Visibility

internal

State Mutability

``

Requires

• require(..., "Open disabled")

• require(..., "Not allowed to issue")

• require(..., "Invalid rate")

• require(..., "Not enough collateral")

• require(..., "Debt limit or invalid rate")

• require(..., "Exceed max borrow power")

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• LoanCreated

_payFees

_Source

Details

Signature

_payFees(uint256 amount, bytes32 synth)

Visibility

internal

State Mutability

``

_processPayment

_Source

Details

Signature

_processPayment(struct ICollateralLoan.Loan loan, uint256 payment)

Visibility

internal

State Mutability

``

Requires

• require(..., "Payment must be above 0")

_recordLoanAsClosed

_Source

Details

Signature

_recordLoanAsClosed(struct ICollateralLoan.Loan loan)

Visibility

internal

State Mutability

``

_repay

_Source

Details

Signature

_repay(address borrower, address repayer, uint256 id, uint256 payment) returns (uint256, uint256)

Visibility

internal

State Mutability

``

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• LoanRepaymentMade

_synth

_Source

Details

Signature

_synth(bytes32 synthName) view returns (contract ISynth)

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

_withdraw

_Source

Details

Signature

_withdraw(uint256 id, uint256 amount) returns (uint256, uint256)

Visibility

internal

State Mutability

``

Modifiers

• rateIsValid

• issuanceIsActive

Emits

• CollateralWithdrawn

Modifiers

issuanceIsActive

_Source

rateIsValid

_Source

Events

CanOpenLoansUpdated

_Source

Signature: CanOpenLoansUpdated(bool canOpenLoans)

CollateralDeposited

_Source

Signature: CollateralDeposited(address account, uint256 id, uint256 amountDeposited, uint256 collateralAfter)

CollateralWithdrawn

_Source

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

IssueFeeRateUpdated

_Source

Signature: IssueFeeRateUpdated(uint256 issueFeeRate)

LoanClosed

_Source

Signature: LoanClosed(address account, uint256 id)

LoanClosedByLiquidation

_Source

Signature: LoanClosedByLiquidation(address account, uint256 id, address liquidator, uint256 amountLiquidated, uint256 collateralLiquidated)

LoanClosedByRepayment

_Source

Signature: LoanClosedByRepayment(address account, uint256 id, uint256 amountRepaid, uint256 collateralAfter)

LoanCreated

_Source

Signature: LoanCreated(address account, uint256 id, uint256 amount, uint256 collateral, bytes32 currency, uint256 issuanceFee)

LoanDrawnDown

_Source

Signature: LoanDrawnDown(address account, uint256 id, uint256 amount)

LoanPartiallyLiquidated

_Source

Signature: LoanPartiallyLiquidated(address account, uint256 id, address liquidator, uint256 amountLiquidated, uint256 collateralLiquidated)

LoanRepaymentMade

_Source

Signature: LoanRepaymentMade(address account, address repayer, uint256 id, uint256 amountRepaid, uint256 amountAfter)

MinCollateralUpdated

_Source

Signature: MinCollateralUpdated(uint256 minCollateral)