build

Tip:

• In releases, you will find a precompiled test app. If you are just curious, you can run install_app.sh and avoid building.

Download and install

Once the app is approved by Ledger, it will be available in their app store (Ledger Live). You can get pre-releases in two ways (THESE ARE UNVETTED DEVELOPMENT RELEASES):

• You can try here: https://hub.zondax.ch/polkadot
• Or you can download a sideloading script from releases. (We only recommend this for developers)

Development

Preconditions

• Be sure you checkout submodules too:

  git submodule update --init --recursive

• Install Docker CE

  • Instructions can be found here: https://docs.docker.com/install/

• We typically use Ubuntu or MacOS. Install the following packages:

  sudo apt update && apt-get -y install build-essential git wget cmake \
  libssl-dev libgmp-dev autoconf libtool

• Install poetry. This simplifies python environments

  https://python-poetry.org/docs/#installing-with-the-official-installer

• Install volta

  curl https://get.volta.sh | bash

• Then you can install node. We recommend at least >=18.0

  volta install node@20

• You will need python 3 and then run

  • make deps

  • The current repository keeps track of Ledger's SDK but it is possible to override it by changing the git submodule.

How to build ?

> We like clion or vscode but let's have some reproducible command line steps

>

• Building the app itself

  If you installed what is described above, just run:

  make

Running tests

• Running rust tests (x64)

  If you installed what is described above, just run:

  make rust_test

• Running C/C++ tests (x64)

  If you installed what is described above, just run:

  make cpp_test

• Running device emulation+integration tests!!

   Use Zemu! Explained below!

How to test with Zemu?

> What is Zemu?? Great you asked!! > As part of this project, we are making public a beta version of our internal testing+emulation framework for Ledger apps.

>

> Npm Package here: https://www.npmjs.com/package/@zondax/zemu

>

> Repo here: https://github.com/Zondax/zemu

Let's go! First install everything: > At this moment, if you change the app you will need to run make before running the test again.

make zemu_install

Then you can run JS tests:

make zemu_test

To run a single specific test:

> At the moment, the recommendation is to run from the IDE. Remember to run make if you change the app.

Using a real device

How to prepare your DEVELOPMENT! device:

> You can use an emulated device for development. This is only required if you are using a physical device

>

> Please do not use a Ledger device with funds for development purposes. >> > Have a separate and marked device that is used ONLY for development and testing

There are a few additional steps that increase reproducibility and simplify development:

1 - Ensure your device works in your OS

• In Linux hosts it might be necessary to adjust udev rules, etc.

  Refer to Ledger documentation: https://support.ledger.com/hc/en-us/articles/115005165269-Fix-connection-issues

2 - Set a test mnemonic

Many of our integration tests expect the device to be configured with a known test mnemonic.

• Plug your device while pressing the right button

• Your device will show "Recovery" in the screen

• Double click

• Run make dev_init. This will take about 2 minutes. The device will be initialized to:

  PIN: 5555
  Mnemonic: equip will roof matter pink blind book anxiety banner elbow sun young

3 - Add a development certificate

• Plug your device while pressing the right button

• Your device will show "Recovery" in the screen

• Click both buttons at the same time

• Enter your pin if necessary

• Run make dev_ca. The device will receive a development certificate to avoid constant manual confirmations.

Building the Ledger App

Loading into your development device

The Makefile will build the firmware in a docker container and leave the binary in the correct directory.

• Build

  make                # Builds the app

• Upload to a device

  The following command will upload the application to the ledger:

  Warning: The application will be deleted before uploading.

  make load          # Builds and loads the app to the device

APDU Specifications

• APDU Protocol