Fix various Linter issues and mispelling

LedgerHQ · Mar 26, 2024 · c19d4cf · c19d4cf
1 parent ccc8bb5
commit c19d4cf
Show file tree

Hide file tree

Showing 100 changed files with 229 additions and 220 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -19,8 +19,8 @@ Describe your issue in as much detail as possible here.
 
 ## Steps to reproduce
 
-* Tell us how to reproduce this issue <br />
-* Where the issue is, if you know <br />
+* Tell us how to reproduce this issue
+* Where the issue is, if you know
 * Which commands triggered the issue, if any
 
 ## Expected behaviour
@@ -37,4 +37,5 @@ Please paste any logs here that demonstrate the issue, if they exist
 
 ## Proposed solution
 
-If you have an idea of how to fix this issue, please write it down here, so we can begin discussing it
+If you have an idea of how to fix this issue, please write it down here,
+so we can begin discussing it
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
 ---
 name: Feature report
-about: Suggest an idea for this project 
+about: Suggest an idea for this project
 title: 'Add [Subject of the issue]'
 labels: 'enhancement'
 assignees: ''

diff --git a/.github/ISSUE_TEMPLATE/network_request.md b/.github/ISSUE_TEMPLATE/network_request.md
@@ -1,19 +1,20 @@
 ---
 name: Network request
-about: Request of new chain or network 
+about: Request of new chain or network
 title: 'Add {NameChain} network ({SYMBOL})'
 labels: 'enhancement, chain/network'
 assignees: ''
 
 ---
 
 ## Description
