@suilend/sdk 1.0.0

package/core/parsers/lendingMarket.d.ts

@@ -0,0 +1,115 @@
+import { CoinMetadata } from "@mysten/sui.js/client";
+import BigNumber from "bignumber.js";
+import { Deps } from "./deps";
+export type ParsedLendingMarket = ReturnType<typeof parseLendingMarket>;
+export declare const parseLendingMarket: ({ LendingMarket, Reserve, PoolRewardManager, PoolReward, simulate, RateLimiter, }: Pick<Deps, "LendingMarket" | "Reserve" | "PoolRewardManager" | "PoolReward" | "simulate" | "RateLimiter">, lendingMarket: any, reserves: any[], coinMetadataMap: Record<string, CoinMetadata>, currentTime: number) => {
+    reserves: {
+        config: {
+            $typeName: any;
+            openLtvPct: any;
+            closeLtvPct: any;
+            maxCloseLtvPct: any;
+            borrowWeightBps: number;
+            depositLimit: BigNumber;
+            borrowLimit: BigNumber;
+            liquidationBonusBps: number;
+            maxLiquidationBonusBps: number;
+            depositLimitUsd: BigNumber;
+            borrowLimitUsd: BigNumber;
+            borrowFeeBps: number;
+            spreadFeeBps: number;
+            protocolLiquidationFeeBps: number;
+            isolated: any;
+            openAttributedBorrowLimitUsd: number;
+            closeAttributedBorrowLimitUsd: number;
+            interestRate: {
+                id: string;
+                utilPercent: BigNumber;
+                aprPercent: BigNumber;
+            }[];
+        };
+        $typeName: any;
+        id: any;
+        arrayIndex: any;
+        coinType: string;
+        mintDecimals: any;
+        priceIdentifier: string;
+        price: BigNumber;
+        smoothedPrice: BigNumber;
+        minPrice: BigNumber;
+        maxPrice: BigNumber;
+        priceLastUpdateTimestampS: any;
+        availableAmount: BigNumber;
+        ctokenSupply: BigNumber;
+        borrowedAmount: BigNumber;
+        cumulativeBorrowRate: BigNumber;
+        interestLastUpdateTimestampS: any;
+        unclaimedSpreadFees: BigNumber;
+        attributedBorrowValue: BigNumber;
+        depositsPoolRewardManager: {
+            $typeName: any;
+            id: any;
+            totalShares: any;
+            poolRewards: {
+                $typeName: any;
+                id: any;
+                rewardIndex: number;
+                poolRewardManagerId: any;
+                coinType: string;
+                startTimeMs: number;
+                endTimeMs: number;
+                totalRewards: BigNumber;
+                allocatedRewards: BigNumber;
+                cumulativeRewardsPerShare: BigNumber;
+                numUserRewardManagers: any;
+                mintDecimals: number;
+                symbol: string;
+            }[];
+            lastUpdateTimeMs: any;
+        };
+        borrowsPoolRewardManager: {
+            $typeName: any;
+            id: any;
+            totalShares: any;
+            poolRewards: {
+                $typeName: any;
+                id: any;
+                rewardIndex: number;
+                poolRewardManagerId: any;
+                coinType: string;
+                startTimeMs: number;
+                endTimeMs: number;
+                totalRewards: BigNumber;
+                allocatedRewards: BigNumber;
+                cumulativeRewardsPerShare: BigNumber;
+                numUserRewardManagers: any;
+                mintDecimals: number;
+                symbol: string;
+            }[];
+            lastUpdateTimeMs: any;
+        };
+        totalDeposits: BigNumber;
+        cTokenExchangeRate: BigNumber;
+        borrowAprPercent: BigNumber;
+        depositAprPercent: BigNumber;
+        utilizationPercent: BigNumber;
+        symbol: string;
+        name: string;
+        iconUrl: string | null | undefined;
+        description: string;
+    }[];
+    rateLimiter: {
+        config: {
+            windowDuration: any;
+            maxOutflow: any;
+        };
+        $typeName: any;
+        prevQty: any;
+        windowStart: any;
+        curQty: any;
+        remainingOutflow: BigNumber;
+    };
+    totalSupplyUsd: BigNumber;
+    totalBorrowUsd: BigNumber;
+    tvlUsd: BigNumber;
+};

