@scallop-io/sui-scallop-sdk 0.44.2 → 0.44.4

package/dist/models/scallopClient.d.ts

@@ -6,7 +6,7 @@ import { ScallopQuery } from './scallopQuery';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
-import type { ScallopClientFnReturnType, ScallopInstanceParams, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, ScallopTxBlock } from '../types';
+import type { ScallopClientFnReturnType, ScallopInstanceParams, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock } from '../types';
 /**
  * @description
  * It provides contract interaction operations for general users.
@@ -103,7 +103,7 @@ export declare class ScallopClient {
      * @param stakeMarketCoinName - Support stake market coin.
      * @return Reward pool data.
      */
-    getRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").RewardPool | undefined>;
+    getStakeRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").StakeRewardPool | undefined>;
     /**
      * Open obligation.
      *
@@ -261,6 +261,37 @@ export declare class ScallopClient {
      */
     claim(stakeMarketCoinName: SupportStakeMarketCoins): Promise<SuiTransactionBlockResponse>;
     claim<S extends boolean>(stakeMarketCoinName: SupportStakeMarketCoins, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * stake obligaion.
+     *
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligaionId - The obligation account object.
+     * @param obligaionKeyId - The obligation key account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    stakeObligation<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * unstake obligaion.
+     *
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligaionId - The obligation account object.
+     * @param obligaionKeyId - The obligation key account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    unstakeObligation<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * unstake market coin from the specific spool.
+     *
+     * @param marketCoinName - Types of mak coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param accountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    claimBorrowIncentive<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Mint and get test coin.
      *

package/dist/models/scallopQuery.d.ts

@@ -1,5 +1,5 @@
 import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins } from '../types';
+import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 /**
@@ -229,31 +229,52 @@ export declare class ScallopQuery {
      */
     getStakePool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").StakePool | undefined>;
     /**
-     * Get reward pools data.
+     * Get stake reward pools data.
      *
      * @description
      * For backward compatible, it is recommended to use `getSpools` method
      * to get all spools data.
      *
      * @param stakeMarketCoinNames - Specific an array of stake market coin name.
-     * @return Reward pools data.
+     * @return Stake reward pools data.
      */
