Platform App Web Browser

Run your Web Application inside Ledger Live

Full documentation · Report Bug · Request Feature

Purpose

This is an application leveraging Ledger Platform SDK to run websites needing cryptocurency address inside a Ledger product (for example Ledger Live). Some examples of websites that can be used with this Web Browser are rainbow.me or poap.xyz.

How to use it

To make your website use this application, you will need to create a manifest and customize the params object based on your website.

Here is an example for the rainbow.me website (with the Web Browser running in local hence the "url": "http://localhost:3000"):

{
  "id": "rainbow",
  "name": "Rainbow.me",
  "url": "http://localhost:3000",
  "params": {
    "webUrl": "https://rainbow.me/{account.address}",
    "webAppName": "Rainbow.me",
    "currencies": ["ethereum"]
  },
  "homepageUrl": "https://rainbow.me",
  "icon": "https://cdn.live.ledger.com/icons/platform/rainbow.png",
  "platform": "all",
  "apiVersion": "^1.0.0 || ~0.0.1",
  "manifestVersion": "1",
  "branch": "stable",
  "categories": ["nft"],
  "currencies": ["ethereum"],
  "content": {
    "shortDescription": {
      "en": "An easy way to visualize the NFT secured by your hardware wallet."
    },
    "description": {
      "en": "An easy way to visualize the NFT secured by your hardware wallet."
    }
  },
  "permissions": [],
  "domains": ["https://*"]
}

Here is a description of the params fields:

webUrl: the url of your website. Use the {account.address} placeholder in the url where you expect a cryptocurency address to be provided.
webAppName: the user readable name of your website
currencies: the list of currencies handled by you website

How to run it

This is a nextjs bootstrapped application, don't hesitate to head over to their website and doc for further details on this framework.

Install dependencies

yarn

Run locally

yarn dev

Format

Check code formatting with

yarn format:check

Format source files in-place with

yarn format:fix

Lint

Check code quality with

yarn lint:check

Automatically fix code quality problems with

yarn lint:fix