Merge branch 'nickez/simulator-winit'

Author: NickeZ

.github/workflows/ci-common.yml

@@ -201,6 +201,7 @@ jobs:
           - factory-setup
           - firmware-debug
           - simulator
+          - simulator-graphical
     runs-on: ubuntu-22.04
     container:
       image: ${{ inputs.container-repo }}:${{ inputs.container-version }}

BUILD.md

@@ -161,12 +161,22 @@ make bootloader
 
 ### Build the simulator
 
-The Multi edition firmware can be built as a simulator for linux-amd64. To build it, run:
+The Multi edition firmware can be built as a simulator for linux and macos. To
+build it, run:
 
 ```sh
 make simulator
 ```
 
+### Build the graphical simulator
+
+The Multi edition firmware can be built as a graphical simulator for linux and
+macos. To build it, run:
+
+```sh
+make simulator-graphical
+```
+
 ### Flash instructions
 
 #### Connect J-Link probe
@@ -236,17 +246,28 @@ To view the results, open `build/docs/html/index.html` in a web browser.
 Run it with:
 
 ```sh
-./build-build/bin/simulator
+./build-build-noasan/bin/simulator
 ```
 
-This launches a server simulating the firmware. The send_message tool can connect to it with:
+or the following if you built the graphical one:
+
+```sh
+./build-build-noasan/bin/simulator-graphical --preseed
+```
+
+This launches a server simulating the firmware. The send_message tool can
+connect to it with:
 
     ./py/send_message.py --simulator
 
-If you choose to create a wallet by restoring a mnemonic, the simulator will automatically use this
-mnemonic:
+Both simulators can load the following seed:
+
+    boring mistake dish oyster truth pigeon viable emerge sort crash wire
+    portion cannon couple enact box walk height pull today solid off enable
+    tide
 
-    boring mistake dish oyster truth pigeon viable emerge sort crash wire portion cannon couple enact box walk height pull today solid off enable tide
+The graphical simulator does it with the flag `--preseed`. The original
+simulator loads it if you restore from mnemonic.
 
 
 #### Debugging using the J-Link probe and GDB

CHANGELOG.md

@@ -8,6 +8,7 @@ customers cannot upgrade their bootloader, its changes are recorded separately.
 
 ### [Unreleased]
 - Fix bug that BLE was turned off when iOS device is unlocked
+- simulator-graphical: a new simulator with a graphical user interface
 
 ### v9.24.0
 - Change title when entering recovery words to `1 of 24`, `2 of 24`, etc.

CMakeLists.txt

@@ -369,6 +369,7 @@ else()
   include(CTest)
   add_subdirectory(test/unit-test)
   add_subdirectory(test/simulator)
+  add_subdirectory(test/simulator-graphical)
   if(COVERAGE)
     find_program(GCOVR gcovr)
     if(NOT GCOVR STREQUAL "GCOVR-NOTFOUND")

Makefile

@@ -108,6 +108,8 @@ rust-docs: | build
 	$(MAKE) -C build rust-docs
 simulator: | build-build-noasan
 	$(MAKE) -C build-build-noasan simulator
+simulator-graphical: | build-build-noasan
+	$(MAKE) -C build-build-noasan simulator-graphical
 run-simulator: | simulator
 	./build-build-noasan/bin/simulator
 unit-test: | build-build
@@ -189,3 +191,7 @@ prepare-tidy: | build build-build
 	$(MAKE) -C build-build rust-cbindgen
 clean:
 	rm -rf build build-build build-debug build-build-noasan
+
+# When you vendor rust libs avoid duplicates
+vendor-rust-deps:
+	(cd external; ./vendor-rust.sh)

README.md

@@ -59,6 +59,14 @@ messages. The encryption protocol used is Noise with out-of-band authentication.
 The instructions for setting up a development environment can be found in [BUILD.md](BUILD.md).
 Please also read our [CONTRIBUTING.md](CONTRIBUTING.md) before filing issues and pull requests.
 
+### Simulator
+
+To test without hardware there are two kinds of simulators. One with GUI and
+one without. See more details in [BUILD.md](BUILD.md#build-the-simulator).
+
+<p align="center"><img src="./doc/bb02-simulator-graphical.png" /></p>
+
+
 ## Installing/upgrading firmware
 
 There are two main ways to install or upgrade firmware on a BitBox02:

doc/bb02-simulator-graphical.png

@@ -17,4 +17,4 @@ branch = "bitbox-20250922"
 replace-with = "vendored-sources"
 
 [source.vendored-sources]
-directory = "external/vendor"
+directory = "../../external/vendor"

.cargo/config.toml renamed to src/rust/.cargo/config.toml

@@ -38,5 +38,16 @@ We generate one header file `rust.h` and ever product specific function is `#ifd
 
 # Vendoring
 
-Run the vendoring script `vendor.sh` to vendor dependencies from crates.io. The
-script will ensure that also rust std libs dependencies are vendored.
+Run the vendoring script `vendor-rust.sh` to vendor dependencies from
+crates.io. The script will ensure that also rust std libs dependencies are
+vendored.
+
+When the toolchain (and standard libraries) are updated they usually depend on
+newer versions of crates. Update our lockfile to the same versions to avoid
+vendoringing duplicate versions. You can use:
+
+```
+cargo update <package> --precise <version>
+```
+
+to specify specific versions to up/downgrade to.

src/rust/README.md

@@ -90,6 +90,14 @@ testing = ["bitbox02-rust/testing", "bitbox02/testing"]
 # Active when the Rust code is compiled to be linked into the C unit tests and simulator.
 c-unit-testing = ["bitbox02-rust/c-unit-testing", "bitbox02/c-unit-testing", "util/c-unit-testing"]
 
+simulator-graphical = [
+  "app-bitcoin",
+  "app-litecoin",
+  "app-ethereum",
+  "app-cardano",
+  "firmware",
+]
+
 app-ethereum = [
   # enable this feature in the deps
   "bitbox02-rust/app-ethereum",