@scallop-io/sui-scallop-sdk 2.1.9 → 2.2.1-sponsored-feeds-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.1.9",
+  "version": "2.2.1-sponsored-feeds-alpha.1",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -40,7 +40,7 @@
   "dependencies": {
     "@mysten/sui": "1.28.2",
     "@pythnetwork/pyth-sui-js": "2.1.0",
-    "@scallop-io/sui-kit": "1.4.0",
+    "@scallop-io/sui-kit": "1.4.1",
     "@tanstack/query-core": "5.59.16",
     "axios": "^1.9.0",
     "bignumber.js": "^9.1.2",
@@ -50,6 +50,8 @@
     "@commitlint/cli": "^18.2.0",
     "@commitlint/config-conventional": "^18.1.0",
     "@commitlint/prompt-cli": "^18.2.0",
+    "@mysten/bcs": "^1.6.1",
+    "@mysten/utils": "^0.0.0",
     "@pythnetwork/price-service-client": "^1.9.0",
     "@pythnetwork/price-service-sdk": "^1.8.0",
     "@types/node": "^20.4.2",
@@ -71,11 +73,13 @@
     "tsup": "^7.2.0",
     "typedoc": "^0.26.3",
     "typescript": "5.5.4",
+    "valibot": "^1.1.0",
+    "vite": "^6.3.5",
     "vitest": "^3.1.1"
   },
   "peerDependencies": {
     "@mysten/sui": "1.28.2",
-    "@scallop-io/sui-kit": "1.4.0",
+    "@scallop-io/sui-kit": "1.4.1",
     "bn.js": "^5.2.1"
   },
   "lint-staged": {

package/src/builders/oracles/index.ts

@@ -25,8 +25,24 @@ export const updateOracles = async (
   options: {
     usePythPullModel: boolean;
     useOnChainXOracleList: boolean;
-  } = { usePythPullModel: true, useOnChainXOracleList: true }
+    sponsoredFeeds: string[];
+  } = {
+    usePythPullModel: true,
+    useOnChainXOracleList: true,
+    sponsoredFeeds: [],
+  }
 ) => {
+  const sponsoredFeeds = new Set(
+    builder.sponsoredFeeds ?? options.sponsoredFeeds
+  );
+
+  // Validate the sponsoredFeeds content.
+  sponsoredFeeds.forEach((feed) => {
+    if (!builder.constants.whitelist.lending.has(feed)) {
+      throw new Error(`${feed} is not valid feed`);
+    }
+  });
+
   const usePythPullModel = builder.usePythPullModel ?? options.usePythPullModel;
   const useOnChainXOracleList =
     builder.useOnChainXOracleList ?? options.useOnChainXOracleList;
@@ -55,17 +71,32 @@ export const updateOracles = async (
     );
   };
 
-  // Handle Pyth price feed
-  if (flattenedRules.has('pyth') && usePythPullModel) {
-    const pythAssetCoinNames = assetCoinNames.filter((assetCoinName) =>
-      filterAssetCoinNames(assetCoinName, 'pyth')
-    );
-    if (pythAssetCoinNames.length > 0)
-      await updatePythPriceFeeds(builder, assetCoinNames, txBlock);
+  const updateAssetCoinNames = [...new Set(assetCoinNames)];
+  const pythAssetCoinNames = updateAssetCoinNames.filter((assetCoinName) =>
+    filterAssetCoinNames(assetCoinName, 'pyth')
+  );
+
+  if (flattenedRules.has('pyth')) {
+    const needToUpdatePythPriceFeeds: string[] = [];
+    for (const pythAssetCoinName of pythAssetCoinNames) {
+      /**
+       * Check if the Pyth pull model is not used but the feed is not sponsored.
+       * This is used to determine if we should update the Pyth price feeds.
+       */
+      const notUsingPullButNotSponsored =
+        !usePythPullModel && !sponsoredFeeds.has(pythAssetCoinName);
+
+      if (usePythPullModel || notUsingPullButNotSponsored) {
+        needToUpdatePythPriceFeeds.push(pythAssetCoinName);
+      }
+    }
+
+    if (needToUpdatePythPriceFeeds.length > 0) {
+      await updatePythPriceFeeds(builder, needToUpdatePythPriceFeeds, txBlock);
+    }
   }
 
   // Remove duplicate coin names.
-  const updateAssetCoinNames = [...new Set(assetCoinNames)];
   for (const assetCoinName of updateAssetCoinNames) {
     updateOracle(builder, txBlock, assetCoinName, xOracleList[assetCoinName]);
   }

package/src/builders/vescaBuilder.ts

@@ -47,7 +47,7 @@ export const requireVeSca = async (
   ...params: [
     builder: ScallopBuilder,
     SuiTxBlock: SuiTxBlock,
-    veScaKey?: SuiObjectData,
+    veScaKey?: SuiObjectData | string,
   ]
 ) => {
   const [builder, txBlock, veScaKey] = params;
@@ -259,12 +259,12 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
   txBlock,
 }) => {
   return {
-    lockScaQuick: async (
+    lockScaQuick: async ({
       amountOrCoin,
       lockPeriodInDays,
+      autoCheck = true,
       veScaKey,
-      autoCheck = true
-    ) => {
+    }) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 
@@ -334,11 +334,11 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.transferObjects(transferObjects, sender);
       }
     },
-    extendLockPeriodQuick: async (
-      lockPeriodInDays: number,
-      veScaKey?: SuiObjectArg,
-      autoCheck = true
-    ) => {
+    extendLockPeriodQuick: async ({
+      lockPeriodInDays,
+      veScaKey,
+      autoCheck = true,
+    }) => {
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
       const newUnlockAt = builder.utils.getUnlockAt(
         lockPeriodInDays,
@@ -352,11 +352,11 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.extendLockPeriod(veSca.keyId, newUnlockAt);
       }
     },
-    extendLockAmountQuick: async (
-      scaAmount: number,
-      veScaKey?: SuiObjectArg,
-      autoCheck = true
-    ) => {
+    extendLockAmountQuick: async ({
+      scaAmount,
+      veScaKey,
+      autoCheck = true,
+    }) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 
@@ -377,12 +377,12 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.transferObjects([leftCoin], sender);
       }
     },
-    renewExpiredVeScaQuick: async (
-      scaAmount: number,
-      lockPeriodInDays: number,
-      veScaKey?: SuiObjectArg,
-      autoCheck = true
-    ) => {
+    renewExpiredVeScaQuick: async ({
+      scaAmount,
+      lockPeriodInDays,
+      veScaKey,
+      autoCheck = true,
+    }) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 
@@ -414,10 +414,13 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         txBlock.transferObjects(transferObjects, sender);
       }
     },
