Class TonConnectUI

constructor

• new TonConnectUI(options?: TonConnectUiCreateOptions): TonConnectUI

  Parameters

  • Optionaloptions: TonConnectUiCreateOptions

  Returns TonConnectUI

ReadonlyconnectionRestored

Readonlyconnector

Readonlymodal

account

• get account(): null | Account

  Current connected account or null.

  Returns null | Account

connected

• get connected(): boolean

  Current connection status.

  Returns boolean

modalState

• get modalState(): WalletsModalState

  Returns current modal window state.

  Returns WalletsModalState

singleWalletModalState

• get singleWalletModalState(): SingleWalletModalState
  Experimental

  Returns current single wallet modal window state.

  Returns SingleWalletModalState

uiOptions

• set uiOptions(options: TonConnectUiOptions): void

  Set and apply new UI options. Object with partial options should be passed. Passed options will be merged with current options.

  Parameters

  • options: TonConnectUiOptions

  Returns void

wallet

• get wallet(): null | Wallet | (Wallet & WalletInfoWithOpenMethod)

  Curren connected wallet app and its info or null.

  Returns null | Wallet | (Wallet & WalletInfoWithOpenMethod)

walletsPreferredFeatures

• get walletsPreferredFeatures(): undefined | RequiredFeatures

  Returns undefined | RequiredFeatures

walletsRequiredFeatures

• get walletsRequiredFeatures(): undefined | RequiredFeatures

  Returns undefined | RequiredFeatures

closeModal

• closeModal(reason?: WalletsModalCloseReason): void

  Closes the modal window.

  Parameters

  • Optionalreason: WalletsModalCloseReason

  Returns void

closeSingleWalletModal

• closeSingleWalletModal(closeReason?: WalletsModalCloseReason): void
  Experimental

  Close the single wallet modal window.

  Parameters

  • OptionalcloseReason: WalletsModalCloseReason

  Returns void

connectWallet

• connectWallet(options?: { traceId?: string }): Promise<ConnectedWallet>

  Parameters

  • Optionaloptions: { traceId?: string }

  Returns Promise<ConnectedWallet>

  Connected wallet.

  Deprecated

  Use tonConnectUI.openModal() instead. Will be removed in the next major version. Opens the modal window and handles a wallet connection.

  Throws

  TonConnectUIError if connection was aborted.

disconnect

• disconnect(options?: { traceId?: string }): Promise<void>

  Disconnect wallet and clean localstorage.

  Parameters

  • Optionaloptions: { traceId?: string }

  Returns Promise<void>

getWallets

• getWallets(): Promise<WalletInfo[]>

  Returns available wallets list.

  Returns Promise<WalletInfo[]>

makeSendActionIntent

• makeSendActionIntent(
      intent: MakeSendActionIntentRequest,
      options?: OptionalTraceable<{ walletUniversalLink?: string }>,
  ): Promise<string>

  Generates a universal link for a send action intent and opens a modal with QR code. This allows users to complete actions via a dynamic action URL without being connected to the wallet.

  Parameters

  • intent: MakeSendActionIntentRequest

    action intent request.
  • Optionaloptions: OptionalTraceable<{ walletUniversalLink?: string }>

    (optional) options including traceId and wallet universal link.

  Returns Promise<string>

  universal link that can be opened in a wallet or displayed as QR code.

makeSendTransactionIntent

• makeSendTransactionIntent(
      intent: MakeSendTransactionIntentRequest,
      options?: OptionalTraceable<{ walletUniversalLink?: string }>,
  ): Promise<string>

  Generates a universal link for a send transaction intent and opens a modal with QR code. This allows users to complete transactions without being connected to the wallet.

  Parameters

  • intent: MakeSendTransactionIntentRequest

    transaction intent request.
  • Optionaloptions: OptionalTraceable<{ walletUniversalLink?: string }>

    (optional) options including traceId and wallet universal link.

  Returns Promise<string>

  universal link that can be opened in a wallet or displayed as QR code.

makeSignDataIntent

• makeSignDataIntent(
      intent: MakeSignDataIntentRequest,
      options?: OptionalTraceable<{ walletUniversalLink?: string }>,
  ): Promise<string>

  Generates a universal link for a sign data intent and opens a modal with QR code. This allows users to sign data without being connected to the wallet.

  Parameters

  • intent: MakeSignDataIntentRequest

    sign data intent request.
  • Optionaloptions: OptionalTraceable<{ walletUniversalLink?: string }>

    (optional) options including traceId and wallet universal link.

  Returns Promise<string>

  universal link that can be opened in a wallet or displayed as QR code.

makeSignMessageIntent

• makeSignMessageIntent(
      intent: MakeSignMessageIntentRequest,
      options?: OptionalTraceable<{ walletUniversalLink?: string }>,
  ): Promise<string>

  Generates a universal link for a sign message intent and opens a modal with QR code. This allows users to sign messages without being connected to the wallet.

  Parameters

  • intent: MakeSignMessageIntentRequest

    sign message intent request.
  • Optionaloptions: OptionalTraceable<{ walletUniversalLink?: string }>

    (optional) options including traceId and wallet universal link.

  Returns Promise<string>

  universal link that can be opened in a wallet or displayed as QR code.

