Merge pull request #45 from eosnetworkfoundation/Force-Ledger-HQ-Feb-…

…2025

Force Merg Ledger HQ Feb 2025

.clang-format

@@ -12,7 +12,6 @@ SortIncludes: false
 SpaceAfterCStyleCast: true
 AllowShortCaseLabelsOnASingleLine: false
 AllowAllArgumentsOnNextLine: false
-AllowAllParametersOfDeclarationOnNextLine: false
 AllowShortBlocksOnASingleLine: Never
 AllowShortFunctionsOnASingleLine: None
 BinPackArguments: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Checklist
+
+<!-- Put an `x` in each box when you have completed the items. -->
+
+- [ ] App update process has been followed <!-- See comment below -->
+- [ ] Target branch is `develop` <!-- unless you have a very good reason -->
+- [ ] Application version has been bumped <!-- required if your changes are to be deployed -->
+
+<!-- Make sure you followed the process described in https://developers.ledger.com/docs/device-app/deliver/maintenance
+ before opening your Pull Request.
+Don't hesitate to contact us directly on Discord if you have any questions ! https://developers.ledger.com/discord -->

.github/workflows/build_and_functional_tests.yml

@@ -0,0 +1,41 @@
+name: Build and run functional tests using ragger through reusable workflow
+
+# This workflow will build the app and then run functional tests using the Ragger framework upon Speculos emulation.
+# It calls a reusable workflow developed by Ledger's internal developer team to build the application and upload the
+# resulting binaries.
+# It then calls another reusable workflow to run the Ragger tests on the compiled application binary.
+#
+# While this workflow is optional, having functional testing on your application is mandatory and this workflow and
+# tooling environment is meant to be easy to use and adapt after forking your application
+
+on:
+  workflow_dispatch:
+    inputs:
+      golden_run:
+        type: choice
+        required: true
+        default: 'Raise an error (default)'
+        description: CI behavior if the test snapshots are different than expected.
+        options:
+          - 'Raise an error (default)'
+          - 'Open a PR'
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+
+jobs:
+  build_application:
+    name: Build application using the reusable workflow
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_build.yml@v1
+    with:
+      upload_app_binaries_artifact: compiled_app_binaries
+
+  ragger_tests:
+    name: Run ragger tests using the reusable workflow
+    needs: build_application
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_ragger_tests.yml@v1
+    with:
+      download_app_binaries_artifact: compiled_app_binaries
+      regenerate_snapshots: ${{ inputs.golden_run == 'Open a PR' }}

.github/workflows/coding_style_checks.yml

@@ -0,0 +1,24 @@
+name: Run coding style check through reusable workflow
+
+# This workflow will run linting checks to ensure a level of uniformization among all Ledger applications.
+#
+# The presence of this workflow is mandatory as a minimal level of linting is required.
+# You are however free to modify the content of the .clang-format file and thus the coding style of your application.
+# We simply ask you to not diverge too much from the linting of the Boilerplate application.
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+
+jobs:
+  check_linting:
+    name: Check linting using the reusable workflow
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_lint.yml@v1
+    with:
+      source: "./src"
+      extensions: "h,c"
+      version: 12

.github/workflows/guidelines_enforcer.yml

@@ -0,0 +1,23 @@
+name: Ensure compliance with Ledger guidelines
+
+# This workflow is mandatory in all applications
+# It calls a reusable workflow guidelines_enforcer developed by Ledger's internal developer team.
+# The successful completion of the reusable workflow is a mandatory step for an app to be available on the Ledger
+# application store.
+#
+# More information on the guidelines can be found in the repository:
+# LedgerHQ/ledger-app-workflows/
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  guidelines_enforcer:
+    name: Call Ledger guidelines_enforcer
+    uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_guidelines_enforcer.yml@v1

.github/workflows/misspellings_checks.yml

@@ -0,0 +1,27 @@
+name: Misspellings checks
+
+# This workflow performs some misspelling checks on the repository
+# It is there to help us maintain a level of quality in our codebase and does not have to be kept on forked
+# applications.
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+
+jobs:
+  misspell:
+    name: Check misspellings
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+
+      - name: Check misspellings
+        uses: codespell-project/actions-codespell@v2
+        with:
+          builtin: clear,rare
+          check_filenames: true

.github/workflows/python_client_checks.yml

@@ -0,0 +1,43 @@
+name: Checks on the Python client
+
+# This workflow performs some checks on the Python client used by the tests
+# It is there to help us maintain a level of quality in our codebase and does not have to be kept on forked
+# applications.
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Installing PIP dependencies
+        run: |
+          pip install pylint
+          pip install -r tests/functional/requirements.txt
+      - name: Lint Python code
+        run: |
+          pylint --rc tests/functional/setup.cfg tests/functional/*.py
+          pylint --rc tests/functional/setup.cfg tests/functional/apps/*.py
+
+  mypy:
+    name: Type checking
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Installing PIP dependencies
+        run: |
+          pip install mypy
+          pip install -r tests/functional/requirements.txt
+      - name: Mypy type checking
+        run: |
+          mypy tests/functional/

.gitignore

@@ -1,14 +1,11 @@
 bin
 debug
-dep
-obj
-src/glyphs.c
-src/glyphs.h
+build
 .vscode
 .idea
 *.pyc
 coverage
 fuzz/corpus/
 fuzz/build/
-tests/elfs/
 tests/functional/snapshots-tmp/
+tests/functional/venv/

.mdl.rb

@@ -0,0 +1,11 @@
+# Style file for mdl
+# https://github.com/markdownlint/markdownlint/blob/main/docs/creating_styles.md
+
+# Include all rules
+all
+
+# Disable specific rules
+#exclude_rule 'MD012'
+
+# Update rules configuration
+rule 'MD013', :line_length => 120

.mdlrc

@@ -0,0 +1,14 @@
+# markdownlint config file
+
+# Use custom style file
+style "#{File.dirname(__FILE__)}/.mdl.rb"
+
+# MD002 - First header in file should be a top level header
+# MD005 - Inconsistent indentation for list items at the same level
+# MD007 - Unordered list indentation
+# MD014 - Dollar signs used before commands without showing output
+# MD024 - Multiple headers with the same content
+# MD029 - Ordered list item prefix
+# MD033 - Inline HTML
+# MD041 - First line in file should be a top level header
+rules "~MD002,~MD005,~MD007,~MD014,~MD024,~MD029,~MD033,~MD041"

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+# To install hooks, run:
+# pre-commit install --hook-type pre-commit
+# pre-commit install --hook-type commit-msg
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-case-conflict
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v12.0.1
+    hooks:
+      - id: clang-format
+        types_or: [c]
+
+  - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
+    rev: v1.6.27.13
+    hooks:
+      - id: actionlint
+        types_or: [yaml]
+        args: [-shellcheck='' -pyflakes='']
+
+  - repo: https://github.com/markdownlint/markdownlint
+    rev: v0.12.0
+    hooks:
+      - id: markdownlint
+        types_or: [markdown]
+
+  - repo: https://github.com/PyCQA/pylint
+    rev: v2.16.2
+    hooks:
+      - id: pylint
+        types: [python]
+        args: ['--jobs=0', '--rcfile=tests/functional/setup.cfg']
+        files: '^tests/functional/.*$'

.yamllint.yml

@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  document-start: disable
+  line-length: disable
+  truthy: disable