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

package/src/types/address.ts

@@ -3,6 +3,7 @@ import type {
   SupportAssetCoins,
   SupportOracleType,
   SupportPackageType,
+  SupportSCoin,
   SupportStakeMarketCoins,
 } from './constant';
 
@@ -121,6 +122,18 @@ export interface AddressesInterface {
     rewardPool: string;
     userRewardTableId: string;
   };
+  scoin: {
+    id: string;
+    coins: Partial<
+      Record<
+        SupportSCoin,
+        {
+          coinType: string;
+          treasury: string;
+        }
+      >
+    >;
+  };
 }
 
 type AddressPathsProps<T> = T extends string

package/src/types/builder/core.ts

@@ -4,13 +4,17 @@ import type {
   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;
@@ -20,8 +24,16 @@ export type CoreIds = {
   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
@@ -113,7 +125,8 @@ export type CoreQuickMethods = {
   ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,
-    poolCoinName: SupportPoolCoins
+    poolCoinName: SupportPoolCoins,
+    returnSCoin?: boolean
   ) => Promise<TransactionResult>;
   withdrawQuick: (
     amount: number,
@@ -129,7 +142,9 @@ export type CoreQuickMethods = {
   ) => Promise<void>;
 };
 
-export type SuiTxBlockWithCoreNormalMethods = SuiKitTxBlock & CoreNormalMethods;
+export type SuiTxBlockWithCoreNormalMethods = SuiKitTxBlock &
+  ScallopTxBlockWithoutCoreTxBlock &
+  CoreNormalMethods;
 
 export type CoreTxBlock = SuiTxBlockWithCoreNormalMethods & CoreQuickMethods;
 

package/src/types/builder/index.ts

@@ -4,16 +4,24 @@ 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 * from './sCoin';
 
-export type ScallopTxBlock = CoreTxBlock &
-  SpoolTxBlock &
-  ReferralTxBlock &
+export type BaseScallopTxBlock = ReferralTxBlock &
   LoyaltyProgramTxBlock &
   BorrowIncentiveTxBlock &
   VeScaTxBlock;
+
+export type ScallopTxBlockWithoutSCoinTxBlock = SpoolTxBlock &
+  BaseScallopTxBlock;
+
+export type ScallopTxBlockWithoutCoreTxBlock = SCoinTxBlock &
+  ScallopTxBlockWithoutSCoinTxBlock;
+
+export type ScallopTxBlock = CoreTxBlock & ScallopTxBlockWithoutCoreTxBlock;

package/src/types/builder/sCoin.ts

@@ -0,0 +1,61 @@
+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; // returns marketCoin
+};
+
+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/src/types/builder/spool.ts

@@ -7,6 +7,7 @@ import type {
 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;
@@ -50,6 +51,7 @@ export type SpoolQuickMethods = {
 };
 
 export type SuiTxBlockWithSpoolNormalMethods = SuiKitTxBlock &
+  BaseScallopTxBlock &
   SpoolNormalMethods;
 
 export type SpoolTxBlock = SuiTxBlockWithSpoolNormalMethods & SpoolQuickMethods;

package/src/types/constant/common.ts

@@ -7,6 +7,7 @@ import {
   SUPPORT_SPOOLS_REWARDS,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
+  SUPPORT_SCOIN,
 } from '../../constants';
 
 type ParseMarketCoins<T extends string> = `s${T}`;
@@ -15,7 +16,8 @@ type ParseCoins<T extends string> = T extends `s${infer R}` ? R : never;
 export type SupportCoins =
   | SupportAssetCoins
   | SupportMarketCoins
-  | SupportStakeMarketCoins;
+  | SupportStakeMarketCoins
+  | SupportSCoin;
 export type SupportAssetCoins =
   | SupportPoolCoins
   | SupportCollateralCoins
@@ -36,6 +38,7 @@ 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];
 

package/src/types/constant/enum.ts

@@ -6,6 +6,7 @@ import {
   SupportStakeRewardCoins,
   SupportBorrowIncentiveCoins,
   SupportBorrowIncentiveRewardCoins,
+  SupportSCoin,
 } from './common';
 
 export type Coins = {
@@ -20,6 +21,10 @@ export type MarketCoins = {
   [K in SupportMarketCoins]: K;
 };
 
+export type SCoins = {
+  [K in SupportSCoin]: K;
+};
+
 export type StakeMarketCoins = {
   [K in SupportStakeMarketCoins]: K;
 };
@@ -36,6 +41,18 @@ 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 = {

package/src/types/query/core.ts

@@ -3,6 +3,7 @@ import type {
   SupportCollateralCoins,
   SupportMarketCoins,
   CoinWrappedType,
+  SupportSCoin,
 } from '../constant';
 
 type OptionalKeys<T> = {
@@ -18,6 +19,8 @@ export type MarketCoinAmounts = OptionalKeys<
   Record<SupportMarketCoins, number>
 >;
 
+export type SCoinAmounts = OptionalKeys<Record<SupportSCoin, number>>;
+
 export type BalanceSheet = {
   cash: string;
   debt: string;

package/src/types/query/index.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/src/types/query/portfolio.ts

@@ -69,6 +69,7 @@ export type ObligationAccount = {
   totalRiskLevel: number;
   totalDepositedPools: number;
   totalBorrowedPools: number;
+  totalRewardedPools: number;
   collaterals: OptionalKeys<
     Record<SupportCollateralCoins, ObligationCollateral>
   >;

package/src/types/query/sCoin.ts

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

package/src/utils/builder.ts

@@ -52,7 +52,7 @@ export const checkExtendLockPeriod = (
     (newUnlockAtInSecondTimestamp - prevUnlockAtInSecondTimestamp) /
       UNLOCK_ROUND_DURATION
   );
-  console.log('availableLockPeriodInDays', availableLockPeriodInDays);
+
   if (lockPeriodInDays > availableLockPeriodInDays) {
     throw new Error(
       `Cannot extend lock period by ${lockPeriodInDays} days, maximum lock period is ~4 years (${MAX_LOCK_ROUNDS} days), remaining lock period is ${

package/src/utils/util.ts

@@ -5,6 +5,7 @@ import {
   SUPPORT_SPOOLS_REWARDS,
   MAX_LOCK_DURATION,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
+  SUPPORT_SCOIN,
 } from '../constants';
 import type { ScallopAddress } from '../models';
 import type {
@@ -13,20 +14,22 @@ import type {
   SupportMarketCoins,
 } from '../types';
 
+const COIN_SET = Array.from(
+  new Set([
+    ...SUPPORT_POOLS,
+    ...SUPPORT_COLLATERALS,
+    ...SUPPORT_SPOOLS_REWARDS,
+    ...SUPPORT_BORROW_INCENTIVE_REWARDS,
+    ...SUPPORT_SCOIN,
+  ])
+);
+
 export const isMarketCoin = (
   coinName: SupportCoins
 ): coinName is SupportMarketCoins => {
   const assetCoinName = coinName.slice(1).toLowerCase() as SupportAssetCoins;
   return (
-    coinName.charAt(0).toLowerCase() === 's' &&
-    [
-      ...new Set([
-        ...SUPPORT_POOLS,
-        ...SUPPORT_COLLATERALS,
-        ...SUPPORT_SPOOLS_REWARDS,
-        ...SUPPORT_BORROW_INCENTIVE_REWARDS,
-      ]),
-    ].includes(assetCoinName)
+    coinName.charAt(0).toLowerCase() === 's' && COIN_SET.includes(assetCoinName)
   );
 };
 
@@ -54,14 +57,7 @@ export const parseDataFromPythPriceFeed = (
   feed: PriceFeed,
   address: ScallopAddress
 ) => {
-  const assetCoinNames = [
-    ...new Set([
-      ...SUPPORT_POOLS,
-      ...SUPPORT_COLLATERALS,
-      ...SUPPORT_SPOOLS_REWARDS,
-      ...SUPPORT_BORROW_INCENTIVE_REWARDS,
-    ]),
-  ] as SupportAssetCoins[];
+  const assetCoinNames = COIN_SET as SupportAssetCoins[];
   const assetCoinName = assetCoinNames.find((assetCoinName) => {
     return (
       address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`) === feed.id