Interface UseRedeemResult

Result of useRedeem. data is the RedeemResult: settled, what the redemption did, read from its receipt (MK-241), beside estimatedBeforeSend, redemptionRate, gas and partial.

isPending stays true until the redemption has MINED, because core redeem() resolves on the receipt: what a redemption redeems is decided at inclusion, so there is nothing to report before it.

interface UseRedeemResult {
    data: undefined | RedeemResult;
    error: null | MusdError;
    hash: null | `0x${string}`;
    isError: boolean;
    isPending: boolean;
    isSuccess: boolean;
    mutate: (params: RedeemParams) => void;
    mutateAsync: (params: RedeemParams) => Promise<RedeemResult>;
    redeem: (params: RedeemParams) => void;
    redeemAsync: (params: RedeemParams) => Promise<RedeemResult>;
    reset: () => void;
}

Hierarchy (View Summary)

Properties

data error hash isError isPending isSuccess mutate mutateAsync redeem redeemAsync reset

Properties

data

data: undefined | RedeemResult

The full core result (e.g. RedeemResult carries settled, what the redemption did, beside estimatedBeforeSend and redemptionRate).

error

error: null | MusdError

The core's typed MusdError, or null.

hash

hash: null | `0x${string}`

The submitted tx hash (once available), or null.

isError

isError: boolean

true if the write failed (see error).

isPending

isPending: boolean

true while the write is in flight.

isSuccess

isSuccess: boolean

true once the write has been submitted successfully.

mutate

mutate: (params: RedeemParams) => void

Fire the write (fire-and-forget; track via isPending/isSuccess/error).

mutateAsync

mutateAsync: (params: RedeemParams) => Promise<RedeemResult>

Promise-returning variant (resolves to the result, or rejects with the typed error).

redeem

redeem: (params: RedeemParams) => void

Redeem MUSD for BTC (alias of mutate).

redeemAsync

redeemAsync: (params: RedeemParams) => Promise<RedeemResult>

Promise-returning redeem.

reset

reset: () => void

Reset the mutation back to idle.

Settings

Member Visibility

On This Page

Properties