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

package/dist/index.d.mts

@@ -1108,6 +1108,7 @@ declare 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.
      */
     selectCoin(txBlock: ScallopTxBlock | SuiTxBlock, assetCoinName: string, amount: number, sender?: string, isSponsored?: boolean): Promise<{
@@ -1523,6 +1524,7 @@ declare 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.
      */
     depositCollateral(collateralCoinName: string, amount: number): Promise<SuiTransactionBlockResponse>;
@@ -1536,9 +1538,10 @@ declare 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.
      */
-    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Deposit asset into the specific pool.
      *
@@ -1582,9 +1585,10 @@ declare 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.
      */
-    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Repay asset into the specific pool.
      *
@@ -1593,9 +1597,10 @@ declare 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.
      */
-    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * FlashLoan asset from the specific pool.
      *
@@ -1813,14 +1818,34 @@ type CoreNormalMethods = {
     repayFlashLoan: (coin: SuiObjectArg, loan: SuiObjectArg, poolCoinName: string) => void;
 };
 type CoreQuickMethods = {
-    addCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg) => Promise<void>;
-    takeCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
-    borrowQuick: (amount: number, poolCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
-    borrowWithReferralQuick: (amount: number, poolCoinName: string, borrowReferral: SuiObjectArg, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
+    addCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<void>;
+    takeCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
+    borrowQuick: (amount: number, poolCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
+    borrowWithReferralQuick: (amount: number, poolCoinName: string, borrowReferral: SuiObjectArg, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
     depositQuick: (amount: number, poolCoinName: string, returnSCoin?: boolean) => Promise<TransactionResult>;
     withdrawQuick: (amount: number, poolCoinName: string) => Promise<TransactionResult>;
     repayQuick: (amount: number, poolCoinName: string, 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>;
 };
 type SuiTxBlockWithCoreNormalMethods = SuiTxBlock & SuiTxBlockWithSpool & CoreNormalMethods;
 type CoreTxBlock = SuiTxBlockWithCoreNormalMethods & CoreQuickMethods;

package/dist/index.d.ts

@@ -1108,6 +1108,7 @@ declare 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.
      */
     selectCoin(txBlock: ScallopTxBlock | SuiTxBlock, assetCoinName: string, amount: number, sender?: string, isSponsored?: boolean): Promise<{
@@ -1523,6 +1524,7 @@ declare 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.
      */
     depositCollateral(collateralCoinName: string, amount: number): Promise<SuiTransactionBlockResponse>;
@@ -1536,9 +1538,10 @@ declare 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.
      */
-    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Deposit asset into the specific pool.
      *
@@ -1582,9 +1585,10 @@ declare 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.
      */
-    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Repay asset into the specific pool.
      *
@@ -1593,9 +1597,10 @@ declare 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.
      */
-    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
     /**
      * FlashLoan asset from the specific pool.
      *
@@ -1813,14 +1818,34 @@ type CoreNormalMethods = {
     repayFlashLoan: (coin: SuiObjectArg, loan: SuiObjectArg, poolCoinName: string) => void;
 };
 type CoreQuickMethods = {
-    addCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg) => Promise<void>;
-    takeCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
-    borrowQuick: (amount: number, poolCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
-    borrowWithReferralQuick: (amount: number, poolCoinName: string, borrowReferral: SuiObjectArg, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<TransactionResult>;
+    addCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, isSponsoredTx?: boolean) => Promise<void>;
+    takeCollateralQuick: (amount: number, collateralCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
+    borrowQuick: (amount: number, poolCoinName: string, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
+    borrowWithReferralQuick: (amount: number, poolCoinName: string, borrowReferral: SuiObjectArg, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg, updateOracleOptions?: {
+        usePythPullModel?: boolean;
+        useOnChainXOracleList?: boolean;
+        sponsoredFeeds?: string[];
+        isSponsoredTx?: boolean;
+    }) => Promise<TransactionResult>;
     depositQuick: (amount: number, poolCoinName: string, returnSCoin?: boolean) => Promise<TransactionResult>;
     withdrawQuick: (amount: number, poolCoinName: string) => Promise<TransactionResult>;
     repayQuick: (amount: number, poolCoinName: string, 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>;
 };
 type SuiTxBlockWithCoreNormalMethods = SuiTxBlock & SuiTxBlockWithSpool & CoreNormalMethods;
 type CoreTxBlock = SuiTxBlockWithCoreNormalMethods & CoreQuickMethods;