lib-base

Home > @mosaic/lib-base

lib-base package

Classes

Class	Description
Decimal	Fixed-point decimal bignumber with 18 digits of precision.
Fees	Calculator for fees.
MosaicStore	Abstract base class of Mosaic data store implementations.
MSICStake	Represents a user's MSIC stake and accrued gains.
StabilityDeposit	A Stability Deposit and its accrued gains.
TransactionFailedError	Thrown by TransactableMosaic 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.

Interfaces

Interface	Description
CollateralGainTransferDetails	Details of a transferCollateralGainToTrove() transaction.
LiquidationDetails	Details of a liquidate() or liquidateUpTo() transaction.
MosaicStoreBaseState	State variables read from the blockchain.
MosaicStoreDerivedState	State variables derived from MosaicStoreBaseState.
MosaicStoreListenerParams	Parameters passed to MosaicStore listeners.
PopulatableMosaic	Prepare Mosaic transactions for sending.
PopulatedMosaicTransaction	A transaction that has been prepared for sending.
PopulatedRedemption	A redemption transaction that has been prepared for sending.
ReadableMosaic	Read the state of the Mosaic protocol.
RedemptionDetails	Details of a redeemMoUSD() transaction.
SendableMosaic	Send Mosaic transactions.
SentMosaicTransaction	A transaction that has already been sent.
StabilityDepositChangeDetails	Details of a depositMoUSDInStabilityPool() or withdrawMoUSDFromStabilityPool() transaction.
StabilityPoolGainsWithdrawalDetails	Details of a withdrawGainsFromStabilityPool() transaction.
TransactableMosaic	Send Mosaic 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.

Variables

Variable	Description
CRITICAL_COLLATERAL_RATIO	Total collateral ratio below which recovery mode is triggered.
MoUSD_LIQUIDATION_RESERVE	Amount of MoUSD that's reserved for compensating the liquidator of a Trove.
MoUSD_MINIMUM_DEBT	A Trove must always have at least this much debt.
MoUSD_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 Aliases

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 Mosaic frontend.
MosaicReceipt	One of either a PendingReceipt, a FailedReceipt or a SuccessfulReceipt.
MosaicStoreState	Type of MosaicStore's state.
MSICStakeChange	Represents the change between two states of an MSIC 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.