@suilend/sdk 1.0.0

package/mainnet/parsers/reserve.d.ts

@@ -0,0 +1,162 @@
+import { CoinMetadata } from "@mysten/sui.js/client";
+import { PoolReward, PoolRewardManager } from "../_generated/suilend/liquidity-mining/structs";
+import { Reserve } from "../_generated/suilend/reserve/structs";
+export type ParsedReserve = ReturnType<typeof parseReserve>;
+export type ParsedReserveConfig = ReturnType<typeof parseReserveConfig>;
+export type ParsedPoolRewardManager = ReturnType<typeof parsePoolRewardManager>;
+export type ParsedPoolReward = NonNullable<ReturnType<typeof parsePoolReward>>;
+export declare const parseReserve: (reserve: Reserve<string>, coinMetadataMap: Record<string, CoinMetadata>) => {
+    config: {
+        $typeName: any;
+        openLtvPct: any;
+        closeLtvPct: any;
+        maxCloseLtvPct: any;
+        borrowWeightBps: number;
+        depositLimit: import("bignumber.js").BigNumber;
+        borrowLimit: import("bignumber.js").BigNumber;
+        liquidationBonusBps: number;
+        maxLiquidationBonusBps: number;
+        depositLimitUsd: import("bignumber.js").BigNumber;
+        borrowLimitUsd: import("bignumber.js").BigNumber;
+        borrowFeeBps: number;
+        spreadFeeBps: number;
+        protocolLiquidationFeeBps: number;
+        isolated: any;
+        openAttributedBorrowLimitUsd: number;
+        closeAttributedBorrowLimitUsd: number;
+        interestRate: {
+            id: string;
+            utilPercent: import("bignumber.js").BigNumber;
+            aprPercent: import("bignumber.js").BigNumber;
+        }[];
+    };
+    $typeName: any;
+    id: any;
+    arrayIndex: any;
+    coinType: string;
+    mintDecimals: any;
+    priceIdentifier: string;
+    price: import("bignumber.js").BigNumber;
+    smoothedPrice: import("bignumber.js").BigNumber;
+    minPrice: import("bignumber.js").BigNumber;
+    maxPrice: import("bignumber.js").BigNumber;
+    priceLastUpdateTimestampS: any;
+    availableAmount: import("bignumber.js").BigNumber;
+    ctokenSupply: import("bignumber.js").BigNumber;
+    borrowedAmount: import("bignumber.js").BigNumber;
+    cumulativeBorrowRate: import("bignumber.js").BigNumber;
+    interestLastUpdateTimestampS: any;
+    unclaimedSpreadFees: import("bignumber.js").BigNumber;
+    attributedBorrowValue: import("bignumber.js").BigNumber;
+    depositsPoolRewardManager: {
+        $typeName: any;
+        id: any;
+        totalShares: any;
+        poolRewards: {
+            $typeName: any;
+            id: any;
+            rewardIndex: number;
+            poolRewardManagerId: any;
+            coinType: string;
+            startTimeMs: number;
+            endTimeMs: number;
+            totalRewards: import("bignumber.js").BigNumber;
+            allocatedRewards: import("bignumber.js").BigNumber;
+            cumulativeRewardsPerShare: import("bignumber.js").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: import("bignumber.js").BigNumber;
+            allocatedRewards: import("bignumber.js").BigNumber;
+            cumulativeRewardsPerShare: import("bignumber.js").BigNumber;
+            numUserRewardManagers: any;
+            mintDecimals: number;
+            symbol: string;
+        }[];
+        lastUpdateTimeMs: any;
+    };
+    totalDeposits: import("bignumber.js").BigNumber;
+    cTokenExchangeRate: import("bignumber.js").BigNumber;
+    borrowAprPercent: import("bignumber.js").BigNumber;
+    depositAprPercent: import("bignumber.js").BigNumber;
+    utilizationPercent: import("bignumber.js").BigNumber;
+    symbol: string;
+    name: string;
+    iconUrl: string | null | undefined;
+    description: string;
+};
+export declare const parseReserveConfig: (reserve: Reserve<string>) => {
+    $typeName: any;
+    openLtvPct: any;
+    closeLtvPct: any;
+    maxCloseLtvPct: any;
+    borrowWeightBps: number;
+    depositLimit: import("bignumber.js").BigNumber;
+    borrowLimit: import("bignumber.js").BigNumber;
+    liquidationBonusBps: number;
+    maxLiquidationBonusBps: number;
+    depositLimitUsd: import("bignumber.js").BigNumber;
+    borrowLimitUsd: import("bignumber.js").BigNumber;
+    borrowFeeBps: number;
+    spreadFeeBps: number;
+    protocolLiquidationFeeBps: number;
+    isolated: any;
+    openAttributedBorrowLimitUsd: number;
+    closeAttributedBorrowLimitUsd: number;
+    interestRate: {
+        id: string;
+        utilPercent: import("bignumber.js").BigNumber;
+        aprPercent: import("bignumber.js").BigNumber;
+    }[];
+};
+export declare const parsePoolRewardManager: (poolRewardManager: PoolRewardManager, coinMetadataMap: Record<string, CoinMetadata>) => {
+    $typeName: any;
+    id: any;
+    totalShares: any;
+    poolRewards: {
+        $typeName: any;
+        id: any;
+        rewardIndex: number;
+        poolRewardManagerId: any;
+        coinType: string;
+        startTimeMs: number;
+        endTimeMs: number;
+        totalRewards: import("bignumber.js").BigNumber;
+        allocatedRewards: import("bignumber.js").BigNumber;
+        cumulativeRewardsPerShare: import("bignumber.js").BigNumber;
+        numUserRewardManagers: any;
+        mintDecimals: number;
+        symbol: string;
+    }[];
+    lastUpdateTimeMs: any;
+};
+export declare const parsePoolReward: (poolReward: PoolReward | null, rewardIndex: number, coinMetadataMap: Record<string, CoinMetadata>) => {
+    $typeName: any;
+    id: any;
+    rewardIndex: number;
+    poolRewardManagerId: any;
+    coinType: string;
+    startTimeMs: number;
+    endTimeMs: number;
+    totalRewards: import("bignumber.js").BigNumber;
+    allocatedRewards: import("bignumber.js").BigNumber;
+    cumulativeRewardsPerShare: import("bignumber.js").BigNumber;
+    numUserRewardManagers: any;
+    mintDecimals: number;
+    symbol: string;
+} | null;

