Manifest

If you want to know more about the Discover tab and the Live Apps in general, you can read this page : Start here (opens in a new tab)

What is a manifest ?

A Manifest is a config file that allows external applications and decentralized applications (dApps) to be integrated inside the Ledger Live software as a Live app and interact with all provided features.

If you have followed instructions on the How to create a Live app 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.

Manifest properties

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.

You don't have to fill in all the fields; we'll fill them in once your integration has been confirmed.

However, here are a few elements you'll need to fill in yourself and their descriptions :

To be filled in by you

Params

params when type = "dapp"

Your app uses the ETH DApp Browser (opens in a new tab)

params when type = "walletApp"

Your app uses the Wallet API (opens in a new tab)

params when type = "webBrowser"

Your app uses the Platform App Web Browser (opens in a new tab)

Permissions

Permissions that allow your app to interact with methods :

"permissions": [
 
    // Account and currencies
    "account.list", 
    "account.receive", 
    "account.request",
    "currency.list",
 
    // Device permissions
    "device.close",
    "device.exchange",
    "device.transport",
 
    // Transaction
    "message.sign",
    "transaction.sign",
    "transaction.signAndBroadcast",
 
    // Wallet Info
    "wallet.capabilities",
    "wallet.info",
    "wallet.userId"
 
  ],
 

Default values

Complete manifest.json file with default or examples values :

{
  "id": "ReplaceAppName",
  "name": "ReplaceAppName",
  "url": "http://localhost:3000",
  "params": {
    "exampleParam": "value"
  },
  "homepageUrl": "http://localhost:3000/",
  "platform": ["ios","android","desktop"],
  "apiVersion": "^2.0.0",
  "manifestVersion": "2",
  "branch": "stable",
  "categories": ["NFT", "Swap", "YourAppCategory"],
  "currencies": "*",
  "content": {
    "shortDescription": {
      "en": "Desc"
    },
    "description": {
      "en": "Desc"
    }
  },
  "permissions": [],
  "domains": ["http://*"],
  "visibility": "complete"
}

Manifest Overrides Guide

Introduction to Overrides

In the context of app manifests, the overrides feature offers a powerful mechanism to create conditional modifications to your manifest. With this feature, you can specify different values for specific conditions, such as Ledger Live versions (llVersion) and device (platform). This ensures a tailored experience across multiple versions and platforms without the need for separate manifest files.

Structure of Overrides

Inside your manifest, you can include an overrides section to define conditions and their corresponding modifications. Here's how you can structure them:

1. ledgerLiveVersion Overrides: Allows you to define variations of the manifest specific to different Ledger Live versions.

Request: /api/v1/apps?llVersion=1.0.0

"overrides": [
  {
    "version": "1.0.0",
    "changes": {
      "name": "overridden manifest"
    }
  }
]

In this example, users with Ledger Live version 1.0.0 will see the app name as "overridden manifest".

2. Platform Overrides: Enables you to tailor the manifest for specific platforms like iOS, Android, etc.

Request param:

• /api/v1/apps?platform=ios

• /api/v1/apps?platform=android

  "overrides": [
    {
      "platform": "ios",
      "changes": {
        "name": "overridden for iOS"
      }
    },
    {
      "platform": "android",
      "changes": {
        "name": "overridden for Android"
      }
    }
  ]

  Depending on the user's device platform, they will see a different app name – "overridden for iOS" on Apple devices and "overridden for Android" on Android devices.

Depth Limitation in Overrides

Only the first depth of fields can be overridden, meaning granular changes to nested properties are not supported directly. To override a field with nested properties, the entire field, including all nested properties, must be redefined.

For example, you cannot override just a nested url:

"overrides": [
 {
   "platform": "ios",
   "changes": {
     "params": {
       "url": "new-url"
     }
   }
 }
]

Instead, you need to redefine the entire params field:

"overrides": [
  {
    "platform": "ios",
    "changes": {
      "params": {
        "url": "new-url",
        "anotherField": "value",
        "yetAnotherField": "anotherValue"
      }
    }
  }
]

Activating Overrides

Overrides are activated when the manifest is requested with specific parameters. Here are the supported parameters and how they activate the overrides:

1. ledgerLiveVersion: Activated by calling with the llVersion parameter.

   Will return all defaults manifests with the 1.0.0 overr if it exist:

   http://localhost:3000/api/v1/apps?llVersion=1.0.0

2. Platform: Activated by calling with the platform parameter. The platforms field inside the manifest will be replaced accordingly.

   Will return all defaults manifests and override for iOS and replace the platforms field in the manifest with ["ios"] if it exist inside the manifest :

   http://localhost:3000/api/v1/apps?platform=ios

3. Combining Parameters: You can combine multiple parameters to activate multiple overrides.

   Apply overrides for both Ledger Live version 1.0.0 and the iOS platform :

   http://localhost:3000/api/v1/apps?llVersion=1.0.0&platform=ios

Priority in Overrides

In cases where both ledgerLiveVersion and platform might have overriding values for the same field, the priority is determined by their order in the manifest. Whichever is listed first takes precedence.

Override Process for Specific Platform Requests

When a request specifies a platform, such as 'ios' (?platform=ios), the system performs an override process as follows:

Request: ?platform=ios

Manifest before override:
{
  "platforms": ["desktop", "android"],
  "overrides": [
    {
      "platform": "ios",
      "changes": {
        "visibility": "searchable"
      }
    }
  ]
}

It begins with the main manifest as the default. Searches for any overrides within the manifest relevant to the requested platform (here "platform": "ios"), and applies them to the default fields. Returns a manifest specific for the requested platform, in this case 'ios'.

{
    "platforms": ["ios"],
    "visibility": "searchable"
}