-- [ ] Symbol: 
-- [ ] ChainId: 
-- [ ] Website: 
-- [ ] Block-Explorer: 
-- [ ] [slip-0044](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) type: 
+
+- [ ] Symbol:
+- [ ] ChainId:
+- [ ] Website:
+- [ ] Block-Explorer:
+- [ ] [slip-0044](https://github.com/satoshilabs/slips/blob/master/slip-0044.md) type:
 
 ## Additional comments
 
-Please post additional comments in this section if you have them, otherwise delete it.
+Please post additional comments in this section if you have them, otherwise delete it.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,6 +1,6 @@
 ## Description
 
-Please provide a detailed description of what was done in this PR.  
+Please provide a detailed description of what was done in this PR.
 (And mentioned if linked to an issue [docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue))
 
 ## Changes include
@@ -18,4 +18,4 @@ Please complete this section if any breaking changes have been made, otherwise d
 
 ## Additional comments
 
-Please post additional comments in this section if you have them, otherwise delete it.
+Please post additional comments in this section if you have them, otherwise delete it.
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,6 @@
 # Compilation of Ledger's app
-src/glyphs.c
-src/glyphs.h
 bin/
 debug/
-dep/
-obj/
 build/
 
 # Python
@@ -20,4 +16,4 @@ tests/elfs/*
 tests/snapshots-tmp
 
 .vscode
-.idea
+.idea
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -211,7 +211,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- Provide network ticker to plugins (especialy helpful for Paraswap plugin)
+- Provide network ticker to plugins (especially helpful for Paraswap plugin)
 - Polygon variant
 
 ## [1.9.10](https://github.com/ledgerhq/app-ethereum/compare/1.9.9...1.9.10) - 2021-10-08

diff --git a/Makefile b/Makefile
@@ -38,9 +38,9 @@ APPVERSION_P = 1
 APPVERSION = $(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)-dev
 APP_LOAD_FLAGS = --appFlags 0xa40 --dep Ethereum:$(APPVERSION)
 
-###########################
-# Set Chain environnement #
-###########################
+#########################
+# Set Chain environment #
+#########################
 
 ifeq ($(CHAIN),)
     CHAIN = ethereum

diff --git a/README.md b/README.md
@@ -31,18 +31,17 @@
   - [Running all tests](#running-all-tests)
     - [With Makefile](#with-makefile)
     - [With yarn](#with-yarn)
-  - [Running a specific tests](#running-a-specific-tests)
+  - [Running a specific test](#running-a-specific-test)
   - [Adding tests](#adding-tests)
     - [Zemu](#zemu)
     - [Update binaries](#update-binaries)
 - [Contributing](#contributing)
 
-
 </details>
 
 ## About the project
 
-Ethereum wallet application framework for Nano S, Nano S Plus and Nano X.  
+Ethereum wallet application framework for Nano S, Nano S Plus and Nano X.
 Ledger Blue is not maintained anymore, but the app can still be compiled for this target using the branch [`blue-final-release`](https://github.com/LedgerHQ/app-ethereum/tree/blue-final-release).
 
 ## Documentation
@@ -53,8 +52,9 @@ To compile it and load it on a device, please check out our [developer portal](h
 
 ### Plugins
 
-We have the concept of plugins in the ETH app.  
-Find the documentations here:  
+We have the concept of plugins in the ETH app.
+Find the documentations here:
+
 - [Blog Ethereum plugins](https://blog.ledger.com/ethereum-plugins/)
 - [Ethereum application Plugins : Technical Specifications](https://github.com/LedgerHQ/app-ethereum/blob/master/doc/ethapp_plugins.asc)
 - [Plugin guide](https://hackmd.io/300Ukv5gSbCbVcp3cZuwRQ)
@@ -68,48 +68,55 @@ Testing is done via the open-source framework [zemu](https://github.com/Zondax/z
 
 - [nodeJS == 16](https://github.com/nvm-sh/nvm)
 - [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
-- [build environnement](https://github.com/LedgerHQ/ledger-app-builder/blob/master/Dockerfile)
+- [build environment](https://github.com/LedgerHQ/ledger-app-builder/blob/master/Dockerfile)
 
-#### Build the applications required by the test suite  
+#### Build the applications required by the test suite
 
 1. Add your BOLOS SDKs path to:
-    - `NANOS_SDK` and `NANOX_SDK`
+
+    `NANOS_SDK` and `NANOX_SDK`
 
 2. Go to the `tests` folder and run `./build_local_test_elfs.sh`
-    - ```sh
-        cd tests
-        # This helper script will build the applications required by the test suite and move them at the right place.
-        yarn install
-        ./build_local_test_elfs.sh
-      ```
+
+    ```sh
+    cd tests
+    # This helper script will build the applications required by the test suite and move them at the right place.
+    yarn install
+    ./build_local_test_elfs.sh
+    ```
 
 ### Running all tests
+
 #### With Makefile
 
 1. Then you can install and run tests by simply running on the `root` of the repo:
-    - ```sh
-        make test
-      ```
-    - This will run `make install_tests` and `make run_tests`
+
+    ```sh
+    make test
+    # This will run `make install_tests` and `make run_tests`
+    ```
 
 #### With yarn
 
 1. Go to the `tests` folder and run:
-    - ```sh
-        yarn test
-      ```
 
-### Running a specific tests
+    ```sh
+    yarn test
+    ```
 
-1.  Go to the `tests` folder and run:
-    - ```sh
-        yarn jest --runInBand --detectOpenHandles {YourTestFile}
-      ```
-2.  For example with the `send test`:
-    - ```sh
-        yarn jest --runInBand --detectOpenHandles src/send.test.js
-      ```
+### Running a specific test
 
+1. Go to the `tests` folder and run:
+
+    ```sh
+    yarn jest --runInBand --detectOpenHandles {YourTestFile}
+    ```
+
+2. For example with the `send test`:
+
+    ```sh
+    yarn jest --runInBand --detectOpenHandles src/send.test.js
+    ```
 
 ### Adding tests
 
@@ -128,7 +135,7 @@ 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:
+Don't forget to update the binaries in the test folder. To do so, compile with those environment variables:
 
 ```sh
 make DEBUG=1 ALLOW_DATA=1
@@ -142,10 +149,9 @@ cp bin/app.elf tests/elfs/ethereum_nanos.elf
 
 Repeat the operation for a binary compiled with nanoX SDK and change for `ethereum_nanox.elf`.
 
-
 ## Contributing
 
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
 
 If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag `enhancement`.
 

diff --git a/client/pyproject.toml b/client/pyproject.toml
@@ -48,4 +48,4 @@ Home = "https://github.com/LedgerHQ/app-ethereum"
 ignore_missing_imports = true
 
 [tool.flake8]
-max-line-length = 120
+max-line-length = 120
diff --git a/doc/eth_contract_support_embedded.adoc b/doc/eth_contract_support_embedded.adoc
@@ -12,7 +12,7 @@ This document described how a specific device UI for a smart contract can be add
 
 ## Standard support
 
-The applications already includes dedicated UI support for those specific contract calls :
+The application already includes dedicated UI support for those specific contract calls :
 
    * ERC 20 approve(address, uint256) - implementation in *src_features/erc20_approval*
    * ERC 20 transfer(address, uint256) - implementation in *src_features/signTx*
@@ -45,4 +45,3 @@ A UI implementation might want to convert an ERC 20 token contract address to a
 2 tickers can be temporarily provisioned to the application by using the PROVIDE ERC 20 TOKEN INFORMATION APDU, described in *src_features/provideErc20TokenInformation* - the UI can then iterate on the provisioned tickers to display relevant information to the user
 
 The same mechanism will be extended to support well known contract addresses in the future
-
diff --git a/doc/ethapp.adoc b/doc/ethapp.adoc
@@ -801,7 +801,7 @@ None
 
 This command provides a trusted way of deciding what information from the JSON data to show and replace some values by more meaningful ones.
 
-This mode can be overriden by the in-app setting to fully clear-sign EIP-712 messages.
+This mode can be overridden by the in-app setting to fully clear-sign EIP-712 messages.
 
 For the signatures :
 

diff --git a/examples/signMessageEIP711v0.py b/examples/signMessageEIP711v0.py
@@ -59,7 +59,7 @@ def parse_bip32_path(path):
 domainHash = binascii.unhexlify(args.domainHash)
 messageHash = binascii.unhexlify(args.messageHash)
 
-encodedTx = domainHash + messageHash 
+encodedTx = domainHash + messageHash
 
 donglePath = parse_bip32_path(args.path)
 apdu = bytearray.fromhex("e00c0000")

diff --git a/makefile_conf/chain/akroma.mk b/makefile_conf/chain/akroma.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/200625'"
 TICKER = "AKA"
 CHAIN_ID = 200625
-APPNAME = "Akroma"
+APPNAME = "Akroma"
diff --git a/makefile_conf/chain/artis_sigma1.mk b/makefile_conf/chain/artis_sigma1.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/246529'"
 TICKER = "ATS"
 CHAIN_ID = 246529
-APPNAME = "ARTIS sigma1"
+APPNAME = "ARTIS sigma1"
diff --git a/makefile_conf/chain/artis_tau1.mk b/makefile_conf/chain/artis_tau1.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/246785'"
 TICKER = "ATS"
 CHAIN_ID = 246785
-APPNAME = "ARTIS tau1"
+APPNAME = "ARTIS tau1"
diff --git a/makefile_conf/chain/atheios.mk b/makefile_conf/chain/atheios.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/1620'"
 TICKER = "ATH"
 CHAIN_ID = 1620
-APPNAME = "Atheios"
+APPNAME = "Atheios"
diff --git a/makefile_conf/chain/bsc.mk b/makefile_conf/chain/bsc.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/60'"
 TICKER = "BNB"
 CHAIN_ID = 56
-APPNAME = "Binance Smart Chain"
+APPNAME = "Binance Smart Chain"
diff --git a/makefile_conf/chain/bttc.mk b/makefile_conf/chain/bttc.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/60'"
 TICKER = "BTT"
 CHAIN_ID = 199
-APPNAME = "BTTC"
+APPNAME = "BTTC"
diff --git a/makefile_conf/chain/callisto.mk b/makefile_conf/chain/callisto.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/820'"
 TICKER = "CLO"
 CHAIN_ID = 820
-APPNAME = "Callisto"
+APPNAME = "Callisto"
diff --git a/makefile_conf/chain/conflux_espace.mk b/makefile_conf/chain/conflux_espace.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/60'"
 TICKER = "CFX"
 CHAIN_ID = 1030
-APPNAME = "Conflux eSpace"
+APPNAME = "Conflux eSpace"
diff --git a/makefile_conf/chain/cube.mk b/makefile_conf/chain/cube.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/60'"
 TICKER = "CUBE"
 CHAIN_ID = 1818
-APPNAME = "Cube"
+APPNAME = "Cube"
diff --git a/makefile_conf/chain/dexon.mk b/makefile_conf/chain/dexon.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/237'"
 TICKER = "DXN"
 CHAIN_ID = 237
-APPNAME = "DEXON"
+APPNAME = "DEXON"
diff --git a/makefile_conf/chain/ellaism.mk b/makefile_conf/chain/ellaism.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/163'"
 TICKER = "ELLA"
 CHAIN_ID = 64
-APPNAME = "Ellaism"
+APPNAME = "Ellaism"
diff --git a/makefile_conf/chain/ether1.mk b/makefile_conf/chain/ether1.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/1313114'"
 TICKER = "ETHO"
 CHAIN_ID = 1313114
-APPNAME = "Ether-1"
+APPNAME = "Ether-1"
diff --git a/makefile_conf/chain/ethereum_classic.mk b/makefile_conf/chain/ethereum_classic.mk
@@ -2,4 +2,4 @@
 APP_LOAD_PARAMS += --path "44'/61'" --path "44'/60'"
 TICKER = "ETC"
 CHAIN_ID = 61
-APPNAME = "Ethereum Classic"
+APPNAME = "Ethereum Classic"
diff --git a/makefile_conf/chain/ethergem.mk b/makefile_conf/chain/ethergem.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/1987'"
 TICKER = "EGEM"
 CHAIN_ID = 1987
-APPNAME = "EtherGem"
+APPNAME = "EtherGem"
diff --git a/makefile_conf/chain/ethersocial.mk b/makefile_conf/chain/ethersocial.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/31102'"
 TICKER = "ESN"
 CHAIN_ID = 31102
-APPNAME = "Ethersocial"
+APPNAME = "Ethersocial"
diff --git a/makefile_conf/chain/expanse.mk b/makefile_conf/chain/expanse.mk
@@ -1,4 +1,4 @@
 APP_LOAD_PARAMS += --path "44'/40'"
 TICKER = "EXP"
 CHAIN_ID = 2
-APPNAME = "Expanse"
+APPNAME = "Expanse"