package/mainnet/parsers/reserve.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePoolReward = exports.parsePoolRewardManager = exports.parseReserveConfig = exports.parseReserve = void 0;
+const core = __importStar(require("../../core/parsers/reserve"));
+const structs_1 = require("../_generated/suilend/liquidity-mining/structs");
+const structs_2 = require("../_generated/suilend/reserve/structs");
+const simulate = __importStar(require("../utils/simulate"));
+const parseReserve = (reserve, coinMetadataMap) => core.parseReserve({ Reserve: (structs_2.Reserve), PoolRewardManager: structs_1.PoolRewardManager, PoolReward: structs_1.PoolReward, simulate }, reserve, coinMetadataMap);
+exports.parseReserve = parseReserve;
+const parseReserveConfig = (reserve) => core.parseReserveConfig({ Reserve: (structs_2.Reserve) }, reserve);
+exports.parseReserveConfig = parseReserveConfig;
+const parsePoolRewardManager = (poolRewardManager, coinMetadataMap) => core.parsePoolRewardManager({ PoolRewardManager: structs_1.PoolRewardManager, PoolReward: structs_1.PoolReward }, poolRewardManager, coinMetadataMap);
+exports.parsePoolRewardManager = parsePoolRewardManager;
+const parsePoolReward = (poolReward, rewardIndex, coinMetadataMap) => core.parsePoolReward({ PoolReward: structs_1.PoolReward }, poolReward, rewardIndex, coinMetadataMap);
+exports.parsePoolReward = parsePoolReward;

package/mainnet/types.d.ts

@@ -0,0 +1 @@
+export * from "../core/types";

package/mainnet/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../core/types"), exports);

package/mainnet/utils/events.d.ts