-    getRewardPools(stakeMarketCoinNames?: SupportStakeMarketCoins[]): Promise<{
-        ssui?: import("../types").RewardPool | undefined;
-        susdc?: import("../types").RewardPool | undefined;
-        susdt?: import("../types").RewardPool | undefined;
+    getStakeRewardPools(stakeMarketCoinNames?: SupportStakeMarketCoins[]): Promise<{
+        ssui?: import("../types").StakeRewardPool | undefined;
+        susdc?: import("../types").StakeRewardPool | undefined;
+        susdt?: import("../types").StakeRewardPool | undefined;
     }>;
     /**
-     * Get reward pool data.
+     * Get stake reward pool data.
      *
      * @description
      * For backward compatible, it is recommended to use `getSpool` method
      * to get spool data.
      *
      * @param marketCoinName - Specific support stake market coin name.
-     * @return Reward pool data.
+     * @return Stake reward pool data.
      */
-    getRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").RewardPool | undefined>;
+    getStakeRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<import("../types").StakeRewardPool | undefined>;
+    /**
+     * Get borrow incentive pools data.
+     *
+     * @param coinNames - Specific an array of support borrow incentive coin name.
+     * @return Borrow incentive pools data.
+     */
+    getBorrowIncentivePools(coinNames?: SupportBorrowIncentiveCoins[]): Promise<{
+        usdc?: import("../types").BorrowIncentivePool | undefined;
+        sui?: import("../types").BorrowIncentivePool | undefined;
+    }>;
+    /**
+     * Get borrow incentive accounts data.
+     *
+     * @param coinNames - Specific support borrow incentive coin name.
+     * @param ownerAddress - The owner address.
+     * @return Borrow incentive accounts data.
+     */
+    getBorrowIncentiveAccounts(obligationId: string, coinNames?: SupportBorrowIncentiveCoins[]): Promise<{
+        usdc?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        sui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+    }>;
     /**
      * Get user lending and spool infomation for specific pools.
      *

package/dist/models/scallopUtils.d.ts

@@ -1,5 +1,5 @@
 import { SuiAddressArg } from '@scallop-io/sui-kit';
-import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, CoinWrappedType } from '../types';
+import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType } from '../types';
 /**
  * @description
  * Integrates some helper functions frequently used in interactions with the Scallop contract.
@@ -81,12 +81,19 @@ export declare class ScallopUtils {
      */
     parseMarketCoinName<T extends SupportMarketCoins>(coinName: SupportCoins): T;
     /**
-     * Get reward type of stake pool.
+     * Get reward type of spool.
      *
      * @param stakeMarketCoinName - Support stake market coin.
-     * @return Reward coin name.
+     * @return Spool reward coin name.
      */
-    getRewardCoinName: (stakeMarketCoinName: SupportStakeMarketCoins) => "sui";
+    getSpoolRewardCoinName: (stakeMarketCoinName: SupportStakeMarketCoins) => "sui";
+    /**
+     * Get reward type of borrow incentive pool.
+     *
+     * @param borrowIncentiveCoinName - Support borrow incentive coin.
+     * @return Borrow incentive reward coin name.
+     */
+    getBorrowIncentiveRewardCoinName: (borrowIncentiveCoinName: SupportBorrowIncentiveCoins) => "sui";
     /**
      * Get coin decimal.
      *

package/dist/queries/borrowIncentiveQuery.d.ts

@@ -0,0 +1,24 @@
+import type { ScallopQuery } from '../models';
+import type { SupportBorrowIncentiveCoins } from '../types';
+/**
+ * Query borrow incentive pools data.
+ *
+ * @param query - The Scallop query instance.
+ * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
+ * @return Borrow incentive pools data.
+ */
+export declare const queryBorrowIncentivePools: (query: ScallopQuery, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]) => Promise<{
+    usdc?: import("../types").BorrowIncentivePool | undefined;
+    sui?: import("../types").BorrowIncentivePool | undefined;
+}>;
+/**
+ * Query borrow incentive accounts data.
+ *
+ * @param query - The Scallop query instance.
+ * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
+ * @return Borrow incentive accounts data.
+ */
+export declare const queryBorrowIncentiveAccounts: (query: ScallopQuery, obligationId: string, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]) => Promise<{
+    usdc?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+    sui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+}>;

package/dist/queries/coreQuery.d.ts

@@ -89,6 +89,14 @@ export declare const getMarketCollateral: (query: ScallopQuery, collateralCoinNa
  * @return Owned obligations.
  */
 export declare const getObligations: (query: ScallopQuery, ownerAddress?: string) => Promise<Obligation[]>;
+/**
+ * Query obligation locked status.
+ *
+ * @param query - The Scallop query instance.
+ * @param obligationId - The obligation id.
+ * @return Obligation locked status.
+ */
+export declare const getObligationLocked: (query: ScallopQuery, obligationId: string) => Promise<boolean>;
 /**
  * Query obligation data.
  *

package/dist/queries/index.d.ts

@@ -1,4 +1,5 @@
 export * from './coreQuery';
 export * from './spoolQuery';
+export * from './borrowIncentiveQuery';
 export * from './priceQuery';
 export * from './portfolioQuery';

package/dist/queries/spoolQuery.d.ts

@@ -1,5 +1,5 @@
 import type { ScallopQuery } from '../models';
-import type { MarketPool, Spool, StakePool, RewardPool, StakeAccounts, SupportStakeMarketCoins } from '../types';
+import type { MarketPool, Spool, StakePool, StakeRewardPool, StakeAccounts, SupportStakeMarketCoins } from '../types';
 /**
  * Get spools data.
  *
@@ -20,7 +20,7 @@ export declare const getSpools: (query: ScallopQuery, stakeMarketCoinNames?: Sup
  * @param marketPool - The market pool data.
  * @return Spool data.
  */
-export declare const getSpool: (query: ScallopQuery, stakeMarketCoinName: SupportStakeMarketCoins, marketPool?: MarketPool) => Promise<Spool | undefined>;
+export declare const getSpool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins, marketPool?: MarketPool) => Promise<Spool | undefined>;
 /**
  * Get all stake accounts of the owner.
  *
@@ -32,16 +32,24 @@ export declare const getStakeAccounts: (query: ScallopQuery, ownerAddress?: stri
 /**
  * Get stake pool data.
  *
+ * @description
+ * For backward compatible, it is recommended to use `getSpool` method
+ * to get stake pool info in spool data.
+ *
  * @param query - The Scallop query instance.
  * @param marketCoinName - Specific support stake market coin name.
  * @return Stake pool data.
  */
 export declare const getStakePool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins) => Promise<StakePool | undefined>;
 /**
- * Get reward pool of the owner.
+ * Get stake reward pool of the owner.
+ *
+ * @description
+ * For backward compatible, it is recommended to use `getSpool` method
+ * to get reward info in spool data.
  *
  * @param query - The Scallop query instance.
  * @param marketCoinName - Specific support stake market coin name.
- * @return Reward pool.
+ * @return Stake reward pool.
  */