package/core/parsers/lendingMarket.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLendingMarket = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const rateLimiter_1 = require("./rateLimiter");
+const reserve_1 = require("./reserve");
+const parseLendingMarket = ({ LendingMarket, Reserve, PoolRewardManager, PoolReward, simulate, RateLimiter, }, lendingMarket, reserves, coinMetadataMap, currentTime) => {
+    const parsedReserves = reserves.map((reserve) => (0, reserve_1.parseReserve)({ Reserve, PoolRewardManager, PoolReward, simulate }, reserve, coinMetadataMap));
+    const parsedRateLimiter = (0, rateLimiter_1.parseRateLimiter)({ RateLimiter }, lendingMarket.rateLimiter, currentTime);
+    // Custom
+    let totalSupplyUsd = new bignumber_js_1.default(0);
+    let totalBorrowUsd = new bignumber_js_1.default(0);
+    let tvlUsd = new bignumber_js_1.default(0);
+    parsedReserves.forEach((properties) => {
+        totalSupplyUsd = totalSupplyUsd.plus(properties.totalDeposits.times(properties.price));
+        totalBorrowUsd = totalBorrowUsd.plus(properties.borrowedAmount.times(properties.price));
+        tvlUsd = tvlUsd.plus(properties.availableAmount.times(properties.price));
+    });
+    return {
+        reserves: parsedReserves,
+        rateLimiter: parsedRateLimiter,
+        totalSupplyUsd,
+        totalBorrowUsd,
+        tvlUsd,
+    };
+};
+exports.parseLendingMarket = parseLendingMarket;

package/core/parsers/obligation.d.ts

