lib-base.troveadjustmentparams

Home > @mosaic/lib-base > TroveAdjustmentParams

TroveAdjustmentParams type

Parameters of an adjustTrove() transaction.

Signature:

export declare type TroveAdjustmentParams<T = unknown> = (_CollateralChange<T> & _NoDebtChange) | (_DebtChange<T> & _NoCollateralChange) | (_CollateralChange<T> & _DebtChange<T>);

Remarks

The type parameter T specifies the allowed value type(s) of the particular TroveAdjustmentParams object's properties.

Even though all properties are optional, a valid TroveAdjustmentParams object must define at least one.

Defining both depositCollateral and withdrawCollateral, or both borrowMoUSD and repayMoUSD at the same time is disallowed, and will result in a type-checking error.

Properties

Property	Type	Description
depositCollateral?	T	(Optional) The amount of collateral that's deposited.
withdrawCollateral?	T	(Optional) The amount of collateral that's withdrawn.
borrowMoUSD?	T	(Optional) The amount of MoUSD that's borrowed.
repayMoUSD?	T	(Optional) The amount of MoUSD that's repaid.