Interface TonConnectOptions

TonConnect constructor options

Hierarchy

  • TonConnectOptions

Properties

disableAutoPauseConnection? eventDispatcher? manifestUrl? storage? walletsListCacheTTLMs? walletsListSource?

Properties

Optional disableAutoPauseConnection

disableAutoPauseConnection?: boolean

Allows to disable auto pause/unpause SSE connection on 'document.visibilitychange' event. It is not recommended to change default behaviour.

Optional eventDispatcher

eventDispatcher?: EventDispatcher<SdkActionEvent>

Event dispatcher to track user actions. By default, it uses window.dispatchEvent for browser environment.

Optional manifestUrl

manifestUrl?: string

Url to the [manifest]https://github.com/ton-connect/docs/blob/main/requests-responses.md#app-manifest with the Dapp metadata that will be displayed in the user's wallet. If not passed, manifest from ${window.location.origin}/tonconnect-manifest.json will be taken.

Optional storage

storage?: IStorage

Storage to save protocol data. For browser default is localStorage. If you use SDK with nodeJS, you have to specify this field.

Optional walletsListCacheTTLMs

walletsListCacheTTLMs?: number

Wallets list cache time to live

Default

Infinity

Optional walletsListSource

walletsListSource?: string

Redefine wallets list source URL. Must be a link to a json file with [following structure]https://github.com/ton-connect/wallets-list

Default

https://raw.githubusercontent.com/ton-connect/wallets-list/main/wallets.json @

Settings

Member Visibility

Theme

Generated using TypeDoc