Merge pull request #247 from LedgerHQ/y333/motherfucker_readme

yogh333 · web-flow · commit 42c02cc8daed · 2025-02-27T15:55:49.000+01:00
Y333/motherfucker readme
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -2,12 +2,12 @@ name: Publish to Crates.io
 
 on:
   push:
-    tags:
-      - '*@*.*.*'  # Match tags like 'package1@1.2.3'
+    branches:
+      - master
   workflow_dispatch:  # Allow manual workflow dispatch
 
 jobs:
-  test-dry-run:
+  dry-run-publish:
     runs-on: ubuntu-latest
     if: github.event_name == 'workflow_dispatch'  # Only run this job for manual triggers
 
@@ -21,33 +21,31 @@ jobs:
           profile: minimal
           toolchain: stable
 
-      - name: Retrieve Package Names from workspace root
-        id: get-root-packages
-        run: |
-          # Retrieve package names from the workspace root
-          PACKAGE_NAMES=$(cargo metadata --format-version=1 --no-deps | jq -r '.packages[].name' | tr '\n' ' ')
-
-          # Set the package names as an output
-          echo "Package names from root Cargo.toml: $PACKAGE_NAMES"
-          echo "::set-output name=package-names::$PACKAGE_NAMES"
-        shell: bash
-        working-directory: ${{ github.workspace }}
-
       - name: Test Dry-Run Publish for Each Package
         run: |
           # Iterate through package names retrieved
-          PACKAGE_NAMES="${{ steps.get-root-packages.outputs.package-names }}"
+          PACKAGE_NAMES="testmacro include_gif ledger_secure_sdk_sys ledger_device_sdk"
           for PACKAGE_NAME in $PACKAGE_NAMES; do
-            # Test a dry-run publish for each package within the workspace
-            cargo publish --dry-run --no-verify --token ${{ secrets.CARGO_REGISTRY_TOKEN }} --package "$PACKAGE_NAME"
+            # Test a dry-run publish for each package within the workspace if required
+            last_published_version=$(cargo search -q --limit 1 $PACKAGE_NAME | grep -oP '\d+\.\d+\.\d+')
+            echo "Published version of $PACKAGE_NAME is $version_published"
+            manifest_version=$(cargo metadata --format-version=1 --no-deps | jq -r --arg PACKAGE_NAME "$PACKAGE_NAME" '.packages[] | select(.name == $PACKAGE_NAME) | .version')
+            echo "Current version in manifest for $PACKAGE_NAME is $manifest_version"
+            if [ "$last_published_version" == "$manifest_version" ]; then
+              echo "Package $PACKAGE_NAME is already published with version $manifest_version."
+            else
+              echo "Package $PACKAGE_NAME is not published with version $manifest_version."
+              echo "Dry-run publishing $PACKAGE_NAME..."
+              cargo publish --dry-run --no-verify --token ${{ secrets.CARGO_REGISTRY_TOKEN }} --package "$PACKAGE_NAME"
+            fi
           done
         env:
           CARGO_TERM_COLOR: always
         working-directory: ${{ github.workspace }}
 
-  build-and-publish:
+  crates-io-publish:
     runs-on: ubuntu-latest
-    if: github.event_name == 'push'  # Only run this job for tag pushes
+    if: github.event_name == 'push'  # Only run this job for pushes
 
     steps:
       - name: Checkout Code
@@ -58,48 +56,25 @@ jobs:
         with:
           profile: minimal
           toolchain: stable