-    redeemScaQuick: async <S extends boolean>(
-      veScaKey?: SuiObjectArg,
-      transferSca: S = true as S
-    ) => {
+    redeemScaQuick: async <T extends boolean>({
+      veScaKey,
+      transferSca,
+    }: {
+      veScaKey?: SuiObjectData | string;
+      transferSca?: T;
+    }) => {
       const sender = requireSender(txBlock);
       const veSca = await requireVeSca(builder, txBlock, veScaKey);
 
@@ -429,14 +432,18 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
           txBlock.transferObjects([sca], sender);
           return;
         }
-        return sca as QuickMethodReturnType<S>;
+        return sca as QuickMethodReturnType<T>;
       }
     },
-    splitVeScaQuick: async <S extends boolean>(
-      splitAmount: string,
-      veScaKey: string,
-      transferVeScaKey: S = true as S
-    ) => {
+    splitVeScaQuick: async <S extends boolean>({
+      splitAmount,
+      veScaKey,
+      transferVeScaKey = true as S,
+    }: {
+      splitAmount: string;
+      veScaKey: string;
+      transferVeScaKey?: S;
+    }) => {
       const isKeyInSubTable = await isInSubsTable(
         builder,
         veScaKey,
@@ -465,12 +472,12 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         return newVeScaKey as QuickMethodReturnType<S>;
       }
     },
-    mergeVeScaQuick: async (targetKey: string, sourceKey: string) => {
+    mergeVeScaQuick: async ({ targetVeScaKey, sourceVeScaKey }) => {
       // check targetKey and sourceKey
       const table = builder.address.get('vesca.subsTableId');
       const [isTargetInSubTable, isSourceInSubTable] = await Promise.all([
-        isInSubsTable(builder, targetKey, table),
-        isInSubsTable(builder, sourceKey, table),
+        isInSubsTable(builder, targetVeScaKey, table),
+        isInSubsTable(builder, sourceVeScaKey, table),
       ]);
 
       const unstakeObligationBeforeStake =
@@ -491,8 +498,8 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       }
 
       const [sourceVesca, targetVesca] = await Promise.all([
-        getVeSca(builder.utils, sourceKey),
-        getVeSca(builder.utils, targetKey),
+        getVeSca(builder.utils, sourceVeScaKey),
+        getVeSca(builder.utils, targetVeScaKey),
       ]);
 
       if (!sourceVesca || !targetVesca) {
@@ -512,7 +519,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
         );
       }
 
-      return txBlock.mergeVeSca(targetKey, sourceKey);
+      return txBlock.mergeVeSca(targetVeScaKey, sourceVeScaKey);
     },
   };
 };

package/src/models/scallopBuilder.ts

@@ -18,6 +18,7 @@ import { ScallopBuilderInterface } from './interface';
 export type ScallopBuilderParams = {
   query?: ScallopQuery;
   usePythPullModel?: boolean;
+  sponsoredFeeds?: string[];
   useOnChainXOracleList?: boolean;
 } & ScallopQueryParams;
 
