@scallop-io/sui-scallop-sdk 0.46.40 → 0.46.42

package/dist/models/scallopBuilder.d.ts

@@ -5,7 +5,7 @@ import { ScallopUtils } from './scallopUtils';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionBlock } from '@mysten/sui.js/transactions';
 import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopInstanceParams, ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins } from '../types';
+import type { ScallopInstanceParams, ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin } from '../types';
 import { ScallopCache } from './scallopCache';
 /**
  * @description
@@ -67,6 +67,21 @@ export declare class ScallopBuilder {
     selectMarketCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender: string): Promise<{
         takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
         leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        totalAmount: number;
+    }>;
+    /**
+     * Specifying the sender's amount of sCoins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param marketCoinName - Specific support sCoin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectSCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender: string): Promise<{
+        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
+        totalAmount: number;
     }>;
     /**
      * Execute Scallop txBlock using the `signAndSendTxn` methods in suikit.

package/dist/models/scallopClient.d.ts

@@ -294,6 +294,11 @@ export declare class ScallopClient {
      * @return Transaction block response or transaction block
      */
     claimBorrowIncentive<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Function to migrate all market coin in user wallet into sCoin
+     * @returns Transaction response
+     */
+    migrateAllMarketCoin<S extends boolean>(sign?: S): 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, SupportBorrowIncentiveCoins } from '../types';
+import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins, SupportSCoin } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
@@ -402,7 +402,26 @@ export declare class ScallopQuery {
      */
     getLoyaltyProgramInfos(veScaKey?: string | SuiObjectData): Promise<import("../types").LoyaltyProgramInfo | null>;
     /**
-     * Get flashloan fee for specified assets
+     * Get total supply of sCoin
+     * @param sCoinName - Supported sCoin name
+     * @returns Total Supply
      */
+    getSCoinTotalSupply(sCoinName: SupportSCoin): Promise<number>;
+    /**
+     * Get all sCoin amounts.
+     *
+     * @param sCoinNames - Specific an array of support sCoin name.
+     * @param ownerAddress - The owner address.
+     * @return All market sCoin amounts.
+     */
+    getSCoinAmounts(sCoinNames?: SupportSCoin[], ownerAddress?: string): Promise<import("../types").OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca", number>>>;
+    /**
+     * Get sCoin amount.
+     *
+     * @param coinNames - Specific support sCoin name.
+     * @param ownerAddress - The owner address.
+     * @return sCoin amount.
+     */
+    getSCoinAmount(sCoinName: SupportSCoin | SupportMarketCoins, ownerAddress?: string): Promise<number>;
     getFlashLoanFees(assetCoinNames?: SupportAssetCoins[]): Promise<Record<"eth" | "btc" | "usdc" | "usdt" | "sui" | "apt" | "sol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca", number>>;
 }

package/dist/models/scallopUtils.d.ts

@@ -1,6 +1,6 @@
 import { SuiAddressArg } from '@scallop-io/sui-kit';
 import { ScallopAddress } from './scallopAddress';
-import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType } from '../types';
+import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType, SupportSCoin } from '../types';
 /**
  * @description
  * Integrates some helper functions frequently used in interactions with the Scallop contract.
@@ -48,6 +48,31 @@ export declare class ScallopUtils {
      * @return Coin type.
      */
     parseCoinType(coinName: SupportCoins): string;
+    /**
+     * Convert coin name to sCoin name.
+     *
+     * @param coinName - Specific support coin name.
+     * @return sCoin name.
+     */
+    parseSCoinName<T extends SupportSCoin>(coinName: SupportCoins | SupportMarketCoins): T | undefined;
+    /**
+     * Convert sCoin name into sCoin type
+     * @param sCoinName
+     * @returns sCoin type
+     */
+    parseSCoinType(sCoinName: SupportSCoin): string;
+    /**
+     * Convert sCoin name into its underlying coin type
+     * @param sCoinName
+     * @returns coin type
+     */
+    parseUnderlyingSCoinType(sCoinName: SupportSCoin): string;
+    /**
+     * Get sCoin treasury id from sCoin name
+     * @param sCoinName
+     * @returns sCoin treasury id
+     */
+    getSCoinTreasury(sCoinName: SupportSCoin): any;
     /**
      * Convert coin name to market coin type.
      *
@@ -117,7 +142,12 @@ export declare class ScallopUtils {
      * @param coinType - The coin type, default is 0x2::SUI::SUI.
      * @return The selected transaction coin arguments.
      */