@@ -0,0 +1,229 @@
+import BigNumber from "bignumber.js";
+import { Deps } from "./deps";
+import { ParsedReserve } from "./reserve";
+export type ParsedObligation = ReturnType<typeof parseObligation>;
+export type ParsedPosition = ParsedObligation["deposits"][0] | ParsedObligation["borrows"][0];
+export declare const parseObligation: ({ Obligation }: Pick<Deps, "Obligation">, obligation: any, parsedReserveMap: {
+    [coinType: string]: ParsedReserve;
+}) => {
+    id: any;
+    totalSupplyUsd: BigNumber;
+    totalBorrowUsd: BigNumber;
+    totalWeightedBorrowUsd: BigNumber;
+    netValueUsd: BigNumber;
+    borrowLimit: BigNumber;
+    unhealthyBorrowValueUsd: BigNumber;
+    positionCount: number;
+    deposits: {
+        coinType: string;
+        reserveArrayIndex: any;
+        userRewardManagerIndex: number;
+        depositedAmount: BigNumber;
+        depositedAmountUsd: BigNumber;
+        userRewardManager: any;
+        reserve: {
+            config: {
+                $typeName: any;
+                openLtvPct: any;
+                closeLtvPct: any;
+                maxCloseLtvPct: any;
+                borrowWeightBps: number;
+                depositLimit: BigNumber;
+                borrowLimit: BigNumber;
+                liquidationBonusBps: number;
+                maxLiquidationBonusBps: number;
+                depositLimitUsd: BigNumber;
+                borrowLimitUsd: BigNumber;
+                borrowFeeBps: number;
+                spreadFeeBps: number;
+                protocolLiquidationFeeBps: number;
+                isolated: any;
+                openAttributedBorrowLimitUsd: number;
+                closeAttributedBorrowLimitUsd: number;
+                interestRate: {
+                    id: string;
+                    utilPercent: BigNumber;
+                    aprPercent: BigNumber;
+                }[];
+            };
+            $typeName: any;
+            id: any;
+            arrayIndex: any;
+            coinType: string;
+            mintDecimals: any;
+            priceIdentifier: string;
+            price: BigNumber;
+            smoothedPrice: BigNumber;
+            minPrice: BigNumber;
+            maxPrice: BigNumber;
+            priceLastUpdateTimestampS: any;
+            availableAmount: BigNumber;
+            ctokenSupply: BigNumber;
+            borrowedAmount: BigNumber;
+            cumulativeBorrowRate: BigNumber;
+            interestLastUpdateTimestampS: any;
+            unclaimedSpreadFees: BigNumber;
+            attributedBorrowValue: BigNumber;
+            depositsPoolRewardManager: {
+                $typeName: any;
+                id: any;
+                totalShares: any;
+                poolRewards: {
+                    $typeName: any;
+                    id: any;
+                    rewardIndex: number;
+                    poolRewardManagerId: any;
+                    coinType: string;
+                    startTimeMs: number;
+                    endTimeMs: number;
+                    totalRewards: BigNumber;
+                    allocatedRewards: BigNumber;
+                    cumulativeRewardsPerShare: BigNumber;
+                    numUserRewardManagers: any;
+                    mintDecimals: number;
+                    symbol: string;
+                }[];
+                lastUpdateTimeMs: any;
+            };
+            borrowsPoolRewardManager: {
+                $typeName: any;
+                id: any;
+                totalShares: any;
+                poolRewards: {
+                    $typeName: any;
+                    id: any;
+                    rewardIndex: number;
+                    poolRewardManagerId: any;
+                    coinType: string;
+                    startTimeMs: number;
+                    endTimeMs: number;
+                    totalRewards: BigNumber;
+                    allocatedRewards: BigNumber;
+                    cumulativeRewardsPerShare: BigNumber;
+                    numUserRewardManagers: any;
+                    mintDecimals: number;
+                    symbol: string;
+                }[];
+                lastUpdateTimeMs: any;
+            };
+            totalDeposits: BigNumber;
+            cTokenExchangeRate: BigNumber;
+            borrowAprPercent: BigNumber;
+            depositAprPercent: BigNumber;
+            utilizationPercent: BigNumber;
+            symbol: string;
+            name: string;
+            iconUrl: string | null | undefined;
+            description: string;
+        };
+        original: any;
+    }[];
+    borrows: {
+        coinType: string;
+        reserveArrayIndex: any;
+        userRewardManagerIndex: number;
+        borrowedAmount: BigNumber;
+        borrowedAmountUsd: BigNumber;
+        userRewardManager: any;
+        reserve: {
+            config: {
+                $typeName: any;
+                openLtvPct: any;
+                closeLtvPct: any;
+                maxCloseLtvPct: any;
+                borrowWeightBps: number;
+                depositLimit: BigNumber;
+                borrowLimit: BigNumber;
+                liquidationBonusBps: number;
+                maxLiquidationBonusBps: number;
+                depositLimitUsd: BigNumber;
+                borrowLimitUsd: BigNumber;
+                borrowFeeBps: number;
+                spreadFeeBps: number;
+                protocolLiquidationFeeBps: number;
+                isolated: any;
+                openAttributedBorrowLimitUsd: number;
+                closeAttributedBorrowLimitUsd: number;
+                interestRate: {
+                    id: string;
+                    utilPercent: BigNumber;
+                    aprPercent: BigNumber;
+                }[];
+            };
+            $typeName: any;
+            id: any;
+            arrayIndex: any;
+            coinType: string;
+            mintDecimals: any;
+            priceIdentifier: string;
+            price: BigNumber;
+            smoothedPrice: BigNumber;
+            minPrice: BigNumber;
+            maxPrice: BigNumber;
+            priceLastUpdateTimestampS: any;
+            availableAmount: BigNumber;
+            ctokenSupply: BigNumber;
+            borrowedAmount: BigNumber;
+            cumulativeBorrowRate: BigNumber;
+            interestLastUpdateTimestampS: any;
+            unclaimedSpreadFees: BigNumber;
+            attributedBorrowValue: BigNumber;
+            depositsPoolRewardManager: {
+                $typeName: any;
+                id: any;
+                totalShares: any;
+                poolRewards: {
+                    $typeName: any;
+                    id: any;
+                    rewardIndex: number;
+                    poolRewardManagerId: any;
+                    coinType: string;
+                    startTimeMs: number;
+                    endTimeMs: number;
+                    totalRewards: BigNumber;
+                    allocatedRewards: BigNumber;
+                    cumulativeRewardsPerShare: BigNumber;
+                    numUserRewardManagers: any;
+                    mintDecimals: number;
+                    symbol: string;
+                }[];
+                lastUpdateTimeMs: any;
+            };
+            borrowsPoolRewardManager: {
+                $typeName: any;
+                id: any;
+                totalShares: any;
+                poolRewards: {
+                    $typeName: any;
+                    id: any;
+                    rewardIndex: number;
+                    poolRewardManagerId: any;
+                    coinType: string;
+                    startTimeMs: number;
+                    endTimeMs: number;
+                    totalRewards: BigNumber;
+                    allocatedRewards: BigNumber;
+                    cumulativeRewardsPerShare: BigNumber;
+                    numUserRewardManagers: any;
+                    mintDecimals: number;
+                    symbol: string;
+                }[];
+                lastUpdateTimeMs: any;
+            };
+            totalDeposits: BigNumber;
+            cTokenExchangeRate: BigNumber;
+            borrowAprPercent: BigNumber;
+            depositAprPercent: BigNumber;
+            utilizationPercent: BigNumber;
+            symbol: string;
+            name: string;
+            iconUrl: string | null | undefined;
+            description: string;
+        };
+        original: any;
+    }[];
+    minPriceBorrowLimit: BigNumber;
+    maxPriceTotalWeightedBorrowUsd: BigNumber;
+    weightedConservativeBorrowUtilizationPercent: BigNumber;
+    original: any;
+};

