@tonconnect/sdk 3.4.0-beta.1 → 3.4.0-beta.2

package/lib/types/index.d.ts

@@ -364,7 +364,9 @@ export declare function createRequestVersionEvent(): RequestVersionEvent;
  */
 export declare function createResponseVersionEvent(version: string): ResponseVersionEvent;
 
-export declare function createSelectedWalletEvent(version: Version, visibleWallets: string[], lastSelectedWallet: WalletInfoInjectable | WalletInfoRemote | null, walletsMenu: 'explicit_wallet' | 'main_screen' | 'other_wallets', redirectLink: string, redirectLinkType?: 'tg_link' | 'external_link', clientId?: string | null, traceId?: string | null): SelectedWalletEvent;
+export declare function createSelectedWalletEvent(version: Version, visibleWallets: string[], lastSelectedWallet: {
+    appName?: string;
+} | null, walletsMenu: 'explicit_wallet' | 'main_screen' | 'other_wallets', redirectLink: string, redirectLinkType?: 'tg_link' | 'external_link', clientId?: string | null, traceId?: string | null): SelectedWalletEvent;
 
 /**
  * Create a transaction init event.
@@ -558,6 +560,31 @@ export declare interface IEnvironment {
     getClientEnvironment(): 'web' | 'miniapp' | (string & {});
 }
 
+/**
+ * Initializes the WalletConnect integration.
+ *
+ * This function must be called once before using WalletConnect features.
+ * A second call will throw an error to prevent accidental re-initialization.
+ *
+ * @param UniversalConnectorCls - A UniversalConnector class imported from '@reown/appkit-universal-connector'
+ * @param {WalletConnectOptions} walletConnectOptions - Configuration options used for initializing WalletConnect.
+ * @example
+ * import { UniversalConnector } from '@reown/appkit-universal-connector';
+ *
+ * initializeWalletConnect(UniversalConnector, {
+ *     projectId: 'abcd1234abcd1234abcd1234abcd1234',
+ *     metadata: {
+ *         name: 'Demo DApp',
+ *         icons: [
+ *             'https://example.com/my-icon.png'
+ *         ],
+ *         url: window.location.origin,
+ *         description: 'Demo DApp'
+ *     }
+ * });
+ */
+export declare function initializeWalletConnect(UniversalConnectorCls: Function, walletConnectOptions: WalletConnectOptions): void;
+
 export declare function isConnectUrl(link: string | undefined): link is string;
 
 export declare function isQaModeEnabled(): boolean;
@@ -586,6 +613,8 @@ export declare interface IStorage {
     removeItem(key: string): Promise<void>;
 }
 
+export declare function isWalletConnectInitialized(): boolean;
+
 /**
  * Checks if `WalletInfo` is `WalletInfoInjectable` and dApp is opened inside this wallet's browser.
  * @param value WalletInfo to check.
@@ -650,7 +679,7 @@ export declare interface ITonConnect {
     connect<T extends WalletConnectionSource | Pick<WalletConnectionSourceHTTP, 'bridgeUrl'>[]>(wallet: T, request?: ConnectAdditionalRequest, options?: OptionalTraceable<{
         openingDeadlineMS?: number;
         signal?: AbortSignal;
-    }>): T extends WalletConnectionSourceJS ? void : string;
+    }>): T extends WalletConnectionSourceJS ? void : T extends WalletConnectionSourceWalletConnect ? void : string;
     /**
      * Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.
      */
@@ -1058,12 +1087,12 @@ declare class TonConnect implements ITonConnect {
         request?: ConnectAdditionalRequest;
         openingDeadlineMS?: number;
         signal?: AbortSignal;
-    }>): T extends WalletConnectionSourceJS ? void : string;
+    }>): T extends WalletConnectionSourceJS ? void : T extends WalletConnectionSourceWalletConnect ? void : string;
     /** @deprecated use connect(wallet, options) instead */
     connect<T extends WalletConnectionSource | Pick<WalletConnectionSourceHTTP, 'bridgeUrl'>[]>(wallet: T, request?: ConnectAdditionalRequest, options?: OptionalTraceable<{
         openingDeadlineMS?: number;
         signal?: AbortSignal;
-    }>): T extends WalletConnectionSourceJS ? void : string;
+    }>): T extends WalletConnectionSourceJS ? void : T extends WalletConnectionSourceWalletConnect ? void : string;
     /**
      * Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.
      */
@@ -1436,7 +1465,7 @@ export declare class WalletAlreadyConnectedError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }
 
-export declare type WalletConnectionSource = WalletConnectionSourceHTTP | WalletConnectionSourceJS;
+export declare type WalletConnectionSource = WalletConnectionSourceHTTP | WalletConnectionSourceJS | WalletConnectionSourceWalletConnect;
 
 export declare interface WalletConnectionSourceHTTP {
     /**
@@ -1456,6 +1485,51 @@ export declare interface WalletConnectionSourceJS {
     jsBridgeKey: string;
 }
 
+export declare interface WalletConnectionSourceWalletConnect {
+    type: 'wallet-connect';
+}
+
+/**
+ * Metadata information about your application that will be displayed to users during WalletConnect pairing.
+ */
+export declare type WalletConnectMetadata = {
+    /**
+     * The name of your application.
+     * @example 'My DApp'
+     */
+    name: string;
+    /**
+     * A brief description of your application.
+     * @example 'My awesome TON DApp'
+     */
+    description: string;
+    /**
+     * The URL of your application. This is used as the domain for ton_proof authentication.
+     * @example 'https://mydapp.com'
+     */
+    url: string;
+    /**
+     * An array of icon URLs representing your application. These icons are shown in wallet interfaces.
+     * @example ['https://mydapp.com/icon-192.png', 'https://mydapp.com/icon-512.png']
+     */
+    icons: string[];
+};
+
+/**
+ * Configuration options for initializing WalletConnect integration.
+ */
+export declare type WalletConnectOptions = {
+    /**
+     * Your WalletConnect project ID. Get one at https://dashboard.reown.com/
+     * @example 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
+     */
+    projectId: string;
+    /**
+     * Metadata about your application that will be displayed to users.
+     */
+    metadata: WalletConnectMetadata;
+};
+
 export declare type WalletInfo = WalletInfoRemote | WalletInfoInjectable | (WalletInfoRemote & WalletInfoInjectable);
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "3.4.0-beta.1",
+  "version": "3.4.0-beta.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ton-connect/sdk.git"