diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml index bd33d342..a1702ee0 100644 --- a/.github/workflows/ci-workflow.yml +++ b/.github/workflows/ci-workflow.yml @@ -11,7 +11,7 @@ on: jobs: build_application: name: Build application - uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_build.yml@master + uses: LedgerHQ/ledger-app-workflows/.github/workflows/reusable_build.yml@v1 with: upload_app_binaries_artifact: compiled_app_binaries diff --git a/README.md b/README.md index cf4d9c08..2d670ea8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Introduction -This is the wallet app for the [Ledger hardware wallets](https://shop.ledger.com/) that makes it possible to store [Stellar](https://www.stellar.org/)-based assets on those devices and generally sign any transaction for the Stellar network. +This is the wallet app for the [Ledger hardware wallets](https://www.ledger.com/) that makes it possible to store [Stellar](https://www.stellar.org/)-based assets on those devices and generally sign any transaction for the Stellar network. ## Documentation @@ -44,7 +44,7 @@ make delete ## Testing -This project provides unit tests, integration tests and end-to-end tests, unit tests are located under the [`./tests_unit`](./tests_unit) folder, and the integration tests and end-to-end tests are located under the [`./tests_zemu`](./tests_zemu) folder. +This project provides unit tests, integration tests and end-to-end tests, unit tests are located under the [`./tests_unit`](./tests_unit) folder, and the integration tests and end-to-end tests are located under the [`./tests_zemu`](./tests_zemu) folder. During development, we recommend that you run the unit test first, as it takes less time to run, and then run the other tests after the unit test has run successfully. @@ -67,9 +67,10 @@ make tests-unit ``` ### Integration testing and end-to-end testing + Testing is done via the open-source framework [zemu](https://github.com/Zondax/zemu). -In order to run these tests, you need to install [Docker](https://www.docker.com/) in addition to the dependencies mentioned in *Unit testing*. +In order to run these tests, you need to install [Docker](https://www.docker.com/) in addition to the dependencies mentioned in _Unit testing_. To build and execute the tests, run the following commands: diff --git a/docs/COMMANDS.md b/docs/COMMANDS.md index 535aa1fa..eb14d5e9 100644 --- a/docs/COMMANDS.md +++ b/docs/COMMANDS.md @@ -82,22 +82,22 @@ ## Status Words - -| SW | SW name | Description | -| ------ | ------------------------------------- | ------------------------------------------------------- | -| 0x6125 | `SW_FORMATTING_FAIL` | Failed to format the data | -| 0x6985 | `SW_DENY` | Rejected by user | -| 0x6A87 | `SW_WRONG_DATA_LENGTH` | `Lc` or minimum APDU lenght is incorrect | -| 0x6B00 | `SW_WRONG_P1P2` | Either `P1` or `P2` is incorrect | -| 0x6C66 | `SW_HASH_SIGNING_MODE_NOT_ENABLED` | Hash signing model not enabled | -| 0x6D00 | `SW_INS_NOT_SUPPORTED` | No command exists with `INS` | -| 0x6E00 | `SW_CLA_NOT_SUPPORTED` | Bad `CLA` used for this application | -| 0xB002 | `SW_DISPLAY_ADDRESS_FAIL` | Failed to display address | -| 0xB003 | `SW_DISPLAY_TRANSACTION_HASH_FAIL` | Failed to display transaction hash | -| 0xB004 | `SW_DATA_TOO_LARGE` | The data is too large to be processed | -| 0xB005 | `SW_DATA_PARSING_FAIL` | Failed to parse raw data | -| 0xB006 | `SW_DATA_HASH_FAIL` | Failed to compute hash digest of raw data | -| 0xB007 | `SW_BAD_STATE` | Security issue with bad state | -| 0xB008 | `SW_SIGNATURE_FAIL` | Generating signature failed | -| 0xB009 | `SW_SWAP_CHECKING_FAIL` | Failed to check swap params (maybe the data is invalid) | -| 0x9000 | `SW_OK` | Success | +| SW | SW name | Description | +| ------ | ------------------------------------------ | --------------------------------------------------------- | +| 0x6125 | `SW_FORMATTING_FAIL` | Failed to format the data | +| 0x6985 | `SW_DENY` | Rejected by user | +| 0x6A87 | `SW_WRONG_DATA_LENGTH` | `Lc` or minimum APDU lenght is incorrect | +| 0x6B00 | `SW_WRONG_P1P2` | Either `P1` or `P2` is incorrect | +| 0x6C66 | `SW_HASH_SIGNING_MODE_NOT_ENABLED` | Hash signing model not enabled | +| 0x6C77 | `SW_UNVERIFIED_CONTRACTS_MODE_NOT_ENABLED` | Unverified contracts (custom contracts) model not enabled | +| 0x6D00 | `SW_INS_NOT_SUPPORTED` | No command exists with `INS` | +| 0x6E00 | `SW_CLA_NOT_SUPPORTED` | Bad `CLA` used for this application | +| 0xB002 | `SW_DISPLAY_ADDRESS_FAIL` | Failed to display address | +| 0xB003 | `SW_DISPLAY_TRANSACTION_HASH_FAIL` | Failed to display transaction hash | +| 0xB004 | `SW_DATA_TOO_LARGE` | The data is too large to be processed | +| 0xB005 | `SW_DATA_PARSING_FAIL` | Failed to parse raw data | +| 0xB006 | `SW_DATA_HASH_FAIL` | Failed to compute hash digest of raw data | +| 0xB007 | `SW_BAD_STATE` | Security issue with bad state | +| 0xB008 | `SW_SIGNATURE_FAIL` | Generating signature failed | +| 0xB009 | `SW_SWAP_CHECKING_FAIL` | Failed to check swap params (maybe the data is invalid) | +| 0x9000 | `SW_OK` | Success |