Merge pull request #535 from HathorNetwork/dev

chore: merge dev changes on master

.github/workflows/e2e.yml

@@ -3,13 +3,15 @@ name: End-to-end tests
 #   push:
 #     branches:
 #       - master
-#       - dev
+#       - release-candidate
+#       - release
 #     tags:
 #       - v*
 #   pull_request:
 #     branches:
-#       - dev
 #       - master
+#       - release-candidate
+#       - release
 jobs:
   cypress-run:
     runs-on: ubuntu-20.04

.github/workflows/main.yml

@@ -3,13 +3,15 @@ on:
   push:
     branches:
     - master
-    - dev
+    - release
+    - release-candidate
     tags:
     - v*
   pull_request:
     branches:
-    - dev
     - master
+    - release
+    - release-candidate
 jobs:
   test:
     runs-on: 'ubuntu-latest'

QA.md

@@ -88,7 +88,7 @@ You can connect your wallet to the testnet (https://node1.foxtrot.testnet.hathor
 1. **Transaction detail**
     1. It should be on the main screen with the HTR selected. Click on the first transaction.
     1. The token list now has a warning that TST is not registered.
-    1. Click on the uid and register it. 
+    1. Click on the uid and register it.
 
 1. **Register in the 'Custom tokens' screen**
     1. Click on 'About Test Token' tab.
@@ -200,7 +200,7 @@ You can connect your wallet to the testnet (https://node1.foxtrot.testnet.hathor
 
 1. **Late backup**
     1. Reset the wallet and close it.
-    1. Open the wallet with the parameters `--unsafe-mode --debug`.
+    1. Open the wallet with the parameters `--unsafe-mode --debug` (see the README.md under "Debug mode on installed app" to understand how).
     1. Click on the application menu Debug > Open Dev Tools. Then type `localStorage.clear()`. This is to simulate a fresh install of the app.
     1. Close and open the wallet again and start a new wallet one without doing backup. It must show a yellow warning saying a backup must be done.
     1. Do the backup (following procedures in the 'Initialization' tests). The backup message has to disappear.

README.md

@@ -12,16 +12,16 @@ You can download the newest version of the wallet for each specific platform fro
 
 ## Screenshots
 
-The basic view of the wallet.  Note that different types of tokens are made possible in the Hathor Network.  On the left hand side we see both a HTR tab and a MTK tab, for the Hathor token, and a different, ERC-20 like, token.   
+The basic view of the wallet.  Note that different types of tokens are made possible in the Hathor Network.  On the left hand side we see both a HTR tab and a MTK tab, for the Hathor token, and a different, ERC-20 like, token.
 ![Wallet Home](https://drive.google.com/thumbnail?id=1pJ4JAxTXjMHW1Xuc4cCG0d0LKeVBGgM6&sz=w3000-h2250)
 
-Sending tokens.  
+Sending tokens.
 ![Send Tokens](https://drive.google.com/thumbnail?id=1Lq6Q0j2J0989vfYzykVSpYjra3bLTI2u&sz=w3000-h2250)
 
-The wallet includes a block and transaction explorer.  
+The wallet includes a block and transaction explorer.
 ![Explorer](https://drive.google.com/thumbnail?id=1YdEfGB7L9E2tA4vGDTsGdGvoKw5bqdhT&sz=w3000-h2250)
 
-A transaction is displayed.  
+A transaction is displayed.
 ![Transaction Detail](https://drive.google.com/thumbnail?id=1N3IaiT0kBT1QkRq6xU_b_D66EZBVajiB&sz=w3000-h2250)
 
 ## For development
@@ -30,7 +30,7 @@ A transaction is displayed.
 
 * Install node v20
 
-### To Install
+### To install dependencies
 
 ```
 npm install
@@ -63,6 +63,19 @@ To use the Chrome Dev Tools associated with Electron for debugging purposes, the
 npm run electron-dev -- --unsafe-mode --hathor-debug
 ```
 
+### Debug mode on installed app
+
+To run the app in debug mode on an installed app you need to pass the flags `--hathor-debug` and `--unsafe-mode` to the app.
+The way to do this depends on your environment.
+
+On Windows the app is installed in the `C:\Users\<username>\AppData\Local\Programs\hathor-wallet` folder.
+You will need to open a terminal (CMD, Powershell, etc.) and run the `Hathor Wallet.exe` executable with the flags above.
+On CMD the command would be `& '.\Hathor Wallet.exe' --unsafe-mode --hathor-debug` or `& 'C:\Users\<username>\AppData\Local\Programs\hathor-wallet\Hathor Wallet.exe' --unsafe-mode --hathor-debug`.
+
+On Linux the app is installed in a way that it is available as the command `hathor-wallet`, so we can simply run `hathor-wallet --unsafe-mode --hathor-debug` from the terminal.
+
+On MacOS the app is usually installed in `/Applications` in a way that is possible to run the following command `open /Applications/Hathor\ Wallet.app --args --hathor-debug --unsafe-mode` from the terminal.
+
 ### To Build
 
 `npm run build` and it will create a folder build with the files to use

RELEASING.md

@@ -16,11 +16,10 @@ In case this is a Hathor release, make sure you also read our [internal guide](h
 
 1. Make sure you have the following environment variables set: `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD` ( [see docs](https://www.electron.build/configuration/mac) ).
 1. Replace the `build.mac.notarize.teamId` property on the `package.json` file with the correct value.
-1. Due to a bug on the notarization process, some versions of `npm` are not able to execute it successfully. The following configurations, that were used on [our last successful build](https://github.com/HathorNetwork/internal-issues/issues/200#issuecomment-1830765685), should work correctly:
+1. Check that the you are using the following version of the tools:
   <br/>- Python 3.11.6
-  <br/>- NodeJS 16.20.1
-  <br/>- npm 8.15.0
-
+  <br/>- NodeJS 20
+
 
 
 1. Run the `release.sh` script, which will clean the environment and build the app for all platforms. The files go to the `dist` folder after the script finishes running. You should get 4 of them: `.AppImage`, `.deb`, `.dmg` and `.exe`.
@@ -96,7 +95,7 @@ $ trust
 
 ## Our public keys
 
-Current releases are signed by one or more of the keys in [./gpg-keys](./gpg-keys). You should download them all and import them with: 
+Current releases are signed by one or more of the keys in [./gpg-keys](./gpg-keys). You should download them all and import them with:
 
 ```
 gpg --import *.pgp