-
-      - name: Determine Package to Publish
-        id: determine-package
-        run: |
-          # Extract package name from the tag name
-          TAG_NAME="${{ github.ref }}"
-          PACKAGE_NAME=$(echo "$TAG_NAME" | cut -d'/' -f3 | cut -d'@' -f1)
-
-          PACKAGE_NAMES=$(cargo metadata --format-version=1 --no-deps | jq -r '.packages[].name' | tr '\n' ' ')
-
-          # Check if the extracted package name is a valid package in the workspace root Cargo.toml
-          if [[ ! " $PACKAGE_NAMES " =~ " $PACKAGE_NAME " ]]; then
-            echo "Invalid package name: $PACKAGE_NAME"
-            exit 1
-          fi
-          echo "Package to publish: $PACKAGE_NAME"
-          echo "::set-output name=package::$PACKAGE_NAME"
-        shell: bash
-        working-directory: ${{ github.workspace }}
-
-      - name: Check Package Version
-        id: check-version
-        run: |
-          PACKAGE_NAME="${{ steps.determine-package.outputs.package }}"
-          TAG_VERSION=$(echo "${{ github.ref }}" | cut -d'@' -f2)
-          MANIFEST_VERSION=$(cargo metadata --format-version=1 --no-deps | jq -r --arg PACKAGE_NAME "$PACKAGE_NAME" '.packages[] | select(.name == $PACKAGE_NAME) | .version')
-
-          if [ "$TAG_VERSION" != "$MANIFEST_VERSION" ]; then
-            echo "Package version in manifest $MANIFEST_VERSION does not match tag version $TAG_VERSION."
-            exit 1
-          else
-            echo "Package version in manifest matches tag version."
-          fi
-        shell: bash
-        working-directory: ${{ github.workspace }}
-
-      - name: Build and Publish
+      
+      - name: Publish Package on crates.io if required
         run: |
-          PACKAGE_NAME="${{ steps.determine-package.outputs.package }}"
-
-          # Publish the specified package within the workspace to crates.io
-          cargo publish --no-verify --token ${{ secrets.CARGO_REGISTRY_TOKEN }} --package "$PACKAGE_NAME"
+          # Iterate through package names retrieved
+          PACKAGE_NAMES="testmacro include_gif ledger_secure_sdk_sys ledger_device_sdk"
+          for PACKAGE_NAME in $PACKAGE_NAMES; do
+            # Publish each package within the workspace if required
+            last_published_version=$(cargo search -q --limit 1 $PACKAGE_NAME | grep -oP '\d+\.\d+\.\d+')
+            echo "Published version of $PACKAGE_NAME is $version_published"
+            manifest_version=$(cargo metadata --format-version=1 --no-deps | jq -r --arg PACKAGE_NAME "$PACKAGE_NAME" '.packages[] | select(.name == $PACKAGE_NAME) | .version')
+            echo "Current version in manifest for $PACKAGE_NAME is $manifest_version"
+            if [ "$last_published_version" == "$manifest_version" ]; then
+              echo "Package $PACKAGE_NAME is already published with version $manifest_version."
+            else
+              echo "Package $PACKAGE_NAME is not published with version $manifest_version."
+              echo "Publishing $PACKAGE_NAME..."
+              cargo publish --no-verify --token ${{ secrets.CARGO_REGISTRY_TOKEN }} --package "$PACKAGE_NAME"
+            fi
+          done
         env:
           CARGO_TERM_COLOR: always
         working-directory: ${{ github.workspace }}
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -1,8 +1,36 @@
 # Ledger Device Rust SDK