-export declare const getRewardPool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins) => Promise<RewardPool | undefined>;
+export declare const getStakeRewardPool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins) => Promise<StakeRewardPool | undefined>;

package/dist/types/address.d.ts

@@ -7,6 +7,7 @@ export interface AddressesInterface {
         market: string;
         adminCap: string;
         coinDecimalsRegistry: string;
+        obligationAccessStore: string;
         coins: Partial<Record<SupportAssetCoins, {
             id: string;
             treasury: string;
@@ -50,6 +51,13 @@ export interface AddressesInterface {
             rewardPoolId: string;
         }>>;
     };
+    borrowIncentive: {
+        id: string;
+        adminCap: string;
+        query: string;
+        incentivePools: string;
+        incentiveAccounts: string;
+    };
 }
 type AddressPathsProps<T> = T extends string ? [] : {
     [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];

package/dist/types/builder/borrowIncentive.d.ts

@@ -0,0 +1,31 @@
+import type { SuiTxBlock as SuiKitTxBlock, SuiAddressArg } from '@scallop-io/sui-kit';
+import type { TransactionResult } from '@mysten/sui.js/transactions';
+import type { ScallopBuilder } from '../../models';
+import type { SupportBorrowIncentiveCoins } from '../constant';
+export type BorrowIncentiveIds = {
+    borrowIncentivePkg: string;
+    query: string;
+    incentivePools: string;
+    incentiveAccounts: string;
+    obligationAccessStore: string;
+};
+export type BorrowIncentiveNormalMethods = {
+    stakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => void;
+    unstakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => void;
+    claimBorrowIncentive: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => TransactionResult;
+};
+export type BorrowIncentiveQuickMethods = {
+    stakeObligationQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
+    unstakeObligationQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
+    claimBorrowIncentiveQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<TransactionResult>;
+};
+export type SuiTxBlockWithBorrowIncentiveNormalMethods = SuiKitTxBlock & BorrowIncentiveNormalMethods;
+export type BorrowIncentiveTxBlock = SuiTxBlockWithBorrowIncentiveNormalMethods & BorrowIncentiveQuickMethods;
+export type GenerateBorrowIncentiveNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiKitTxBlock;
+}) => BorrowIncentiveNormalMethods;
+export type GenerateBorrowIncentiveQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithBorrowIncentiveNormalMethods;
+}) => BorrowIncentiveQuickMethods;

package/dist/types/builder/index.d.ts

@@ -1,5 +1,7 @@
 import type { CoreTxBlock } from './core';
 import type { SpoolTxBlock } from './spool';
+import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 export type * from './core';
 export type * from './spool';
-export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock;
+export type * from './borrowIncentive';
+export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & BorrowIncentiveTxBlock;

package/dist/types/constant/common.d.ts