@@ -0,0 +1,144 @@
+import { SuiClient, SuiEvent } from "@mysten/sui.js/client";
+type TypeName = {
+    name: string;
+};
+type Decimal = {
+    value: string;
+};
+type address = string;
+type u64 = string;
+export declare function addressToString(addr: address): string;
+export declare function u64ToNumber(value: u64): number;
+export declare function typeNameToString(value: TypeName): string;
+export declare function decimalToNumber(value: Decimal): number;
+export declare enum SuilendEventType {
+    MintEvent = "MintEvent",
+    RedeemEvent = "RedeemEvent",
+    DepositEvent = "DepositEvent",
+    WithdrawEvent = "WithdrawEvent",
+    BorrowEvent = "BorrowEvent",
+    RepayEvent = "RepayEvent",
+    LiquidateEvent = "LiquidateEvent",
+    InterestUpdateEvent = "InterestUpdateEvent",
+    ReserveAssetDataEvent = "ReserveAssetDataEvent"
+}
+export declare enum SuilendTransactionModule {
+    LendingMarket = "lending_market",
+    Reserve = "reserve"
+}
+declare class TypedParamsSuiEvent<T> {
+    event: SuiEvent;
+    constructor(event: SuiEvent);
+    params(): T;
+    isType(module: SuilendTransactionModule, eventType: SuilendEventType): boolean;
+}
+export declare class GenericSuilendEvent extends TypedParamsSuiEvent<{}> {
+}
+export declare class InterestUpdateEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    cumulative_borrow_rate: Decimal;
+    available_amount: u64;
+    borrowed_amount: Decimal;
+    unclaimed_spread_fees: Decimal;
+    ctoken_supply: u64;
+    borrow_interest_paid: Decimal;
+    spread_fee: Decimal;
+    supply_interest_earned: Decimal;
+    borrow_interest_paid_usd_estimate: Decimal;
+    protocol_fee_usd_estimate: Decimal;
+    supply_interest_earned_usd_estimate: Decimal;
+}> {
+}
+export declare class ReserveAssetDataEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    available_amount: Decimal;
+    supply_amount: Decimal;
+    borrowed_amount: Decimal;
+    available_amount_usd_estimate: Decimal;
+    supply_amount_usd_estimate: Decimal;
+    borrowed_amount_usd_estimate: Decimal;
+    borrow_apr: Decimal;
+    supply_apr: Decimal;
+    ctoken_supply: u64;
+    cumulative_borrow_rate: Decimal;
+    price: Decimal;
+    smoothed_price: Decimal;
+    price_last_update_timestamp_s: u64;
+}> {
+}
+export declare class MintEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    liquidity_amount: u64;
+    ctoken_amount: u64;
+}> {
+}
+export declare class RedeemEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    ctoken_amount: u64;
+    liquidity_amount: u64;
+}> {
+}
+export declare class DepositEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    obligation_id: address;
+    ctoken_amount: u64;
+}> {
+}
+export declare class WithdrawEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    obligation_id: address;
+    ctoken_amount: u64;
+}> {
+}
+export declare class BorrowEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    obligation_id: address;
+    liquidity_amount: u64;
+}> {
+}
+export declare class RepayEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    coin_type: TypeName;
+    reserve_id: address;
+    obligation_id: address;
+    liquidity_amount: u64;
+}> {
+}
+export declare class LiquidateEvent extends TypedParamsSuiEvent<{
+    lending_market: TypeName;
+    repay_reserve_id: address;
+    withdraw_reserve_id: address;
+    obligation_id: address;
+    repay_amount: u64;
+    withdraw_amount: u64;
+    protocol_fee_amount: u64;
+    liquidator_bonus_amount: u64;
+}> {
+}
+export declare class ClaimRewardEvent extends TypedParamsSuiEvent<{
+    coin_type: TypeName;
+    is_deposit_reward: boolean;
+    lending_market_id: string;
+    liquidity_amount: string;
+    obligation_id: string;
+    pool_reward_id: string;
+    reserve_id: "0x0b8faf51e65f0beee47f6b9627108ee25b5a2b922ae7ee5725485ed7a9293523";
+}> {
+}
+export declare function getEvents(client: SuiClient, digest: string): Promise<GenericSuilendEvent[]>;
+export declare function getRedeemEvent(client: SuiClient, digest: string): Promise<RedeemEvent | null>;
+export {};

package/mainnet/utils/events.js

