ledgered 0.9.1.dev4__tar.gz → 0.10.1__tar.gz

ledgered-0.10.1/.github/workflows/build_and_tests.yml

@@ -0,0 +1,69 @@
+name: Build, test and deploy Ledgered
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+    paths:
+      - 'src/**'
+      - 'tests/**'
+      - .github/workflows/build_and_tests.yml
+# Cancel previous runs on this reference
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+
+  build_install_test:
+    name: Build, install and test the Ledgered Python package
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+    steps:
+    - name: Clone
+      uses: actions/checkout@v4
+
+    - name: Setup Python version
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python_version }}
+
+    - name: Build & install
+      run: |
+        pip install -U pip
+        pip install -U .[dev]
+
+    - name: Run unit tests and generate coverage
+      run: pytest -v --tb=short tests/unit --cov ledgered --cov-report xml
+
+    - name: Run functional tests and generate coverage
+      run: pytest -v --tb=short tests/functional --cov ledgered --cov-report xml --cov-append --token "${{ secrets.GITHUB_TOKEN }}"
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        name: codecov-ledgered
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+
+  package_and_deploy:
+    name: Build and deploy the Ledgered Python package
+    needs: [build_install_test]
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_pypi_deployment.yml@v1
+    with:
+      package_name: ledgered
+      publish: ${{ startsWith(github.ref, 'refs/tags/') }}
+    secrets:
+      pypi_token: ${{ secrets.PYPI_PUBLIC_API_TOKEN  }}

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/.github/workflows/codeql-analysis.yml

@@ -15,6 +15,10 @@ on:
       - tests
   schedule:
     - cron: '35 0 * * 5'
+# Cancel previous runs on this reference
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   analyze:

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/.github/workflows/fast-checks.yml

@@ -7,6 +7,10 @@ on:
       - develop
       - master
   pull_request:
+# Cancel previous runs on this reference
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   ruff:

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.1] - 2025-05-14
+
+### Fix
+
+- Parsing 'nanos+' in manifests now returns 'nanosp', which is breaking when this name is used to
+  gather a SDK tag.
+  Added a specific "sdk_name" field in the JSON / `Device` to be returned when parsing the manifest,
+  to get back the previous, 0.9.1- behavior.
+
+## [0.10.0] - 2025-05-09
+
+### Added
+
+- Added `devices` module, declaring Ledger devices as class / enum, dynamically generated from a
+  JSON configuration file. This should enable to add new devices more easily, and device
+  characteristics are now reachable from a centralized place.
+
 ## [0.9.1] - 2025-03-26
 
 ### Fixed

ledgered-0.10.1/MANIFEST.in

@@ -0,0 +1 @@
+include src/ledgered/devices.json

