| Class | Description |
|---|---|
| Decimal | Fixed-point decimal bignumber with 18 digits of precision. |
| Fees | Calculator for fees. |
| LiquityStore | Abstract base class of Liquity data store implementations. |
| LQTYStake | Represents a user's LQTY stake and accrued gains. |
| StabilityDeposit | A Stability Deposit and its accrued gains. |
| TransactionFailedError | Thrown by TransactableLiquity functions in case of transaction failure. |
| Trove | A combination of collateral and debt. |
| TroveWithPendingRedistribution | A Trove in its state after the last direct modification. |
| UserTrove | A Trove that is associated with a single owner. |
| Interface | Description |
|---|---|
| CollateralGainTransferDetails | Details of a transferCollateralGainToTrove() transaction. |
| LiquidationDetails | Details of a liquidate() or liquidateUpTo() transaction. |
| LiquityStoreBaseState | State variables read from the blockchain. |
| LiquityStoreDerivedState | State variables derived from LiquityStoreBaseState. |
| LiquityStoreListenerParams | Parameters passed to LiquityStore listeners. |
| PopulatableLiquity | Prepare Liquity transactions for sending. |
| PopulatedLiquityTransaction | A transaction that has been prepared for sending. |
| PopulatedRedemption | A redemption transaction that has been prepared for sending. |
| ReadableLiquity | Read the state of the Liquity protocol. |
| RedemptionDetails | Details of a redeemLUSD() transaction. |
| SendableLiquity | Send Liquity transactions. |
| SentLiquityTransaction | A transaction that has already been sent. |
| StabilityDepositChangeDetails | Details of a depositLUSDInStabilityPool() or withdrawLUSDFromStabilityPool() transaction. |
| StabilityPoolGainsWithdrawalDetails | Details of a withdrawGainsFromStabilityPool() transaction. |
| TransactableLiquity | Send Liquity transactions and wait for them to succeed. |
| TroveAdjustmentDetails | Details of an adjustTrove() transaction. |
| TroveClosureDetails | Details of a closeTrove() transaction. |
| TroveCreationDetails | Details of an openTrove() transaction. |
| TroveListingParams | Parameters of the getTroves() function. |
| Variable | Description |
|---|---|
| CRITICAL_COLLATERAL_RATIO | Total collateral ratio below which recovery mode is triggered. |
| LUSD_LIQUIDATION_RESERVE | Amount of LUSD that's reserved for compensating the liquidator of a Trove. |
| LUSD_MINIMUM_DEBT | A Trove must always have at least this much debt. |
| LUSD_MINIMUM_NET_DEBT | A Trove must always have at least this much debt on top of the liquidation reserve. |
| MAXIMUM_BORROWING_RATE | Value that the borrowing rate will never exceed. |
| MINIMUM_BORROWING_RATE | Value that the borrowing rate will never decay below. |
| MINIMUM_COLLATERAL_RATIO | Collateral ratio below which a Trove can be liquidated in normal mode. |
| MINIMUM_REDEMPTION_RATE | Value that the redemption rate will never decay below. |
| Type Alias | Description |
|---|---|
| Decimalish | Types that can be converted into a Decimal. |
| FailedReceipt | Indicates that the transaction has been mined, but it failed. |
| FrontendStatus | Represents whether an address has been registered as a Liquity frontend. |
| LiquityReceipt | One of either a PendingReceipt, a FailedReceipt or a SuccessfulReceipt. |
| LiquityStoreState | Type of LiquityStore's state. |
| LQTYStakeChange | Represents the change between two states of an LQTY Stake. |
| MinedReceipt | Either a FailedReceipt or a SuccessfulReceipt. |
| PendingReceipt | Indicates that the transaction hasn't been mined yet. |
| StabilityDepositChange | Represents the change between two Stability Deposit states. |
| SuccessfulReceipt | Indicates that the transaction has succeeded. |
| TroveAdjustmentParams | Parameters of an adjustTrove() transaction. |
| TroveChange | Represents the change between two Trove states. |
| TroveClosureParams | Parameters of a closeTrove() transaction. |
| TroveCreationError | Describes why a Trove could not be created. |
| TroveCreationParams | Parameters of an openTrove() transaction. |
| UserTroveStatus | Represents whether a UserTrove is open or not, or why it was closed. |