Addition of Poethepoet package as task runner manager

CHANGELOG.md

@@ -1,3 +1,48 @@
+# Changelog 24.04.beta8 - November 20, 2023
+
+## Changes
+
+### IRQ Interfaces
+Button and touch presses are now detected by the application through IO interrupts. Meaning inputs events will be registered and handled even if they happened when other tasks were being executed by the processor, resulting in a better UX.
+
+### Save and Load Wallet Output Descriptor from SD card
+Create or load from a wallet output descriptor file on a SD card. The backup file format is compatible with most coordinators.
+
+### Restore Default Settings
+Option to restore the device's settings to its factory state.
+
+### Wipe Device
+Option on settings to wipe the device, permanently removing settings and stored encrypted mnemonics by erasing every single bit of user's flash space.
+
+### Screensaver
+Optional screensaver to reduce pixels' burn-in and grab attention of the user when the device is left powered on.
+
+### Maix Dock Simulator
+Now Krux PC simulator can also run in Maix Dock mode, mimetizing appearance and characteristics of the most DIY Krux device
+
+### Update Embit to version 0.7
+Use latest Embit release
+
+### Optimized QR codes
+QR codes rendering is faster and uses less RAM
+
+### Mnemonic Numbers
+To match the input options, export mnemonics as decimal, hexadecimal or octal numbers
+When loading from numbers, a new numbers confirmation screen was added.
+
+### Addresses Exploring
+More receive and change addresses per page are shown on bigger screens
+
+### Export QR Codes as Images to SD Card
+Some QR codes can be exported as images to SD card
+
+### Optimized Settings Storage
+Device's storage is now used more efficiently, data is stored less frequently, only in case a setting is changed from defaults.
+
+### Other Small Fixes and Code Optimizations
+Many other small fixes and optimizations under the hood
+
+
 # Version 23.09.1 - November 18, 2023
 This release contain bugfixes:
 

README.md

@@ -66,25 +66,25 @@ Note that you can run `poetry install` after making a change to the krux code if
 
 ## Format code
 ```bash
-poetry run black ./src
-poetry run black ./tests
+poetry run poe format
 ```
 
 ## Run pylint
 ```bash
-poetry run pylint ./src
+poetry run poe lint
 ```
 
 ## Run tests
 ```bash
-poetry run pytest --cache-clear --cov src/krux --cov-report html ./tests
+poetry run poe test
 ```
+
 This will run all tests and generate a coverage report you can browse to locally in your browser at `file:///path/to/krux/htmlcov/index.html`.
 
 For more verbose test output (e.g., to see the output of print statements), run:
 
 ```bash
-poetry run pytest --cache-clear --cov src/krux --cov-report html --show-capture all --capture tee-sys -r A ./tests
+poetry run poe test-verbose
 ```
 
 To run just a specific test from a specific file, run:

docs/faq.en.md

