@scallop-io/sui-scallop-sdk 2.2.3-pyth-sponsored-transaction-alpha.2 → 2.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.2.3-pyth-sponsored-transaction-alpha.2",
+  "version": "2.2.3",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -39,7 +39,7 @@
   ],
   "dependencies": {
     "@mysten/sui": "1.28.2",
-    "@pythnetwork/pyth-sui-js": "2.1.0",
+    "@pythnetwork/pyth-sui-js": "2.2.0",
     "@scallop-io/sui-kit": "1.4.1",
     "@tanstack/query-core": "5.59.16",
     "axios": "^1.9.0",
@@ -146,6 +146,7 @@
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
     "build": "pnpm run build:tsup",
+    "build:sourcemap": "tsup ./src/index.ts --format esm,cjs --sourcemap --dts",
     "build:tsup": "tsup ./src/index.ts --format esm,cjs --splitting --minify --treeshake --dts",
     "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
     "watch:types": "tsc --watch",

package/src/builders/coreBuilder.ts

@@ -313,7 +313,8 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       amount,
       collateralCoinName,
       obligationId,
-      obligationKey
+      obligationKey,
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -324,7 +325,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       const updateCoinNames = await builder.utils.getObligationCoinNames(
         obligationInfo.obligationId
       );
-      await updateOracles(builder, txBlock, updateCoinNames);
+      await updateOracles(
+        builder,
+        txBlock,
+        updateCoinNames,
+        updateOracleOptions
+      );
       return txBlock.takeCollateral(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -387,7 +393,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       poolCoinName,
       obligationId,
       obligationKey,
-      isSponsoredTx = false
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -400,7 +406,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
           obligationInfo.obligationId
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
-      await updateOracles(builder, txBlock, updateCoinNames, { isSponsoredTx });
+      await updateOracles(
+        builder,
+        txBlock,
+        updateCoinNames,
+        updateOracleOptions
+      );
       return txBlock.borrow(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -414,7 +425,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       borrowReferral,
       obligationId,
       obligationKey,
-      isSponsoredTx = false
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -427,9 +438,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
           obligationInfo.obligationId
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
-      await updateOracles(builder, txBlock, updateCoinNames, {
-        isSponsoredTx,
-      });
+      await updateOracles(
+        builder,
+        txBlock,
+        updateCoinNames,
+        updateOracleOptions
+      );
       return txBlock.borrowWithReferral(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -461,8 +475,13 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       if (leftCoin) txBlock.transferObjects([leftCoin], sender);
       return txBlock.repay(obligationInfo.obligationId, takeCoin, poolCoinName);
     },
-    updateAssetPricesQuick: async (assetCoinNames) => {
-      return await updateOracles(builder, txBlock, assetCoinNames);
+    updateAssetPricesQuick: async (assetCoinNames, updateOracleOptions) => {
+      return await updateOracles(
+        builder,
+        txBlock,
+        assetCoinNames,
+        updateOracleOptions
+      );
     },
   };
 };

package/src/builders/oracles/pyth.ts

@@ -1,9 +1,82 @@
 import {
+  HexString,
   SuiPriceServiceConnection,
   SuiPythClient,
 } from '@pythnetwork/pyth-sui-js';
 import { ScallopBuilder } from 'src/models';
-import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import {
+  SUI_CLOCK_OBJECT_ID,
+  type SuiTxBlock as SuiKitTxBlock,
+  type Transaction,
+} from '@scallop-io/sui-kit';
+import { SuiClient } from '@mysten/sui/client';
+
+type ObjectId = string;
+class ScallopPythClient extends SuiPythClient {
+  constructor(
+    provider: SuiClient,
+    pythStateId: ObjectId,
+    wormholeStateId: ObjectId,
+    private params: {
+      // addressId?: string;
+      defaultPackageId: ObjectId;
+      gasStationId: ObjectId;
+    }
+  ) {
+    super(provider, pythStateId, wormholeStateId);
+  }
+
+  async updatePriceFeedsWithSponsoredBaseUpdateFee(
+    tx: Transaction,
+    updates: Buffer[],
+    feedIds: HexString[]
+  ) {
+    if (!this.params) throw new Error('Please provide params');
+    const { defaultPackageId: scallopSponsorPackage, gasStationId } =
+      this.params;
+    const packageId = await this.getPythPackageId();
+    let priceUpdatesHotPotato = await this.verifyVaasAndGetHotPotato(
+      tx,
+      updates,
+      packageId
+    );
+
+    const priceInfoObjects = [];
+    for (const feedId of feedIds) {
+      const priceInfoObjectId = await this.getPriceFeedObjectId(feedId);
+      if (!priceInfoObjectId) {
+        throw new Error(`Price feed object not found for ID: ${feedId}`);
+      }
+      priceInfoObjects.push(priceInfoObjectId);
+    }
+
+    const clockObjectRef = tx.sharedObjectRef({
+      objectId: SUI_CLOCK_OBJECT_ID,
+      mutable: false,
+      initialSharedVersion: '1',
+    });
+
+    for (let i = 0; i < priceInfoObjects.length; i++) {
+      const priceInfoObjectId = priceInfoObjects[i];
+      [priceUpdatesHotPotato] = tx.moveCall({
+        target: `${scallopSponsorPackage}::pyth_sponsor::update_single_price_feed_with_sponsor`,
+        arguments: [
+          tx.object(this.pythStateId),
+          priceUpdatesHotPotato,
+          tx.object(priceInfoObjectId),
+          tx.object(gasStationId),
+          clockObjectRef,
+        ],
+      });
+    }
+
+    tx.moveCall({
+      target: `${packageId}::hot_potato_vector::destroy`,
+      arguments: [priceUpdatesHotPotato],
+      typeArguments: [`${packageId}::price_info::PriceInfo`],
+    });
+  }
+}
 
 export const updatePythPriceFeeds = async (
   builder: ScallopBuilder,
@@ -11,7 +84,7 @@ export const updatePythPriceFeeds = async (
   txBlock: SuiKitTxBlock,
   isSponsoredTx: boolean = false
 ) => {
-  const pythClient = new SuiPythClient(
+  const pythClient = new ScallopPythClient(
     builder.suiKit.client,
     builder.address.get('core.oracles.pyth.state'),
     builder.address.get('core.oracles.pyth.wormholeState'),
@@ -26,23 +99,33 @@ export const updatePythPriceFeeds = async (
     builder.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`)
   );
 
-  // iterate through the endpoints
   const endpoints = builder.utils.pythEndpoints ?? [
     ...builder.constants.whitelist.pythEndpoints,
   ];
+
+  // iterate through the endpoints
   for (const endpoint of endpoints) {
     try {
       const pythConnection = new SuiPriceServiceConnection(endpoint);
       const priceUpdateData =
         await pythConnection.getPriceFeedsUpdateData(priceIds);
-      await pythClient.updatePriceFeeds(
-        txBlock.txBlock,
-        priceUpdateData,
-        priceIds,
-        isSponsoredTx
-      );
 
-      break;
+      if (isSponsoredTx) {
+        // Use gas station to sponsor the baseFeeUpdate
+        await pythClient.updatePriceFeedsWithSponsoredBaseUpdateFee(
+          txBlock.txBlock,
+          priceUpdateData,
+          priceIds
+        );
+      } else {
+        await pythClient.updatePriceFeeds(
+          txBlock.txBlock,
+          priceUpdateData,
+          priceIds
+        );
+      }
+
+      return;
     } catch (e) {
       console.warn(
         `Failed to update price feeds with endpoint ${endpoint}: ${e}`

package/src/constants/testAddress.ts

@@ -534,10 +534,7 @@ export const WHITELIST = {
   suiBridge: new Set(['sbeth', 'sbusdt', 'sbwbtc']),
   wormhole: new Set(['wusdc', 'wusdt', 'weth', 'wbtc', 'wapt', 'wsol']),
   oracles: new Set(['pyth', 'supra', 'switchboard']),
-  pythEndpoints: new Set([
-    'https://hermes.pyth.network',
-    'https://scallop.rpc.p2p.world',
-  ]),
+  pythEndpoints: new Set(['https://hermes.pyth.network']),
   deprecated: new Set(['wapt', 'wusdc', 'wusdt', 'weth', 'wbtc']),
   borrowIncentiveRewards: new Set(['mpoints']),
   rewardsAsPoint: new Set(['mpoints']),

package/src/models/scallopBuilder.ts

@@ -96,6 +96,7 @@ class ScallopBuilder implements ScallopBuilderInterface {
    * @param assetCoinName - Specific support asset coin name.
    * @param amount - Amount of coins to be selected.
    * @param sender - Sender address.
+   * @param isSponsored - Whether the transaction is a sponsored transaction.
    * @return Take coin and left coin.
    */
   async selectCoin(

package/src/models/scallopUtils.ts

@@ -31,6 +31,7 @@ class ScallopUtils implements ScallopUtilsInterface {
   public pythEndpoints: string[];
   public readonly scallopSuiKit: ScallopSuiKit;
   public readonly constants: ScallopConstants;
+  public readonly timeout: number;
 
   constructor(params: ScallopUtilsParams = {}) {
     this.constants = params.scallopConstants ?? new ScallopConstants(params);
@@ -43,8 +44,9 @@ class ScallopUtils implements ScallopUtilsInterface {
 
     this.pythEndpoints = params.pythEndpoints ?? [
       'https://hermes.pyth.network',
-      'https://scallop.rpc.p2p.world',
     ];
+
+    this.timeout = params.axiosTimeout ?? 4000;
   }
 
   get walletAddress() {
@@ -539,7 +541,7 @@ class ScallopUtils implements ScallopUtilsInterface {
 
       const priceIds = priceIdPairs.map(([_, priceId]) => priceId);
       const pythConnection = new SuiPriceServiceConnection(endpoint, {
-        timeout: 4000,
+        timeout: this.timeout,
       });
 
       try {

package/src/types/builder/core.ts

@@ -93,14 +93,25 @@ export type CoreQuickMethods = {
     amount: number,
     collateralCoinName: string,
     obligationId?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligationKey?: SuiObjectArg,
+    updateOracleOptions?: {
+      usePythPullModel?: boolean;
+      useOnChainXOracleList?: boolean;
+      sponsoredFeeds?: string[];
+      isSponsoredTx?: boolean;
+    }
   ) => Promise<TransactionResult>;
   borrowQuick: (
     amount: number,
     poolCoinName: string,
     obligationId?: SuiObjectArg,
     obligationKey?: SuiObjectArg,
-    isSponsoredTx?: boolean
+    updateOracleOptions?: {
+      usePythPullModel?: boolean;
+      useOnChainXOracleList?: boolean;
+      sponsoredFeeds?: string[];
+      isSponsoredTx?: boolean;
+    }
   ) => Promise<TransactionResult>;
   borrowWithReferralQuick: (
     amount: number,
@@ -108,7 +119,12 @@ export type CoreQuickMethods = {
     borrowReferral: SuiObjectArg,
     obligationId?: SuiObjectArg,
     obligationKey?: SuiObjectArg,
-    isSponsoredTx?: boolean
+    updateOracleOptions?: {
+      usePythPullModel?: boolean;
+      useOnChainXOracleList?: boolean;
+      sponsoredFeeds?: string[];
+      isSponsoredTx?: boolean;
+    }
   ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,
@@ -125,7 +141,15 @@ export type CoreQuickMethods = {
     obligationId?: SuiObjectArg,
     isSponsoredTx?: boolean
   ) => Promise<void>;
-  updateAssetPricesQuick: (assetCoinNames?: string[]) => Promise<void>;
+  updateAssetPricesQuick: (
+    assetCoinNames?: string[],
+    updateOracleOptions?: {
+      usePythPullModel?: boolean;
+      useOnChainXOracleList?: boolean;
+      sponsoredFeeds?: string[];
+      isSponsoredTx?: boolean;
+    }
+  ) => Promise<void>;
 };
 
 export type SuiTxBlockWithCoreNormalMethods = SuiKitTxBlock &