Write and load the manifest | Developers

Write and load the manifest

Estimated reading time: 3 minutes

To be able to test and integrate your application, you first need to write your application Manifest file. This file must contain some mandatory information, such as the app package names, the components, the permissions needed, the hardware and software features, etc.

If you have followed instructions on the previous page, you should now be ready to interact with the Dapp directly from Ledger Live interface to make sure all the basic features work as expected.

To test and integrate your application, you first need to write your application Manifest file. This file must contain some mandatory information, such as the app package names, the components, the permissions needed, the hardware and software features, etc.

Check and if necessary edit your manifest file as described below.

Load your Live App locally on desktop

To load your Live App locally, Unlock the Developer mode in Ledger Live and add a local app.

Load your Live App locally on mobile (Android only)

Go to the Settings -> Developer section, and click on Load Platform Manifest you can copy your manifest here and load it.

Example of Manifest (JSON format) for the “Lido” application:

{
    "id": "lido",
    "name": "Lido",
    "url": "https://platform.apps.ledger.com/app/dapp-browser?dappName=Lido&nanoApp=Lido&url=https%3A%2F%2Fstake.lido.fi%2F%3Fref%3D0x558247e365be655f9144e1a0140D793984372Ef3%26embed%3Dtrue",
    "homepageUrl": "https://lido.fi/",
    "icon": "https://cdn.live.ledger.com/icons/platform/lido.png",
    "platform": "all",
    "apiVersion": "0.0.1",
    "manifestVersion": "1",
    "branch": "stable",
    "categories": [
      "staking",
      "defi"
    ],
    "currencies": [
      "ethereum"
    ],
    "content": {
      "shortDescription": {
        "en": "Stake your ETH with Lido to earn daily staking rewards."
      },
      "description": {
        "en": "Stake your ETH with Lido to earn daily staking rewards."
      }
    },
    "permissions": [],
    "domains": [
      "https://*"
    ]
  }

Here is the list of the mandatory fields required in your Manifest file:

Field Description Type
id The identification of your application. Must be in lowercase. String
name The name of your application ("Lido" in this example). String
url The URL of your application. Must be expressed in the following way "https://platform.apps.ledger.com/app/dapp-browser?dappName=Lido&nanoApp=Lido&url=YOUR_URL", with YOUR_URL encoded with a tool like this one. String
homepageUrl The homepage of your service. For instance, "https://www.google.fr/". String
icon A link to the icon displayed in the Ledger Live Discover section. Will be hosted on Ledger CDN before being released in production. URL
platform To set the platform (desktop, mobile, iOS, Android) on which your service is available. By default, you should set the value to "all". String
apiVersion The API version, by default "0.0.1".. String
manifestVersion The manifest version. By default should be "1". String
branch The specific branch used by Ledger to deploy the changes. Can take the values stable | experimental | debug | soon. By default, you should set it to "stable". The value “soon” will mark your app as “Coming soon” and it won’t be usable. String
categories A JSON array of metadata information about your application. For instance : ["staking","defi" ] Type: list(string). List(string)
currencies A JSON array of the currency/network being used by your application. For instance ["ethereum",”polygon”]. List(string)
content A description of your service. It will be displayed on the entry card of your application. Type: l18n strings. L18n strings
permissions
domains

Did you find this page helpful?


How would you improve this page for developers?



Add a provider
Plugin requirements and submission
Getting Started
Theme Features
Customization