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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.2.0",
+  "version": "2.2.1-sponsored-feeds-alpha.1",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

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/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() {