lib-base.populatedredemption

Home > @mosaic/lib-base > PopulatedRedemption

PopulatedRedemption interface

A redemption transaction that has been prepared for sending.

Signature:

export interface PopulatedRedemption<P = unknown, S = unknown, R = unknown> extends PopulatedMosaicTransaction<P, SentMosaicTransaction<S, MosaicReceipt<R, RedemptionDetails>>> 

Extends: PopulatedMosaicTransaction<P, SentMosaicTransaction<S, MosaicReceipt<R, RedemptionDetails>>>

Remarks

The Mosaic protocol fulfills redemptions by repaying the debt of Troves in ascending order of their collateralization ratio, and taking a portion of their collateral in exchange. Due to the minimum debt requirement that Troves must fulfill, some MoUSD amounts are not possible to redeem exactly.

When redeemMoUSD() is called with an amount that can't be fully redeemed, the amount will be truncated (see the redeemableMoUSDAmount property). When this happens, the redeemer can either redeem the truncated amount by sending the transaction unchanged, or prepare a new transaction by increasing the amount to the next lowest possible value, which is the sum of the truncated amount and MoUSD_MINIMUM_NET_DEBT.

Properties

Property	Type	Description
attemptedMoUSDAmount	Decimal	Amount of MoUSD the redeemer is trying to redeem.
isTruncated	boolean	Whether redeemableMoUSDAmount is less than attemptedMoUSDAmount.
redeemableMoUSDAmount	Decimal	Maximum amount of MoUSD that is currently redeemable from attemptedMoUSDAmount.

Methods

Method	Description
increaseAmountByMinimumNetDebt(maxRedemptionRate)	Prepare a new transaction by increasing the attempted amount to the next lowest redeemable value.