@tonconnect/ui 2.3.1 → 2.4.0-beta.1

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { WalletInfoInjectable, WalletInfoRemote, RequiredFeatures, VersionEvent, ConnectionEvent, ConnectionRestoringEvent, DisconnectionEvent, TransactionSigningEvent, DataSigningEvent, EventDispatcher, SdkActionEvent, ITonConnect, Wallet, FeatureName, WalletInfo, Account, ConnectAdditionalRequest, TonConnectError, SendTransactionRequest, SendTransactionResponse, SignDataPayload, SignDataResponse } from '@tonconnect/sdk';
+import { WalletInfoInjectable, WalletInfoRemote, RequiredFeatures, VersionEvent, ConnectionEvent, ConnectionRestoringEvent, DisconnectionEvent, TransactionSigningEvent, DataSigningEvent, WalletModalOpenedEvent, SelectedWalletEvent, EventDispatcher, SdkActionEvent, ITonConnect, Wallet, OptionalTraceable, FeatureName, WalletInfo, Account, ConnectAdditionalRequest, ChainId, TonConnectError, SendTransactionRequest, SendTransactionResponse, SignDataPayload, SignDataResponse } from '@tonconnect/sdk';
 export * from '@tonconnect/sdk';
 import { Property } from 'csstype';
 
@@ -179,7 +179,7 @@ interface TonConnectUiOptions {
 /**
  * User action events.
  */
-type UserActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent | DataSigningEvent;
+type UserActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent | DataSigningEvent | WalletModalOpenedEvent | SelectedWalletEvent;
 
 type TonConnectUiCreateOptions = TonConnectUiOptionsWithConnector | TonConnectUiOptionsWithManifest;
 interface TonConnectUiOptionsWithManifest extends TonConnectUiCreateOptionsBase {
@@ -233,7 +233,7 @@ interface WalletsModal {
     /**
      * Open the modal.
      */
-    open: () => void;
+    open: (options?: OptionalTraceable) => void;
     /**
      * Close the modal.
      * @default 'action-cancelled'
@@ -292,7 +292,7 @@ type ChooseSupportedFeatureWalletsModal = {
 /**
  * Modal window state.
  */
-type WalletsModalState = WalletModalOpened | WalletModalClosed | ChooseSupportedFeatureWalletsModal;
+type WalletsModalState = OptionalTraceable<WalletModalOpened | WalletModalClosed | ChooseSupportedFeatureWalletsModal>;
 /**
  * Modal window close reason.
  */
@@ -404,6 +404,12 @@ declare class TonConnectUI {
      * If `connectRequestParameters.state` was changed to 'ready' or it's value has been changed, QR will be re-rendered.
      */
     setConnectRequestParameters(connectRequestParameters: Loadable<ConnectAdditionalRequest> | undefined | null): void;
+    /**
+     * Set desired network for the connection. Can only be set before connecting.
+     * If wallet connects with a different chain, the SDK will throw an error and abort connection.
+     * @param network desired network id (e.g., '-239', '-3', or custom). Pass undefined to allow any network.
+     */
+    setConnectionNetwork(network?: ChainId): void;
     /**
      * Returns available wallets list.
      */
@@ -416,7 +422,7 @@ declare class TonConnectUI {
     /**
      * Opens the modal window, returns a promise that resolves after the modal window is opened.
      */
-    openModal(): Promise<void>;
+    openModal(options?: OptionalTraceable): Promise<void>;
     /**
      * Closes the modal window.
      */
@@ -455,26 +461,26 @@ declare class TonConnectUI {
      * @return Connected wallet.
      * @throws TonConnectUIError if connection was aborted.
      */
-    connectWallet(): Promise<ConnectedWallet>;
+    connectWallet(options?: OptionalTraceable): Promise<ConnectedWallet>;
     /**
      * Disconnect wallet and clean localstorage.
      */
-    disconnect(): Promise<void>;
+    disconnect(options?: OptionalTraceable): Promise<void>;
     /**
      * Opens the modal window and handles the transaction sending.
      * @param tx transaction to send.
      * @param options modal and notifications behaviour settings. Default is show only 'before' modal and all notifications.
      */
-    sendTransaction(tx: SendTransactionRequest, options?: ActionConfiguration & {
+    sendTransaction(tx: SendTransactionRequest, options?: ActionConfiguration & OptionalTraceable<{
         onRequestSent?: (redirectToWallet: () => void) => void;
-    }): Promise<SendTransactionResponse>;
+    }>): Promise<OptionalTraceable<SendTransactionResponse>>;
     /**
      * Signs the data and returns the signature.
      * @param data data to sign.
      */
-    signData(data: SignDataPayload, options?: {
+    signData(data: SignDataPayload, options?: OptionalTraceable<{
         onRequestSent?: (redirectToWallet: () => void) => void;
-    }): Promise<SignDataResponse>;
+    }>): Promise<SignDataResponse>;
     /**
      * Gets the current session ID if available.
      * @returns session ID string or null if not available.