onIntentResponse

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

  Subscribe to intent response events. This allows you to receive responses from intents (e.g., transaction results, sign data results).

  Parameters

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

    will be called when an intent response is received.

  Returns () => void

  unsubscribe function.

onModalStateChange

• onModalStateChange(onChange: (state: WalletsModalState) => void): () => void

  Subscribe to the modal window state changes, returns a function which has to be called to unsubscribe.

  Parameters

  • onChange: (state: WalletsModalState) => void

  Returns () => void

onSingleWalletModalStateChange

• onSingleWalletModalStateChange(
      onChange: (state: SingleWalletModalState) => void,
  ): () => void
  Experimental

  Subscribe to the single wallet modal window state changes, returns a function which has to be called to unsubscribe.

  Parameters

  • onChange: (state: SingleWalletModalState) => void

  Returns () => void

onStatusChange

• onStatusChange(
      callback: (wallet: null | ConnectedWallet) => void,
      errorsHandler?: (err: TonConnectError) => void,
  ): () => void

  Subscribe to connection status change.

  Parameters

  • callback: (wallet: null | ConnectedWallet) => void
  • OptionalerrorsHandler: (err: TonConnectError) => void

  Returns () => void

  function which has to be called to unsubscribe.

openModal

• openModal(options?: { traceId?: string }): Promise<void>

  Opens the modal window, returns a promise that resolves after the modal window is opened.

  Parameters

  • Optionaloptions: { traceId?: string }

  Returns Promise<void>

openSingleWalletModal

• openSingleWalletModal(wallet: string): Promise<void>
  Experimental

  Opens the single wallet modal window, returns a promise that resolves after the modal window is opened.

  Parameters

  • wallet: string

  Returns Promise<void>

sendTransaction

• sendTransaction(
      tx: SendTransactionRequest,
      options?: ActionConfiguration & { traceId?: string } & {
          onRequestSent?: (redirectToWallet: () => void) => void;
      },
  ): Promise<OptionalTraceable<SendTransactionResponse>>

  Opens the modal window and handles the transaction sending.

  Parameters

  • tx: SendTransactionRequest

    transaction to send.
  • Optionaloptions: ActionConfiguration & { traceId?: string } & {
        onRequestSent?: (redirectToWallet: () => void) => void;
    }

    modal and notifications behaviour settings. Default is show only 'before' modal and all notifications.

  Returns Promise<OptionalTraceable<SendTransactionResponse>>

setConnectionNetwork

• setConnectionNetwork(network?: string): 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

setConnectRequestParameters

• setConnectRequestParameters(
      connectRequestParameters:
          | undefined
          | null
          | Loadable<ConnectAdditionalRequest>,
  ): void

  Use it to customize ConnectRequest and add tonProof payload. You can call it multiply times to set updated tonProof payload if previous one is outdated. If connectRequestParameters.state === 'loading' loader will appear instead of the qr code in the wallets modal. If connectRequestParameters.state was changed to 'ready' or it's value has been changed, QR will be re-rendered.

  Parameters

  • connectRequestParameters: undefined | null | Loadable<ConnectAdditionalRequest>

  Returns void

setIntentConnectRequestParameters

• setIntentConnectRequestParameters(
      options:
          | undefined
          | null
          | {
              includeConnect: boolean;
              includeTonProof?: boolean;
              tonProofPayload?: string;
          },
  ): void

  Configure connect request parameters for intents.

  Parameters

  • options:
        | undefined
        | null
        | {
            includeConnect: boolean;
            includeTonProof?: boolean;
            tonProofPayload?: string;
        }

    Configuration options:

    • includeConnect: if true, intents will include a connect request
    • includeTonProof: if true and includeConnect is true, ton_proof will be included in the connect request
    • tonProofPayload: optional payload for ton_proof (if not provided, will be generated automatically)

  Returns void

signData

• signData(
      data: SignDataPayload,
      options?: OptionalTraceable<
          { onRequestSent?: (redirectToWallet: () => void) => void },
      >,
  ): Promise<SignDataResponse>

  Signs the data and returns the signature.

  Parameters

  • data: SignDataPayload

    data to sign.
  • Optionaloptions: OptionalTraceable<{ onRequestSent?: (redirectToWallet: () => void) => void }>

  Returns Promise<SignDataResponse>

signMessage

• signMessage(
      message: SignMessageRequest,
      options?: ActionConfiguration & { traceId?: string } & {
          onRequestSent?: (redirectToWallet: () => void) => void;
      },
  ): Promise<OptionalTraceable<SignMessageResponse>>

  Signs the message and returns the signed boc.

  Parameters

  • message: SignMessageRequest

    message to sign.
  • Optionaloptions: ActionConfiguration & { traceId?: string } & {
        onRequestSent?: (redirectToWallet: () => void) => void;
    }

  Returns Promise<OptionalTraceable<SignMessageResponse>>

StaticgetWallets

• getWallets(): Promise<WalletInfo[]>

  Returns Promise<WalletInfo[]>