Collateral

Description

Source: contracts/Collateral.sol

Variables

canOpenLoans

_Source

Type: bool

collateralKey

_Source

Type: bytes32

interactionDelay

_Source

Type: uint256

issueFeeRate

_Source

Type: uint256

manager

_Source

Type: address

maxLoansPerAccount

_Source

Type: uint256

minCollateral

_Source

Type: uint256

minCratio

_Source

Type: uint256

shortingRewards

_Source

Type: mapping(bytes32 => address)

state

_Source

Type: contract CollateralState

synths

_Source

Type: bytes32[]

synthsByKey

_Source

Type: mapping(bytes32 => bytes32)

Constructor

constructor

_Source

Details

Signature

constructor(contract CollateralState _state, address _owner, address _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(struct ICollateralLoan.Loan loan) view returns (uint256 cratio)

Visibility

public

State Mutability

view

collateralRedeemed

_Source

Details

Signature

collateralRedeemed(bytes32 currency, uint256 amount) view returns (uint256 collateral)

Visibility

public

State Mutability

view

liquidationAmount

_Source

Details

Signature

liquidationAmount(struct ICollateralLoan.Loan loan) view returns (uint256 amount)

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(..., "Input array length mismatch")

Modifiers

• onlyOwner

setCanOpenLoans

_Source

Details

Signature

setCanOpenLoans(bool _canOpenLoans)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• CanOpenLoansUpdated

setInteractionDelay

_Source

Details

Signature

setInteractionDelay(uint256 _interactionDelay)

Visibility

external

State Mutability

``

Requires

• require(..., "Max 1 hour")

Modifiers

• onlyOwner

Emits

• InteractionDelayUpdated

setIssueFeeRate

_Source

Details

Signature

setIssueFeeRate(uint256 _issueFeeRate)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• IssueFeeRateUpdated

setManager

_Source

Details

Signature

setManager(address _newManager)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• ManagerUpdated

setMinCratio

_Source

Details

Signature

setMinCratio(uint256 _minCratio)

Visibility

external

State Mutability

``

Requires

• require(..., "Must be greater than 1")

Modifiers

• onlyOwner

Emits

• MinCratioRatioUpdated

Internal Functions

_checkLoanAvailable

_Source

Details

Signature

_checkLoanAvailable(struct ICollateralLoan.Loan _loan) view

Visibility

internal

State Mutability

view

Requires

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

• require(..., "Loan recently interacted with")

_checkSynthBalance

_Source

Details

Signature

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

Visibility

internal

State Mutability

view

Requires

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

_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

_manager

_Source

Details

Signature

_manager() view returns (contract ICollateralManager)

Visibility

internal

State Mutability

view

_payFees

_Source

Details

Signature

_payFees(uint256 amount, bytes32 synth)

Visibility

internal

State Mutability

``

_processPayment

_Source

Details

Signature

_processPayment(struct ICollateralLoan.Loan loanBefore, uint256 payment) returns (struct ICollateralLoan.Loan loanAfter)

Visibility

internal

State Mutability

``

_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

accrueInterest

_Source

Details

Signature

accrueInterest(struct ICollateralLoan.Loan loan) returns (struct ICollateralLoan.Loan loanAfter)

Visibility

internal

State Mutability

``

Requires

• require(..., "Rates are invalid")

closeByLiquidationInternal

_Source

Details

Signature

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

Visibility

internal

State Mutability

``

Requires

• require(..., "Waiting or settlement owing")

Emits

• LoanClosedByLiquidation

closeInternal

_Source

Details

Signature

closeInternal(address borrower, uint256 id) returns (uint256 collateral)

Visibility

internal

State Mutability

``

Requires

• require(..., "Waiting secs or settlement owing")

Modifiers

• rateIsValid

Emits

• LoanClosed

depositInternal

_Source

Details

Signature

depositInternal(address account, uint256 id, uint256 amount)

Visibility

internal

State Mutability

``

Requires

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

Modifiers

• rateIsValid

Emits

• CollateralDeposited

drawInternal

_Source

Details

Signature

drawInternal(uint256 id, uint256 amount)

Visibility

internal

State Mutability

``

Requires

• require(..., "Cannot draw this much")

Modifiers

• rateIsValid

Emits

• LoanDrawnDown

issuanceRatio

_Source

Details

Signature

issuanceRatio() view returns (uint256 ratio)

Visibility

internal

State Mutability

view

liquidateInternal

_Source

Details

Signature

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

Visibility

internal

State Mutability

``

Requires

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

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

• require(..., "Waiting or settlement owing")

Modifiers

• rateIsValid

Emits

• LoanPartiallyLiquidated

openInternal

_Source

Details

Signature

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

Visibility

internal

State Mutability

``

Requires

• require(..., "Opening is disabled")

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

• require(..., "Currency rate is invalid")

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

• require(..., "Max loans exceeded")

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

• require(..., "Exceeds max borrowing power")

Modifiers

• rateIsValid

Emits

• LoanCreated

repayInternal

_Source

Details

Signature

repayInternal(address borrower, address repayer, uint256 id, uint256 payment)

Visibility

internal

State Mutability

``

Requires

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

• require(..., "Waiting or settlement owing")

Modifiers

• rateIsValid

Emits

• LoanRepaymentMade

withdrawInternal

_Source

Details

Signature

withdrawInternal(uint256 id, uint256 amount) returns (uint256 withdraw)

Visibility

internal

State Mutability

``

Requires

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

Modifiers

• rateIsValid

Emits

• CollateralWithdrawn

Modifiers

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)

InteractionDelayUpdated

_Source

Signature: InteractionDelayUpdated(uint256 interactionDelay)

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)

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)

ManagerUpdated

_Source

Signature: ManagerUpdated(address manager)

MaxLoansPerAccountUpdated

_Source

Signature: MaxLoansPerAccountUpdated(uint256 maxLoansPerAccount)

MinCollateralUpdated

_Source

Signature: MinCollateralUpdated(uint256 minCollateral)

MinCratioRatioUpdated

_Source

Signature: MinCratioRatioUpdated(uint256 minCratio)