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

package/package.json

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

package/src/builders/coreBuilder.ts

@@ -4,7 +4,7 @@ import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { getObligations } from '../queries';
 import { updateOracles } from './oracles';
 import { requireSender } from '../utils';
-import type { SuiObjectArg, TransactionResult } from '@scallop-io/sui-kit';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from 'src/models';
 import type {
   CoreIds,
@@ -287,7 +287,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
   txBlock,
 }) => {
   return {
-    addCollateralQuick: async (amount, collateralCoinName, obligationId) => {
+    addCollateralQuick: async (
+      amount,
+      collateralCoinName,
+      obligationId,
+      isSponsoredTx = false
+    ) => {
       const sender = requireSender(txBlock);
       const { obligationId: obligationArg } = await requireObligationInfo(
         builder,
@@ -295,26 +300,25 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         obligationId
       );
 
-      if (collateralCoinName === 'sui') {
-        const [suiCoin] = txBlock.splitSUIFromGas([amount]);
-        txBlock.addCollateral(obligationArg, suiCoin, collateralCoinName);
-      } else {
-        const { leftCoin, takeCoin } = await builder.selectCoin(
-          txBlock,
-          collateralCoinName,
-          amount,
-          sender
-        );
-        txBlock.addCollateral(obligationArg, takeCoin, collateralCoinName);
+      const { takeCoin, leftCoin } = await builder.selectCoin(
+        txBlock,
+        collateralCoinName,
+        amount,
+        sender,
+        isSponsoredTx
+      );
+
+      if (leftCoin) {
         txBlock.transferObjects([leftCoin], sender);
       }
+      txBlock.addCollateral(obligationArg, takeCoin, collateralCoinName);
     },
     takeCollateralQuick: async (
       amount,
       collateralCoinName,
       obligationId,
       obligationKey,
-      isSponsoredTx = false
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -325,7 +329,12 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       const updateCoinNames = await builder.utils.getObligationCoinNames(
         obligationInfo.obligationId
       );
-      await updateOracles(builder, txBlock, updateCoinNames, { isSponsoredTx });
+      await updateOracles(
+        builder,
+        txBlock,
+        updateCoinNames,
+        updateOracleOptions
+      );
       return txBlock.takeCollateral(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
@@ -335,20 +344,16 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
     },
     depositQuick: async (amount, poolCoinName, returnSCoin = true) => {
       const sender = requireSender(txBlock);
-      let marketCoinDeposit: TransactionResult | undefined;
-      if (poolCoinName === 'sui') {
-        const [suiCoin] = txBlock.splitSUIFromGas([amount]);
-        marketCoinDeposit = txBlock.deposit(suiCoin, poolCoinName);
-      } else {
-        const { leftCoin, takeCoin } = await builder.selectCoin(
-          txBlock,
-          poolCoinName,
-          amount,
-          sender
-        );
+      const { leftCoin, takeCoin } = await builder.selectCoin(
+        txBlock,
+        poolCoinName,
+        amount,
+        sender
+      );
+      if (leftCoin) {
         txBlock.transferObjects([leftCoin], sender);
-        marketCoinDeposit = txBlock.deposit(takeCoin, poolCoinName);
       }
+      const marketCoinDeposit = txBlock.deposit(takeCoin, poolCoinName);
 
       // convert to sCoin
       return returnSCoin
@@ -388,7 +393,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       poolCoinName,
       obligationId,
       obligationKey,
-      isSponsoredTx = false
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -401,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,
@@ -415,7 +425,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
       borrowReferral,
       obligationId,
       obligationKey,
-      isSponsoredTx = false
+      updateOracleOptions
     ) => {
       const obligationInfo = await requireObligationInfo(
         builder,
@@ -428,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,
@@ -462,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

@@ -99,12 +99,11 @@ 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,
   ];
 
-  // get feed object ids
+  // iterate through the endpoints
   for (const endpoint of endpoints) {
     try {
       const pythConnection = new SuiPriceServiceConnection(endpoint);

package/src/builders/referralBuilder.ts

@@ -111,16 +111,10 @@ const generateReferralQuickMethod: GenerateReferralQuickMethod = ({
       const objToTransfer: SuiObjectArg[] = [];
       for (const coinName of coinNames) {
         if (coinName === 'sui') {
-          const rewardCoin = await txBlock.claimReferralRevenue(
-            veScaKey,
-            coinName
-          );
+          const rewardCoin = txBlock.claimReferralRevenue(veScaKey, coinName);
           objToTransfer.push(rewardCoin);
         } else {
-          const rewardCoin = await txBlock.claimReferralRevenue(
-            veScaKey,
-            coinName
-          );
+          const rewardCoin = txBlock.claimReferralRevenue(veScaKey, coinName);
           try {
             // get the matching user coin if exists
             const coins = await builder.suiKit.suiInteractor.selectCoins(

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/scallopClient.ts

@@ -210,6 +210,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligationId - The obligation object.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async depositCollateral(
@@ -228,23 +229,30 @@ class ScallopClient implements ScallopClientInterface {
     amount: number,
     sign: S = true as S,
     obligationId?: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
     txBlock.setSender(sender);
 
-    const obligations = await this.query.getObligations(sender);
-    const specificObligationId = obligationId ?? obligations[0]?.id;
+    const specificObligationId =
+      obligationId ?? (await this.query.getObligations(sender))[0]?.id;
     if (specificObligationId) {
       await txBlock.addCollateralQuick(
         amount,
         collateralCoinName,
-        specificObligationId
+        specificObligationId,
+        isSponsoredTx
       );
     } else {
       const [obligation, obligationKey, hotPotato] = txBlock.openObligation();
-      await txBlock.addCollateralQuick(amount, collateralCoinName, obligation);
+      await txBlock.addCollateralQuick(
+        amount,
+        collateralCoinName,
+        obligation,
+        isSponsoredTx
+      );
       txBlock.returnObligation(obligation, hotPotato);
       txBlock.transferObjects([obligationKey], sender);
     }
@@ -267,6 +275,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param obligationId - The obligation object.
    * @param obligationKey - The obligation key object to verifying obligation authority.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async withdrawCollateral<S extends boolean>(
@@ -275,7 +284,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -285,7 +295,8 @@ class ScallopClient implements ScallopClientInterface {
       amount,
       collateralCoinName,
       obligationId,
-      obligationKey
+      obligationKey,
+      { isSponsoredTx }
     );
     txBlock.transferObjects([collateralCoin], sender);
 
@@ -449,6 +460,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param obligationId - The obligation object.
    * @param obligationKey - The obligation key object to verifying obligation authority.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async borrow<S extends boolean>(
@@ -457,7 +469,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -471,7 +484,8 @@ class ScallopClient implements ScallopClientInterface {
       amount,
       poolCoinName,
       obligationId,
-      obligationKey
+      obligationKey,
+      { isSponsoredTx }
     );
     txBlock.transferObjects([coin], sender);
     if (sign && availableStake) {
@@ -495,6 +509,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligationId - The obligation object.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async repay<S extends boolean>(
@@ -503,7 +518,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -513,7 +529,7 @@ class ScallopClient implements ScallopClientInterface {
     if (sign && availableStake) {
       await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }
-    await txBlock.repayQuick(amount, poolCoinName, obligationId);
+    await txBlock.repayQuick(amount, poolCoinName, obligationId, isSponsoredTx);
     if (sign && availableStake) {
       await txBlock.stakeObligationWithVeScaQuick(obligationId, obligationKey);
     }

package/src/types/builder/core.ts

@@ -87,21 +87,32 @@ export type CoreQuickMethods = {
   addCollateralQuick: (
     amount: number,
     collateralCoinName: string,
-    obligationId?: SuiObjectArg
+    obligationId?: SuiObjectArg,
+    isSponsoredTx?: boolean
   ) => Promise<void>;
   takeCollateralQuick: (
     amount: number,
     collateralCoinName: string,
     obligationId?: SuiObjectArg,
     obligationKey?: SuiObjectArg,
-    isSponsoredTx?: boolean
+    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,
@@ -109,7 +120,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,
@@ -126,7 +142,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 &