@@ -72,4 +72,7 @@ If after flashing `maixpy_amigo_tft` to your device you notice that the buttons
 Starting from version 23.09.0, Krux supports SD card hot plugging. If you are using older versions, it may only detect the SD card at boot, so make sure Krux is turned off when inserting the microSD into it. To test the card compatibility use Krux [Tools>Check SD Card](getting-started/features/tools.md/#check-sd-card).
 Make sure the SD card is using MBR/DOS partition table and FAT32 format.
 
-Here is some [supported microSD cards](https://github.com/m5stack/m5-docs/blob/master/docs/en/core/m5stickv.md#tf-cardmicrosd-test), and here is the MaixPy FAQ explaining [Why my micro SD card cannot be read](https://wiki.sipeed.com/soft/maixpy/en/others/maixpy_faq.html#Micro-SD-card-cannot-be-read).
+Here is some [supported microSD cards](https://github.com/m5stack/m5-docs/blob/master/docs/en/core/m5stickv.md#tf-cardmicrosd-test), and here is the MaixPy FAQ explaining [Why my micro SD card cannot be read](https://wiki.sipeed.com/soft/maixpy/en/others/maixpy_faq.html#Micro-SD-card-cannot-be-read).
+
+## Why insert an SD card into my device? What is it for? Does it save something?
+SD card use is optional, most people use Krux only with QR codes. But you can use SD card to to upgrade the firmware, save settings, cnc/file, QR codes, XPUBs, encrypted mnemonics, and to save and load PSBTs, messages and wallet output descriptors.

docs/getting-started/usage/generating-a-mnemonic.en.md

@@ -53,8 +53,13 @@ Note: For 12-word mnemonics, only the first half of the SHA256 hash is used (128
 
 <div style="clear: both"></div>
 
+### How to verify
+
+Don't trust, verify.  We encourage you not to trust any claim you cannot verify yourself. Therefore, there are wallets that use compatible algorithms to calculate the entropy derived from dice rolls. You can use the [SeedSigner](https://seedsigner.com/) or Coldcard hardware wallets, or even the [Bitcoiner Guide website](https://bitcoiner.guide/seed/), they share the same logic that Krux uses and will give the same mnemonic.
+
 ## Alternatives
-See [here](https://vault12.com/securemycrypto/cryptocurrency-security-how-to/seed-phrase-creation/) for good methods to generate a mnemonic manually, or visit [Ian Coleman's BIP-39 Tool](https://iancoleman.io/bip39/) offline or on an airgapped device to generate one automatically. 
 
-It's worth noting that Ian's tool is able to take a mnemonic and generate a QR code that Krux can read in via the QR input method mentioned on the next page.
+You can use any other offline airgapped devices to generate your mnemonic. If you want to use a regular PC, a common strategy is to boot the PC using [Tails](https://tails.boum.org/) from a USB stick, without connecting the device to the internet, and then use a copy of the the [Bitcoiner Guide website](https://bitcoiner.guide/seed/) or even [Ian Coleman's BIP-39 Tool](https://iancoleman.io/bip39/). It's worth noting that both generate a QR code that Krux can read via the QR input method mentioned on the next page (Loading a Mnemonic).
+
+See [here](https://vault12.com/securemycrypto/cryptocurrency-security-how-to/seed-phrase-creation/) for other good methods to generate a mnemonic manually.
 

docs/getting-started/usage/navigating-the-main-menu.en.md

@@ -62,7 +62,7 @@ The encrypted mnemonic will be converted to a QR code. When you scan this QR cod
 <img src="../../../img/maixpy_m5stickv/extended-public-key-wsh-xpub-text-125.png" align="right">
 <img src="../../../img/maixpy_amigo_tft/extended-public-key-wsh-xpub-text-150.png" align="right">
 
-This option displays your master extended public key (xpub) as text as well as a QR code.
+This option displays your master extended public key (xpub) as text as well as a QR code. The extended public key (xpub) can also be stored on a SD card if available.
 
 After the xpub, a zpub or Zpub is shown depending on if a single-sig or multisig wallet was chosen. This z/Zpub is usually not necessary unless you are using a wallet coordinator that either cannot parse or ignores [key origin information in key expressions](https://github.com/bitcoin/bips/blob/master/bip-0380.mediawiki#Key_Expressions).
 

firmware/font/README.md

@@ -1,14 +1,14 @@
 # Updating the built-in font
-Krux uses a [custom fork](https://github.com/bachan/terminus-font-vietnamese) of the [Terminus](http://terminus-font.sourceforge.net/) font for its glyphs that includes Vietnamese characters, the Bitcoin currency symbol (₿) and the Pokémon Dollar symbol (₽ with 2 horizontal lines).
+Krux uses a [custom fork](https://github.com/bachan/terminus-font-vietnamese) of the [Terminus](http://terminus-font.sourceforge.net/) font for its glyphs that includes Vietnamese characters, the Bitcoin currency symbol (₿) and custom icons.
 
 To rebuild the font for all devices, run:
 ```
 ./bdftokff.sh ter-u14n 8 14 > m5stickv.kff
-./bdftokff.sh ter-u16n 8 16 > bit_dock.kff
+./bdftokff.sh ter-u16n 8 16 > bit_dock_yahboom.kff
 ./bdftokff.sh ter-u24b 12 24 > amigo.kff
 ```
 
-Once you have a `.kff` file, locate the project that you want to use the updated font under `firmware/MaixPy/projects/` (`maixpy_amigo_tft/` for ex.), open its `compile/overrides/components/micropython/port/src/omv/img/font.c` file and replace the array contents in the `unicode` variable with the byte array found within the `.kff` file, then rebuild the firmware.
+Once you have `.kff` files, for each project that you want to use the updated fonts, edit `../MaixPy/projects/*/compile/overrides/components/micropython/port/src/omv/img/font.c` (substituting `maixpy_amigo_tft` for `*` if only for an amigo) and replace the array contents in the `unicode` variable with the byte array found within the appropriate `.kff` file, then rebuild the firmware.
 
 # How it works
 Krux uses bitmap fonts that are custom-built for each device it runs on. The format that the firmware expects fonts to be in is a custom format referred to as "krux font format," or `.kff`. 

firmware/font/font_icons/Derivation_bit_dock_yahboom.pbm

@@ -0,0 +1,4 @@
+P4
+# Created by GIMP version 2.10.34 PNM plug-in
+8 16
+ðððð`dffd`df

firmware/font/font_icons/Derivation_m5stickv.pbm

@@ -0,0 +1,4 @@
+P4
+# Created by GIMP version 2.10.34 PNM plug-in
+8 14
+ðððôffd`df

firmware/font/font_icons/Fingerprint_m5stickv.pbm

@@ -0,0 +1,4 @@
+P4
+# Created by GIMP version 2.10.34 PNM plug-in
+8 14
+<fyͅ­¹ƒî8ƒæ<

firmware/font/font_icons/pbm2bdf.py

@@ -0,0 +1,66 @@
+# The MIT License (MIT)
+
+# Copyright (c) 2021-2023 Krux contributors
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# Convert pbm files to bdf format
+# Draw pbm files in gimp and use them as glyphs
+# Usage: python pbm2bdf.py Derivation_Amigo.pbm 21B3
+# Where 21B3 is the target codepoint, ex U+21B3
+# Copy the output to the bdf file
+
+import sys
+
+code_point_hex = None
+try:
+    pbm_file = sys.argv[1]
+    code_point_hex = sys.argv[2]
+except Exception as e:
+    print("Not enough arguments")
+    exit()
+try:
+    with open(pbm_file, "rb") as f:
+        lines = f.read().split(b"\n")
+        popped = 0
+        for i in range(len(lines)):
+            if lines[i - popped].startswith(b"#"):
+                lines.pop(i - popped)
+                popped += 1
+        dimensions = lines[1].split(b" ")
+        width = int(dimensions[0].decode())
+        bytes_width = (width + 7) // 8
+        height = int(dimensions[1].decode())
+
+except Exception as e:
+    print(e, "Failed to read file")
+    exit()
+print("STARTCHAR U+" + code_point_hex.upper())
+print("ENCODING " + str(int(code_point_hex, 16)))
+print("SWIDTH 1000 0")
+print("DWIDTH " + str(width) + " 0")
+print("BBX " + str(width) + " " + str(height) + " 0 0")
+print("BITMAP")
+
+for i in range(len(lines[2]) // bytes_width):
+    line_bytes = ""
+    for j in range(bytes_width):
+        line_bytes += "%0.2X" % lines[2][i * bytes_width + j]
+    print(line_bytes)
+print("ENDCHAR")

firmware/font/ter-u14n.bdf

@@ -29993,27 +29993,10 @@ BITMAP
 04
 78
 ENDCHAR
-STARTCHAR U+20BD
-ENCODING 8381
-SWIDTH 571 0
-DWIDTH 8 0
-BBX 8 11 0 -1
-BITMAP
-3E
-21
-21
-21
-3E
-20
-FC
-20
-FC
-20
-20
-ENDCHAR
+
 STARTCHAR U+20BF
 ENCODING 8383
-SWIDTH 500 0
+SWIDTH 1000 0
 DWIDTH 8 0
 BBX 8 14 0 -2
 BITMAP
@@ -30032,4 +30015,46 @@ FE
 28
 28
 ENDCHAR
+STARTCHAR U+21B3
+ENCODING 8627
+SWIDTH 1000 0
+DWIDTH 8 0
+BBX 8 14 0 0
+BITMAP
+F0
+F0
+F0
+F4
+66
+7F
+66
+64
+60
+64
+66
+7F
+06
+04
+ENDCHAR
+STARTCHAR U+229A
+ENCODING 8858
+SWIDTH 1000 0
+DWIDTH 8 0
+BBX 8 14 0 0
+BITMAP
+3C
+66
+03
+79
+CD
+85
+AD
+B9
+83
+EE
+38
+83
+E6
+3C
+ENDCHAR
 ENDFONT

firmware/font/ter-u16n.bdf

@@ -32707,24 +32707,6 @@ BITMAP
 04
 78
 ENDCHAR
-STARTCHAR U+20BD
-ENCODING 8381
-SWIDTH 500 0
-DWIDTH 8 0
-BBX 8 11 0 -1
-BITMAP
-3E
-21
-21
-21
-3E
-20
-FC
-20
-FC
-20
-20
-ENDCHAR
 STARTCHAR U+20BF
 ENCODING 8383
 SWIDTH 500 0
@@ -32746,4 +32728,50 @@ FE
 28
 28
 ENDCHAR
+STARTCHAR U+21B3
+ENCODING 8627
+SWIDTH 1000 0
+DWIDTH 8 0
+BBX 8 16 0 0
+BITMAP
+F0
+F0
+F0
+F0
+60
+64
+66
+7F
+66
+64
+60
+64
+66
+7F
+06
+04
+ENDCHAR
+STARTCHAR U+229A
+ENCODING 8858
+SWIDTH 1000 0
+DWIDTH 8 0
+BBX 8 16 0 -2
+BITMAP
+00
+3C
+66
+03
+79
+CD
+85
+AD
+B9
+83
+EE
+38
+83
+E6
+3C
+00
+ENDCHAR
 ENDFONT