@nightlylabs/dex-sdk 1.0.4 → 1.0.6

package/dist/index.d.cts

@@ -6143,13 +6143,13 @@ declare class Client {
     _abis: ReturnType<typeof getABIsForNetwork>;
     _contractAddress: string;
     /**
-     * init.
-     *
-     * @param connection - Aptos connection instance. See {@link Aptos}.
-     * @param config - Client configuration options. See {@link ClientConfig}.
-
-    * @returns A promise that resolves to {@link Client}.
-     */
+       * init.
+       *
+       * @param connection - Aptos connection instance. See {@link Aptos}.
+       * @param config - Client configuration options. See {@link ClientConfig}.
+  
+      * @returns A promise that resolves to {@link Client}.
+       */
     static init(connection: Aptos, config?: ClientConfig): Promise<Client>;
     /**
      * constructor.
@@ -6253,20 +6253,20 @@ declare class Client {
     disconnectWebSocket(): Promise<void>;
     isWebSocketConnected(): boolean;
     /**
-     * sendWsMessage.
-     *
-     * @param message - See {@link WsCommand}.
-
-    * @returns A promise that resolves to {@link WsMessage}.
-     */
+       * sendWsMessage.
+       *
+       * @param message - See {@link WsCommand}.
+  
+      * @returns A promise that resolves to {@link WsMessage}.
+       */
     sendWsMessage(message: WsCommand): Promise<WsMessage>;
     /**
-     * subscribeIndexPricesUpdates.
-     *
-     * @param callback - Callback invoked for oracle updates. See {@link WsOracleUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeIndexPricesUpdates.
+       *
+       * @param callback - Callback invoked for oracle updates. See {@link WsOracleUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeIndexPricesUpdates(callback: (data: WsOracleUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeIndexPricesUpdates.
@@ -6275,12 +6275,12 @@ declare class Client {
      */
     unsubscribeIndexPricesUpdates(): Promise<void>;
     /**
-     * subscribeBorrowLendingUpdates.
-     *
-     * @param callback - Callback invoked for borrow-lending updates. See {@link WsBorrowLendUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeBorrowLendingUpdates.
+       *
+       * @param callback - Callback invoked for borrow-lending updates. See {@link WsBorrowLendUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeBorrowLendingUpdates(callback: (data: WsBorrowLendUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeBorrowLendingUpdates.
@@ -6289,12 +6289,12 @@ declare class Client {
      */
     unsubscribeBorrowLendingUpdates(): Promise<void>;
     /**
-     * subscribeBoxOpeningUpdates.
-     *
-     * @param callback - Callback invoked for box-opening updates. See {@link WsBoxOpeningUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeBoxOpeningUpdates.
+       *
+       * @param callback - Callback invoked for box-opening updates. See {@link WsBoxOpeningUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeBoxOpeningUpdates(callback: (data: WsBoxOpeningUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeBoxOpeningUpdates.
@@ -6303,12 +6303,12 @@ declare class Client {
      */
     unsubscribeBoxOpeningUpdates(): Promise<void>;
     /**
-     * subscribeLiquidationUpdates.
-     *
-     * @param callback - Callback invoked for liquidation updates. See {@link WsLiquidationUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeLiquidationUpdates.
+       *
+       * @param callback - Callback invoked for liquidation updates. See {@link WsLiquidationUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeLiquidationUpdates(callback: (data: WsLiquidationUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeLiquidationUpdates.
@@ -6317,13 +6317,13 @@ declare class Client {
      */
     unsubscribeLiquidationUpdates(): Promise<void>;
     /**
-     * subscribeUserUpdates.
-     *
-     * @param userId - See string.
-     * @param callback - Callback invoked for user updates. See {@link WsUserUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeUserUpdates.
+       *
+       * @param userId - See string.
+       * @param callback - Callback invoked for user updates. See {@link WsUserUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeUserUpdates(userId: string, callback: (data: WsUserUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeUserUpdates.
@@ -6332,13 +6332,13 @@ declare class Client {
      */
     unsubscribeUserUpdates(userId: string): Promise<void>;
     /**
-     * subscribePerpMarketUpdates.
-     *
-     * @param market - See string.
-     * @param callback - Callback invoked for perpetual market updates. See {@link WsPerpMarketUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribePerpMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for perpetual market updates. See {@link WsPerpMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribePerpMarketUpdates(market: string, callback: (data: WsPerpMarketUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribePerpMarketUpdates.
@@ -6347,13 +6347,13 @@ declare class Client {
      */
     unsubscribePerpMarketUpdates(market: string): Promise<void>;
     /**
-     * subscribeSpotMarketUpdates.
-     *
-     * @param market - See string.
-     * @param callback - Callback invoked for spot market updates. See {@link WsSpotMarketUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeSpotMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for spot market updates. See {@link WsSpotMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeSpotMarketUpdates(market: string, callback: (data: WsSpotMarketUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeSpotMarketUpdates.
@@ -6435,39 +6435,39 @@ declare class Client {
      */
     submitSponsoredMultiAgentTransaction: (tx: MultiAgentTransaction, signature: AccountAuthenticator, secondarySignersAuthenticators: AccountAuthenticator[]) => Promise<SubmitSponsoredTransactionResponse>;
     /**
-     * createAndSubmitTransaction.
-     *
-     * @param aptosPayload - See {@link AnyTransactionPayloadInstance}.
-
-    * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
-     */
+       * createAndSubmitTransaction.
+       *
+       * @param aptosPayload - See {@link AnyTransactionPayloadInstance}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
     createAndSubmitTransaction(aptosPayload: AnyTransactionPayloadInstance): Promise<SubmitSponsoredTransactionResponse>;
     /**
-     * createOpenBoxesMessage.
-     *
-     * @param boxId - See string.
-     * @param amount - See string.
-     * @param userId - See string.
-     * @param apiKey - See string.
-
-    * @returns The generated box-open message.
-     */
+       * createOpenBoxesMessage.
+       *
+       * @param boxId - See string.
+       * @param amount - See string.
+       * @param userId - See string.
+       * @param apiKey - See string.
+  
+      * @returns The generated box-open message.
+       */
     createOpenBoxesMessage(boxId: string, amount: string, userId: string, apiKey: string): string;
     /**
-     * openBoxes.
-     *
-     * @param params - See {@link OpenBoxesRequest}.
-
-    * @returns A promise that resolves to {@link OpenBoxesResponse}.
-     */
+       * openBoxes.
+       *
+       * @param params - See {@link OpenBoxesRequest}.
+  
+      * @returns A promise that resolves to {@link OpenBoxesResponse}.
+       */
     openBoxes(params: OpenBoxesRequest): Promise<OpenBoxesResponse>;
     /**
-     * removeApiKey.
-     *
-     * @param params - See {@link RemoveApiKeyParams}.
-
-    * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
-     */
+       * removeApiKey.
+       *
+       * @param params - See {@link RemoveApiKeyParams}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
     removeApiKey(params: RemoveApiKeyParams): Promise<SubmitSponsoredTransactionResponse>;
     /**
      * setAliasName.

package/dist/index.d.ts

@@ -6143,13 +6143,13 @@ declare class Client {
     _abis: ReturnType<typeof getABIsForNetwork>;
     _contractAddress: string;
     /**
-     * init.
-     *
-     * @param connection - Aptos connection instance. See {@link Aptos}.
-     * @param config - Client configuration options. See {@link ClientConfig}.
-
-    * @returns A promise that resolves to {@link Client}.
-     */
+       * init.
+       *
+       * @param connection - Aptos connection instance. See {@link Aptos}.
+       * @param config - Client configuration options. See {@link ClientConfig}.
+  
+      * @returns A promise that resolves to {@link Client}.
+       */
     static init(connection: Aptos, config?: ClientConfig): Promise<Client>;
     /**
      * constructor.
@@ -6253,20 +6253,20 @@ declare class Client {
     disconnectWebSocket(): Promise<void>;
     isWebSocketConnected(): boolean;
     /**
-     * sendWsMessage.
-     *
-     * @param message - See {@link WsCommand}.
-
-    * @returns A promise that resolves to {@link WsMessage}.
-     */
+       * sendWsMessage.
+       *
+       * @param message - See {@link WsCommand}.
+  
+      * @returns A promise that resolves to {@link WsMessage}.
+       */
     sendWsMessage(message: WsCommand): Promise<WsMessage>;
     /**
-     * subscribeIndexPricesUpdates.
-     *
-     * @param callback - Callback invoked for oracle updates. See {@link WsOracleUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeIndexPricesUpdates.
+       *
+       * @param callback - Callback invoked for oracle updates. See {@link WsOracleUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeIndexPricesUpdates(callback: (data: WsOracleUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeIndexPricesUpdates.
@@ -6275,12 +6275,12 @@ declare class Client {
      */
     unsubscribeIndexPricesUpdates(): Promise<void>;
     /**
-     * subscribeBorrowLendingUpdates.
-     *
-     * @param callback - Callback invoked for borrow-lending updates. See {@link WsBorrowLendUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeBorrowLendingUpdates.
+       *
+       * @param callback - Callback invoked for borrow-lending updates. See {@link WsBorrowLendUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeBorrowLendingUpdates(callback: (data: WsBorrowLendUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeBorrowLendingUpdates.
@@ -6289,12 +6289,12 @@ declare class Client {
      */
     unsubscribeBorrowLendingUpdates(): Promise<void>;
     /**
-     * subscribeBoxOpeningUpdates.
-     *
-     * @param callback - Callback invoked for box-opening updates. See {@link WsBoxOpeningUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeBoxOpeningUpdates.
+       *
+       * @param callback - Callback invoked for box-opening updates. See {@link WsBoxOpeningUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeBoxOpeningUpdates(callback: (data: WsBoxOpeningUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeBoxOpeningUpdates.
@@ -6303,12 +6303,12 @@ declare class Client {
      */
     unsubscribeBoxOpeningUpdates(): Promise<void>;
     /**
-     * subscribeLiquidationUpdates.
-     *
-     * @param callback - Callback invoked for liquidation updates. See {@link WsLiquidationUpdate}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeLiquidationUpdates.
+       *
+       * @param callback - Callback invoked for liquidation updates. See {@link WsLiquidationUpdate}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeLiquidationUpdates(callback: (data: WsLiquidationUpdate) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeLiquidationUpdates.
@@ -6317,13 +6317,13 @@ declare class Client {
      */
     unsubscribeLiquidationUpdates(): Promise<void>;
     /**
-     * subscribeUserUpdates.
-     *
-     * @param userId - See string.
-     * @param callback - Callback invoked for user updates. See {@link WsUserUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeUserUpdates.
+       *
+       * @param userId - See string.
+       * @param callback - Callback invoked for user updates. See {@link WsUserUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeUserUpdates(userId: string, callback: (data: WsUserUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeUserUpdates.
@@ -6332,13 +6332,13 @@ declare class Client {
      */
     unsubscribeUserUpdates(userId: string): Promise<void>;
     /**
-     * subscribePerpMarketUpdates.
-     *
-     * @param market - See string.
-     * @param callback - Callback invoked for perpetual market updates. See {@link WsPerpMarketUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribePerpMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for perpetual market updates. See {@link WsPerpMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribePerpMarketUpdates(market: string, callback: (data: WsPerpMarketUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribePerpMarketUpdates.
@@ -6347,13 +6347,13 @@ declare class Client {
      */
     unsubscribePerpMarketUpdates(market: string): Promise<void>;
     /**
-     * subscribeSpotMarketUpdates.
-     *
-     * @param market - See string.
-     * @param callback - Callback invoked for spot market updates. See {@link WsSpotMarketUpdates}.
-
-     * @returns A promise that resolves to an unsubscribe function.
-     */
+       * subscribeSpotMarketUpdates.
+       *
+       * @param market - See string.
+       * @param callback - Callback invoked for spot market updates. See {@link WsSpotMarketUpdates}.
+  
+       * @returns A promise that resolves to an unsubscribe function.
+       */
     subscribeSpotMarketUpdates(market: string, callback: (data: WsSpotMarketUpdates) => void): Promise<() => Promise<void>>;
     /**
      * unsubscribeSpotMarketUpdates.
@@ -6435,39 +6435,39 @@ declare class Client {
      */
     submitSponsoredMultiAgentTransaction: (tx: MultiAgentTransaction, signature: AccountAuthenticator, secondarySignersAuthenticators: AccountAuthenticator[]) => Promise<SubmitSponsoredTransactionResponse>;
     /**
-     * createAndSubmitTransaction.
-     *
-     * @param aptosPayload - See {@link AnyTransactionPayloadInstance}.
-
-    * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
-     */
+       * createAndSubmitTransaction.
+       *
+       * @param aptosPayload - See {@link AnyTransactionPayloadInstance}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
     createAndSubmitTransaction(aptosPayload: AnyTransactionPayloadInstance): Promise<SubmitSponsoredTransactionResponse>;
     /**
-     * createOpenBoxesMessage.
-     *
-     * @param boxId - See string.
-     * @param amount - See string.
-     * @param userId - See string.
-     * @param apiKey - See string.
-
-    * @returns The generated box-open message.
-     */
+       * createOpenBoxesMessage.
+       *
+       * @param boxId - See string.
+       * @param amount - See string.
+       * @param userId - See string.
+       * @param apiKey - See string.
+  
+      * @returns The generated box-open message.
+       */
     createOpenBoxesMessage(boxId: string, amount: string, userId: string, apiKey: string): string;
     /**
-     * openBoxes.
-     *
-     * @param params - See {@link OpenBoxesRequest}.
-
-    * @returns A promise that resolves to {@link OpenBoxesResponse}.
-     */
+       * openBoxes.
+       *
+       * @param params - See {@link OpenBoxesRequest}.
+  
+      * @returns A promise that resolves to {@link OpenBoxesResponse}.
+       */
     openBoxes(params: OpenBoxesRequest): Promise<OpenBoxesResponse>;
     /**
-     * removeApiKey.
-     *
-     * @param params - See {@link RemoveApiKeyParams}.
-
-    * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
-     */
+       * removeApiKey.
+       *
+       * @param params - See {@link RemoveApiKeyParams}.
+  
+      * @returns A promise that resolves to {@link SubmitSponsoredTransactionResponse}.
+       */
     removeApiKey(params: RemoveApiKeyParams): Promise<SubmitSponsoredTransactionResponse>;
     /**
      * setAliasName.