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

package/lib/types/index.d.ts

@@ -6,7 +6,7 @@ export declare interface Account {
     /**
      * User's selected chain.
      */
-    chain: CHAIN;
+    chain: ChainId;
     /**
      * Base64 (not url safe) encoded wallet contract stateInit.
      * Can be used to get user's public key from the stateInit if the wallet contract doesn't support corresponding get method.
@@ -70,6 +70,8 @@ export declare enum CHAIN {
     TESTNET = "-3"
 }
 
+export declare type ChainId = CHAIN | string;
+
 export declare function checkRequiredWalletFeatures(features: Feature[], walletsRequiredFeatures?: RequiredFeatures): boolean;
 
 export declare enum CONNECT_EVENT_ERROR_CODES {
@@ -362,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.
@@ -556,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;
@@ -584,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.
@@ -648,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.
      */
@@ -665,6 +696,12 @@ export declare interface ITonConnect {
      * Unpause bridge HTTP connection if it is paused.
      */
     unPauseConnection(): Promise<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;
     /**
      * Disconnect form thw connected wallet and drop current session.
      */
@@ -852,7 +889,7 @@ export declare interface SendTransactionRequest {
     /**
      * The network (mainnet or testnet) where DApp intends to send the transaction. If not set, the transaction is sent to the network currently set in the wallet, but this is not safe and DApp should always strive to set the network. If the network parameter is set, but the wallet has a different network set, the wallet should show an alert and DO NOT ALLOW TO SEND this transaction.
      */
-    network?: CHAIN;
+    network?: ChainId;
     /**
      * The sender address in '<wc>:<hex>' format from which DApp intends to send the transaction. Current account.address by default.
      */
@@ -925,7 +962,7 @@ export declare type SignDataFeature = {
 };
 
 export declare type SignDataPayload = {
-    network?: CHAIN;
+    network?: ChainId;
     from?: string;
 } & (SignDataPayloadText | SignDataPayloadBinary | SignDataPayloadCell);
 
@@ -967,17 +1004,22 @@ export declare type TelegramUser = {
 
 export declare interface TonAddressItem {
     name: 'ton_addr';
+    /**
+     * Desired network global_id. If provided, wallet should connect on this network.
+     */
+    network?: ChainId;
 }
 
 export declare interface TonAddressItemReply {
     name: 'ton_addr';
     address: string;
-    network: CHAIN;
+    network: ChainId;
     walletStateInit: string;
     publicKey: string;
 }
 
 declare class TonConnect implements ITonConnect {
+    private desiredChainId;
     private static readonly walletsList;
     /**
      * Check if specified wallet is injected and available to use with the app.
@@ -1045,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.
      */
@@ -1075,6 +1117,12 @@ declare class TonConnect implements ITonConnect {
         onRequestSent?: () => void;
         signal?: AbortSignal;
     }>): Promise<Traceable<SignDataResponse>>;
+    /**
+     * 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;
     /**
      * Disconnect form thw connected wallet and drop current session.
      */
@@ -1417,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 {
     /**
@@ -1437,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);
 
 /**
@@ -1632,6 +1725,18 @@ export declare class WalletsListManager {
     private isCorrectWalletConfigDTO;
 }
 
+export declare class WalletWrongNetworkError extends TonConnectError<{
+    expectedChainId: string;
+    actualChainId: string;
+}> {
+    constructor(message: string, options: {
+        cause: {
+            expectedChainId: string;
+            actualChainId: string;
+        };
+    });
+}
+
 /**
  * Parameters without version field.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "3.4.0-beta.0",
+  "version": "3.4.0-beta.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ton-connect/sdk.git"
@@ -22,7 +22,7 @@
   "dependencies": {
     "@tonconnect/isomorphic-eventsource": "0.0.2",
     "@tonconnect/isomorphic-fetch": "0.0.3",
-    "@tonconnect/protocol": "2.3.0"
+    "@tonconnect/protocol": "2.4.0-beta.0"
   },
   "files": [
     "lib",