@scallop-io/sui-scallop-sdk 2.0.12 → 2.0.13-merge-split-ve-sca-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.0.12",
+  "version": "2.0.13-merge-split-ve-sca-alpha.1",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -64,6 +64,9 @@
     "@types/node": "^20.4.2",
     "@typescript-eslint/eslint-plugin": "^8.11.0",
     "@typescript-eslint/parser": "8.10.0",
+    "@vitest/expect": "^3.1.1",
+    "@vitest/runner": "^3.1.1",
+    "@vitest/spy": "^3.1.1",
     "dotenv": "^16.3.1",
     "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
@@ -77,7 +80,7 @@
     "tsup": "^7.2.0",
     "typedoc": "^0.26.3",
     "typescript": "5.5.4",
-    "vitest": "^0.34.6"
+    "vitest": "^3.1.1"
   },
   "peerDependencies": {
     "@mysten/bcs": "^1.2.0",

package/src/builders/borrowIncentiveBuilder.ts

@@ -3,8 +3,8 @@ import {
   SuiTxBlock as SuiKitTxBlock,
   SUI_CLOCK_OBJECT_ID,
 } from '@scallop-io/sui-kit';
-import { getObligations, getObligationLocked } from '../queries';
-import { requireSender } from '../utils';
+import { getObligations, getObligationLocked } from 'src/queries';
+import { requireSender } from 'src/utils';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from 'src/models';
 import type {
@@ -14,8 +14,7 @@ import type {
   SuiTxBlockWithBorrowIncentiveNormalMethods,
   BorrowIncentiveTxBlock,
   ScallopTxBlock,
-  VescaIds,
-} from '../types';
+} from 'src/types';
 import { OLD_BORROW_INCENTIVE_PROTOCOL_ID } from 'src/constants';
 
 /**
@@ -92,7 +91,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
       obligationAccessStore: builder.address.get('core.obligationAccessStore'),
     };
 
-    const veScaIds: Omit<VescaIds, 'pkgId'> = {
+    const veScaIds = {
       table: builder.address.get('vesca.table'),
       treasury: builder.address.get('vesca.treasury'),
       config: builder.address.get('vesca.config'),

package/src/builders/coreBuilder.ts

@@ -5,7 +5,7 @@ import { getObligations } from '../queries';
 import { updateOracles } from './oracles';
 import { requireSender } from '../utils';
 import type { SuiObjectArg, TransactionResult } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
+import type { ScallopBuilder } from 'src/models';
 import type {
   CoreIds,
   GenerateCoreNormalMethod,
@@ -15,7 +15,7 @@ import type {
   ScallopTxBlock,
   NestedResult,
   SuiTxBlockWithSpool,
-} from '../types';
+} from 'src/types';
 
 /**
  * Check and get Obligation information from transaction block.

package/src/builders/index.ts

@@ -4,8 +4,8 @@ import { newCoreTxBlock } from './coreBuilder';
 import { newSpoolTxBlock } from './spoolBuilder';
 import { newBorrowIncentiveTxBlock } from './borrowIncentiveBuilder';
 import { newVeScaTxBlock } from './vescaBuilder';
-import type { ScallopBuilder } from '../models';
-import type { ScallopTxBlock } from '../types';
+import type { ScallopBuilder } from 'src/models';
+import type { ScallopTxBlock } from 'src/types';
 import { newReferralTxBlock } from './referralBuilder';
 import { newLoyaltyProgramTxBlock } from './loyaltyProgramBuilder';
 import { newSCoinTxBlock } from './sCoinBuilder';

package/src/builders/spoolBuilder.ts

@@ -5,7 +5,7 @@ import { getStakeAccounts } from '../queries/spoolQuery';
 import { requireSender } from '../utils';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
-import type { ScallopBuilder } from '../models';
+import type { ScallopBuilder } from 'src/models';
 import type {
   SpoolIds,
   GenerateSpoolNormalMethod,
@@ -14,7 +14,7 @@ import type {
   SpoolTxBlock,
   ScallopTxBlock,
   SuiTxBlockWithSCoin,
-} from '../types';
+} from 'src/types';
 
 /**
  * Check and get stake account id from transaction block.

package/src/builders/vescaBuilder.ts

@@ -5,8 +5,8 @@ import {
   SuiTxBlock as SuiKitTxBlock,
 } from '@scallop-io/sui-kit';
 import { SCA_COIN_TYPE } from 'src/constants';
-import { ScallopBuilder } from '../models';
-import { getVeSca, getVeScas } from '../queries';
+import { ScallopBuilder } from 'src/models';
+import { getVeSca, getVeScas } from 'src/queries';
 import {
   requireSender,
   checkLockSca,
@@ -14,19 +14,19 @@ import {
   checkExtendLockAmount,
   checkRenewExpiredVeSca,
   checkVesca,
-} from '../utils';
+} from 'src/utils';
 import type {
   TransactionObjectArgument,
   SuiObjectArg,
 } from '@scallop-io/sui-kit';
 import type {
+  AddressesInterface,
   GenerateVeScaNormalMethod,
   GenerateVeScaQuickMethod,
-  RedeemScaQuickReturnType,
+  QuickMethodReturnType,
   ScallopTxBlock,
   SuiTxBlockWithVeScaNormalMethods,
   VeScaTxBlock,
-  VescaIds,
 } from 'src/types';
 
 /**
@@ -70,6 +70,27 @@ export const requireVeSca = async (
   return veScaKey ? veScas.find(({ keyId }) => veScaKey === keyId) : veScas[0];
 };
 
+export const isInSubsTable = async (
+  ...params: [builder: ScallopBuilder, veScaKey: string, tableId: string]
+) => {
+  const [builder, veScaKey, tableId] = params;
+  try {
+    const _resp = await builder.cache.queryGetDynamicFieldObject({
+      parentId: tableId,
+      name: {
+        type: '0x2::object::ID',
+        value: veScaKey,
+      },
+    });
+    return true;
+  } catch (e) {
+    console.error(e);
+    return false;
+  }
+};
+
+type VeScaProps = 'id' | 'table' | 'treasury' | 'config' | 'subsTable';
+
 /**
  * Generate veSCA normal methods.
  *
@@ -81,12 +102,14 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
   builder,
   txBlock,
 }) => {
-  const veScaIds: VescaIds = {
-    pkgId: builder.address.get('vesca.id'),
+  const veScaIds: Pick<AddressesInterface['vesca'], VeScaProps> = {
+    id: builder.address.get('vesca.id'),
     table: builder.address.get('vesca.table'),
     treasury: builder.address.get('vesca.treasury'),
     config: builder.address.get('vesca.config'),
+    subsTable: builder.address.get('vesca.subsTable'),
   };
+
   const clockObjectRef = txBlock.sharedObjectRef({
     objectId: SUI_CLOCK_OBJECT_ID,
     mutable: false,
@@ -97,7 +120,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     lockSca: (scaCoin, unlockAtInSecondTimestamp) => {
       return builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::mint_ve_sca_key`,
+        `${veScaIds.id}::ve_sca::mint_ve_sca_key`,
         [
           veScaIds.config,
           veScaIds.table,
@@ -112,7 +135,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     extendLockPeriod: (veScaKey, newUnlockAtInSecondTimestamp) => {
       builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::extend_lock_period`,
+        `${veScaIds.id}::ve_sca::extend_lock_period`,
         [
           veScaIds.config,
           veScaKey,
@@ -127,7 +150,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     extendLockAmount: (veScaKey, scaCoin) => {
       builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::lock_more_sca`,
+        `${veScaIds.id}::ve_sca::lock_more_sca`,
         [
           veScaIds.config,
           veScaKey,
@@ -142,7 +165,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     renewExpiredVeSca: (veScaKey, scaCoin, newUnlockAtInSecondTimestamp) => {
       builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::renew_expired_ve_sca`,
+        `${veScaIds.id}::ve_sca::renew_expired_ve_sca`,
         [
           veScaIds.config,
           veScaKey,
@@ -158,7 +181,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     redeemSca: (veScaKey) => {
       return builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::redeem`,
+        `${veScaIds.id}::ve_sca::redeem`,
         [
           veScaIds.config,
           veScaKey,
@@ -172,11 +195,39 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     mintEmptyVeSca: () => {
       return builder.moveCall(
         txBlock,
-        `${veScaIds.pkgId}::ve_sca::mint_ve_sca_placeholder_key`,
+        `${veScaIds.id}::ve_sca::mint_ve_sca_placeholder_key`,
         [veScaIds.config, veScaIds.table],
         []
       );
     },
+    splitVeSca: (veScaKey, splitAmount) => {
+      return builder.moveCall(txBlock, `${veScaIds.id}::ve_sca::split`, [
+        veScaIds.config,
+        veScaKey,
+        veScaIds.table,
+        veScaIds.subsTable,
+        txBlock.pure.u64(splitAmount),
+      ]);
+    },
+    mergeVeSca: (targetKey, sourceKey) => {
+      return builder.moveCall(
+        txBlock,
+        `${veScaIds.id}::ve_sca::merge`,
+        [
+          veScaIds.config,
+          targetKey,
+          sourceKey,
+          veScaIds.table,
+          veScaIds.subsTable,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
+        []
+      );
+    },
   };
 };
 
@@ -362,9 +413,57 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
           txBlock.transferObjects([sca], sender);
           return;
         }
-        return sca as RedeemScaQuickReturnType<S>;
+        return sca as QuickMethodReturnType<S>;
+      }
+    },
+    splitVeScaQuick: async <S extends boolean>(
+      splitAmount: string,
+      veScaKey: string,
+      transferVeScaKey: S = true as S
+    ) => {
+      const isKeyInSubTable = await isInSubsTable(
+        builder,
+        veScaKey,
+        builder.address.get('vesca.subsTable')
+      );
+      if (isKeyInSubTable) {
+        throw new Error(
+          'Key cannot be in the subs table, please call unsubscribe vesca or unstake obligation first'
+        );
+      }
+
+      const newVeScaKey = txBlock.splitVeSca(veScaKey, splitAmount);
+      // txBlock.addMergeSplitSub(newVeScaKey);
+      if (transferVeScaKey) {
+        txBlock.transferObjects(newVeScaKey, requireSender(txBlock));
+        return;
+      } else {
+        return newVeScaKey as QuickMethodReturnType<S>;
       }
     },
+    mergeVeScaQuick: async (targetKey: string, sourceKey: string) => {
+      // check targetKey and sourceKey
+      const [isTargetInSubTable, isSourceInSubTable] = await Promise.all([
+        isInSubsTable(
+          builder,
+          targetKey,
+          builder.address.get('vesca.subsTable')
+        ),
+        isInSubsTable(
+          builder,
+          sourceKey,
+          builder.address.get('vesca.subsTable')
+        ),
+      ]);
+
+      if (isTargetInSubTable || isSourceInSubTable) {
+        throw new Error(
+          'Both target and source cannot be in the subs table. Please call unsubscribe vesca or unstake obligation first'
+        );
+      }
+
+      return txBlock.mergeVeSca(targetKey, sourceKey);
+    },
   };
 };
 

package/src/constants/testAddress.ts

@@ -256,18 +256,24 @@ export const TEST_ADDRESSES: AddressesInterface = {
       '0x9636e7b947b806b9fe438d037f02bb24026c5b2691d2f6bad349c2e117f77cc3',
   },
   vesca: {
-    id: '0x1158813b32962c2d22888fae257d5f2365b03631f0cd5d5b912ccdf51ff4e2f2',
+    id: '0x0c7f5568dbd69488437ee95f2d9a028724e1de12432965ff8acca7c67310ba46',
     object:
-      '0xcfe2d87aa5712b67cad2732edb6a2201bfdf592377e5c0968b7cb02099bd8e21',
+      '0x0c7f5568dbd69488437ee95f2d9a028724e1de12432965ff8acca7c67310ba46',
     adminCap:
       '0x4d105b16467acca81d18c132cdd1a3cee159920a86c1ef4bdbf2e8d7878500c5',
     tableId:
-      '0x0a0b7f749baeb61e3dfee2b42245e32d0e6b484063f0a536b33e771d573d7246',
-    table: '0xd3a4632b1080f7d96e1c2487d4dabf2c1196916937c505a69954ac9f393be8d0',
+      '0x06f763060ea5da3d639fb56df70674490a8354511cfe61584062aafd83b1940d',
+    table: '0x06f763060ea5da3d639fb56df70674490a8354511cfe61584062aafd83b1940d',
     treasury:
-      '0xafa4b6231e49c15a22d641ce33fda761baaf650fa21899dfa2eb1716146e7306',
+      '0x934919cc31fa89b67578039bb10d5518fa23c50bc8f78500f1d1a718407a0a71',
     config:
-      '0x7cbcb0a342179577a117dfdff974cf1ab765d3b571067bf22ddf5f9e3a667922',
+      '0x38d3f7a1fa5071226535d4d8bfca8ccab3d24871402df1be669d7d5e9e3e9cb4',
+    subsTable:
+      '0x4756b716670ff62760b22bebed73c6eb2c2cb118674a2eea3a56ebea9e27ae76',
+    subsTableId:
+      '0x924b56d383b45445984a80002185b670aa2e72cd7df496d345f45f9407a12c07',
+    subsWhitelist:
+      '0xfc72adae643da4f2fe080adc1e2cca981eadcb518facb02324eeaab169752ffb',
   },
   referral: {
     id: '0x1bf5a8ce77050d8052549d743e16b469f15aa6b81b752b78b6ebb65179665f5a',

package/src/models/scallop.ts

@@ -11,7 +11,7 @@ import type {
   ScallopParams,
   ScallopQueryParams,
   ScallopUtilsParams,
-} from '../types/';
+} from 'src/types';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';

package/src/models/scallopAddress.ts

@@ -1,11 +1,11 @@
-import { API_BASE_URL, USE_TEST_ADDRESS } from '../constants';
+import { API_BASE_URL, USE_TEST_ADDRESS } from 'src/constants';
 import { type NetworkType } from '@scallop-io/sui-kit';
 import type {
   ScallopAddressParams,
   AddressesInterface,
   AddressStringPath,
   ScallopAddressInstanceParams,
-} from '../types';
+} from 'src/types';
 import { ScallopCache } from './scallopCache';
 import axios, { AxiosInstance } from 'axios';
 import { TEST_ADDRESSES } from 'src/constants/testAddress';
@@ -335,6 +335,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
     table: '',
     treasury: '',
     config: '',
+    subsTable: '',
+    subsTableId: '',
+    subsWhitelist: '',
   },
   referral: {
     id: '',

package/src/models/scallopBuilder.ts

@@ -21,7 +21,7 @@ import type {
   ScallopTxBlock,
   ScallopBuilderInstanceParams,
   SelectCoinReturnType,
-} from '../types';
+} from 'src/types';
 import { ScallopCache } from './scallopCache';
 import { newSuiKit } from './suiKit';
 import { ScallopConstants } from './scallopConstants';

package/src/models/scallopCache.ts

@@ -55,7 +55,7 @@ const deepMergeObject = <T>(curr: T, update: T): T => {
   return result;
 };
 
-class RateLimiter {
+export class RateLimiter {
   private tokens: number;
   private lastRefillTime: number;
   private readonly refillRate: number; // tokens per millisecond

package/src/models/scallopClient.ts

@@ -18,7 +18,7 @@ import type {
   ScallopTxBlock,
   ScallopClientVeScaReturnType,
   ScallopClientInstanceParams,
-} from '../types';
+} from 'src/types';
 import { newSuiKit } from './suiKit';
 import { ScallopConstants } from './scallopConstants';
 

package/src/models/scallopConstants.ts

@@ -109,6 +109,7 @@ export class ScallopConstants {
       'spool',
       'oracles',
       'pythEndpoints',
+      'emerging',
     ] as const;
     return (
       this.isAddressInitialized && // address is initialized
@@ -387,15 +388,22 @@ export class ScallopConstants {
     ]);
 
     if (!this.params.forceWhitelistInterface) {
-      this._whitelist = Object.fromEntries(
-        Object.entries(whitelistResponse)
-          .filter(([_, value]) => Array.isArray(value) || value instanceof Set)
-          .map(([key, value]) => [
-            key as keyof Whitelist,
-            value instanceof Set ? value : new Set(value),
-          ])
-      ) as Whitelist;
+      this._whitelist = Object.keys(this._whitelist).reduce(
+        (acc, key: unknown) => {
+          const whiteListKey = key as keyof Whitelist;
+          const whiteListValue = whitelistResponse[whiteListKey];
+          acc[whiteListKey] =
+            whiteListValue instanceof Set
+              ? whiteListValue
+              : Array.isArray(whiteListValue)
+                ? new Set(whiteListValue)
+                : new Set();
+          return acc;
+        },
+        {} as Whitelist
+      );
     }
+
     if (!this.params.forcePoolAddressInterface) {
       this._poolAddresses = Object.fromEntries(
         Object.entries(poolAddressesResponse)

package/src/models/scallopIndexer.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance } from 'axios';
-import { SDK_API_BASE_URL } from '../constants';
+import { SDK_API_BASE_URL } from 'src/constants';
 import type {
   Market,
   MarketPools,

package/src/queries/borrowIncentiveQuery.ts

@@ -3,8 +3,8 @@ import {
   parseOriginBorrowIncentivePoolData,
   parseOriginBorrowIncentiveAccountData,
   calculateBorrowIncentivePoolPointData,
-} from '../utils';
-import type { ScallopAddress, ScallopQuery, ScallopUtils } from '../models';
+} from 'src/utils';
+import type { ScallopAddress, ScallopQuery, ScallopUtils } from 'src/models';
 import type {
   BorrowIncentivePoolsQueryInterface,
   BorrowIncentivePools,
@@ -14,7 +14,7 @@ import type {
   OptionalKeys,
   CoinPrices,
   MarketPools,
-} from '../types';
+} from 'src/types';
 import BigNumber from 'bignumber.js';
 import { SuiObjectRef } from '@mysten/sui/client';