Documentation
    Preparing search index...

    Interface ITonConnect

    interface ITonConnect {
        account: null | Account;
        connected: boolean;
        wallet: null | Wallet;
        connect<
            T extends
                | WalletConnectionSource
                | Pick<WalletConnectionSourceHTTP, "bridgeUrl">[],
        >(
            wallet: T,
            request?: ConnectAdditionalRequest,
            options?: OptionalTraceable<
                { openingDeadlineMS?: number; signal?: AbortSignal },
            >,
        ): T extends WalletConnectionSourceJS
            ? void
            : T extends WalletConnectionSourceWalletConnect ? void : string;
        disconnect(
            options?: OptionalTraceable<{ signal?: AbortSignal }>,
        ): Promise<void>;
        getConnectRequestForIntent(
            additionalRequest?: ConnectAdditionalRequest,
        ): ConnectRequest;
        getSessionId(): Promise<null | string>;
        getWallets(): Promise<WalletInfo[]>;
        onIntentResponse(
            callback: (
                response: {
                    error?: unknown;
                    id: string;
                    result?: unknown;
                    traceId: string;
                },
            ) => void,
        ): () => void;
        onStatusChange(
            callback: (walletInfo: null | Wallet) => void,
            errorsHandler?: (err: TonConnectError) => void,
        ): () => void;
        pauseConnection(): void;
        restoreConnection(
            options?: OptionalTraceable<
                { openingDeadlineMS?: number; signal?: AbortSignal },
            >,
        ): Promise<void>;
        sendActionIntent(
            action: SendActionIntentRequest,
            options?: OptionalTraceable<IntentUrlOptions>,
        ): Promise<OptionalTraceable<SendActionIntentResponse>>;
        sendTransaction(
            transaction: SendTransactionRequest,
            options?: OptionalTraceable<
                { onRequestSent?: () => void; signal?: AbortSignal },
            >,
        ): Promise<OptionalTraceable<SendTransactionIntentResponse>>;
        sendTransaction(
            transaction: SendTransactionRequest,
            onRequestSent?: () => void,
        ): Promise<OptionalTraceable<SendTransactionIntentResponse>>;
        sendTransactionIntent(
            transaction: SendTransactionIntentRequest,
            options?: OptionalTraceable<IntentUrlOptions>,
        ): Promise<OptionalTraceable<SendTransactionIntentResponse>>;
        setConnectionNetwork(network?: string): void;
        signData(
            data: SignDataPayload,
            options?: OptionalTraceable<
                { onRequestSent?: () => void; signal?: AbortSignal },
            >,
        ): Promise<OptionalTraceable<SignDataIntentResponse>>;
        signDataIntent(
            data: SignDataIntentRequest,
            options?: OptionalTraceable<IntentUrlOptions>,
        ): Promise<OptionalTraceable<SignDataIntentResponse>>;
        signMessage(
            message: SendTransactionRequest,
            options?: OptionalTraceable<
                { onRequestSent?: () => void; signal?: AbortSignal },
            >,
        ): Promise<OptionalTraceable<SignMessageIntentResponse>>;
        signMessageIntent(
            message: SignMessageIntentRequest,
            options?: OptionalTraceable<IntentUrlOptions>,
        ): Promise<OptionalTraceable<SignMessageIntentResponse>>;
        unPauseConnection(): Promise<void>;
    }

    Implemented by

    Index

    Properties

    account connected wallet

    Methods

    connect disconnect getConnectRequestForIntent getSessionId getWallets onIntentResponse onStatusChange pauseConnection restoreConnection sendActionIntent sendTransaction sendTransactionIntent setConnectionNetwork signData signDataIntent signMessage signMessageIntent unPauseConnection

    Properties

    account: null | Account

    Current connected account or null if no account is connected.

    connected: boolean

    Shows if the wallet is connected right now.

    wallet: null | Wallet

    Current connected wallet or null if no account is connected.

    Methods

    • Disconnect form thw connected wallet and drop current session.

      Parameters

      Returns Promise<void>

    • Builds a full ConnectRequest for use in intent options (e.g. from UI). Merges manifest from connector config with optional additional request (tonProof etc).

      Parameters

      Returns ConnectRequest

    • Gets the current session ID if available.

      Returns Promise<null | string>

      session ID string or null if not available.

    • Returns available wallets list.

      Returns Promise<WalletInfo[]>

    • Parameters

      • callback: (
            response: {
                error?: unknown;
                id: string;
                result?: unknown;
                traceId: string;
            },
        ) => void

      Returns () => void

    • Allows to subscribe to connection status changes and handle connection errors.

      Parameters

      • callback: (walletInfo: null | Wallet) => void

        will be called after connections status changes with actual wallet or null.

      • OptionalerrorsHandler: (err: TonConnectError) => void

        (optional) will be called with some instance of TonConnectError when connect error is received.

      Returns () => void

      unsubscribe callback.

    • Pause bridge HTTP connection. Might be helpful, if you want to pause connections while browser tab is unfocused, or if you use SDK with NodeJS and want to save server resources.

      Returns void

    • Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.

      Parameters

      • Optionaloptions: OptionalTraceable<{ openingDeadlineMS?: number; signal?: AbortSignal }>

      Returns 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.

      Parameters

      • Optionalnetwork: string

        desired network id (e.g., '-239', '-3', or custom). Pass undefined to allow any network.

      Returns void

    • Unpause bridge HTTP connection if it is paused.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods