@scallop-io/sui-scallop-sdk 2.3.0 → 2.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/oracles/pyth.ts

@@ -95,8 +95,12 @@ export const updatePythPriceFeeds = async (
         '0xa8b8dcc9880166edb57b53e05f8df7364d31b5d9b7d107fd27f0b69cf338b687',
     }
   );
-  const priceIds = assetCoinNames.map((assetCoinName) =>
-    builder.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`)
+  const priceIds = Array.from(
+    new Set(
+      assetCoinNames.map((assetCoinName) =>
+        builder.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`)
+      )
+    )
   );
 
   const endpoints = builder.utils.pythEndpoints ?? [
@@ -106,7 +110,11 @@ export const updatePythPriceFeeds = async (
   // iterate through the endpoints
   for (const endpoint of endpoints) {
     try {
-      const pythConnection = new SuiPriceServiceConnection(endpoint);
+      const pythConnection = new SuiPriceServiceConnection(endpoint, {
+        priceFeedRequestConfig: {
+          binary: true,
+        },
+      });
       const priceUpdateData =
         await pythConnection.getPriceFeedsUpdateData(priceIds);
 

package/src/builders/spoolBuilder.ts

@@ -196,7 +196,7 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
  *
  * @description
  * The quick methods are the same as the normal methods, but they will automatically
- * help users organize transaction blocks, include get stake account info, and transfer
+ * help users organize transaction blocks, including getting stake account info, and transferring
  * coins to the sender. So, they are all asynchronous methods.
  *
  * @param builder - Scallop builder instance.
@@ -273,7 +273,7 @@ const generateSpoolQuickMethod: GenerateSpoolQuickMethod = ({
       for (const account of stakeAccounts) {
         if (account.staked === 0) continue;
         const amountToUnstake = Math.min(amount, account.staked);
-        const marketCoin = await txBlock.unstake(
+        const marketCoin = txBlock.unstake(
           account.id,
           amountToUnstake,
           stakeMarketCoinName
@@ -281,10 +281,7 @@ const generateSpoolQuickMethod: GenerateSpoolQuickMethod = ({
 
         // convert to new sCoin
         if (returnSCoin) {
-          const sCoin = await txBlock.mintSCoin(
-            stakeMarketCoinName,
-            marketCoin
-          );
+          const sCoin = txBlock.mintSCoin(stakeMarketCoinName, marketCoin);
           toTransfer.push(sCoin);
         } else {
           toTransfer.push(marketCoin);

package/src/constants/queryKeys.ts

@@ -74,6 +74,10 @@ export const queryKeys = {
     },
   },
   oracle: {
-    getPythLatestPriceFeeds: () => ['oracle', 'getPythPriceIds'],
+    getPythLatestPriceFeeds: (priceIds: string[]) => [
+      'oracle',
+      'getPythPriceIds',
+      priceIds,
+    ],
   },
 };

package/src/constants/rpc.ts

@@ -2,7 +2,6 @@ import { getFullnodeUrl } from '@mysten/sui/client';
 
 export const RPC_PROVIDERS = [
   getFullnodeUrl('mainnet'),
-  'https://sui-mainnet.public.blastapi.io',
   'https://sui-mainnet-ca-2.cosmostation.io',
   'https://sui-mainnet-eu-4.cosmostation.io',
   'https://sui-mainnet-endpoint.blockvision.org',

package/src/models/interface.ts

@@ -24,7 +24,7 @@ interface ScallopBuilderInterface extends ScallopQueryInterface {
   query: ScallopQuery;
 }
 
-interface ScallopClientInterface extends ScallopBaseInterface {
+interface ScallopClientInterface extends ScallopBuilderInterface {
   builder: ScallopBuilder;
 }
 

package/src/models/scallop.ts

@@ -23,7 +23,7 @@ export type ScallopParams = {
 } & ScallopClientParams;
 class Scallop {
   public readonly client: ScallopClient;
-  public constructor(params: ScallopParams) {
+  public constructor(params: ScallopParams = {}) {
     this.client = params.client ?? new ScallopClient(params);
   }
 

package/src/models/scallopAddress.ts

@@ -12,7 +12,7 @@ export type ScallopAddressParams = {
     addresses?: string[];
   };
   auth?: string;
-  network?: NetworkType;
+  networkType?: NetworkType;
   forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
   defaultValues?: {
     addresses?: Partial<Record<NetworkType, AddressesInterface>>;
@@ -452,7 +452,7 @@ class ScallopAddress {
       ...params,
     });
 
-    this.network = params.network ?? 'mainnet';
+    this.network = params.networkType ?? 'mainnet';
     this.addressId = params.addressId ?? this.defaultParamValues.addressId;
     this.auth = params.auth ?? '';
 

package/src/models/scallopBuilder.ts

@@ -39,7 +39,7 @@ class ScallopBuilder implements ScallopBuilderInterface {
   public readonly useOnChainXOracleList: boolean;
   public readonly sponsoredFeeds: string[];
 
-  public constructor(params: ScallopBuilderParams) {
+  public constructor(params: ScallopBuilderParams = {}) {
     this.query = params.query ?? new ScallopQuery(params);
     this.usePythPullModel = params.usePythPullModel ?? true;
     this.useOnChainXOracleList = params.useOnChainXOracleList ?? true;
@@ -112,9 +112,13 @@ class ScallopBuilder implements ScallopBuilderInterface {
     } else {
       const coinType = this.utils.parseCoinType(assetCoinName);
       const coins = await this.utils.selectCoins(amount, coinType, sender);
+      const totalAmount = coins.reduce((prev, coin) => {
+        prev += Number(coin.balance);
+        return prev;
+      }, 0);
       const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(coins, amount);
 
-      return { takeCoin, leftCoin };
+      return { takeCoin, leftCoin, totalAmount };
     }
   }
 

package/src/models/scallopClient.ts

@@ -42,7 +42,7 @@ class ScallopClient implements ScallopClientInterface {
   public readonly builder: ScallopBuilder;
   public networkType: NetworkType;
 
-  public constructor(params: ScallopClientParams) {
+  public constructor(params: ScallopClientParams = {}) {
     this.builder = params.builder ?? new ScallopBuilder(params);
     this.networkType = params.networkType ?? 'mainnet';
   }
@@ -84,9 +84,9 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query market data.
-   *
+   * @deprecated use ScallopQuery instance instead
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @return Market data.
    */
@@ -96,9 +96,9 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Get obligations data.
-   *
+   * @deprecated use ScallopQuery instance instead
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param ownerAddress - The owner address.
    * @return Obligations data.
@@ -110,9 +110,9 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query obligation data.
-   *
+   * @deprecated use ScallopQuery instance instead
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param obligationId - The obligation id.
    * @return Obligation data.
@@ -123,9 +123,9 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query all stake accounts data.
-   *
+   * @deprecated use ScallopQuery instance instead
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param ownerAddress - The owner address.
    * @return All stake accounts data.
@@ -137,9 +137,9 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query stake account data.
-   *
+   * @deprecated use ScallopQuery instance instead
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param stakeMarketCoinName - Support stake market coin.
    * @param ownerAddress - The owner address.
@@ -152,9 +152,10 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query stake pool data.
+   * @deprecated use ScallopQuery instance instead
    *
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param stakeMarketCoinName - Support stake market coin.
    * @return Stake pool data.
@@ -165,9 +166,10 @@ class ScallopClient implements ScallopClientInterface {
 
   /**
    * Query reward pool data.
+   * @deprecated use ScallopQuery instance instead
    *
    * @description
-   * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+   * This method might be deprecated in the future, please use the {@link ScallopQuery} query instance instead.
    *
    * @param stakeMarketCoinName - Support stake market coin.
    * @return Reward pool data.
@@ -730,12 +732,7 @@ class ScallopClient implements ScallopClientInterface {
         throw new Error(`Invalid sCoin type: ${stakeMarketCoinName}`);
 
       // merge to existing sCoins if exist
-      await this.utils.mergeSimilarCoins(
-        txBlock,
-        sCoin,
-        sCoinType,
-        requireSender(txBlock)
-      );
+      await this.utils.mergeSimilarCoins(txBlock, sCoin, sCoinType, sender);
     }
 
     txBlock.transferObjects([sCoin], sender);

package/src/models/scallopQuery.ts

@@ -74,7 +74,7 @@ class ScallopQuery implements ScallopQueryInterface {
   public readonly indexer: ScallopIndexer;
   public readonly utils: ScallopUtils;
 
-  constructor(params: ScallopQueryParams) {
+  constructor(params: ScallopQueryParams = {}) {
     this.utils = params.utils ?? new ScallopUtils(params);
     this.indexer =
       params.indexer ??

package/src/models/scallopUtils.ts

@@ -542,11 +542,12 @@ class ScallopUtils implements ScallopUtilsInterface {
       const priceIds = priceIdPairs.map(([_, priceId]) => priceId);
       const pythConnection = new SuiPriceServiceConnection(endpoint, {
         timeout: this.timeout,
+        httpRetries: 0,
       });
 
       try {
         const feeds = await this.queryClient.fetchQuery({
-          queryKey: queryKeys.oracle.getPythLatestPriceFeeds(),
+          queryKey: queryKeys.oracle.getPythLatestPriceFeeds(priceIds),
           queryFn: async () => {
             return await pythConnection.getLatestPriceFeeds(priceIds);
           },

package/src/queries/poolAddressesQuery.ts

@@ -3,7 +3,6 @@ import { AddressesInterface, OptionalKeys, PoolAddress } from 'src/types';
 
 const RPC_PROVIDERS = [
   getFullnodeUrl('mainnet'),
-  'https://sui-mainnet.public.blastapi.io',
   'https://sui-mainnet-ca-2.cosmostation.io',
   'https://sui-mainnet-eu-4.cosmostation.io',
   'https://sui-mainnet-endpoint.blockvision.org',