@@ -0,0 +1,115 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedeemEvent = exports.getEvents = exports.ClaimRewardEvent = exports.LiquidateEvent = exports.RepayEvent = exports.BorrowEvent = exports.WithdrawEvent = exports.DepositEvent = exports.RedeemEvent = exports.MintEvent = exports.ReserveAssetDataEvent = exports.InterestUpdateEvent = exports.GenericSuilendEvent = exports.SuilendTransactionModule = exports.SuilendEventType = exports.decimalToNumber = exports.typeNameToString = exports.u64ToNumber = exports.addressToString = void 0;
+function addressToString(addr) {
+    return addr;
+}
+exports.addressToString = addressToString;
+function u64ToNumber(value) {
+    return parseInt(value);
+}
+exports.u64ToNumber = u64ToNumber;
+function typeNameToString(value) {
+    return value.name;
+}
+exports.typeNameToString = typeNameToString;
+function decimalToNumber(value) {
+    return parseInt(value.value) / 10 ** 18;
+}
+exports.decimalToNumber = decimalToNumber;
+var SuilendEventType;
+(function (SuilendEventType) {
+    SuilendEventType["MintEvent"] = "MintEvent";
+    SuilendEventType["RedeemEvent"] = "RedeemEvent";
+    SuilendEventType["DepositEvent"] = "DepositEvent";
+    SuilendEventType["WithdrawEvent"] = "WithdrawEvent";
+    SuilendEventType["BorrowEvent"] = "BorrowEvent";
+    SuilendEventType["RepayEvent"] = "RepayEvent";
+    SuilendEventType["LiquidateEvent"] = "LiquidateEvent";
+    SuilendEventType["InterestUpdateEvent"] = "InterestUpdateEvent";
+    SuilendEventType["ReserveAssetDataEvent"] = "ReserveAssetDataEvent";
+})(SuilendEventType || (exports.SuilendEventType = SuilendEventType = {}));
+var SuilendTransactionModule;
+(function (SuilendTransactionModule) {
+    SuilendTransactionModule["LendingMarket"] = "lending_market";
+    SuilendTransactionModule["Reserve"] = "reserve";
+})(SuilendTransactionModule || (exports.SuilendTransactionModule = SuilendTransactionModule = {}));
+class TypedParamsSuiEvent {
+    constructor(event) {
+        this.event = event;
+    }
+    params() {
+        return this.event.parsedJson;
+    }
+    isType(module, eventType) {
+        return this.event.type.includes(`${module}::${eventType}`);
+    }
+}
+class GenericSuilendEvent extends TypedParamsSuiEvent {
+}
+exports.GenericSuilendEvent = GenericSuilendEvent;
+class InterestUpdateEvent extends TypedParamsSuiEvent {
+}
+exports.InterestUpdateEvent = InterestUpdateEvent;
+class ReserveAssetDataEvent extends TypedParamsSuiEvent {
+}
+exports.ReserveAssetDataEvent = ReserveAssetDataEvent;
+class MintEvent extends TypedParamsSuiEvent {
+}
+exports.MintEvent = MintEvent;
+class RedeemEvent extends TypedParamsSuiEvent {
+}
+exports.RedeemEvent = RedeemEvent;
+class DepositEvent extends TypedParamsSuiEvent {
+}
+exports.DepositEvent = DepositEvent;
+class WithdrawEvent extends TypedParamsSuiEvent {
+}
+exports.WithdrawEvent = WithdrawEvent;
+class BorrowEvent extends TypedParamsSuiEvent {
+}
+exports.BorrowEvent = BorrowEvent;
+class RepayEvent extends TypedParamsSuiEvent {
+}
+exports.RepayEvent = RepayEvent;
+class LiquidateEvent extends TypedParamsSuiEvent {
+}
+exports.LiquidateEvent = LiquidateEvent;
+class ClaimRewardEvent extends TypedParamsSuiEvent {
+}
+exports.ClaimRewardEvent = ClaimRewardEvent;
+function getEvents(client, digest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tx = yield client.getTransactionBlock({
+            digest,
+            options: { showEvents: true },
+        });
+        const events = [];
+        for (const event of tx.events || []) {
+            events.push(new GenericSuilendEvent(event));
+        }
+        return events;
+    });
+}
+exports.getEvents = getEvents;
+function getRedeemEvent(client, digest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const events = yield getEvents(client, digest);
+        for (const event of events) {
+            if (event.isType(SuilendTransactionModule.LendingMarket, SuilendEventType.RedeemEvent)) {
+                return event;
+            }
+        }
+        return null;
+    });
+}
+exports.getRedeemEvent = getRedeemEvent;

package/mainnet/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./events";
+export * from "./obligation";
+export * from "./simulate";
+export * from "./utils";

package/mainnet/utils/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./events"), exports);
+__exportStar(require("./obligation"), exports);
+__exportStar(require("./simulate"), exports);
+__exportStar(require("./utils"), exports);

package/mainnet/utils/obligation.d.ts

@@ -0,0 +1,25 @@
+import { SuiClient } from "@mysten/sui.js/client";
+import { Obligation } from "../_generated/suilend/obligation/structs";
+export declare function fetchAllObligationsForMarketWithHandler(client: SuiClient, marketAddress: string, chunkHandler: (obligations: Obligation<string>[]) => Promise<void>): Promise<void>;
+export declare function fetchAllObligationsForMarket(client: SuiClient, marketAddress: string): Promise<Obligation<string>[]>;
+export type formattedObligationHistory = nonLiquidationHistoryEvent | liquidationHistoryEvent;
+export type nonLiquidationHistoryEvent = {
+    reserveId: string;
+    quantity: number;
+    action: string;
+    timestampMs: number;
+    digest: string;
+};
+export type liquidationHistoryEvent = {
+    repayReserveId: string;
+    repayQuantity: number;
+    withdrawReserveId: string;
+    withdrawQuantity: number;
+    action: "Liquidation";
+    timestampMs: number;
+    digest: string;
+};
+export declare function getObligationHistoryPage(client: SuiClient, obligationId: string, maxQuantity: number, cursor: string | null): Promise<{
+    cursor: string | null | undefined;
+    history: formattedObligationHistory[];
+}>;