@suilend/sdk 1.0.0

package/core/types.d.ts

@@ -0,0 +1,662 @@
+import { BcsType, InferBcsType } from "@mysten/bcs";
+import { ObjectArg as SuiObjectArg } from "@mysten/sui.js/bcs";
+import { SuiClient } from "@mysten/sui.js/client";
+import { TransactionArgument } from "@mysten/sui.js/transactions";
+export declare const ID: BcsType<{
+    bytes: string;
+}, {
+    bytes: string;
+}>;
+export declare const UID: BcsType<{
+    id: {
+        bytes: string;
+    };
+}, {
+    id: {
+        bytes: string;
+    };
+}>;
+export declare const ObligationOwnerCap: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    obligation_id: {
+        bytes: string;
+    };
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    obligation_id: {
+        bytes: string;
+    };
+}>;
+export declare const Decimal: BcsType<{
+    value: string;
+}, {
+    value: string | number | bigint;
+}>;
+export declare const Borrow: BcsType<{
+    reserve_id: string;
+    borrowed_amount: {
+        value: string;
+    };
+    cumulative_borrow_rate: {
+        value: string;
+    };
+    market_value: {
+        value: string;
+    };
+}, {
+    reserve_id: string | number | bigint;
+    borrowed_amount: {
+        value: string | number | bigint;
+    };
+    cumulative_borrow_rate: {
+        value: string | number | bigint;
+    };
+    market_value: {
+        value: string | number | bigint;
+    };
+}>;
+export declare const Deposit: BcsType<{
+    reserve_id: string;
+    deposited_ctoken_amount: string;
+    market_value: {
+        value: string;
+    };
+}, {
+    reserve_id: string | number | bigint;
+    deposited_ctoken_amount: string | number | bigint;
+    market_value: {
+        value: string | number | bigint;
+    };
+}>;
+export declare const Bag: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    size: string;
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    size: string | number | bigint;
+}>;
+export declare const Obligation: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    owner: string;
+    deposits: {
+        reserve_id: string;
+        deposited_ctoken_amount: string;
+        market_value: {
+            value: string;
+        };
+    }[];
+    borrows: {
+        reserve_id: string;
+        borrowed_amount: {
+            value: string;
+        };
+        cumulative_borrow_rate: {
+            value: string;
+        };
+        market_value: {
+            value: string;
+        };
+    }[];
+    balances: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string;
+    };
+    deposited_value_usd: {
+        value: string;
+    };
+    allowed_borrow_value_usd: {
+        value: string;
+    };
+    unhealthy_borrow_value_usd: {
+        value: string;
+    };
+    unweighted_borrowed_value_usd: {
+        value: string;
+    };
+    weighted_borrowed_value_usd: {
+        value: string;
+    };
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    owner: string;
+    deposits: Iterable<{
+        reserve_id: string | number | bigint;
+        deposited_ctoken_amount: string | number | bigint;
+        market_value: {
+            value: string | number | bigint;
+        };
+    }> & {
+        length: number;
+    };
+    borrows: Iterable<{
+        reserve_id: string | number | bigint;
+        borrowed_amount: {
+            value: string | number | bigint;
+        };
+        cumulative_borrow_rate: {
+            value: string | number | bigint;
+        };
+        market_value: {
+            value: string | number | bigint;
+        };
+    }> & {
+        length: number;
+    };
+    balances: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string | number | bigint;
+    };
+    deposited_value_usd: {
+        value: string | number | bigint;
+    };
+    allowed_borrow_value_usd: {
+        value: string | number | bigint;
+    };
+    unhealthy_borrow_value_usd: {
+        value: string | number | bigint;
+    };
+    unweighted_borrowed_value_usd: {
+        value: string | number | bigint;
+    };
+    weighted_borrowed_value_usd: {
+        value: string | number | bigint;
+    };
+}>;
+export type ObligationType = typeof Obligation.$inferType;
+export type ReserveType = typeof Reserve.$inferType;
+export type LendingMarketType = typeof LendingMarket.$inferType;
+export declare const InterestRateModel: BcsType<{
+    utils: number[];
+    aprs: string[];
+}, {
+    utils: Iterable<number> & {
+        length: number;
+    };
+    aprs: Iterable<string | number | bigint> & {
+        length: number;
+    };
+}>;
+export declare const ReserveConfig: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    open_ltv_pct: number;
+    close_ltv_pct: number;
+    borrow_weight_bps: string;
+    deposit_limit: string;
+    borrow_limit: string;
+    liquidation_bonus_pct: number;
+    borrow_fee_bps: string;
+    spread_fee_bps: string;
+    liquidation_fee_bps: string;
+    interest_rate: {
+        utils: number[];
+        aprs: string[];
+    };
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    open_ltv_pct: number;
+    close_ltv_pct: number;
+    borrow_weight_bps: string | number | bigint;
+    deposit_limit: string | number | bigint;
+    borrow_limit: string | number | bigint;
+    liquidation_bonus_pct: number;
+    borrow_fee_bps: string | number | bigint;
+    spread_fee_bps: string | number | bigint;
+    liquidation_fee_bps: string | number | bigint;
+    interest_rate: {
+        utils: Iterable<number> & {
+            length: number;
+        };
+        aprs: Iterable<string | number | bigint> & {
+            length: number;
+        };
+    };
+}>;
+export declare const PriceIdentifier: BcsType<{
+    bytes: number[];
+}, {
+    bytes: Iterable<number> & {
+        length: number;
+    };
+}>;
+export declare const Reserve: BcsType<{
+    config: {
+        vec: {
+            id: {
+                id: {
+                    bytes: string;
+                };
+            };
+            open_ltv_pct: number;
+            close_ltv_pct: number;
+            borrow_weight_bps: string | number | bigint;
+            deposit_limit: string | number | bigint;
+            borrow_limit: string | number | bigint;
+            liquidation_bonus_pct: number;
+            borrow_fee_bps: string | number | bigint;
+            spread_fee_bps: string | number | bigint;
+            liquidation_fee_bps: string | number | bigint;
+            interest_rate: {
+                utils: Iterable<number> & {
+                    length: number;
+                };
+                aprs: Iterable<string | number | bigint> & {
+                    length: number;
+                };
+            };
+        }[];
+    };
+    mint_decimals: number;
+    price_identifier: {
+        bytes: number[];
+    };
+    price: {
+        value: string;
+    };
+    price_last_update_timestamp_s: string;
+    available_amount: string;
+    ctoken_supply: string;
+    borrowed_amount: {
+        value: string;
+    };
+    cumulative_borrow_rate: {
+        value: string;
+    };
+    interest_last_update_timestamp_s: string;
+    fees_accumulated: {
+        value: string;
+    };
+}, {
+    config: {
+        vec: Iterable<{
+            id: {
+                id: {
+                    bytes: string;
+                };
+            };
+            open_ltv_pct: number;
+            close_ltv_pct: number;
+            borrow_weight_bps: string | number | bigint;
+            deposit_limit: string | number | bigint;
+            borrow_limit: string | number | bigint;
+            liquidation_bonus_pct: number;
+            borrow_fee_bps: string | number | bigint;
+            spread_fee_bps: string | number | bigint;
+            liquidation_fee_bps: string | number | bigint;
+            interest_rate: {
+                utils: Iterable<number> & {
+                    length: number;
+                };
+                aprs: Iterable<string | number | bigint> & {
+                    length: number;
+                };
+            };
+        }> & {
+            length: number;
+        };
+    };
+    mint_decimals: number;
+    price_identifier: {
+        bytes: Iterable<number> & {
+            length: number;
+        };
+    };
+    price: {
+        value: string | number | bigint;
+    };
+    price_last_update_timestamp_s: string | number | bigint;
+    available_amount: string | number | bigint;
+    ctoken_supply: string | number | bigint;
+    borrowed_amount: {
+        value: string | number | bigint;
+    };
+    cumulative_borrow_rate: {
+        value: string | number | bigint;
+    };
+    interest_last_update_timestamp_s: string | number | bigint;
+    fees_accumulated: {
+        value: string | number | bigint;
+    };
+}>;
+export declare const ObjectBag: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    size: string;
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    size: string | number | bigint;
+}>;
+export declare const LendingMarket: BcsType<{
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    reserves: {
+        config: {
+            vec: {
+                id: {
+                    id: {
+                        bytes: string;
+                    };
+                };
+                open_ltv_pct: number;
+                close_ltv_pct: number;
+                borrow_weight_bps: string | number | bigint;
+                deposit_limit: string | number | bigint;
+                borrow_limit: string | number | bigint;
+                liquidation_bonus_pct: number;
+                borrow_fee_bps: string | number | bigint;
+                spread_fee_bps: string | number | bigint;
+                liquidation_fee_bps: string | number | bigint;
+                interest_rate: {
+                    utils: Iterable<number> & {
+                        length: number;
+                    };
+                    aprs: Iterable<string | number | bigint> & {
+                        length: number;
+                    };
+                };
+            }[];
+        };
+        mint_decimals: number;
+        price_identifier: {
+            bytes: number[];
+        };
+        price: {
+            value: string;
+        };
+        price_last_update_timestamp_s: string;
+        available_amount: string;
+        ctoken_supply: string;
+        borrowed_amount: {
+            value: string;
+        };
+        cumulative_borrow_rate: {
+            value: string;
+        };
+        interest_last_update_timestamp_s: string;
+        fees_accumulated: {
+            value: string;
+        };
+    }[];
+    reserve_treasuries: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string;
+    };
+    obligations: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string;
+    };
+}, {
+    id: {
+        id: {
+            bytes: string;
+        };
+    };
+    reserves: Iterable<{
+        config: {
+            vec: Iterable<{
+                id: {
+                    id: {
+                        bytes: string;
+                    };
+                };
+                open_ltv_pct: number;
+                close_ltv_pct: number;
+                borrow_weight_bps: string | number | bigint;
+                deposit_limit: string | number | bigint;
+                borrow_limit: string | number | bigint;
+                liquidation_bonus_pct: number;
+                borrow_fee_bps: string | number | bigint;
+                spread_fee_bps: string | number | bigint;
+                liquidation_fee_bps: string | number | bigint;
+                interest_rate: {
+                    utils: Iterable<number> & {
+                        length: number;
+                    };
+                    aprs: Iterable<string | number | bigint> & {
+                        length: number;
+                    };
+                };
+            }> & {
+                length: number;
+            };
+        };
+        mint_decimals: number;
+        price_identifier: {
+            bytes: Iterable<number> & {
+                length: number;
+            };
+        };
+        price: {
+            value: string | number | bigint;
+        };
+        price_last_update_timestamp_s: string | number | bigint;
+        available_amount: string | number | bigint;
+        ctoken_supply: string | number | bigint;
+        borrowed_amount: {
+            value: string | number | bigint;
+        };
+        cumulative_borrow_rate: {
+            value: string | number | bigint;
+        };
+        interest_last_update_timestamp_s: string | number | bigint;
+        fees_accumulated: {
+            value: string | number | bigint;
+        };
+    }> & {
+        length: number;
+    };
+    reserve_treasuries: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string | number | bigint;
+    };
+    obligations: {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        size: string | number | bigint;
+    };
+}>;
+export declare function load<T>(client: SuiClient, type: BcsType<T>, id: string): Promise<InferBcsType<BcsType<T>>>;
+export declare enum Side {
+    DEPOSIT = "deposit",
+    BORROW = "borrow"
+}
+export type ObjectId = string;
+export type ObjectCallArg = {
+    Object: SuiObjectArg;
+};
+export type ObjectArg = string | ObjectCallArg | TransactionArgument;
+export interface PhantomReified<P> {
+    phantomType: P;
+    kind: "PhantomReified";
+}
+export interface AddReserveArgs {
+    lendingMarketOwnerCap: ObjectArg;
+    lendingMarket: ObjectArg;
+    priceInfo: ObjectArg;
+    config: ObjectArg;
+    coinMetadata: ObjectArg;
+    clock: ObjectArg;
+}
+export interface CreateReserveConfigArgs {
+    openLtvPct: number | TransactionArgument;
+    closeLtvPct: number | TransactionArgument;
+    maxCloseLtvPct: number | TransactionArgument;
+    borrowWeightBps: bigint | TransactionArgument;
+    depositLimit: bigint | TransactionArgument;
+    borrowLimit: bigint | TransactionArgument;
+    liquidationBonusBps: bigint | TransactionArgument;
+    maxLiquidationBonusBps: bigint | TransactionArgument;
+    depositLimitUsd: bigint | TransactionArgument;
+    borrowLimitUsd: bigint | TransactionArgument;
+    borrowFeeBps: bigint | TransactionArgument;
+    spreadFeeBps: bigint | TransactionArgument;
+    protocolLiquidationFeeBps: bigint | TransactionArgument;
+    interestRateUtils: Array<number | TransactionArgument> | TransactionArgument;
+    interestRateAprs: Array<bigint | TransactionArgument> | TransactionArgument;
+    isolated: boolean | TransactionArgument;
+    openAttributedBorrowLimitUsd: bigint | TransactionArgument;
+    closeAttributedBorrowLimitUsd: bigint | TransactionArgument;
+}
+export interface UpdateReserveConfigArgs {
+    lendingMarketOwnerCap: ObjectArg;
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    config: ObjectArg;
+}
+export interface AddPoolRewardArgs {
+    lendingMarketOwnerCap: ObjectArg;
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    isDepositReward: boolean | TransactionArgument;
+    rewards: ObjectArg;
+    startTimeMs: bigint | TransactionArgument;
+    endTimeMs: bigint | TransactionArgument;
+    clock: ObjectArg;
+}
+export interface CancelPoolRewardArgs {
+    lendingMarketOwnerCap: ObjectArg;
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    isDepositReward: boolean | TransactionArgument;
+    rewardIndex: bigint | TransactionArgument;
+    clock: ObjectArg;
+}
+export interface ClaimRewardsArgs {
+    lendingMarket: ObjectArg;
+    cap: ObjectArg;
+    clock: ObjectArg;
+    reserveId: bigint | TransactionArgument;
+    rewardIndex: bigint | TransactionArgument;
+    isDepositReward: boolean | TransactionArgument;
+}
+export interface ClaimRewardsAndDepositArgs {
+    lendingMarket: ObjectArg;
+    obligationId: string | TransactionArgument;
+    clock: ObjectArg;
+    rewardReserveId: bigint | TransactionArgument;
+    rewardIndex: bigint | TransactionArgument;
+    isDepositReward: boolean | TransactionArgument;
+    depositReserveId: bigint | TransactionArgument;
+}
+export interface CreateRateLimiterConfigArgs {
+    windowDuration: bigint | TransactionArgument;
+    maxOutflow: bigint | TransactionArgument;
+}
+export interface UpdateRateLimiterConfigArgs {
+    lendingMarketOwnerCap: ObjectArg;
+    lendingMarket: ObjectArg;
+    clock: ObjectArg;
+    config: ObjectArg;
+}
+export interface RefreshReservePriceArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    clock: ObjectArg;
+    priceInfo: ObjectArg;
+}
+export interface DepositLiquidityAndMintCtokensArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    clock: ObjectArg;
+    deposit: ObjectArg;
+}
+export interface DepositCtokensIntoObligationArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    obligationOwnerCap: ObjectArg;
+    clock: ObjectArg;
+    deposit: ObjectArg;
+}
+export interface WithdrawCtokensArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    obligationOwnerCap: ObjectArg;
+    clock: ObjectArg;
+    amount: bigint | TransactionArgument;
+}
+export interface BorrowArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    obligationOwnerCap: ObjectArg;
+    clock: ObjectArg;
+    amount: bigint | TransactionArgument;
+}
+export interface RepayArgs {
+    lendingMarket: ObjectArg;
+    reserveArrayIndex: bigint | TransactionArgument;
+    obligationId: string | TransactionArgument;
+    clock: ObjectArg;
+    maxRepayCoins: ObjectArg;
+}
+export interface LiquidateArgs {
+    lendingMarket: ObjectArg;
+    obligationId: string | TransactionArgument;
+    repayReserveArrayIndex: bigint | TransactionArgument;
+    withdrawReserveArrayIndex: bigint | TransactionArgument;
+    clock: ObjectArg;
+    repayCoins: ObjectArg;
+}