跳到主要内容

Manifest creation

Manifest definition​

Every app needs a manifest to pass meta information to the wallet.

The manifest is a JSON file named tonconnect-manifest.json and has the following format:

{
    "url": "<app-url>",                        // required
    "name": "<app-name>",                      // required
    "iconUrl": "<app-icon-url>",               // required
    "termsOfUseUrl": "<terms-of-use-url>",     // optional
    "privacyPolicyUrl": "<privacy-policy-url>" // optional
}
FieldRequirementDescription
urlrequiredurl defines the app URL. It will be used to open the DApp after clicking its icon in the wallet. It is recommended to pass the URL without closing the slash, e.g., 'https://mydapp.com' instead of 'https://mydapp.com/'.
namerequiredname defines the app name. Typically simple word. Shouldn't be used as identifier.
iconUrlrequirediconUrl defines the URL to the app icon. It must be in PNG or ICO format. SVG icons are not supported. Perfectly pass the URL to a 180x180px PNG icon.
termsOfUseUrloptionalOptional for usual apps, but required for the apps placed in the Tonkeeper recommended apps list.
privacyPolicyUrloptionalOptional for usual apps, but required for the apps placed in the Tonkeeper recommended apps list.
信息

The original definition is here.

Example​

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

Best practices​

  • Place the manifest in the root of your app and repository, for example: https://myapp.com/tonconnect-manifest.json. It allows the wallet to handle your app better and improve the UX connected to your app.
  • The fields url, iconUrl, termsOfUseUrl, privacyPolicyUrl: must be publicly accessible from the internet and should be requestable from any origin without CORS restrictions.
  • The manifest must be publicly accessible from the internet and should be requestable from any origin without CORS restrictions.
  • Ensure that the manifest.json file is accessible via a GET request at its URL

See also​

Next steps​

  1. Add SDK to your project → SDK installation
  2. Check the Payload cookbook and craft custom transfers → Payload cookbook
Was this article useful?