Interface SettledRedemption

What a redemption SETTLED, read from the Redemption event in its receipt (MK-241).

TroveManager.redeemCollateral emits Redemption(_attemptedAmount, _actualAmount, _collateralSent, _collateralFee) once, after the loop (TroveManager.sol:420-425, declared at ITroveManager.sol:48-53). The contract's own names are a trap here, as they were for the rate (MK-014): _collateralSent is passed totals.totalCollateralDrawn, which INCLUDES the fee, and the redeemer is sent totalCollateralDrawn - collateralFee (:416-418, :444-447). So the fields below are named for what each quantity is, and the one the redeemer receives is derived.

interface SettledRedemption {
    attemptedAmount: bigint;
    blockNumber: bigint;
    collateralDrawn: bigint;
    collateralFee: bigint;
    collateralReceived: bigint;
    redeemedAmount: bigint;
    unredeemedAmount: bigint;
}

Properties

attemptedAmount blockNumber collateralDrawn collateralFee collateralReceived redeemedAmount unredeemedAmount

Properties

attemptedAmount

attemptedAmount: bigint

_attemptedAmount: the MUSD the call asked to redeem, the amount sent.

blockNumber

blockNumber: bigint

The block the redemption mined in.

collateralDrawn

collateralDrawn: bigint

_collateralSent, which is collateral DRAWN from the Troves, fee included, in BTC wei.

collateralFee

collateralFee: bigint

_collateralFee, the redemption fee in BTC wei, sent to the PCV (:433-437).

collateralReceived

collateralReceived: bigint

collateralDrawn - collateralFee: the BTC wei the redeemer actually received (:444-447).

redeemedAmount

redeemedAmount: bigint

_actualAmount: the MUSD actually redeemed and burned from the caller (TroveManager.sol:428-431). Can be far less than attemptedAmount: the loop stops at the first cancelled partial (:392, :1299-1306), and a call succeeds as long as something was drawn (:406-408).

unredeemedAmount

unredeemedAmount: bigint

attemptedAmount - redeemedAmount: MUSD asked for and not redeemed, still in the caller's balance.

Settings

Member Visibility

On This Page

Properties