vm

This is the Vanadium Risc-V VM app. For now, it's just boilerplate.

Vanadium VM for Ledger devices

Quick start guide

Vanadium binaries

You can download precompiled binaries, or compile them yourself as described below.

Precompiled binaries

You can download the latest version of the binaries from GitHub by launching the download_vanadium.sh script in the vm folder:

$ cd vm
$ bash download_vanadium.sh

Build with the Ledger VS Code extension

You can quickly setup a development environment on any platform (macOS, Linux or Windows) to build and test your application with Ledger's VS Code extension.

By using Ledger's own developer tools Docker image, the extension allows you to build your apps with the latest SDK, test them on Speculos and load them on any supported device.

• Install and run Docker.
• Make sure you have an X11 server running :
  • On Ubuntu Linux, it should be running by default.
  • On macOS, install and launch XQuartz (make sure to go to XQuartz > Preferences > Security and check "Allow client connections").
  • On Windows, install and launch VcXsrv (make sure to configure it to disable access control).
• Install VScode and add Ledger's extension.
• Open a terminal and clone vanadium with git clone git@github.com:LedgerHQ/vanadium.git.
• Open the vm folder in the vanadium repository with VSCode.
• Use Ledger extension's sidebar menu or open the tasks menu with ctrl + shift + b (command + shift + b on a Mac) to build the app, or load it on a device.

We recommend not to run the Vanadium app from the VSCode extension. Instead, install the Speculos emulator locally.

Emulator

After downloading the binaries or building, you can run the app directly on the Speculos emulator. For example, if you build the app for Flex:

speculos target/flex/release/app-vanadium

If you use just, you can also run:

just run-flex  # or run-nanosplus, run-nanox, run-stax, run-apex_p