@@ -1,14 +1,16 @@
-import { SUPPORT_POOLS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_SPOOLS, SUPPORT_REWARD_POOLS } from '../../constants';
+import { SUPPORT_POOLS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_SPOOLS, SUPPORT_SPOOLS_REWARDS, SUPPORT_BORROW_INCENTIVE_POOLS, SUPPORT_BORROW_INCENTIVE_REWARDS } from '../../constants';
 type ParseMarketCoins<T extends string> = `s${T}`;
 type ParseCoins<T extends string> = T extends `s${infer R}` ? R : never;
 export type SupportCoins = SupportAssetCoins | SupportMarketCoins | SupportStakeMarketCoins;
-export type SupportAssetCoins = SupportPoolCoins | SupportCollateralCoins | SupportRewardCoins;
+export type SupportAssetCoins = SupportPoolCoins | SupportCollateralCoins | SupportStakeRewardCoins | SupportBorrowIncentiveRewardCoins;
 export type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
 export type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
 export type SupportMarketCoins = ParseMarketCoins<SupportPoolCoins> | SupportStakeMarketCoins;
 export type SupportStakeMarketCoins = (typeof SUPPORT_SPOOLS)[number];
 export type SupportStakeCoins = Extract<SupportPoolCoins, ParseCoins<SupportStakeMarketCoins>>;
-export type SupportRewardCoins = (typeof SUPPORT_REWARD_POOLS)[number];
+export type SupportStakeRewardCoins = (typeof SUPPORT_SPOOLS_REWARDS)[number];
+export type SupportBorrowIncentiveCoins = (typeof SUPPORT_BORROW_INCENTIVE_POOLS)[number];
+export type SupportBorrowIncentiveRewardCoins = (typeof SUPPORT_BORROW_INCENTIVE_REWARDS)[number];
 export type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
 export type SupportPackageType = (typeof SUPPORT_PACKAGES)[number];
 export type SupportCoinDecimals = Record<SupportCoins, number>;

package/dist/types/constant/enum.d.ts

@@ -1,4 +1,4 @@
-import { SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportRewardCoins } from './common';
+import { SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportStakeRewardCoins, SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins } from './common';
 export type Coins = {
     [K in SupportCoins]: K;
 };