package/core/parsers/obligation.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseObligation = void 0;
+const utils_1 = require("@mysten/sui.js/utils");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const constants_1 = require("../constants");
+const parseObligation = ({ Obligation }, obligation, parsedReserveMap) => {
+    let totalSupplyUsd = new bignumber_js_1.default(0);
+    let totalBorrowUsd = new bignumber_js_1.default(0);
+    let borrowLimit = new bignumber_js_1.default(0);
+    let minPriceBorrowLimit = new bignumber_js_1.default(0);
+    let unhealthyBorrowValueUsd = new bignumber_js_1.default(0);
+    let totalWeightedBorrowUsd = new bignumber_js_1.default(0);
+    let maxPriceTotalWeightedBorrowUsd = new bignumber_js_1.default(0);
+    const positionCount = obligation.deposits.filter((pos) => pos.depositedCtokenAmount.toString() !== "0").length +
+        obligation.borrows.filter((pos) => pos.borrowedAmount.value.toString() !== "0").length;
+    const deposits = obligation.deposits.map((deposit) => {
+        const coinType = (0, utils_1.normalizeStructTag)(deposit.coinType.name);
+        const reserve = parsedReserveMap[coinType];
+        if (!reserve)
+            throw new Error(`Reserve with coinType ${deposit.coinType.name} not found`);
+        const depositedCtokenAmount = new bignumber_js_1.default(deposit.depositedCtokenAmount.toString()).div(10 ** reserve.mintDecimals);
+        const depositedAmount = depositedCtokenAmount.times(reserve.cTokenExchangeRate);
+        const depositedAmountUsd = depositedAmount.times(reserve.price);
+        totalSupplyUsd = totalSupplyUsd.plus(depositedAmountUsd);
+        minPriceBorrowLimit = minPriceBorrowLimit.plus(depositedAmount
+            .times(reserve.minPrice)
+            .times(reserve.config.openLtvPct / 100));
+        borrowLimit = borrowLimit.plus(depositedAmountUsd.times(reserve.config.openLtvPct / 100));
+        unhealthyBorrowValueUsd = unhealthyBorrowValueUsd.plus(depositedAmountUsd.times(reserve.config.closeLtvPct / 100));
+        const userRewardManagerIndex = Number(deposit.userRewardManagerIndex.toString());
+        const userRewardManager = obligation.userRewardManagers[userRewardManagerIndex];
+        const reserveArrayIndex = deposit.reserveArrayIndex;
+        return {
+            coinType,
+            reserveArrayIndex,
+            userRewardManagerIndex,
+            depositedAmount,
+            depositedAmountUsd,
+            userRewardManager,
+            reserve,
+            original: obligation,
+        };
+    });
+    const borrows = obligation.borrows.map((borrow) => {
+        const coinType = (0, utils_1.normalizeStructTag)(borrow.coinType.name);
+        const reserve = parsedReserveMap[coinType];
+        if (!reserve)
+            throw new Error(`Reserve with coinType ${borrow.coinType.name} not found`);
+        const reserveCumulativeBorrowRate = new bignumber_js_1.default(borrow.cumulativeBorrowRate.value.toString()).div(constants_1.WAD.toString());
+        const borrowedAmountInitial = new bignumber_js_1.default(borrow.borrowedAmount.value.toString())
+            .div(constants_1.WAD.toString())
+            .div(10 ** reserve.mintDecimals);
+        const borrowInterestIndex = reserve.cumulativeBorrowRate.div(reserveCumulativeBorrowRate);
+        const borrowedAmount = borrowedAmountInitial.times(borrowInterestIndex);
+        const borrowedAmountUsd = borrowedAmount.times(reserve.price);
+        const borrowWeight = reserve.config.borrowWeightBps / 10000;
+        totalBorrowUsd = totalBorrowUsd.plus(borrowedAmountUsd);
+        totalWeightedBorrowUsd = totalWeightedBorrowUsd.plus(borrowedAmountUsd.times(borrowWeight));
+        maxPriceTotalWeightedBorrowUsd = maxPriceTotalWeightedBorrowUsd.plus(borrowedAmount.times(reserve.maxPrice).times(borrowWeight));
+        const userRewardManagerIndex = Number(borrow.userRewardManagerIndex.toString());
+        const userRewardManager = obligation.userRewardManagers[userRewardManagerIndex];
+        const reserveArrayIndex = borrow.reserveArrayIndex;
+        return {
+            coinType,
+            reserveArrayIndex,
+            userRewardManagerIndex,
+            borrowedAmount,
+            borrowedAmountUsd,
+            userRewardManager,
+            reserve,
+            original: obligation,
+        };
+    });
+    const netValueUsd = totalSupplyUsd.minus(totalBorrowUsd);
+    const weightedConservativeBorrowUtilizationPercent = minPriceBorrowLimit.isZero()
+        ? new bignumber_js_1.default(0)
+        : maxPriceTotalWeightedBorrowUsd.div(minPriceBorrowLimit).times(100);
+    return {
+        id: obligation.id,
+        totalSupplyUsd,
+        totalBorrowUsd,
+        totalWeightedBorrowUsd,
+        netValueUsd,
+        borrowLimit,
+        unhealthyBorrowValueUsd,
+        positionCount,
+        deposits,
+        borrows,
+        minPriceBorrowLimit,
+        maxPriceTotalWeightedBorrowUsd,
+        weightedConservativeBorrowUtilizationPercent,
+        original: obligation,
+    };
+};
+exports.parseObligation = parseObligation;