@@ -36,11 +37,13 @@ class ScallopBuilder implements ScallopBuilderInterface {
   public readonly query: ScallopQuery;
   public readonly usePythPullModel: boolean;
   public readonly useOnChainXOracleList: boolean;
+  public readonly sponsoredFeeds: string[];
 
   public constructor(params: ScallopBuilderParams) {
     this.query = params.query ?? new ScallopQuery(params);
     this.usePythPullModel = params.usePythPullModel ?? true;
     this.useOnChainXOracleList = params.useOnChainXOracleList ?? true;
+    this.sponsoredFeeds = params.sponsoredFeeds ?? [];
   }
 
   get utils() {

package/src/models/scallopClient.ts

@@ -1085,9 +1085,12 @@ class ScallopClient implements ScallopClientInterface {
     tx.setSender(sender);
 
     await Promise.all(
-      veScaKeys.map(async (key) => {
+      veScaKeys.map(async (veScaKey) => {
         try {
-          const scaCoin = await tx.redeemScaQuick(key, false);
+          const scaCoin = await tx.redeemScaQuick({
+            veScaKey,
+            transferSca: false,
+          });
           if (!scaCoin) return;
           scaCoins.push(scaCoin);
         } catch (_e) {

package/src/types/builder/vesca.ts

@@ -1,6 +1,7 @@
 import { SuiTxBlock as SuiKitTxBlock, SuiObjectArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import { ScallopBuilder } from 'src/models';
+import { SuiObjectData } from '@mysten/sui/client';
 
 export type VeScaNormalMethods = {
   lockSca: (
@@ -31,7 +32,7 @@ export type VeScaNormalMethods = {
 
 export type QuickMethodReturnType<T extends boolean> = T extends true
   ? void
-  : TransactionResult | undefined;
+  : TransactionResult;
 
 export type VeScaQuickMethods = {
   /**
@@ -50,41 +51,41 @@ export type VeScaQuickMethods = {
    * @param lockPeriodInDays
    * @param autoCheck
    */
-  lockScaQuick(
-    amountOrCoin?: SuiObjectArg | number,
-    lockPeriodInDays?: number,
-    veScaKey?: SuiObjectArg,
-    autoCheck?: boolean
-  ): Promise<void>;
-  extendLockPeriodQuick: (
-    lockPeriodInDays: number,
-    veScaKey?: SuiObjectArg,
-    autoCheck?: boolean
-  ) => Promise<void>;
-  extendLockAmountQuick: (
-    scaAmount: number,
-    veScaKey?: SuiObjectArg,
-    autoCheck?: boolean
-  ) => Promise<void>;
-  renewExpiredVeScaQuick: (
-    scaAmount: number,
-    lockPeriodInDays: number,
-    veScaKey?: SuiObjectArg,
-    autoCheck?: boolean
-  ) => Promise<void>;
-  redeemScaQuick: <T extends boolean>(
-    veScaKey?: SuiObjectArg,
-    transferSca?: T
-  ) => Promise<QuickMethodReturnType<T>>;
-  splitVeScaQuick: <T extends boolean>(
-    splitAmount: string,
-    veScaKey: string,
-    transferVeScaKey?: T
-  ) => Promise<QuickMethodReturnType<T>>;
-  mergeVeScaQuick: (
-    targetVeScaKey: string,
-    sourceVeScaKey: string
-  ) => Promise<void>;
+  lockScaQuick(params: {
+    amountOrCoin?: SuiObjectArg | number;
+    lockPeriodInDays?: number;
+    autoCheck?: boolean;
+    veScaKey?: SuiObjectData | string;
+  }): Promise<void>;
+  extendLockPeriodQuick: (params: {
+    lockPeriodInDays: number;
+    autoCheck?: boolean;
+    veScaKey?: SuiObjectData | string;
+  }) => Promise<void>;
+  extendLockAmountQuick: (params: {
+    scaAmount: number;
+    autoCheck?: boolean;
+    veScaKey?: SuiObjectData | string;
+  }) => Promise<void>;
+  renewExpiredVeScaQuick: (params: {
+    scaAmount: number;
+    lockPeriodInDays: number;
+    autoCheck?: boolean;
+    veScaKey?: SuiObjectData | string;
+  }) => Promise<void>;
+  redeemScaQuick: <T extends boolean>(params: {
+    veScaKey?: SuiObjectData | string;
+    transferSca?: T;
+  }) => Promise<QuickMethodReturnType<T> | undefined>;
+  splitVeScaQuick: <T extends boolean>(params: {
+    splitAmount: string;
+    veScaKey: string;
+    transferVeScaKey?: T;
+  }) => Promise<QuickMethodReturnType<T> | undefined>;
+  mergeVeScaQuick: (params: {
+    targetVeScaKey: string;
+    sourceVeScaKey: string;
+  }) => Promise<void>;
 };
 
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock &