This is the Accumulate application which can be forked to start a new project for the Ledger Nano S/X.
Plug in ledger Nano S or Nano S+ into USB port and make sure the screen is unlocked and no apps are open.
git clone https://gitlab.com/accumulatenetwork/ledger/app-accumulate.git
cd app-accumulate
#git checkout desired-branch
./docker-loader.sh
From within the docker shell, if side-loading on Nano S:
make clean
make load
if side-loading on a Nano S+:
export BOLOS_SDK=/opt/nanosplus-secure-sdk
make clean
make load
https://developers.ledger.com/docs/nano-app/build/
Be sure to have your environment correctly set up (see Getting Started) and ledgerblue and installed.
If you want to benefit from vscode integration, it's recommended to move the toolchain in /opt and set BOLOS_ENV environment variable as follows
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:
accumulate-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