https://github.com/LedgerHQ/app-neo3
This is the NEO3 ledger application for the Nano S/X. It is based on Ledgers Boilerplate app.
You can follow Ledgers Getting Started guide to setup your environment to build and load the app onto your device. At the time of writing their setup documentation was found to be convoluted, outdated and at times missing steps. The setup environment document hopefully solves this.
BOLOS_ENV=/opt/bolos-devenv
and do the same with BOLOS_SDK environment variable
BOLOS_SDK=/opt/nanos-secure-sdk
make DEBUG=1 # compile optionally with PRINTF
make load # load the app on the Nano using ledgerblue
High level documentation such as APDU, commands and transaction serialization are included in developer documentation which can be generated with doxygen
doxygen .doxygen/Doxyfile
the process outputs HTML and LaTeX documentations in doc/html and doc/latex folders.
The flow processed in GitHub Actions is the following:
- Code formatting with clang-format
- Compilation of the application for Ledger Nano S in ledger-app-builder
- Unit tests of C functions with cmocka (see unit-tests/)
- End-to-end tests with Speculos emulator (see tests/)
- Code coverage with gcov/lcov and upload to codecov.io
- Documentation generation with doxygen
It outputs 4 artifacts:
boilerplate-app-debugwithin output files of the compilation process in debug modespeculos-logwithin APDU command/response when executing end-to-end testscode-coveragewithin HTML details of code coveragedocumentationwithin HTML auto-generated documentation
A special thanks goes out to Edouard Merle of Ledger for answering support questions, follow up to bug reports and assisting in tracking down an issue ❤️.