@alphafi/alphalend-sdk - v4.0.0
    Preparing search index...

    Interface BorrowParams

    Parameters for borrowing assets from a lending market Used with the borrow method

    interface BorrowParams {
        address: string;
        amount: bigint;
        coinType: string;
        lazerUpdateBytes?: Uint8Array<ArrayBufferLike>;
        marketId: string;
        positionCapId: string;
        priceUpdateCoinTypes: string[];
        tx?: Transaction;
    }
    Index

    Properties

    address amount coinType lazerUpdateBytes? marketId positionCapId priceUpdateCoinTypes tx?

    Properties

    address: string

    Address of the user borrowing tokens

    amount: bigint

    Amount to borrow in base units (in mists)

    coinType: string

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

    lazerUpdateBytes?: Uint8Array<ArrayBufferLike>

    Your own signed Lazer update for this transaction; skips the fetch from AlphaLend's proxy.

    marketId: string

    Market ID to borrow from

    positionCapId: string

    Object ID of the position capability object

    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 borrowing)

    tx?: Transaction

    Optional existing transaction to build upon

    Settings

    Member Visibility

    On This Page

    Properties