-    selectCoinIds(amount: number, coinType?: string, ownerAddress?: string): Promise<string[]>;
+    selectCoins(amount: number, coinType?: string, ownerAddress?: string): Promise<{
+        objectId: string;
+        digest: string;
+        version: string;
+        balance: string;
+    }[]>;
     /**
      * Get all asset coin names in the obligation record by obligation id.
      *

package/dist/queries/portfolioQuery.d.ts

@@ -40,7 +40,7 @@ export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportP
  * @param marketCoinAmount - The market coin amount.
  * @return User lending infomation for specific pool.
  */
-export declare const getLending: (query: ScallopQuery, poolCoinName: SupportPoolCoins, ownerAddress?: string, indexer?: boolean, marketPool?: MarketPool, spool?: Spool, stakeAccounts?: StakeAccount[], coinAmount?: number, marketCoinAmount?: number, coinPrice?: number) => Promise<Lending>;
+export declare const getLending: (query: ScallopQuery, poolCoinName: SupportPoolCoins, ownerAddress?: string, indexer?: boolean, marketPool?: MarketPool, spool?: Spool, stakeAccounts?: StakeAccount[], coinAmount?: number, marketCoinAmount?: number, coinPrice?: number, sCoinAmount?: number) => Promise<Lending>;
 /**
  * Get all obligation accounts data.
  *

package/dist/queries/sCoinQuery.d.ts

@@ -0,0 +1,27 @@
+import { ScallopQuery } from 'src/models';
+import { OptionalKeys, SupportSCoin, sCoinBalance } from 'src/types';
+/**
+ * Get total supply of sCoin
+ * @param query
+ * @param sCoinName
+ * @returns `number`
+ */
+export declare const getSCoinTotalSupply: (query: ScallopQuery, sCoinName: SupportSCoin) => Promise<sCoinBalance>;
+/**
+ * Query all owned sCoin amount.
+ *
+ * @param query - The Scallop query instance.
+ * @param sCoinNames - Specific an array of support sCoin name.
+ * @param ownerAddress - The owner address.
+ * @return All owned sCoins amount.
+ */
+export declare const getSCoinAmounts: (query: ScallopQuery, sCoinNames?: SupportSCoin[], ownerAddress?: string) => Promise<OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca", number>>>;
+/**
+ * Query owned sCoin amount.
+ *
+ * @param query - The Scallop query instance.
+ * @param sCoinNames - Specific support sCoin name.
+ * @param ownerAddress - The owner address.
+ * @return Owned sCoin amount.
+ */
+export declare const getSCoinAmount: (query: ScallopQuery, sCoinName: SupportSCoin, ownerAddress?: string) => Promise<number>;

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/address.d.ts

@@ -1,5 +1,5 @@
 import { SUPPORT_ORACLES } from '../constants';
