Interface UseAddCollateralResult

Result of useAddCollateral.

interface UseAddCollateralResult {
    addCollateral: (params: { amount: bigint }) => void;
    addCollateralAsync: (params: { amount: bigint }) => Promise<WriteResult>;
    data: undefined | WriteResult;
    error: null | MusdError;
    hash: null | `0x${string}`;
    isError: boolean;
    isPending: boolean;
    isSuccess: boolean;
    mutate: (params: { amount: bigint }) => void;
    mutateAsync: (params: { amount: bigint }) => Promise<WriteResult>;
    reset: () => void;
}

Hierarchy (View Summary)

Properties

addCollateral addCollateralAsync data error hash isError isPending isSuccess mutate mutateAsync reset

Properties

addCollateral

addCollateral: (params: { amount: bigint }) => void

Top up collateral (alias of mutate).

addCollateralAsync

addCollateralAsync: (params: { amount: bigint }) => Promise<WriteResult>

Promise-returning addCollateral.

data

data: undefined | WriteResult

The full core result (e.g. RedeemResult carries truncatedAmount + fee).

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: { amount: bigint }) => void

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

mutateAsync

mutateAsync: (params: { amount: bigint }) => Promise<WriteResult>

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

reset

reset: () => void

Reset the mutation back to idle.

Settings

Member Visibility

On This Page

Properties