lib-base.trove

Home > @mosaic/lib-base > Trove

Trove class

A combination of collateral and debt.

Signature:

export declare class Trove 

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Trove class.

Properties

Property	Modifiers	Type	Description
collateral		Decimal	Amount of native currency (e.g. Ether) collateralized.
debt		Decimal	Amount of MoUSD owed.
isEmpty		boolean
netDebt		Decimal	Amount of MoUSD that must be repaid to close this Trove.

Methods

Method	Modifiers	Description
add(that)
addCollateral(collateral)
addDebt(debt)
adjust(params, borrowingRate)		Calculate the result of an adjustTrove() transaction on this Trove.
adjustTo(that, borrowingRate)		Calculate the parameters of an adjustTrove() transaction that will change this Trove into the given Trove.
apply(change, borrowingRate)		Make a new Trove by applying a TroveChange to this Trove.
collateralRatio(price)		Calculate the Trove's collateralization ratio at a given price.
collateralRatioIsBelowCritical(price)		Whether the collateralization ratio is less than the CRITICAL_COLLATERAL_RATIO at a given price.
collateralRatioIsBelowMinimum(price)		Whether the Trove is undercollateralized at a given price.
create(params, borrowingRate)	static	Calculate the result of an openTrove() transaction.
equals(that)
isOpenableInRecoveryMode(price)		Whether the Trove is sufficiently collateralized to be opened during recovery mode.
multiply(multiplier)
recreate(that, borrowingRate)	static	Calculate the parameters of an openTrove() transaction that will result in the given Trove.
setCollateral(collateral)
setDebt(debt)
subtract(that)
subtractCollateral(collateral)
subtractDebt(debt)
whatChanged(that, borrowingRate)		Calculate the difference between this Trove and another.