https://github.com/platonnetwork/ledger-app-platon
https://github.com/platonnetwork/ledger-app-platon
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/platonnetwork/ledger-app-platon
- Owner: PlatONnetwork
- License: apache-2.0
- Created: 2021-08-02T01:57:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T09:47:27.000Z (about 3 years ago)
- Last Synced: 2024-04-22T00:43:39.333Z (about 1 year ago)
- Language: C
- Size: 411 KB
- Stars: 0
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# app-lat
Platon wallet application framework for Nano S and Nano X.
This app follows the specification available in the `doc/` folder.
# Plugins
This app support external plugins. More info in [doc/latapp_plugin.md](./doc/latapp_plugins.md). If you wish to have a look at an existing plugin, feel free to check out the [ParaSwap plugin](https://github.com/LedgerHQ/app-plugin-paraswap).
# Testing
Testing is done via the open-source framework zemu.
## Running tests
First [install yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable).
Open `tests/build_local_test_elfs.sh` and add your BOLOS SDKs path to `NANOS_SDK` and `NANOX_SDK`.
This helper script will build the applications required by the test suite and move them at the right place.
```
cd test
./build_local_test_elfs.sh
```
Then you can install the project by simply running:
```
cd ..
make test
```
This will run `make install_tests` and `make run_tests`
To run a specific tests (here the send test):
```
cd tests
jest --runInBand --detectOpenHandles src/send.test.js
```
Make sure you're in the `tests` folder before running `jest` or `yarn test`.
## Adding tests
### Zemu
To add tests, copy one of the already existing test files in `tests/src/`.
You then need to adapt the `buffer` and `tx` variables to adapt to the APDU you wish to send.
- Adapt the expected screen flow. Please create a folder under `tests/snapshots` with the name of the test you're performing.
- Then adapt the `ORIGINAL_SNAPSHOT_PATH_PREFIX` with the name of the folder you just created.
- To create the snapshots, modify the `SNAPSHOT_PATH_PREFIX` and set it to be equal to `ORIGINAL_SNAPSHOT_PATH_PREFIX`.
- Run the tests once, this will create all the snapshots in the folder you created.
- Put back your `SNAPSHOT_PATH_PREFIX` to `snapshots/tmp/`.
Finally make sure you adapt the expected signature!
### Update binaries
Don't forget to update the binaries in the test folder. To do so, compile with those environement variables:
```
make DEBUG=1 ALLOW_DATA=1
```
Then copy the binary to the `tests/elfs` folder (in this case, compiled with SDK for nanoS):
```
cp bin/app.elf tests/elfs/platon_nanos.elf
```
Repeat the operation for a binary compiled with nanoX SDK and change for `platon_nanox.elf`.