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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.2.2",
+  "version": "2.2.3-pyth-sponsored-transaction-alpha.2",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/coreBuilder.ts

@@ -382,7 +382,13 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       if (!marketCoin) throw new Error(`No market coin for ${poolCoinName}`);
       return txBlock.withdraw(marketCoin, poolCoinName);
     },
-    borrowQuick: async (amount, poolCoinName, obligationId, obligationKey) => {
+    borrowQuick: async (
+      amount,
+      poolCoinName,
+      obligationId,
+      obligationKey,
+      isSponsoredTx = false
+    ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
         txBlock,
@@ -394,7 +400,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
           obligationInfo.obligationId
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
-      await updateOracles(builder, txBlock, updateCoinNames);
+      await updateOracles(builder, txBlock, updateCoinNames, { isSponsoredTx });
       return txBlock.borrow(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -407,7 +413,8 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       poolCoinName,
       borrowReferral,
       obligationId,
-      obligationKey
+      obligationKey,
+      isSponsoredTx = false
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -420,7 +427,9 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
           obligationInfo.obligationId
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
-      await updateOracles(builder, txBlock, updateCoinNames);
+      await updateOracles(builder, txBlock, updateCoinNames, {
+        isSponsoredTx,
+      });
       return txBlock.borrowWithReferral(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -429,7 +438,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         poolCoinName
       );
     },
-    repayQuick: async (amount, poolCoinName, obligationId) => {
+    repayQuick: async (
+      amount,
+      poolCoinName,
+      obligationId,
+      isSponsoredTx = false
+    ) => {
       const sender = requireSender(txBlock);
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -437,27 +451,15 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         obligationId
       );
 
-      if (poolCoinName === 'sui') {
-        const [suiCoin] = txBlock.splitSUIFromGas([amount]);
-        return txBlock.repay(
-          obligationInfo.obligationId,
-          suiCoin,
-          poolCoinName
-        );
-      } else {
-        const { leftCoin, takeCoin } = await builder.selectCoin(
-          txBlock,
-          poolCoinName,
-          amount,
-          sender
-        );
-        txBlock.transferObjects([leftCoin], sender);
-        return txBlock.repay(
-          obligationInfo.obligationId,
-          takeCoin,
-          poolCoinName
-        );
-      }
+      const { leftCoin, takeCoin } = await builder.selectCoin(
+        txBlock,
+        poolCoinName,
+        amount,
+        sender,
+        isSponsoredTx
+      );
+      if (leftCoin) txBlock.transferObjects([leftCoin], sender);
+      return txBlock.repay(obligationInfo.obligationId, takeCoin, poolCoinName);
     },
     updateAssetPricesQuick: async (assetCoinNames) => {
       return await updateOracles(builder, txBlock, assetCoinNames);

package/src/builders/oracles/index.ts

@@ -22,19 +22,21 @@ export const updateOracles = async (
   builder: ScallopBuilder,
   txBlock: SuiKitTxBlock,
   assetCoinNames: string[] = [...builder.constants.whitelist.lending],
-  options: {
-    usePythPullModel: boolean;
-    useOnChainXOracleList: boolean;
-    sponsoredFeeds: string[];
-  } = {
-    usePythPullModel: true,
-    useOnChainXOracleList: true,
-    sponsoredFeeds: [],
+  options?: {
+    usePythPullModel?: boolean;
+    useOnChainXOracleList?: boolean;
+    sponsoredFeeds?: string[];
+    isSponsoredTx?: boolean;
   }
 ) => {
+  const usePythPullModel =
+    options?.usePythPullModel ?? builder.usePythPullModel;
+  const useOnChainXOracleList =
+    options?.useOnChainXOracleList ?? builder.useOnChainXOracleList;
   const sponsoredFeeds = new Set(
-    builder.sponsoredFeeds ?? options.sponsoredFeeds
+    options?.sponsoredFeeds ?? builder.sponsoredFeeds
   );
+  const isSponsoredTx = options?.isSponsoredTx ?? false;
 
   // Validate the sponsoredFeeds content.
   sponsoredFeeds.forEach((feed) => {
@@ -43,10 +45,6 @@ export const updateOracles = async (
     }
   });
 
-  const usePythPullModel = builder.usePythPullModel ?? options.usePythPullModel;
-  const useOnChainXOracleList =
-    builder.useOnChainXOracleList ?? options.useOnChainXOracleList;
-
   const xOracleList = useOnChainXOracleList
     ? await builder.query.getAssetOracles()
     : X_ORACLE_LIST;
@@ -92,7 +90,12 @@ export const updateOracles = async (
     }
 
     if (needToUpdatePythPriceFeeds.length > 0) {
-      await updatePythPriceFeeds(builder, needToUpdatePythPriceFeeds, txBlock);
+      await updatePythPriceFeeds(
+        builder,
+        needToUpdatePythPriceFeeds,
+        txBlock,
+        isSponsoredTx
+      );
     }
   }
 

package/src/builders/oracles/pyth.ts

@@ -8,12 +8,19 @@ import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 export const updatePythPriceFeeds = async (
   builder: ScallopBuilder,
   assetCoinNames: string[],
-  txBlock: SuiKitTxBlock
+  txBlock: SuiKitTxBlock,
+  isSponsoredTx: boolean = false
 ) => {
   const pythClient = new SuiPythClient(
     builder.suiKit.client,
     builder.address.get('core.oracles.pyth.state'),
-    builder.address.get('core.oracles.pyth.wormholeState')
+    builder.address.get('core.oracles.pyth.wormholeState'),
+    {
+      defaultPackageId:
+        '0xa6f9bec2f9748656b6af8aafb5d7bc1a0d5faf25ac9645fc7f447822cd509325',
+      gasStationId:
+        '0xa8b8dcc9880166edb57b53e05f8df7364d31b5d9b7d107fd27f0b69cf338b687',
+    }
   );
   const priceIds = assetCoinNames.map((assetCoinName) =>
     builder.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`)
@@ -29,9 +36,10 @@ export const updatePythPriceFeeds = async (
       const priceUpdateData =
         await pythConnection.getPriceFeedsUpdateData(priceIds);
       await pythClient.updatePriceFeeds(
-        txBlock.txBlock, // convert txBlock to TransactionBlock because pyth sdk not support new @mysten/sui yet
+        txBlock.txBlock,
         priceUpdateData,
-        priceIds
+        priceIds,
+        isSponsoredTx
       );
 
       break;

package/src/models/scallopBuilder.ts

@@ -12,7 +12,7 @@ import type {
   SuiTxArg,
   SuiVecTxArg,
 } from '@scallop-io/sui-kit';
-import type { ScallopTxBlock, SelectCoinReturnType } from '../types';
+import type { ScallopTxBlock } from '../types';
 import { ScallopBuilderInterface } from './interface';
 
 export type ScallopBuilderParams = {
@@ -98,20 +98,22 @@ class ScallopBuilder implements ScallopBuilderInterface {
    * @param sender - Sender address.
    * @return Take coin and left coin.
    */
-  async selectCoin<T extends string>(
+  async selectCoin(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
-    assetCoinName: T,
+    assetCoinName: string,
     amount: number,
-    sender: string = this.walletAddress
-  ): Promise<SelectCoinReturnType<T>> {
-    if (assetCoinName === 'sui') {
+    sender: string = this.walletAddress,
+    isSponsored: boolean = false
+  ) {
+    if (assetCoinName === 'sui' && !isSponsored) {
       const [takeCoin] = txBlock.splitSUIFromGas([amount]);
-      return { takeCoin } as SelectCoinReturnType<T>;
+      return { takeCoin };
     } else {
       const coinType = this.utils.parseCoinType(assetCoinName);
       const coins = await this.utils.selectCoins(amount, coinType, sender);
       const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(coins, amount);
-      return { takeCoin, leftCoin } as SelectCoinReturnType<T>;
+
+      return { takeCoin, leftCoin };
     }
   }
 

package/src/types/builder/core.ts

@@ -99,14 +99,16 @@ export type CoreQuickMethods = {
     amount: number,
     poolCoinName: string,
     obligationId?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligationKey?: SuiObjectArg,
+    isSponsoredTx?: boolean
   ) => Promise<TransactionResult>;
   borrowWithReferralQuick: (
     amount: number,
     poolCoinName: string,
     borrowReferral: SuiObjectArg,
     obligationId?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligationKey?: SuiObjectArg,
+    isSponsoredTx?: boolean
   ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,
@@ -120,7 +122,8 @@ export type CoreQuickMethods = {
   repayQuick: (
     amount: number,
     poolCoinName: string,
-    obligationId?: SuiObjectArg
+    obligationId?: SuiObjectArg,
+    isSponsoredTx?: boolean
   ) => Promise<void>;
   updateAssetPricesQuick: (assetCoinNames?: string[]) => Promise<void>;
 };

package/src/types/builder/index.ts

@@ -1,4 +1,4 @@
-import type { CoreTxBlock, NestedResult } from './core';
+import type { CoreTxBlock } from './core';
 import type { SpoolTxBlock } from './spool';
 import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
@@ -21,12 +21,3 @@ export type BaseScallopTxBlock = ReferralTxBlock &
 export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
 export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
 export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
-
-export type SelectCoinReturnType<T extends string> = T extends 'sui'
-  ? {
-      takeCoin: NestedResult;
-    }
-  : {
-      takeCoin: NestedResult;
-      leftCoin: NestedResult;
-    };