Interface WithdrawParams

Parameters for withdrawing collateral from a lending market Used with the withdraw method

interface WithdrawParams {
    address: string;
    amount: bigint;
    coinType: string;
    marketId: string;
    positionCapId: string;
    priceUpdateCoinTypes: string[];
}

Index

Properties

address amount coinType marketId positionCapId priceUpdateCoinTypes

Properties

address

address: string

Address of the user withdrawing collateral

amount

amount: bigint

Amount to withdraw (in mists, use MAX_U64 constant to withdraw all)

coinType

coinType: string

Withdraw coin type (e.g., "0x2::sui::SUI")

marketId

marketId: string

Market ID from which to withdraw

positionCapId

positionCapId: string

Object ID of the position capability object

priceUpdateCoinTypes

priceUpdateCoinTypes: string[]

Coin types of the coins whose price needs to be updated (Will have to pass all market coin types that user has supplied or borrowed in and current market coin type in which user is withdrawing)

Interface WithdrawParams

Index

Properties

Properties

address

amount

coinType

marketId

positionCapId

priceUpdateCoinTypes

Settings

On This Page