Skip to content

LedgerHQ/app-streaming

Folders and files

NameName
Last commit message
Last commit date

Latest commit

082fe13 · Mar 13, 2024
Mar 13, 2024
Jul 13, 2022
May 25, 2022
Jul 26, 2022
May 23, 2022
Jul 27, 2022
Mar 3, 2022
Jul 5, 2022
Mar 4, 2022
May 11, 2022
Dec 15, 2022
Sep 4, 2023
Apr 14, 2022
Jun 27, 2022
Jul 5, 2022

Repository files navigation

ARCHIVED

📝 New repository:
Development continues in the Vanadium repository

DISCLAIMER

⚠️ THIS IS AN EXPERIMENTAL PROJECT.
Please don't start depending on it, and do not use it in production. Large parts of this project are subject to change, and there might be critical vulnerabilities.
This is an open source project developed by a dedicated team in Ledger, but it is not an official Ledger product.
⚠️

App Streaming

The App Streaming project allows running any app on Ledger Nano devices (X, S+, Stax) without restrictions such as memory limitations. Basically, the Ledger Nano runs a VM which can launch any app ; the (unlimited) memory is exported encrypted on the PC or the smartphone of the user.

For developers, development is now standard since there's no restriction on the stack, heap nor code size. Modern software stack can be used (which implies standard toolchains, tests, fuzzing tools and standard libraries) along usual development patterns. The code is totally independent from the firmware and the same app is compatible with Nano X, Nano S+ and Stax. An emulator such as speculos isn't required anymore and apps can be developed in Rust.

For end-users, it means that there's no restrictions on the number of apps since there's no app install anymore: all supported apps are immediately available. In a similary way, there are no no app updates anymore, app version is always the latest. Regarding the transport, there's no USB or BLE deconnection when switching from an app to another.

Usage

(Excerpt from docs/app-dev.md).

  1. Run the VM with speculos: speculos.py --model nanox vm/bin/app.elf
  2. Launch the app: ./host/stream.py --speculos --app ./app/build/app-swap/app-swap

Code

A few apps are available in the app/ folder:

The Nano RISC-V VM app is in vm/ and Python tools to interact with the VM app are in host/.

Once the project will be adopted more broadly, it will be split into several repositories. Meanwhile, it's more convenient to work on a mono-repo.

Build and test apps Build and test the Nano VM Build container images

Documentation

Technical and usage information can be found in the docs/ folder.

Licensing

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Community

Feel free to join the #streaming-project discord channel.