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(comming soon) 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.

Ethereum Dapp Browser

Your DApp will be ran inside the Ethereum Dapp Browser, which is a separate application loaded inside Ledger Live to handle interactions between a Dapp and the Ledger Live application. Don’t hesitate to have a look at this project’s Readme to have more information on how to use it and what are the currently supported RPC calls.

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

Properties	Descripton	Type	Requirements
id	uniq id of your app	string	a-z \| 0-9 \|
author	Name of your organisation	string	optional \| *
name	Name of your live app (will be displayed and used to search your app inside the Discover section)	string	*
url	Url of the live app homepage (users will be redirected to this link once they open your app)	string (URL)	*
homepageUrl	Url of your organisation	string (URL)	optional \| *
supportUrl	Your support url	string (URL)	optional \| *
icon	Icon URL (will be displayed inside the Discover section)	string (URL)	optional \| *
platforms	Platform compatibility	Array(enum)	"ios", "android", "desktop"
apiVersion	Specific manifest schema version (leave it as default)	string	*
manifestVersion	Version supported by the app that the wallet needs to implement in order to support (leave it as default)	enum	2
categories	List of category related to your Live App (example)	Array(string)	items: min 1 → *
currencies	currencies supported by your Live App	Array(string)	items: min 1 → *
content	Descripton of your Live App (will be displayed inside the Discover section)	Object	{shortDescription: string, description: string}
permissions	List of permissions you will need in order to interact with wallet-api	enum
domains	___	Array(string)	optional
type	Type of you Live app	enum	"dapp", "walletApp", "webBrowser"
params	___	Object	depend on the type
visibility	Visibility of your live app inside Ledger Live. (Leave it as default)	string	"complete", "searchable", "deep"

Params

params when `type = "dapp"`

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

Params	Type	Requirements
dappUrl	string (URL)	*
nanoApp	string	*
dappName	string	*
networks	Array (unique Object)	(chainID: number, nodeURL: string, currency: enum)

params when `type = "walletApp"`

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

Params	Type	Requirements
any param	any	optional \| *

params when `type = "webBrowser"`

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

Params	Type	Requirements
webUrl	string (URL)	*
webAppName	string	*
currencies	Array (enum)	"ethereum", "bitcoin", ...

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": {
    "dappUrl": "http://localhost:3000/",
    "nanoApp": "ReplaceAppName",
    "dappName": "ReplaceAppName",
    "networks": [
      {
        "currency": "ethereum",
        "chainID": 1,
        "nodeURL": "..."
      }
    ]
  },
  "homepageUrl": "http://localhost:3000/",
  "platform": ["ios","android","desktop"],
  "apiVersion": "^1.0.0",
  "manifestVersion": "2",
  "branch": "stable",
  "categories": ["NFT", "Swap", "YourAppCategory"],
  "currencies": "*",
  "content": {
    "shortDescription": {
      "en": "Desc"
    },
    "description": {
      "en": "Desc"
    }
  },
  "permissions": [],
  "domains": ["http://*"],
  "visibility": "complete"
}

Transaction