{ledgered-0.9.1.dev4/src/ledgered.egg-info → ledgered-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ledgered
-Version: 0.9.1.dev4
+Version: 0.10.1
 Summary: Python tools, utils, libraries, to be used with Ledger cryptodevices
 Author-email: Ledger <hello@ledger.fr>
 License: MIT License
@@ -40,9 +40,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: toml
+Requires-Dist: pydantic
 Requires-Dist: pyelftools
 Requires-Dist: pygithub
+Requires-Dist: toml
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/pyproject.toml

@@ -30,9 +30,10 @@ classifiers = [
 dynamic = [ "version" ]
 requires-python = ">=3.9"
 dependencies = [
-    "toml",
+    "pydantic",
     "pyelftools",
     "pygithub",
+    "toml",
 ]
 
 [project.optional-dependencies]

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/src/ledgered/__version__.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.9.1.dev4'
-__version_tuple__ = version_tuple = (0, 9, 1, 'dev4')
+__version__ = version = '0.10.1'
+__version_tuple__ = version_tuple = (0, 10, 1)

ledgered-0.10.1/src/ledgered/devices/__init__.py

@@ -0,0 +1,81 @@
+import dataclasses
+import json
+from enum import IntEnum, auto
+from pathlib import Path
+from pydantic.dataclasses import dataclass
+from typing import Optional
+
+
+class DeviceType(IntEnum):
+    NANOS = auto()
+    NANOSP = auto()
+    NANOX = auto()
+    STAX = auto()
+    FLEX = auto()
+
+
+@dataclass
+class Resolution:
+    x: int
+    y: int
+
+
+@dataclass
+class Device:
+    type: DeviceType
+    resolution: Resolution
+    touchable: bool = True
+    deprecated: bool = False
+    names: list[str] = dataclasses.field(default_factory=lambda: [])
+    _sdk_name: Optional[str] = None
+
+    @property
+    def name(self) -> str:
+        """
+        Returns the name of the current firmware's device
+        """
+        return self.type.name.lower()
+
+    @property
+    def sdk_name(self) -> str:
+        """
+        Returns the SDK name, meaning the device name used to tag the SDK.
+        If the device does not have a SDK name, returns the default name
+        """
+        return self._sdk_name or self.name
+
+    @property
+    def is_nano(self):
+        """
+        States if the firmware's name starts with 'nano' or not.
+        """
+        return self.type in [DeviceType.NANOS, DeviceType.NANOSP, DeviceType.NANOX]
+
+    @classmethod
+    def from_dict(cls, dico: dict) -> "Device":
+        type = dico.pop("type")
+        dico["type"] = DeviceType[type.upper()]
+        return Device(**dico)
+
+
+class Devices:
+    _devices_file = Path(__file__).absolute().parent / "devices.json"
+    with _devices_file.open() as filee:
+        _devices = json.load(filee)
+
+    DEVICE_DATA = {item.type: item for item in [Device.from_dict(i) for i in _devices]}
+
+    def __iter__(self):
+        for d in self.DEVICE_DATA.values():
+            yield d
+
+    @classmethod
+    def get_by_type(cls, device_type: DeviceType) -> Device:
+        return cls.DEVICE_DATA[device_type]
+
+    @classmethod
+    def get_by_name(cls, name: str) -> Device:
+        for device in cls.DEVICE_DATA.values():
+            if name.lower() == device.name or name.lower() in device.names:
+                return device
+        raise KeyError(f"Device named '{name}' unknown")

ledgered-0.10.1/src/ledgered/devices/devices.json

@@ -0,0 +1,7 @@
+[
+    {"type": "nanos", "resolution": {"x": 128, "y": 32}, "touchable": false, "deprecated": true},
+    {"type": "nanosp", "resolution": {"x": 128, "y": 64}, "touchable": false, "names": ["nanos+", "nanos2", "nanosplus"], "_sdk_name": "nanos+"},
+    {"type": "nanox", "resolution": {"x": 128, "y": 64}, "touchable": false},
+    {"type": "flex", "resolution": {"x": 480, "y": 600}},
+    {"type": "stax", "resolution": {"x": 400, "y": 670}}
+]

ledgered-0.10.1/src/ledgered/manifest/__init__.py

@@ -0,0 +1,6 @@
+from .app import AppConfig
+from .constants import MANIFEST_FILE_NAME
+from .manifest import Manifest
+from .tests import TestsConfig
+
+__all__ = ["AppConfig", "Manifest", "MANIFEST_FILE_NAME", "TestsConfig"]

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/src/ledgered/manifest/app.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from typing import Iterable, Union
 
 from ledgered.serializers import Jsonable, JsonSet
-from .constants import EXISTING_DEVICES
+from ledgered.devices import Devices
 
 
 @dataclass
@@ -18,12 +18,7 @@ class AppConfig(Jsonable):
             raise ValueError(f"'{sdk}' unknown. Must be either 'C' or 'Rust'")
         self.sdk = sdk
         self.build_directory = Path(build_directory)
-        devices = JsonSet(device.lower() for device in devices)
-        unknown_devices = devices.difference(EXISTING_DEVICES)
-        if unknown_devices:
-            unknown_devices_str = "', '".join(unknown_devices)
-            raise ValueError(f"Unknown devices: '{unknown_devices_str}'")
-        self.devices = devices
+        self.devices = JsonSet(Devices.get_by_name(device).sdk_name for device in devices)
 
     @property
     def is_rust(self) -> bool:

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/src/ledgered/manifest/constants.py

@@ -1,3 +1,2 @@
-EXISTING_DEVICES = ["nanos", "nanox", "nanos+", "stax", "flex"]
 MANIFEST_FILE_NAME = "ledger_app.toml"
 DEFAULT_USE_CASE = "default"

{ledgered-0.9.1.dev4 → ledgered-0.10.1/src/ledgered.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ledgered
-Version: 0.9.1.dev4
+Version: 0.10.1
 Summary: Python tools, utils, libraries, to be used with Ledger cryptodevices
 Author-email: Ledger <hello@ledger.fr>
 License: MIT License
@@ -40,9 +40,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: toml
+Requires-Dist: pydantic
 Requires-Dist: pyelftools
 Requires-Dist: pygithub
+Requires-Dist: toml
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/src/ledgered.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@
 .pre-commit-config.yaml
 CHANGELOG.md
 LICENSE
+MANIFEST.in
 README.md
 pyproject.toml
 .github/workflows/build_and_tests.yml
@@ -21,6 +22,8 @@ src/ledgered.egg-info/dependency_links.txt
 src/ledgered.egg-info/entry_points.txt
 src/ledgered.egg-info/requires.txt
 src/ledgered.egg-info/top_level.txt
+src/ledgered/devices/__init__.py
+src/ledgered/devices/devices.json
 src/ledgered/manifest/__init__.py
 src/ledgered/manifest/app.py
 src/ledgered/manifest/cli.py
@@ -47,6 +50,8 @@ tests/unit/test_binary.py
 tests/unit/test_github.py
 tests/unit/test_github_AppRepository.py
 tests/unit/test_serializers.py
+tests/unit/devices/__init__.py
+tests/unit/devices/test___init__.py
 tests/unit/manifest/__init__.py
 tests/unit/manifest/test_app.py
 tests/unit/manifest/test_manifest.py

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/src/ledgered.egg-info/requires.txt

@@ -1,6 +1,7 @@
-toml
+pydantic
 pyelftools
 pygithub
+toml
 
 [dev]
 pytest

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/tests/_data/full_correct.toml

@@ -1,7 +1,7 @@
 [app]
 build_directory = "./"
 sdk = "C"
-devices = ["nanox"]
+devices = ["nanos+"]
 
 [use_cases]
 debug = "DEBUG=1"

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/tests/functional/manifest/test_cli.py

@@ -20,7 +20,7 @@ class PrintMock(MagicMock):
 FULL_EXPECTED_TEXT = """build_directory: .
 sdk: c
 devices:
-0. nanox
+0. nanos+
 use_cases:
   debug: DEBUG=1
   test: DEBUG=1
@@ -31,7 +31,7 @@ tests:
 FULL_EXPECTED_JSON = {
     "build_directory": ".",
     "sdk": "c",
-    "devices": ["nanox"],
+    "devices": ["nanos+"],
     "use_cases": {"debug": "DEBUG=1", "test": "DEBUG=1"},
     "tests": {"unit_directory": "tests/unit", "pytest_directory": "tests/functional"},
 }

ledgered-0.10.1/tests/unit/devices/test___init__.py

@@ -0,0 +1,65 @@
+from ledgered.devices import Device, DeviceType, Devices, Resolution
+from unittest import TestCase
+
+
+class TestDevice(TestCase):
+    def setUp(self):
+        self.res = Resolution(x=10, y=20)
+
+    def test___init__simple(self):
+        type = DeviceType.NANOS
+        device = Device(type, self.res)
+        self.assertEqual(device.type, type)
+        self.assertEqual(device.touchable, True)
+        self.assertFalse(device.deprecated)
+        self.assertEqual(device.name, type.name.lower())
+        self.assertEqual(device.resolution, self.res)
+
+    def test_is_nano(self):
+        device = Device(DeviceType.NANOS, self.res)
+        self.assertTrue(device.is_nano)
+        device = Device(DeviceType.STAX, self.res)
+        self.assertFalse(device.is_nano)
+
+    def test_from_dict(self):
+        type, touchable, deprecated = "flex", False, True
+        device = Device.from_dict(
+            {
+                "type": type,
+                "resolution": {"x": self.res.x, "y": self.res.y},
+                "touchable": touchable,
+                "deprecated": deprecated,
+            }
+        )
+        self.assertEqual(device.type, DeviceType[type.upper()])
+        self.assertEqual(device.touchable, touchable)
+        self.assertEqual(device.deprecated, deprecated)
+        self.assertEqual(device.name, type)
+        self.assertEqual(device.resolution, Resolution(x=self.res.x, y=self.res.y))
+
+
+class TestDevices(TestCase):
+    def test_get_type_ok(self):
+        type = DeviceType.STAX
+        device = Devices.get_by_type(type)
+        self.assertIsInstance(device, Device)
+        self.assertEqual(device.type, type)
+
+    def test_get_type_nok(self):
+        with self.assertRaises(KeyError):
+            Devices.get_by_type(9)
+
+    def test_get_by_name_ok(self):
+        device = Devices.get_by_name("nanos+")
+        self.assertIsInstance(device, Device)
+        self.assertEqual(device.type, DeviceType.NANOSP)
+        self.assertEqual(device.name, "nanosp")
+        self.assertEqual(device.sdk_name, "nanos+")
+
+    def test_get_by_name_nok(self):
+        with self.assertRaises(KeyError):
+            Devices.get_by_name("non existent")
+
+    def test___iter__(self):
+        for d in Devices():
+            self.assertIsInstance(d, Device)

{ledgered-0.9.1.dev4 → ledgered-0.10.1}/tests/unit/manifest/test_app.py

@@ -12,7 +12,7 @@ class TestAppConfig(TestCase):
         config = AppConfig(sdk=sdk, build_directory=str(bd), devices=devices)
         self.assertEqual(config.sdk, sdk.lower())
         self.assertEqual(config.build_directory, bd)
-        self.assertEqual(config.devices, {device.lower() for device in devices})
+        self.assertEqual(config.devices, {"nanos", "nanos+"})
         self.assertTrue(config.is_rust)
         self.assertFalse(config.is_c)
 
@@ -21,8 +21,6 @@ class TestAppConfig(TestCase):
             AppConfig(sdk="Java", build_directory=str(), devices=set())
 
     def test___init___nok_unknown_device(self):
-        devices = {"hic sunt", "dracones"}
-        with self.assertRaises(ValueError) as error:
+        devices = {"nanosp", "flex", "hic sunt", "dracones"}
+        with self.assertRaises(KeyError):
             AppConfig(sdk="rust", build_directory=str(), devices=devices)
-        for device in devices:
-            self.assertIn(device, str(error.exception))

ledgered-0.9.1.dev4/.github/workflows/build_and_tests.yml

@@ -1,154 +0,0 @@
-name: Build, test and deploy Ledgered
-
-on:
-  workflow_dispatch:
-  push:
-    tags:
-      - '*'
-    branches:
-      - master
-      - develop
-  pull_request:
-    branches:
-      - master
-      - develop
-    paths:
-      - 'src/**'
-      - 'tests/**'
-      - .github/workflows/build_and_tests.yml
-
-jobs:
-
-  build_install_test:
-    name: Build, install and test the Ledgered Python package
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python_version: ['3.9', '3.10', '3.11', '3.12', '3.13']
-    steps:
-    - name: Clone
-      uses: actions/checkout@v4
-
-    - name: Setup Python version
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python_version }}
-
-    - name: Build & install
-      run: |
-        pip install -U pip
-        pip install -U .[dev]
-
-    - name: Run tests and generate coverage
-      run: pytest -v --tb=short tests/ --cov ledgered --cov-report xml
-
-    - name: Run unit tests and generate coverage
-      run: pytest -v --tb=short tests/unit --cov ledgered --cov-report xml
-
-    - name: Run functional tests and generate coverage
-      run: pytest -v --tb=short tests/functional --cov ledgered --cov-report xml --cov-append --token "${{ secrets.GITHUB_TOKEN }}"
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v4
-      with:
-        name: codecov-ledgered
-        token: ${{ secrets.CODECOV_TOKEN }}
-
-
-  package_and_deploy:
-    name: Build and deploy Ledgered Python package
-    runs-on: public-ledgerhq-shared-small
-    needs: [build_install_test]
-    permissions:
-      id-token: write
-      attestations: write
-      contents: write
-    steps:
-
-    - name: Clone
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-
-    - name: Build Ledgered Python package
-      run: |
-        # Needed to workaround this bug https://github.com/pypa/setuptools/issues/4759
-        # To be removed when it's fixed
-        pip install -U packaging
-        pip install --upgrade pip build twine
-        python -m build
-        pip install .
-        python -m twine check dist/*
-        echo "TAG_VERSION=$(python -c 'from ledgered import __version__; print(__version__)')" >> "$GITHUB_ENV"
-
-    - name: Display current status
-      run: |
-        echo "Current status is:"
-        if [[ ${{ github.ref }} == "refs/tags/"* ]];
-        then
-            echo "- Triggered from tag, package will be a release";
-        else
-            echo "- Not triggered from tag, package will be a pre-release";
-        fi
-        echo "- Tag version: ${{ env.TAG_VERSION }}"
-
-    - name: Check version against CHANGELOG
-      if: startsWith(github.ref, 'refs/tags/')
-      run: |
-        CHANGELOG_VERSION=$(grep -Po '(?<=## \[)(\d+\.)+[^\]]' CHANGELOG.md | head -n 1)
-        if [ "${{ env.TAG_VERSION }}" == "${CHANGELOG_VERSION}" ]; \
-        then \
-            exit 0; \
-        else \
-            echo "Tag '${{ env.TAG_VERSION }}' and CHANGELOG '${CHANGELOG_VERSION}' versions mismatch!"; \
-            exit 1; \
-        fi
-
-    - name: Publish Python package on pypi.org
-      if: success() && github.event_name == 'push'
-      run: python -m twine upload dist/*
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_PUBLIC_API_TOKEN  }}
-        TWINE_NON_INTERACTIVE: 1
-
-    - name: Login to Ledger Artifactory
-      if: success() && github.event_name == 'push'
-      timeout-minutes: 10
-      id: jfrog-login
-      uses: LedgerHQ/actions-security/actions/jfrog-login@actions/jfrog-login-1
-
-    - name: Publish Python package on Ledger Artifactory
-      if: success() && github.event_name == 'push'
-      run: python -m twine upload dist/*
-      env:
-        TWINE_REPOSITORY_URL: https://jfrog.ledgerlabs.net/artifactory/api/pypi/embedded-apps-pypi-prod-green
-        TWINE_USERNAME: ${{ steps.jfrog-login.outputs.oidc-user }}
-        TWINE_PASSWORD: ${{ steps.jfrog-login.outputs.oidc-token }}
-        TWINE_NON_INTERACTIVE: 1
-
-    - name: Generate library build attestations
-      if: success() && github.event_name == 'push'
-      timeout-minutes: 10
-      uses: LedgerHQ/actions-security/actions/attest@actions/attest-1
-      with:
-        subject-path: dist/*
-
-    - name: Sign library artifacts
-      if: success() && github.event_name == 'push'
-      timeout-minutes: 10
-      uses: LedgerHQ/actions-security/actions/sign-blob@actions/sign-blob-1
-      with:
-        path: dist
-
-    - name: Publish a release on the repo
-      if: success() && github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-      uses: "marvinpinto/action-automatic-releases@latest"
-      with:
-        automatic_release_tag: "v${{ env.TAG_VERSION }}"
-        repo_token: "${{ secrets.GITHUB_TOKEN }}"
-        prerelease: false
-        files: |
-          LICENSE
-          dist/

ledgered-0.9.1.dev4/src/ledgered/manifest/__init__.py

@@ -1,6 +0,0 @@
-from .app import AppConfig
-from .constants import EXISTING_DEVICES, MANIFEST_FILE_NAME
-from .manifest import Manifest
-from .tests import TestsConfig
-
-__all__ = ["AppConfig", "EXISTING_DEVICES", "Manifest", "MANIFEST_FILE_NAME", "TestsConfig"]