Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 2.05 KB

lib-base.stabilitydeposit.md

File metadata and controls

37 lines (25 loc) · 2.05 KB

Home > @sovryn-zero/lib-base > StabilityDeposit

StabilityDeposit class

A Stability Deposit and its accrued gains.

Signature:

export declare class StabilityDeposit 

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 StabilityDeposit class.

Properties

Property Modifiers Type Description
collateralGain Decimal Amount of native currency (e.g. Ether) received in exchange for the used-up ZUSD.
currentZUSD Decimal Amount of ZUSD left in the Stability Deposit.
frontendTag string Address of frontend through which this Stability Deposit was made.
initialZUSD Decimal Amount of ZUSD in the Stability Deposit at the time of the last direct modification.
isEmpty boolean
zeroReward Decimal Amount of ZERO rewarded since the last modification of the Stability Deposit.

Methods

Method Modifiers Description
apply(change) Apply a StabilityDepositChange to this Stability Deposit.
equals(that) Compare to another instance of StabilityDeposit.
whatChanged(thatZUSD) Calculate the difference between the currentZUSD in this Stability Deposit and thatZUSD.