Interface ITonConnect

account

connected

wallet

connect

• 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

  Generates universal link for an external wallet and subscribes to the wallet's bridge, or sends connect request to the injected wallet.

  Type Parameters

  • T extends WalletConnectionSource | Pick<WalletConnectionSourceHTTP, "bridgeUrl">[]

  Parameters

  • wallet: T

    wallet's bridge url and universal link for an external wallet or jsBridge key for the injected wallet, or list of bridges urls for creating an universal connection request for the corresponding wallets.
  • Optionalrequest: ConnectAdditionalRequest

    (optional) additional request to pass to the wallet while connect (currently only ton_proof is available).
  • Optionaloptions: OptionalTraceable<{ openingDeadlineMS?: number; signal?: AbortSignal }>

    (optional) options

  Returns T extends WalletConnectionSourceJS
      ? void
      : T extends WalletConnectionSourceWalletConnect ? void : string

  universal link if external wallet was passed or void for the injected wallet.

disconnect

• disconnect(options?: OptionalTraceable<{ signal?: AbortSignal }>): Promise<void>

  Disconnect form thw connected wallet and drop current session.

  Parameters

  • Optionaloptions: OptionalTraceable<{ signal?: AbortSignal }>

  Returns Promise<void>

getSessionId

• getSessionId(): Promise<null | string>

  Gets the current session ID if available.

  Returns Promise<null | string>

  session ID string or null if not available.

getWallets

• getWallets(): Promise<WalletInfo[]>

  Returns available wallets list.

  Returns Promise<WalletInfo[]>

onStatusChange

• onStatusChange(
      callback: (walletInfo: null | Wallet) => void,
      errorsHandler?: (err: TonConnectError) => void,
  ): () => 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.

pauseConnection

• pauseConnection(): void

  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

restoreConnection

• restoreConnection(
      options?: OptionalTraceable<
          { openingDeadlineMS?: number; signal?: AbortSignal },
      >,
  ): Promise<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>

sendTransaction

• sendTransaction(
      transaction: SendTransactionRequest,
      options?: OptionalTraceable<
          { onRequestSent?: () => void; signal?: AbortSignal },
      >,
  ): Promise<OptionalTraceable<SendTransactionResponse>>

  Asks connected wallet to sign and send the transaction.

  Parameters

  • transaction: SendTransactionRequest

    transaction to send.
  • Optionaloptions: OptionalTraceable<{ onRequestSent?: () => void; signal?: AbortSignal }>

    (optional) onRequestSent callback will be called after the transaction is sent and signal to abort the request.

  Returns Promise<OptionalTraceable<SendTransactionResponse>>

  signed transaction boc that allows you to find the transaction in the blockchain. If user rejects transaction, method will throw the corresponding error.
• sendTransaction(
      transaction: SendTransactionRequest,
      onRequestSent?: () => void,
  ): Promise<OptionalTraceable<SendTransactionResponse>>

  Parameters

  • transaction: SendTransactionRequest
  • OptionalonRequestSent: () => void

  Returns Promise<OptionalTraceable<SendTransactionResponse>>

  Deprecated

  use sendTransaction(transaction, options) instead

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

signData

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

  Parameters

  • data: SignDataPayload
  • Optionaloptions: OptionalTraceable<{ onRequestSent?: () => void; signal?: AbortSignal }>

  Returns Promise<OptionalTraceable<SignDataResponse>>

unPauseConnection

• unPauseConnection(): Promise<void>

  Unpause bridge HTTP connection if it is paused.

  Returns Promise<void>