package/core/parsers/rateLimiter.d.ts

@@ -0,0 +1,19 @@
+import BigNumber from "bignumber.js";
+import { Deps } from "./deps";
+export type ParsedRateLimiter = ReturnType<typeof parseRateLimiter>;
+export type ParsedRateLimiterConfig = ReturnType<typeof parseRateLimiterConfig>;
+export declare const parseRateLimiter: ({ RateLimiter }: Pick<Deps, "RateLimiter">, rateLimiter: any, currentTime: number) => {
+    config: {
+        windowDuration: any;
+        maxOutflow: any;
+    };
+    $typeName: any;
+    prevQty: any;
+    windowStart: any;
+    curQty: any;
+    remainingOutflow: BigNumber;
+};
+export declare const parseRateLimiterConfig: ({ RateLimiter }: Pick<Deps, "RateLimiter">, rateLimiter: any) => {
+    windowDuration: any;
+    maxOutflow: any;
+};

package/core/parsers/rateLimiter.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRateLimiterConfig = exports.parseRateLimiter = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const parseRateLimiter = ({ RateLimiter }, rateLimiter, currentTime) => {
+    const config = (0, exports.parseRateLimiterConfig)({ RateLimiter }, rateLimiter);
+    const $typeName = rateLimiter.$typeName;
+    const prevQty = rateLimiter.prevQty.value;
+    const windowStart = rateLimiter.windowStart;
+    const curQty = rateLimiter.curQty.value;
+    // Custom
+    const prevWeight = new bignumber_js_1.default(config.windowDuration.toString())
+        .minus((BigInt(currentTime) - windowStart + BigInt(1)).toString())
+        .div(config.windowDuration.toString());
+    const currentOutflow = prevWeight
+        .times(new bignumber_js_1.default(prevQty.toString()))
+        .plus(new bignumber_js_1.default(curQty.toString()))
+        .div(10 ** 18);
+    const remainingOutflow = currentOutflow.gt(config.maxOutflow.toString())
+        ? new bignumber_js_1.default(0)
+        : new bignumber_js_1.default(config.maxOutflow.toString()).minus(currentOutflow);
+    return {
+        config,
+        $typeName,
+        prevQty,
+        windowStart,
+        curQty,
+        remainingOutflow,
+    };
+};
+exports.parseRateLimiter = parseRateLimiter;
+const parseRateLimiterConfig = ({ RateLimiter }, rateLimiter) => {
+    const config = rateLimiter.config;
+    if (!config)
+        throw new Error("Rate limiter config not found");
+    const windowDuration = config.windowDuration;
+    const maxOutflow = config.maxOutflow;
+    return {
+        windowDuration,
+        maxOutflow,
+    };
+};
+exports.parseRateLimiterConfig = parseRateLimiterConfig;