@@ -11,8 +11,11 @@ export type MarketCoins = {
 export type StakeMarketCoins = {
     [K in SupportStakeMarketCoins]: K;
 };
-export type RewardCoins = {
-    [key in SupportStakeMarketCoins]: SupportRewardCoins;
+export type StakeRewardCoins = {
+    [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
+};
+export type BorrowIncentiveRewardCoins = {
+    [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins;
 };
 export type AssetCoinIds = {
     [key in SupportAssetCoins]: string;

package/dist/types/query/borrowIncentive.d.ts

@@ -0,0 +1,118 @@
+import type { SupportBorrowIncentiveCoins } from '../constant';
+export interface BorrowIncentiveAccountKey {
+    id: string;
+    onwerId: string;
+}
+type OptionalKeys<T> = {
+    [K in keyof T]?: T[K];
+};
+export type BorrowIncentivePools = OptionalKeys<Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>>;
+export type BorrowIncentivePool = {
+    coinName: SupportBorrowIncentiveCoins;
+    symbol: string;
+    coinType: string;
+    rewardCoinType: string;
+    coinDecimal: number;
+    rewardCoinDecimal: number;
+    coinPrice: number;
+    rewardCoinPrice: number;
+} & Required<Pick<ParsedBorrowIncentivePoolData, 'maxPoint' | 'distributedPoint' | 'maxStake'>> & CalculatedBorrowIncentivePoolData & BorrowIncentiveRewardPool;
+export type OriginBorrowIncentivePoolData = {
+    created_at: string;
+    distributed_point: string;
+    distributed_point_per_period: string;
+    index: string;
+    last_update: string;
+    max_distributed_point: string;
+    max_stakes: string;
+    point_distribution_time: string;
+    pool_type: {
+        name: string;
+    };
+    stakes: string;
+};
+export type ParsedBorrowIncentivePoolData = {
+    poolType: string;
+    maxPoint: number;
+    distributedPoint: number;
+    pointPerPeriod: number;
+    period: number;
+    maxStake: number;
+    staked: number;
+    index: number;
+    createdAt: number;
+    lastUpdate: number;
+};
+export type CalculatedBorrowIncentivePoolData = {
+    stakedAmount: number;
+    stakedCoin: number;
+    stakedValue: number;
+    distributedPointPerSec: number;
+    accumulatedPoints: number;
+    currentPointIndex: number;
+    currentTotalDistributedPoint: number;
+    startDate: Date;
+    endDate: Date;
+};
+export type BorrowIncentiveRewardPool = Required<Pick<ParsedBorrowIncentiveRewardPoolData, 'exchangeRateNumerator' | 'exchangeRateDenominator'>> & CalculatedBorrowIncentiveRewardPoolData;
+export type OriginBorrowIncentiveRewardPoolData = {
+    claimed_rewards: string;
+    exchange_rate_denominator: string;
+    exchange_rate_numerator: string;
+    remaining_reward: string;
+    reward_type: {
+        name: string;
+    };
+};
+export type ParsedBorrowIncentiveRewardPoolData = {
+    rewardType: string;
+    claimedRewards: number;
+    exchangeRateNumerator: number;
+    exchangeRateDenominator: number;
+    remainingRewards: number;
+};
+export type CalculatedBorrowIncentiveRewardPoolData = {
+    rewardApr: number;
+    totalRewardAmount: number;
+    totalRewardCoin: number;
+    totalRewardValue: number;
+    remaindRewardAmount: number;
+    remaindRewardCoin: number;
+    remaindRewardValue: number;
+    claimedRewardAmount: number;
+    claimedRewardCoin: number;
+    claimedRewardValue: number;
+    rewardPerSec: number;
+};
+export type BorrowIncentiveAccounts = OptionalKeys<Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>>;
+export type OriginBorrowIncentiveAccountData = {
+    amount: string;
+    index: string;
+    points: string;
+    pool_type: {
+        name: string;
+    };
+    total_points: string;
+};
+export type ParsedBorrowIncentiveAccountData = {
+    poolType: string;
+    amount: number;
+    index: number;
+    points: number;
+    totalPoints: number;
+};
+/**
+ * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
+ */
+export interface BorrowIncentivePoolsQueryInterface {
+    incentive_pools: OriginBorrowIncentivePoolData[];
+    reward_pool: OriginBorrowIncentiveRewardPoolData;
+}
+/**
+ * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
+ */
+export interface BorrowIncentiveAccountsQueryInterface {
+    incentive_states: OriginBorrowIncentiveAccountData[];
+    total_points: string;
+}
+export {};

package/dist/types/query/core.d.ts

@@ -255,6 +255,7 @@ export type Market = {
 export type Obligation = {
     id: string;
     keyId: string;
+    locked: boolean;
 };
 /**
  * The query interface for `market_query::market_data` inspectTxn.

package/dist/types/query/index.d.ts

@@ -1,3 +1,4 @@
 export type * from './core';
 export type * from './spool';
+export type * from './borrowIncentive';
 export type * from './portfolio';

package/dist/types/query/portfolio.d.ts

@@ -48,6 +48,7 @@ export type ObligationAccount = {
     totalBorrowedPools: number;
     collaterals: OptionalKeys<Record<SupportCollateralCoins, ObligationCollateral>>;
     debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
+    borrowIncentives: OptionalKeys<Record<SupportPoolCoins, ObligationBorrowIncentive>>;
 };
 export type ObligationCollateral = {
     coinName: SupportCollateralCoins;
@@ -81,6 +82,18 @@ export type ObligationDebt = {
     availableRepayAmount: number;
     availableRepayCoin: number;
 };
+export type ObligationBorrowIncentive = {
+    coinName: SupportPoolCoins;
+    coinType: string;
+    rewardCoinType: string;
+    symbol: string;
+    coinDecimal: number;
+    rewardCoinDecimal: number;
+    coinPrice: number;
+    rewardCoinPrice: number;
+    availableClaimAmount: number;
+    availableClaimCoin: number;
+};
 export type TotalValueLocked = {
     supplyValue: number;
     borrowValue: number;

package/dist/types/query/spool.d.ts

@@ -2,9 +2,6 @@ import type { SupportStakeMarketCoins } from '../constant';
 type OptionalKeys<T> = {
     [K in keyof T]?: T[K];
 };
-export type StakePools = OptionalKeys<Record<SupportStakeMarketCoins, StakePool>>;
-export type RewardPools = OptionalKeys<Record<SupportStakeMarketCoins, RewardPool>>;
-export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
 export type Spools = OptionalKeys<Record<SupportStakeMarketCoins, Spool>>;
 export type Spool = {
     marketCoinName: SupportStakeMarketCoins;
@@ -17,8 +14,8 @@ export type Spool = {
     coinPrice: number;
     marketCoinPrice: number;
     rewardCoinPrice: number;
-} & CalculatedStakePoolData & CalculatedRewardPoolData;
-export type OriginStakePoolData = {
+} & Required<Pick<ParsedSpoolData, 'maxPoint' | 'distributedPoint' | 'maxStake'>> & CalculatedSpoolData & SpoolRewardPool;
+export type OriginSpoolData = {
     stakeType: {
         fields: {
             name: string;
@@ -34,7 +31,7 @@ export type OriginStakePoolData = {
     createdAt: string;
     lastUpdate: string;
 };
-export type ParsedStakePoolData = {
+export type ParsedSpoolData = {
     stakeType: string;
     maxPoint: number;
     distributedPoint: number;
@@ -46,7 +43,7 @@ export type ParsedStakePoolData = {
     createdAt: number;
     lastUpdate: number;
 };
-export type CalculatedStakePoolData = {
+export type CalculatedSpoolData = {
     stakedAmount: number;
     stakedCoin: number;
     stakedValue: number;
@@ -57,21 +54,22 @@ export type CalculatedStakePoolData = {
     startDate: Date;
     endDate: Date;
 };
-export type OriginRewardPoolData = {
+export type SpoolRewardPool = Required<Pick<ParsedSpoolRewardPoolData, 'exchangeRateNumerator' | 'exchangeRateDenominator'>> & CalculatedSpoolRewardPoolData;
+export type OriginSpoolRewardPoolData = {
     claimed_rewards: string;
     exchange_rate_denominator: string;
     exchange_rate_numerator: string;
     rewards: string;
     spool_id: string;
 };
-export type ParsedRewardPoolData = {
+export type ParsedSpoolRewardPoolData = {
     claimedRewards: number;
     exchangeRateNumerator: number;
     exchangeRateDenominator: number;
     rewards: number;
     spoolId: string;
 };
-export type CalculatedRewardPoolData = {
+export type CalculatedSpoolRewardPoolData = {
     rewardApr: number;
     totalRewardAmount: number;
     totalRewardCoin: number;
@@ -83,9 +81,10 @@ export type CalculatedRewardPoolData = {
     claimedRewardCoin: number;
     claimedRewardValue: number;
     rewardPerSec: number;
-    exchangeRateNumerator: number;
-    exchangeRateDenominator: number;
 };
+export type StakePools = OptionalKeys<Record<SupportStakeMarketCoins, StakePool>>;
+export type StakeRewardPools = OptionalKeys<Record<SupportStakeMarketCoins, StakeRewardPool>>;
+export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
 export interface StakeAccount {
     id: string;
     type: string;
@@ -110,7 +109,7 @@ export interface StakePool {
     createdAt: number;
     lastUpdate: number;
 }
-export interface RewardPool {
+export interface StakeRewardPool {
     id: string;
     type: string;
     stakePoolId: string;

package/dist/utils/builder.d.ts

@@ -0,0 +1,8 @@
+import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+/**
+ * Check and get the sender from the transaction block.
+ *
+ * @param txBlock - TxBlock created by SuiKit.
+ * @return Sender of transaction.
+ */
+export declare const requireSender: (txBlock: SuiKitTxBlock) => string;

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
-export * from './oracle';
+export * from './builder';
 export * from './query';
 export * from './util';