Class TonConnect

constructor

• new TonConnect(options?: TonConnectOptions): TonConnect

  Parameters

  • Optionaloptions: TonConnectOptions

  Returns TonConnect

StaticisInsideWalletBrowser

StaticisWalletInjected

account

• get account(): null | Account

  Current connected account or null if no account is connected.

  Returns null | Account

connected

• get connected(): boolean

  Shows if the wallet is connected right now.

  Returns boolean

wallet

• get wallet(): null | Wallet

  Current connected wallet or null if no account is connected.

  Returns null | Wallet
• set wallet(value: null | Wallet): void

  Current connected wallet or null if no account is connected.

  Parameters

  • value: null | Wallet

  Returns void

connect

• connect<
      T extends
          | WalletConnectionSource
          | Pick<WalletConnectionSourceHTTP, "bridgeUrl">[],
  >(
      wallet: T,
      options?: OptionalTraceable<
          {
              openingDeadlineMS?: number;
              request?: ConnectAdditionalRequest;
              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.
  • Optionaloptions: OptionalTraceable<
        {
            openingDeadlineMS?: number;
            request?: ConnectAdditionalRequest;
            signal?: AbortSignal;
        },
    >

    (optional) openingDeadlineMS for the connection opening deadline and signal for the connection abort.

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

  universal link if external wallet was passed or void for the injected 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

  Type Parameters

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

  Parameters

  • wallet: T
  • Optionalrequest: ConnectAdditionalRequest
  • Optionaloptions: OptionalTraceable<{ openingDeadlineMS?: number; signal?: AbortSignal }>

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

  Deprecated

  use connect(wallet, options) instead

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: (wallet: null | Wallet) => void,
      errorsHandler?: (err: TonConnectError) => void,
  ): () => void

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

  Parameters

  • callback: (wallet: 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<Traceable<SendTransactionResponse>>

  Asks connected wallet to sign and send the transaction.

  Parameters

  • transaction: SendTransactionRequest

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

    (optional) onRequestSent will be called after the request was sent to the wallet and signal for the transaction abort.

  Returns Promise<Traceable<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<Traceable<SendTransactionResponse>>

  Parameters

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

  Returns Promise<Traceable<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<Traceable<SignDataResponse>>

  Parameters

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

  Returns Promise<Traceable<SignDataResponse>>

unPauseConnection

• unPauseConnection(): Promise<void>

  Unpause bridge HTTP connection if it is paused.

  Returns Promise<void>

StaticgetWallets

• getWallets(): Promise<WalletInfo[]>

  Returns available wallets list.

  Returns Promise<WalletInfo[]>