-import type { SupportAssetCoins, SupportOracleType, SupportPackageType, SupportStakeMarketCoins } from './constant';
+import type { SupportAssetCoins, SupportOracleType, SupportPackageType, SupportSCoin, SupportStakeMarketCoins } from './constant';
 export interface AddressesInterface {
     core: {
         version: string;
@@ -91,6 +91,13 @@ export interface AddressesInterface {
         rewardPool: string;
         userRewardTableId: string;
     };
+    scoin: {
+        id: string;
+        coins: Partial<Record<SupportSCoin, {
+            coinType: string;
+            treasury: string;
+        }>>;
+    };
 }
 type AddressPathsProps<T> = T extends string ? [] : {
     [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];

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

@@ -1,7 +1,8 @@
 import type { SuiTxBlock as SuiKitTxBlock, SuiAddressArg, SuiObjectArg, SuiTxArg } from '@scallop-io/sui-kit';
-import type { TransactionResult } from '@mysten/sui.js/transactions';
+import type { TransactionArgument, TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
 import type { SupportCollateralCoins, SupportPoolCoins, SupportAssetCoins } from '../constant';
+import { ScallopTxBlockWithoutCoreTxBlock } from '.';
 export type CoreIds = {
     protocolPkg: string;
     market: string;
@@ -9,8 +10,14 @@ export type CoreIds = {
     coinDecimalsRegistry: string;
     xOracle: string;
 };
+export type NestedResult = Extract<TransactionArgument, {
+    kind: 'NestedResult';
+}>;
+type Obligation = NestedResult;
+type ObligationKey = NestedResult;
+type ObligationHotPotato = NestedResult;
 export type CoreNormalMethods = {
-    openObligation: () => TransactionResult;
+    openObligation: () => [Obligation, ObligationKey, ObligationHotPotato];
     returnObligation: (obligation: SuiAddressArg, obligationHotPotato: SuiObjectArg) => void;
     openObligationEntry: () => void;
     addCollateral: (obligation: SuiAddressArg, coin: SuiObjectArg, collateralCoinName: SupportCollateralCoins) => void;
@@ -31,12 +38,12 @@ export type CoreQuickMethods = {
     takeCollateralQuick: (amount: number, collateralCoinName: SupportCollateralCoins, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
     borrowQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
     borrowWithReferralQuick: (amount: number, poolCoinName: SupportPoolCoins, borrowReferral: SuiObjectArg, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
-    depositQuick: (amount: number, poolCoinName: SupportPoolCoins) => Promise<TransactionResult>;
+    depositQuick: (amount: number, poolCoinName: SupportPoolCoins, returnSCoin?: boolean) => Promise<TransactionResult>;
     withdrawQuick: (amount: number, poolCoinName: SupportPoolCoins) => Promise<TransactionResult>;
     repayQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiAddressArg) => Promise<void>;
     updateAssetPricesQuick: (assetCoinNames?: SupportAssetCoins[]) => Promise<void>;
 };
-export type SuiTxBlockWithCoreNormalMethods = SuiKitTxBlock & CoreNormalMethods;
+export type SuiTxBlockWithCoreNormalMethods = SuiKitTxBlock & ScallopTxBlockWithoutCoreTxBlock & CoreNormalMethods;
 export type CoreTxBlock = SuiTxBlockWithCoreNormalMethods & CoreQuickMethods;
 export type GenerateCoreNormalMethod = (params: {
     builder: ScallopBuilder;
@@ -46,3 +53,4 @@ export type GenerateCoreQuickMethod = (params: {
     builder: ScallopBuilder;
     txBlock: SuiTxBlockWithCoreNormalMethods;
 }) => CoreQuickMethods;
+export {};

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

@@ -4,9 +4,14 @@ import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
 import type { ReferralTxBlock } from './referral';
 import { LoyaltyProgramTxBlock } from './loyaltyProgram';
+import { SCoinTxBlock } from './sCoin';
 export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
 export type * from './vesca';
 export type * from './loyaltyProgram';
-export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & ReferralTxBlock & LoyaltyProgramTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;
+export type * from './sCoin';
+export type BaseScallopTxBlock = ReferralTxBlock & LoyaltyProgramTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;
+export type ScallopTxBlockWithoutSCoinTxBlock = SpoolTxBlock & BaseScallopTxBlock;
+export type ScallopTxBlockWithoutCoreTxBlock = SCoinTxBlock & ScallopTxBlockWithoutSCoinTxBlock;
+export type ScallopTxBlock = CoreTxBlock & ScallopTxBlockWithoutCoreTxBlock;

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

@@ -0,0 +1,37 @@
+import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock, TransactionResult } from '@scallop-io/sui-kit';
+import { SupportSCoin } from '../constant';
+import { ScallopBuilder } from 'src/models';
+import { ScallopTxBlockWithoutSCoinTxBlock } from '.';
+export type sCoinPkgIds = {
+    pkgId: string;
+};
+export type sCoinNormalMethods = {
+    /**
+     * Lock marketCoin and return sCoin
+     * @param marketCoinName
+     * @param marketCoin
+     * @returns
+     */
+    mintSCoin: (marketCoinName: SupportSCoin, marketCoin: SuiObjectArg) => TransactionResult;
+    /**
+     * Burn sCoin and return marketCoin
+     * @param sCoinName
+     * @param sCoin
+     * @returns
+     */
+    burnSCoin: (sCoinName: SupportSCoin, sCoin: SuiObjectArg) => TransactionResult;
+};
+export type sCoinQuickMethods = {
+    mintSCoinQuick: (marketCoinName: SupportSCoin, amount: number) => Promise<TransactionResult>;
+    burnSCoinQuick: (sCoinName: SupportSCoin, amount: number) => Promise<TransactionResult>;
+};
+export type SuiTxBlockWithSCoinNormalMethods = SuiKitTxBlock & ScallopTxBlockWithoutSCoinTxBlock & sCoinNormalMethods;
+export type SCoinTxBlock = SuiTxBlockWithSCoinNormalMethods & sCoinQuickMethods;
+export type GenerateSCoinNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiKitTxBlock;
+}) => sCoinNormalMethods;
+export type GenerateSCoinQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithSCoinNormalMethods;
+}) => sCoinQuickMethods;

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

@@ -2,6 +2,7 @@ import type { SuiTxBlock as SuiKitTxBlock, SuiAddressArg, SuiObjectArg, SuiTxArg
 import type { TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
 import type { SupportStakeMarketCoins } from '../constant';
+import { BaseScallopTxBlock } from '.';
 export type SpoolIds = {
     spoolPkg: string;
 };
@@ -16,7 +17,7 @@ export type SpoolQuickMethods = {
     unstakeQuick(amount: number, stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<TransactionResult[]>;
     claimQuick(stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<TransactionResult[]>;
 };
-export type SuiTxBlockWithSpoolNormalMethods = SuiKitTxBlock & SpoolNormalMethods;
+export type SuiTxBlockWithSpoolNormalMethods = SuiKitTxBlock & BaseScallopTxBlock & SpoolNormalMethods;
 export type SpoolTxBlock = SuiTxBlockWithSpoolNormalMethods & SpoolQuickMethods;
 export type GenerateSpoolNormalMethod = (params: {
     builder: ScallopBuilder;

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

@@ -1,7 +1,7 @@
-import { SUPPORT_POOLS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_SPOOLS, SUPPORT_SPOOLS_REWARDS, SUPPORT_BORROW_INCENTIVE_POOLS, SUPPORT_BORROW_INCENTIVE_REWARDS } from '../../constants';
+import { SUPPORT_POOLS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_SPOOLS, SUPPORT_SPOOLS_REWARDS, SUPPORT_BORROW_INCENTIVE_POOLS, SUPPORT_BORROW_INCENTIVE_REWARDS, SUPPORT_SCOIN } 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 SupportCoins = SupportAssetCoins | SupportMarketCoins | SupportStakeMarketCoins | SupportSCoin;
 export type SupportAssetCoins = SupportPoolCoins | SupportCollateralCoins | SupportStakeRewardCoins | SupportBorrowIncentiveRewardCoins;
 export type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
 export type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
@@ -11,6 +11,7 @@ export type SupportStakeCoins = Extract<SupportPoolCoins, ParseCoins<SupportStak
 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 SupportSCoin = (typeof SUPPORT_SCOIN)[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, SupportStakeRewardCoins, SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins } from './common';
+import { SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportStakeRewardCoins, SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins, SupportSCoin } from './common';
 export type Coins = {
     [K in SupportCoins]: K;
 };
@@ -8,6 +8,9 @@ export type AssetCoins = {
 export type MarketCoins = {
     [K in SupportMarketCoins]: K;
 };
+export type SCoins = {
+    [K in SupportSCoin]: K;
+};
 export type StakeMarketCoins = {
     [K in SupportStakeMarketCoins]: K;
 };
@@ -20,6 +23,15 @@ export type BorrowIncentiveRewardCoins = {
 export type AssetCoinIds = {
     [key in SupportAssetCoins]: string;
 };
+export type SCoinIds = {
+    [key in SupportSCoin]: string;
+};
+export type SCoinTreasuryCaps = {
+    [key in SupportSCoin]: string;
+};
+export type SCoinConverterTreasury = {
+    [key in SupportSCoin]: string;
+};
 type PickFromUnion<T, K extends string> = K extends T ? K : never;
 export type WormholeCoinIds = {
     [key in PickFromUnion<SupportAssetCoins, 'eth' | 'btc' | 'usdc' | 'usdt' | 'apt' | 'sol'>]: string;

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

@@ -1,4 +1,4 @@
-import type { SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, CoinWrappedType } from '../constant';
+import type { SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, CoinWrappedType, SupportSCoin } from '../constant';
 type OptionalKeys<T> = {
     [K in keyof T]?: T[K];
 };
@@ -6,6 +6,7 @@ export type MarketPools = OptionalKeys<Record<SupportPoolCoins, MarketPool>>;
 export type MarketCollaterals = OptionalKeys<Record<SupportCollateralCoins, MarketCollateral>>;
 export type CoinAmounts = OptionalKeys<Record<SupportPoolCoins, number>>;
 export type MarketCoinAmounts = OptionalKeys<Record<SupportMarketCoins, number>>;
+export type SCoinAmounts = OptionalKeys<Record<SupportSCoin, number>>;
 export type BalanceSheet = {
     cash: string;
     debt: string;

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

@@ -4,3 +4,4 @@ export type * from './borrowIncentive';
 export type * from './portfolio';
 export type * from './vesca';
 export type * from './loyaltyProgram';
+export type * from './sCoin';

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

@@ -47,6 +47,7 @@ export type ObligationAccount = {
     totalRiskLevel: number;
     totalDepositedPools: number;
     totalBorrowedPools: number;
+    totalRewardedPools: number;
     collaterals: OptionalKeys<Record<SupportCollateralCoins, ObligationCollateral>>;
     debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
     borrowIncentives: OptionalKeys<Record<SupportPoolCoins, ObligationBorrowIncentive>>;

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

@@ -0,0 +1 @@
+export type sCoinBalance = number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.46.40",
+  "version": "0.46.42",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -44,7 +44,7 @@
     "@noble/hashes": "^1.3.2",
     "@pythnetwork/price-service-client": "^1.8.2",
     "@pythnetwork/pyth-sui-js": "2.0.0",
-    "@scallop-io/sui-kit": "^0.45.0",
+    "@scallop-io/sui-kit": "0.52.0",
     "@scure/bip39": "^1.2.1",
     "@tanstack/query-core": "^5.28.0",
     "axios": "^1.6.0",
@@ -77,7 +77,7 @@
   },
   "peerDependencies": {
     "@mysten/sui.js": "0.52.0",
-    "@scallop-io/sui-kit": "^0.45.0",
+    "@scallop-io/sui-kit": "0.52.0",
     "bn.js": "^5.2.1"
   },
   "lint-staged": {

package/src/builders/coreBuilder.ts

@@ -4,7 +4,7 @@ import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { getObligations } from '../queries';
 import { updateOracles } from './oracle';
 import { requireSender } from '../utils';
-import type { SuiAddressArg } from '@scallop-io/sui-kit';
+import type { SuiAddressArg, TransactionResult } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from '../models';
 import type {
   CoreIds,
@@ -13,14 +13,15 @@ import type {
   SuiTxBlockWithCoreNormalMethods,
   CoreTxBlock,
   ScallopTxBlock,
+  NestedResult,
 } from '../types';
 
 /**
  * Check and get Obligation information from transaction block.
  *
  * @description
- * If the obligation id is provided, direactly return it.
- * If both obligation id and key is provided, direactly return them.
+ * If the obligation id is provided, directly return it.
+ * If both obligation id and key is provided, directly return them.
  * Otherwise, automatically get obligation id and key from the sender.
  *
  * @param builder - Scallop builder instance.
@@ -75,11 +76,17 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
   const referralWitnessType = `${referralPkgId}::scallop_referral_program::REFERRAL_WITNESS`;
 
   return {
-    openObligation: () =>
-      txBlock.moveCall(
+    openObligation: () => {
+      const [obligation, obligationKey, obligationHotPotato] = txBlock.moveCall(
         `${coreIds.protocolPkg}::open_obligation::open_obligation`,
         [coreIds.version]
-      ),
+      );
+      return [obligation, obligationKey, obligationHotPotato] as [
+        NestedResult,
+        NestedResult,
+        NestedResult,
+      ];
+    },
     returnObligation: (obligation, obligationHotPotato) =>
       txBlock.moveCall(
         `${coreIds.protocolPkg}::open_obligation::return_obligation`,
@@ -300,11 +307,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         collateralCoinName
       );
     },
-    depositQuick: async (amount, poolCoinName) => {
+    depositQuick: async (amount, poolCoinName, returnSCoin = true) => {
       const sender = requireSender(txBlock);
+      let marketCoinDeposit: TransactionResult | undefined;
       if (poolCoinName === 'sui') {
         const [suiCoin] = txBlock.splitSUIFromGas([amount]);
-        return txBlock.deposit(suiCoin, poolCoinName);
+        marketCoinDeposit = txBlock.deposit(suiCoin, poolCoinName);
       } else {
         const { leftCoin, takeCoin } = await builder.selectCoin(
           txBlock,
@@ -313,20 +321,67 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
           sender
         );
         txBlock.transferObjects([leftCoin], sender);
-        return txBlock.deposit(takeCoin, poolCoinName);
+        marketCoinDeposit = txBlock.deposit(takeCoin, poolCoinName);
       }
+
+      // convert to sCoin
+      return returnSCoin
+        ? txBlock.mintSCoin(
+            builder.utils.parseMarketCoinName(poolCoinName),
+            marketCoinDeposit
+          )
+        : marketCoinDeposit;
     },
     withdrawQuick: async (amount, poolCoinName) => {
       const sender = requireSender(txBlock);
       const marketCoinName = builder.utils.parseMarketCoinName(poolCoinName);
-      const { leftCoin, takeCoin } = await builder.selectMarketCoin(
-        txBlock,
-        marketCoinName,
-        amount,
-        sender
-      );
-      txBlock.transferObjects([leftCoin], sender);
-      return txBlock.withdraw(takeCoin, poolCoinName);
+
+      // check if user has sCoin instead of marketCoin
+      try {
+        const sCoinName = builder.utils.parseSCoinName(poolCoinName);
+        if (!sCoinName) throw new Error(`No sCoin for ${poolCoinName}`);
+        const { leftCoin, takeCoin, totalAmount } = await builder.selectSCoin(
+          txBlock,
+          sCoinName,
+          amount,
+          sender
+        );
+        txBlock.transferObjects([leftCoin], sender);
+        const marketCoin = txBlock.burnSCoin(sCoinName, takeCoin);
+
+        const txResult = txBlock.withdraw(marketCoin, poolCoinName);
+
+        // check amount
+        amount -= totalAmount;
+        try {
+          if (amount > 0) {
+            // sCoin is not enough, try market coin
+            const { leftCoin, takeCoin } = await builder.selectMarketCoin(
+              txBlock,
+              marketCoinName,
+              amount,
+              sender
+            );
+            txBlock.transferObjects([leftCoin], sender);
+            txBlock.mergeCoins(txResult, [
+              txBlock.withdraw(takeCoin, poolCoinName),
+            ]);
+          }
+        } catch (e) {
+          // ignore
+        }
+        return txResult;
+      } catch (e) {
+        // no sCoin found
+        const { leftCoin, takeCoin } = await builder.selectMarketCoin(
+          txBlock,
+          marketCoinName,
+          amount,
+          sender
+        );
+        txBlock.transferObjects([leftCoin], sender);
+        return txBlock.withdraw(takeCoin, poolCoinName);
+      }
     },
     borrowQuick: async (amount, poolCoinName, obligationId, obligationKey) => {
       const obligationInfo = await requireObligationInfo(

package/src/builders/index.ts

@@ -8,6 +8,7 @@ import type { ScallopBuilder } from '../models';
 import type { ScallopTxBlock } from '../types';
 import { newReferralTxBlock } from './referralBuilder';
 import { newLoyaltyProgramTxBlock } from './loyaltyProgramBuilder';
+import { newSCoinTxBlock } from './sCoinBuilder';
 
 /**
  * Create a new ScallopTxBlock instance.
@@ -28,7 +29,8 @@ export const newScallopTxBlock = (
   );
   const referralTxBlock = newReferralTxBlock(builder, borrowIncentiveTxBlock);
   const spoolTxBlock = newSpoolTxBlock(builder, referralTxBlock);
-  const coreTxBlock = newCoreTxBlock(builder, spoolTxBlock);
+  const sCoinTxBlock = newSCoinTxBlock(builder, spoolTxBlock);
+  const coreTxBlock = newCoreTxBlock(builder, sCoinTxBlock);
 
   return new Proxy(coreTxBlock, {
     get: (target, prop) => {
@@ -42,6 +44,8 @@ export const newScallopTxBlock = (
         return Reflect.get(spoolTxBlock, prop);
       } else if (prop in loyaltyTxBlock) {
         return Reflect.get(loyaltyTxBlock, prop);
+      } else if (prop in sCoinTxBlock) {
+        return Reflect.get(sCoinTxBlock, prop);
       }
       return Reflect.get(target, prop);
     },

package/src/builders/loyaltyProgramBuilder.ts

@@ -68,7 +68,7 @@ const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
 };
 
 /**
- * Create an enhanced transaction block instance for interaction with borrow incentive modules of the Scallop contract.
+ * Create an enhanced transaction block instance for interaction with loyalty program modules of the Scallop contract.
  *
  * @param builder - Scallop builder instance.
  * @param initTxBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.

package/src/builders/referralBuilder.ts

@@ -117,7 +117,7 @@ const generateReferralQuickMethod: GenerateReferralQuickMethod = ({
               Infinity,
               builder.utils.parseCoinType(coinName)
             );
-            txBlock.mergeCoins(rewardCoin, coins);
+            txBlock.mergeCoins(rewardCoin, coins.slice(0, 500));
           } catch (e) {
             // ignore
           } finally {