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

package/dist/index.d.mts

@@ -152,7 +152,7 @@ type ScallopAddressParams = {
         addresses?: string[];
     };
     auth?: string;
-    network?: NetworkType;
+    networkType?: NetworkType;
     forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
     defaultValues?: {
         addresses?: Partial<Record<NetworkType, AddressesInterface>>;
@@ -522,7 +522,7 @@ type ScallopQueryParams = {
 declare class ScallopQuery implements ScallopQueryInterface {
     readonly indexer: ScallopIndexer;
     readonly utils: ScallopUtils;
-    constructor(params: ScallopQueryParams);
+    constructor(params?: ScallopQueryParams);
     initIndexerFallback(): void;
     /**
      * Request the scallop API to initialize data.
@@ -1117,7 +1117,7 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
     readonly usePythPullModel: boolean;
     readonly useOnChainXOracleList: boolean;
     readonly sponsoredFeeds: string[];
-    constructor(params: ScallopBuilderParams);
+    constructor(params?: ScallopBuilderParams);
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;
     get walletAddress(): string;
@@ -1153,9 +1153,11 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
             NestedResult: [number, number];
         };
         leftCoin?: undefined;
+        totalAmount?: undefined;
     } | {
         takeCoin: TransactionObjectArgument;
         leftCoin: TransactionObjectArgument;
+        totalAmount: number;
     }>;
     /**
      * Specifying the sender's amount of market coins to get coins args from transaction result.
@@ -1216,7 +1218,7 @@ interface ScallopQueryInterface extends ScallopUtilsInterface {
 interface ScallopBuilderInterface extends ScallopQueryInterface {
     query: ScallopQuery;
 }
-interface ScallopClientInterface extends ScallopBaseInterface {
+interface ScallopClientInterface extends ScallopBuilderInterface {
     builder: ScallopBuilder;
 }
 
@@ -1461,7 +1463,7 @@ type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTrans
 declare class ScallopClient implements ScallopClientInterface {
     readonly builder: ScallopBuilder;
     networkType: NetworkType;
-    constructor(params: ScallopClientParams);
+    constructor(params?: ScallopClientParams);
     get query(): ScallopQuery;
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;
@@ -1476,18 +1478,18 @@ declare class ScallopClient implements ScallopClientInterface {
     init(force?: boolean): Promise<void>;
     /**
      * 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.
      */
     queryMarket(): Promise<Market>;
     /**
      * 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.
@@ -1495,9 +1497,9 @@ declare class ScallopClient implements ScallopClientInterface {
     getObligations(ownerAddress?: string): Promise<Obligation[]>;
     /**
      * 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.
@@ -1505,9 +1507,9 @@ declare class ScallopClient implements ScallopClientInterface {
     queryObligation(obligationId: string): Promise<ObligationQueryInterface | undefined>;
     /**
      * 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.
@@ -1515,9 +1517,9 @@ declare class ScallopClient implements ScallopClientInterface {
     getAllStakeAccounts(ownerAddress?: string): Promise<StakeAccounts>;
     /**
      * 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.
@@ -1526,9 +1528,10 @@ declare class ScallopClient implements ScallopClientInterface {
     getStakeAccounts(stakeMarketCoinName: string, ownerAddress?: string): Promise<StakeAccount[]>;
     /**
      * 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.
@@ -1536,9 +1539,10 @@ declare class ScallopClient implements ScallopClientInterface {
     getStakePool(stakeMarketCoinName: string): Promise<StakePool | undefined>;
     /**
      * 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.
@@ -1784,7 +1788,7 @@ type ScallopParams = {
 } & ScallopClientParams;
 declare class Scallop {
     readonly client: ScallopClient;
-    constructor(params: ScallopParams);
+    constructor(params?: ScallopParams);
     init(force?: boolean): Promise<void>;
     /**
      * Create a scallop client instance that already has initial data.

package/dist/index.d.ts

@@ -152,7 +152,7 @@ type ScallopAddressParams = {
         addresses?: string[];
     };
     auth?: string;
-    network?: NetworkType;
+    networkType?: NetworkType;
     forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
     defaultValues?: {
         addresses?: Partial<Record<NetworkType, AddressesInterface>>;
@@ -522,7 +522,7 @@ type ScallopQueryParams = {
 declare class ScallopQuery implements ScallopQueryInterface {
     readonly indexer: ScallopIndexer;
     readonly utils: ScallopUtils;
-    constructor(params: ScallopQueryParams);
+    constructor(params?: ScallopQueryParams);
     initIndexerFallback(): void;
     /**
      * Request the scallop API to initialize data.
@@ -1117,7 +1117,7 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
     readonly usePythPullModel: boolean;
     readonly useOnChainXOracleList: boolean;
     readonly sponsoredFeeds: string[];
-    constructor(params: ScallopBuilderParams);
+    constructor(params?: ScallopBuilderParams);
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;
     get walletAddress(): string;
@@ -1153,9 +1153,11 @@ declare class ScallopBuilder implements ScallopBuilderInterface {
             NestedResult: [number, number];
         };
         leftCoin?: undefined;
+        totalAmount?: undefined;
     } | {
         takeCoin: TransactionObjectArgument;
         leftCoin: TransactionObjectArgument;
+        totalAmount: number;
     }>;
     /**
      * Specifying the sender's amount of market coins to get coins args from transaction result.
@@ -1216,7 +1218,7 @@ interface ScallopQueryInterface extends ScallopUtilsInterface {
 interface ScallopBuilderInterface extends ScallopQueryInterface {
     query: ScallopQuery;
 }
-interface ScallopClientInterface extends ScallopBaseInterface {
+interface ScallopClientInterface extends ScallopBuilderInterface {
     builder: ScallopBuilder;
 }
 
@@ -1461,7 +1463,7 @@ type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTrans
 declare class ScallopClient implements ScallopClientInterface {
     readonly builder: ScallopBuilder;
     networkType: NetworkType;
-    constructor(params: ScallopClientParams);
+    constructor(params?: ScallopClientParams);
     get query(): ScallopQuery;
     get utils(): ScallopUtils;
     get constants(): ScallopConstants;
@@ -1476,18 +1478,18 @@ declare class ScallopClient implements ScallopClientInterface {
     init(force?: boolean): Promise<void>;
     /**
      * 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.
      */
     queryMarket(): Promise<Market>;
     /**
      * 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.
@@ -1495,9 +1497,9 @@ declare class ScallopClient implements ScallopClientInterface {
     getObligations(ownerAddress?: string): Promise<Obligation[]>;
     /**
      * 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.
@@ -1505,9 +1507,9 @@ declare class ScallopClient implements ScallopClientInterface {
     queryObligation(obligationId: string): Promise<ObligationQueryInterface | undefined>;
     /**
      * 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.
@@ -1515,9 +1517,9 @@ declare class ScallopClient implements ScallopClientInterface {
     getAllStakeAccounts(ownerAddress?: string): Promise<StakeAccounts>;
     /**
      * 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.
@@ -1526,9 +1528,10 @@ declare class ScallopClient implements ScallopClientInterface {
     getStakeAccounts(stakeMarketCoinName: string, ownerAddress?: string): Promise<StakeAccount[]>;
     /**
      * 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.
@@ -1536,9 +1539,10 @@ declare class ScallopClient implements ScallopClientInterface {
     getStakePool(stakeMarketCoinName: string): Promise<StakePool | undefined>;
     /**
      * 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.
@@ -1784,7 +1788,7 @@ type ScallopParams = {
 } & ScallopClientParams;
 declare class Scallop {
     readonly client: ScallopClient;
-    constructor(params: ScallopParams);
+    constructor(params?: ScallopParams);
     init(force?: boolean): Promise<void>;
     /**
      * Create a scallop client instance that already has initial data.