Skip to content

Latest commit

 

History

History
251 lines (171 loc) · 9.66 KB

README.md

File metadata and controls

251 lines (171 loc) · 9.66 KB
Raw

Ledger Dev Tools


Visual Studio Marketplace Version Visual Studio Marketplace Installs Visual Studio Marketplace Rating

VS Code extension that provides a quick and easy way to build and test applications for Ledger devices.

The extension uses Ledger's own Docker image to allow developers to setup a build and test environment in a few minutes.

  • Build your app for all Ledger devices : Nano S, Nano S Plus, Nano X, Stax and Flex.
  • Supports C and Rust apps.
  • Stay up to date with the latest SDK.
  • Run tests on the device emulator (Speculos) or on a real device.
  • Supports multiple apps folders in the same workspace, each folder having its own Docker container.
  • See what's executed by the extension in VS Code's terminal panels.
  • Run development guidelines checks to ensure your app is ready to get deployed

Features

Tasks

Automatically add tasks to help you build, test and load your app on a physical device. These tasks are accessible through the build task menu keyboard shortcut to avoid clicking around.

Sidebar

The tasks are all accessible through an easy to use sidebar menu.

Status Bar

Status bar items to quickly identify :

  • Which device you are currently building your app for.
  • The status of the Ledger developer tools Docker image.

Requirements

  • Docker should be installed and running.
  • On macOS and Windows, make sure an X Window System server is installed and running (see XQuartz for mac and VcXsrv for windows). Otherwise, some testing tasks will not work. Make sure client connections are allowed.

Extension Settings

This extension contributes the following settings:

  • ledgerDevTools.onboardingPin: Set the device quick onboarding PIN code.
  • ledgerDevTools.onboardingSeed: Set the device quick onboarding 24-word Seed phrase.
  • ledgerDevTools.dockerImage: Set the Ledger developer tools Docker image.
  • ledgerDevTools.dockerRunArgs: Any additional command line args to pass to the docker run command for the Ledger developer tools Docker image.
  • ledgerDevTools.additionalReqsPerApp: Add prerequisites for current app's functional tests (for instance 'apk add python3-protobuf').
  • ledgerDevTools.keepTerminal: Indicates to keep the Terminal window opened after a successful task execution.
  • ledgerDevTools.openContainerAsRoot: Open docker container using root:root user.
  • ledgerDevTools.containerUpdateRetries: Set the max number of Container Update retries.
  • ledgerDevTools.userScpPrivateKey: Use the host's SCP_PRIVKEY environment variable when loading/deleting app on device. Cf. https://developers.ledger.com/docs/embedded-app/pin-bypass
  • ledgerDevTools.defaultDevice: Select the default Device
  • ledgerDevTools.enableDeviceOpsForNanoX: Allow device operations on Nano X (requires special development device)

Release Notes

[0.8.0]

  • Add new setting to Open Terminal as root (enabled by default).
  • Add item to run the Guideline Enforcer, with possibility to run a single check or all (by default)
  • Add xhost+ command when updating the container, to ensure compatibility with Ubuntu 24.04
  • Update the message for NanoX unsupported device operations
  • Fix menu selection (device, variant...) to not select the 1st item as soon as the menu is displayed
  • Fix BOLOS_SDK variable when entering the container

0.7.2

  • Added dockerRunArgs setting.

0.7.1

  • Fix regression on AppName detection on Windows platform
  • Fix Env variable in Deploy workflow

0.7.0

  • Update webpack and electron versions and dependencies
  • Update KeepTerminal to also include Load app on device and Delete app from device
  • Start Update Container task in background
  • 1st CI workflows to perform:
    • Spelling check
    • Build / Lint / Test (Fix Add CI with some checks and publishing mechanism #10)
    • Deploy (when a new tag is pushed)
  • Export the chosen device when opening the terminal (Fix Export currently chosen device when opening the terminal #15)
  • Add function to properly retrieve the APPNAME, using make listinfo (Fix Improve App detection #40)
  • Add build use case feature, allowing to build selecting a use case defined in the manifest (Fix Add an easy way to build with flags #14)
  • Add build variant feature, allowing to build a specific variant (Fix Add an easy way to build with flags #14)
  • Save the selected target device in settings (Fix Memorize target device when VS Code is quit #39)

0.6.1

  • Fix macOS venv creation for device operation tasks.

0.6.0

  • Flex device support.
  • Fix wording case for "Update container" task.

0.5.2

  • Fix plugin support on Windows : clone and build of test dependencies were not working properly.

0.5.1

  • Fix bugs introduced in 0.5.0 :
    • "dependsOn" task execution string was missing when generating tasks.
    • When one app detection failed, it prevented any app in the workspace to be detected afterwards.
    • Extension update was not triggered properly when selecting app through the quick pick menu.

0.5.0

  • New setting to allow / deny device operations on Nano X (denied by default).
  • Support parsing of test.dependencies fields from the app manifest specification. Speed up the setup for running functional tests by automating the clone/build of tests dependencies when needed.
  • Add button to rebuild test dependencies (if any) in treeview.
  • Refactor of appSelected.ts for better maintainability.
  • Replace TOML parsing package (previous one couldn't parse 1.0.0 TOML)
  • Update Udev rules for sideloading following hidapi python package update. Display warning message when rules need to be updated.
  • Wording in some tree view items.

0.4.0

  • Add "select all targets" command with a button in the main tree view.
  • Replace .png icons with vscode.ThemeIcon icons.
  • Fix app sideload task requirements installation on macOS.

0.3.4

  • Fix section titles in README.

0.3.3

  • Fix logo link in README.

0.3.2

  • Update README + displayed extension name.

0.3.1

  • Clean debug logs.

0.3.0

  • Support for new manifest (keep support of legacy Rust manifest and Makefile only C apps)
  • Rename tree view elements.
  • Fix target name bug for Rust apps.
  • Refactor code of TargetSelector, make it a real class.

0.2.1

  • Add command in group Functional Tests to run tests with option --golden_run.
  • Add setting parameter to use the host's SCP_PRIVKEY environment variable when loading/deleting app on device.
  • Add setting parameter to set the default device.

0.2.0

  • Add support for Rust apps (no sideloading yet).
  • Fix various display bugs.
  • Add welcome view when no app folder is detected in the workspace.
  • Dynamic tasks list : disable functional tests tasks when no conftest.py file is found or if task is not defined for app language.

0.1.6

  • Add setting parameter allowing to automatically close the terminal Window when the Container Update is successful.
  • Add setting parameter to set the max number of allowed Container Update retries avoiding the infinite loop.

0.1.5

  • Add 'delete app from device' feature.
  • Do a 'git submodule update --init --recursive' before the build tasks.

0.1.4

  • Remove unfinished 'delete app from device' feature.

0.1.3

  • Fix infinite container spawning loop bug on Windows (for real this time).

0.1.2

  • Better tooltips for sidebar items.
  • New command to add additional test dependencies in app docker container.
  • Fix infinite container spawning loop bug.

0.1.1

  • Add icons to side bar root items.
  • Add auto run of docker containers.

0.1.0

  • Code refactoring.
  • New tasks :
    • Run app in Speculos,
    • Kill Speculos,
    • On device functional tests,
    • Device quick onboarding.

0.0.6

Fixes app detection for Windows.

0.0.5

Add multi-folder workspace support. User can now choose which app to build from a quickpick menu.

0.0.4

Adds container terminal task to side bar items.

0.0.3

Fixes workspace path in docker run task for Windows.

0.0.2

Add extension icon.

0.0.1

Initial release of the extension.