-This workspace contains the 5 crates members of Ledger Device Rust SDK
+[![DEV SUPPORT](https://img.shields.io/badge/Dev_Support-red?logo=discord
+)](https://discord.com/channels/885256081289379850/912241185677000704)
 
-* [ledger_device_sdk](./ledger_device_sdk): main Rust SDK crate used to build an application that runs on BOLOS OS,
-* [ledger_secure_sdk_sys](./ledger_secure_sdk_sys): bindings to [ledger_secure_sdk](https://github.com/LedgerHQ/ledger-secure-sdk)
-* [include_gif](./include_gif): procedural macro used to manage GIF
-* [testmacro](./testmacro): procedural macro used by unit and integrations tests
-* [cargo-ledger](./cargo-ledger): tool to build Ledger device applications developped in Rust
+## Crates
+
+| Crate                                            | Description                                                     | Latest Release |
+| ------------------------------------------------ | --------------------------------------------------------------- | -------------- |
+| [cargo-ledger](./cargo-ledger)                   | Cargo extension required to build Ledger applications           | ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fcargo-ledger%2FCargo.toml&query=%24.package.version&label=version) |
+| [ledger_device_sdk](./ledger_device_sdk)         | Rust SDK                                                        | ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fledger_device_sdk%2FCargo.toml&query=%24.package.version&label=version) |
+| [ledger_secure_sdk_sys](./ledger_secure_sdk_sys) | [C SDK](https://github.com/LedgerHQ/ledger-secure-sdk) bindings | ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fledger_secure_sdk_sys%2FCargo.toml&query=%24.package.version&label=version) |
+| [include_gif](./include_gif)                     | Procedural macro to integrate logo in the UI/UX                 | ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Finclude_gif%2FCargo.toml&query=%24.package.version&label=version) |
+| [testmacro](./testmacro)                         | Procedural macro used by unit and integrations tests            | ![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Ftestmacro%2FCargo.toml&query=%24.package.version&label=version) |
+
+## Docker builder
+
+Docker images are available and shall be used to build and test Rust applications for Ledger devices.
+ 
+||`full` | `dev-tools` |
+| ---- | ----- | ----------- |
+| Rust nightly-2024-12-01 toolchain | :white_check_mark: | :white_check_mark: |
+| cargo-ledger | :white_check_mark: | :white_check_mark: |
+| Rust Ledger devices custom targets | :white_check_mark: | :white_check_mark: |
+| ARM & LLVM toolchains | :white_check_mark: | :white_check_mark: |
+| [Speculos](https://github.com/LedgerHQ/speculos) | :x: | :white_check_mark: |
+| [Ragger](https://github.com/LedgerHQ/ragger)  | :x: | :white_check_mark: |
+
+Please check [here](https://github.com/LedgerHQ/ledger-app-builder) for more details.
+
+## Links
+
+To learn more about using the SDK and what is required to publish an app on the Ledger Live app store, please don't hesitate to check the following resources:
+
+- 📚 [Developer's documentation](https://developers.ledger.com/)
+- 🗣️ [Ledger's Discord server](https://discord.gg/Ledger)
+- 📦 [Fully featured boilerplate app](https://github.com/LedgerHQ/app-boilerplate-rust)
diff --git a/cargo-ledger/README.md b/cargo-ledger/README.md
@@ -1,8 +1,9 @@
-# Cargo-ledger
+# cargo-ledger
+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fcargo-ledger%2FCargo.toml&query=%24.package.version&label=version)
 
-Builds a Nano App and outputs a JSON manifest file that can be used by [ledgerctl](https://github.com/LedgerHQ/ledgerctl) to install an application directly.
+Builds a Ledger device embedded app and outputs a JSON/TOML manifest file that can be used by [ledgerctl](https://github.com/LedgerHQ/ledgerctl) to install an application directly on a device.
 
-In order to build for Nano S, Nano X, and Nano S Plus, [custom target files](https://docs.rust-embedded.org/embedonomicon/custom-target.html) are used. They can be found at the root of the [Rust SDK](https://github.com/LedgerHQ/ledger-nanos-sdk/) and can be installed automatically with the command `setup`.
+In order to build for Nano X, Nano S Plus, Stax and Flex [custom target files](https://docs.rust-embedded.org/embedonomicon/custom-target.html) are used. They can be found at the root of the [ledger_secure_sdk_sys](https://github.com/LedgerHQ/ledger_secure_sdk_sys/) and can be installed automatically with the command `cargo ledger setup`.
 
 ## Installation
 
@@ -41,9 +42,10 @@ cargo ledger setup
 ### Building
 
 ```
-cargo ledger build nanos
 cargo ledger build nanox
 cargo ledger build nanosplus
+cargo ledger build stax
+cargo ledger build flex
 ```
 
 Loading on device can optionally be performed by appending `--load` or `-l` to the command.
diff --git a/include_gif/README.md b/include_gif/README.md
@@ -1,3 +1,4 @@
-# sdk_include_gif
+# include_gif
+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Finclude_gif%2FCargo.toml&query=%24.package.version&label=version)
 
-This crate provides a macro `include_gif!("path/to/image.gif")` that packs a gif image into a byte representation that can be understood by the [Rust Nano SDK](https://github.com/LedgerHQ/ledger-device-rust-sdk/tree/master/ledger_device_sdk) and included at compile time to produce black-and-white icons.
+This crate provides a macro `include_gif!("path/to/image.gif")` that packs a gif image into a byte representation that can be understood by the [Rust SDK](https://github.com/LedgerHQ/ledger-device-rust-sdk/tree/master/ledger_device_sdk) and included at compile time to produce icons.
diff --git a/ledger_device_sdk/README.md b/ledger_device_sdk/README.md
@@ -1,4 +1,5 @@
-# Ledger wallets SDK for Rust Applications
+# Ledger device SDK for Rust Applications
+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fledger_device_sdk%2FCargo.toml&query=%24.package.version&label=version)
 
 Crate that allows developing Ledger device apps in Rust with a default configuration.
 
@@ -9,20 +10,11 @@ Contains:
 - signature abstractions
 - UI libraries (the `ui` module for Nano (S/SP/X) apps, `nbgl` module for Stax and Flex apps)
 
-## Links
-
-To learn more about using the SDK and what is required to publish an app on the Ledger Live app store, please don't hesitate to check the following resources :
-
-- 📚 [Developer's documentation](https://developers.ledger.com/)
-- 🗣️ [Ledger's Discord server](https://discord.gg/Ledger)
-- 📦 [Fully featured boilerplate app](https://github.com/LedgerHQ/app-boilerplate-rust)
-- 📦 [A Password Manager app](https://github.com/LedgerHQ/rust-app-password-manager)
-
 ## Supported devices
 
-|       Nano S       |       Nano X       |    Nano S Plus     |        Stax        |       Flex         |
-| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
-| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|       Nano X       |    Nano S Plus     |        Stax        |       Flex         |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 
 ## Usage
 
@@ -31,7 +23,7 @@ On Ubuntu, `gcc-multilib` might also be required.
 
 Using rustc nightly builds is mandatory as some unstable features are required.
 
-- `rustup default nightly`
+- `rustup default nightly-2024-12-01`
 - `rustup component add rust-src`
 - install [Clang](http://releases.llvm.org/download.html).
 - install an [ARM gcc toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
@@ -51,45 +43,33 @@ sudo pacman -S clang arm-none-eabi-gcc arm-none-eabi-newlib
 
 This SDK provides [custom target](https://doc.rust-lang.org/rustc/targets/custom.html) files. One for each supported device.
 
-### Building for Nano S
-
-```
-cargo build --release -Z build-std=core --target=./nanos.json
-```
-
 ### Building for Nano X
 
 ```
-cargo build --release -Z build-std=core --target=./nanox.json
+cargo build --release --target=nanox
 ```
 
 ### Building for Nano S+
 
 ```
-cargo build --release -Z build-std=core --target=./nanosplus.json
+cargo build --release --target=nanosplus
 ```
 
 ### Building for Stax
 
 ```
-cargo build --release -Z build-std=core --target=./stax.json
+cargo build --release --target=stax
 ```
 
 ### Building for Flex
 
 ```
-cargo build --release -Z build-std=core --target=./flex.json
+cargo build --release --target=flex
 ```
 
-## Building with rustc < 1.54
-
-Building before rustc 1.54 should fail with `error[E0635]: unknown feature const_fn_trait_bound`.
-
-This is solved by activating a specific feature: `cargo build --features pre1_54`
-
 ## Contributing
 
-You can submit an issue or even a pull request if you wish to contribute, we will check what we can do.
+You can submit an issue or even a pull request if you wish to contribute.
 
 Make sure you've followed the installation steps above. In order for your PR to be accepted, it will have to pass the CI, which performs the following checks:
 
diff --git a/ledger_secure_sdk_sys/README.md b/ledger_secure_sdk_sys/README.md
@@ -1,4 +1,5 @@
 # Rust Low-level bindings to the Ledger C SDK
+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fledger_secure_sdk_sys%2FCargo.toml&query=%24.package.version&label=version)
 
 Provides access to low-level APIs to the operating system of Ledger devices.
 
diff --git a/testmacro/README.md b/testmacro/README.md
@@ -1,3 +1,4 @@
 # testmacro
+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Ftestmacro%2FCargo.toml&query=%24.package.version&label=version)
 
 A macro inspired from [Writing an OS in Rust](https://os.phil-opp.com/testing/) and [Rust Raspberry OS tutorials](https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials/tree/master/13_integrated_testing) that helps building `#![no_std]` tests in some other projects.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Rust Low-level bindings to the Ledger C SDK`
	`2`	`+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Fledger_secure_sdk_sys%2FCargo.toml&query=%24.package.version&label=version)`
`2`	`3`
`3`	`4`	`Provides access to low-level APIs to the operating system of Ledger devices.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`# testmacro`
	`2`	`+![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FLedgerHQ%2Fledger-device-rust-sdk%2Frefs%2Fheads%2Fmaster%2Ftestmacro%2FCargo.toml&query=%24.package.version&label=version)`
`2`	`3`
`3`	`4`	A macro inspired from [Writing an OS in Rust](https://os.phil-opp.com/testing/) and [Rust Raspberry OS tutorials](https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials/tree/master/13_integrated_testing) that helps building `#![no_std]` tests in some other projects.