跳到主要内容

Manifest creation

Manifest definition​

To integrate with wallets through TON Connect, every app must include a manifest file that provides essential metadata.

The manifest is a JSON file named tonconnect-manifest.json, and it must follow the format below:

{
    "url": "<app-url>",                        // required
    "name": "<app-name>",                      // required
    "iconUrl": "<app-icon-url>",               // required
    "termsOfUseUrl": "<terms-of-use-url>",     // optional
    "privacyPolicyUrl": "<privacy-policy-url>" // optional
}
FieldRequiredDescription
urlYesDefines the DApp’s base URL. It is used to open the app when a user taps its icon in the wallet. The URL should not include a trailing slash — for example, use https://mydapp.com instead of https://mydapp.com/.
nameYesDefines the app name; it should be a simple word or phrase and is not used as a unique identifier.
iconUrlYesDefines the URL to the app icon. Must be in PNG or ICO format. SVG is not supported. Ideally, use a 180x180px PNG.
termsOfUseUrlOptionalOptional for most apps, but mandatory for those listed in the Tonkeeper recommended apps list.
privacyPolicyUrlOptionalOptional for most apps, but mandatory for those listed in the Tonkeeper recommended apps list.
信息

For reference, see the TON Connect specification.

Example​

{
    "url": "https://ton.vote",
    "name": "TON Vote",
    "iconUrl": "https://ton.vote/logo.png"
}

Best practices​

  1. Place the manifest file in the root of your app and repository.

For example: https://myapp.com/tonconnect-manifest.json. This helps wallets discover your app more reliably and enhances the overall user experience when users connect to it.

  1. The fields url, iconUrl, termsOfUseUrl, and privacyPolicyUrl must be publicly accessible from any origin without CORS restrictions.
  2. Ensure the manifest.json is accessible and can be retrieved through a GET request to its URL.

See also​

Next steps​

Add the SDK to the project and explore the payload cookbook to start building with TON Connect.

Install SDK

Check payload cookbook
Was this article useful?