Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/navcoin/app-navcoin
PSBT-native Bitcoin Application
https://github.com/navcoin/app-navcoin
Last synced: about 4 hours ago
JSON representation
PSBT-native Bitcoin Application
- Host: GitHub
- URL: https://github.com/navcoin/app-navcoin
- Owner: navcoin
- License: apache-2.0
- Created: 2022-05-28T09:22:03.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-07T20:21:11.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T04:36:03.756Z (7 months ago)
- Language: C
- Homepage:
- Size: 1.81 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ledger Navcoin Application
## Prerequisite
Be sure to have your environment correctly set up (see [Getting Started](https://developers.ledger.com/docs/nano-app/introduction/)) and [ledgerblue](https://pypi.org/project/ledgerblue/) installed.
If you want to benefit from [vscode](https://code.visualstudio.com/) 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
```
## Compilation
```
make DEBUG=1 # compile optionally with PRINTF
make load # load the app on the Nano using ledgerblue
```
## Documentation
High level documentation on the architecture and interface of the app:
- [bitcoin.md](doc/bitcoin.md): specifications of application commands.
- [wallet.md](doc/wallet.md): supported wallet signing policies.
- [merkle.md](doc/merkle.md): rationale and specifications for the usage of Merkle trees.
Additional documentation can be generated with [doxygen](https://www.doxygen.nl)
```
doxygen .doxygen/Doxyfile
```
the process outputs HTML and LaTeX documentations in `doc/html` and `doc/latex` folders.
## Client libraries
A [Python client library](bitcoin_client) and a [TypeScript client library](bitcoin_client_js) are available in this repository.
## Tests & Continuous Integration
The flow processed in [GitHub Actions](https://github.com/features/actions) is the following:
- Code formatting with [clang-format](http://clang.llvm.org/docs/ClangFormat.html)
- Compilation of the application for Ledger Nano S in [ledger-app-builder](https://github.com/LedgerHQ/ledger-app-builder)
- Unit tests of C functions with [cmocka](https://cmocka.org/) (see [unit-tests/](unit-tests/))
- End-to-end tests with [Speculos](https://github.com/LedgerHQ/speculos) emulator (see [tests/](tests/))
- Code coverage with [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html)/[lcov](http://ltp.sourceforge.net/coverage/lcov.php) and upload to [codecov.io](https://about.codecov.io)
- Documentation generation with [doxygen](https://www.doxygen.nl)
It outputs 4 artifacts:
- `bitcoin-app-debug` within output files of the compilation process in debug mode
- `code-coverage` within HTML details of code coverage
- `documentation` within HTML auto-generated documentation