Introduce OptionsModel backend, Wire up Storage Amount settings to backend #207

jarolrod · 2022-12-14T09:35:09Z

This re-uses #184, with changes, to introduce an OptionsModel backend, while also wiring the Storage Amount settings; as the first settings to be wired to the options backend.

Both the "easy configuration" and "advanced configuration" methods for configuring the storage amount are wired to the backend. While on the fifth view of the onboarding wizard, the view with the header "Storage", if you click on the "Reduce Storage" button, your Settings.json file will show:

{
    "prune": 1907
}

and if you click on the "Store all data" button, your Settings.json file will show:

{
    "prune": 0
}

Within "Detailed Settings", you can examine that the prune target specified within the Settings.json file will only be non-zero if a non-zero value is set in storage limit and if the "Store recent blocks only" switch is enabled, as it should be.

The values you configure while onboarding will then be visible within the NodeSettings view when you click on "Storage".

Note: This doesn't complete the entire feature set around the setting, enabling, or disabling of this feature. There is still work to be done, this is the initial introduction and wiring.

The screenshots below highlight the functionality of this PR.

configuring while onboarding	correct values available within the node settings window

johnny9 · 2022-12-14T13:12:00Z

src/qml/bitcoin.cpp

@@ -185,6 +186,9 @@ int QmlGuiMain(int argc, char* argv[])

    engine.rootContext()->setContextProperty("nodeModel", &node_model);

+    OptionsQmlModel options_model{*node};
+    engine.rootContext()->setContextProperty("options", &options_model);


Might want a more specfic variable name here since its registered to the root to prevent possible conflicts with other property names. "optionsModel" maybe.

Also, I can't get my head around how this is working now. When hebasto did the previous PR setting a rootContext like this wasn't accessible in any of the sub components but this one is working. All I can think of is that it has something to do with how the StackView in main.qml is implemented now. Possibly due to the Onboarding components being statically defined instead of loading in the files with the Wizard.

In debug.log, I can observe a few TypeErrors.

% cat debug.log | grep GUI 2022-12-20T13:45:16Z GUI: qrc:/qml/components/StorageSettings.qml:24: TypeError: Cannot read property 'pruneSizeGB' of null 2022-12-20T13:45:16Z GUI: qrc:/qml/components/StorageSettings.qml:16: TypeError: Cannot read property 'prune' of null

The reason for this TypeError is that the OptionsQmlModel is initialized after the engine.
And since objects are destroyed in reverse order of how they are initialized, the OptionsQmlModel is getting destroyed before the QML engine.

The same TypeErrors existed in #184, as pointed out by @johnny9 here.

So you have to initialize the OptionsQmlModel before the engine to solve this.

will address both of these soon

hebasto · 2022-12-17T15:20:54Z

Rebase?

shaavan

There is one bug in the code due to which the OptionsButton and Setting are not correctly connected.

Steps to reproduce:

Start GUI.
Select the "no prune" option.
Complete onboarding.
Restart GUI.

Observation:

The OptionsButton has reset back to the "prune" option, but the prune option is deselected in the detailed setting.

Recording:

Recording.mp4

jarolrod · 2022-12-21T01:40:52Z

@shaavan technically that can be addressed, but the issue here really is that we just haven't introduced detection of whether or not it's the first time that the user is running the gui. If there is a settings.json in the data directory we're looking in we wouldn't be showing the onboarding process.

jarolrod · 2023-01-13T07:03:33Z

updated from 12cbdc9 to d72ac4c

changes: rebased over changes on master

hebasto · 2023-01-14T11:34:29Z

I've re-run CI.

johnny9 · 2023-01-14T19:14:35Z

src/qml/bitcoin.cpp

@@ -185,6 +186,9 @@ int QmlGuiMain(int argc, char* argv[])

    engine.rootContext()->setContextProperty("nodeModel", &node_model);

+    OptionsQmlModel options_model{*node};
+    engine.rootContext()->setContextProperty("options", &options_model);


Suggested change

engine.rootContext()->setContextProperty("options", &options_model);

engine.rootContext()->setContextProperty("optionsModel", &options_model);

johnny9 · 2023-01-14T19:14:59Z

src/qml/components/StorageOptions.qml

@@ -19,11 +19,18 @@ ColumnLayout {
        description: qsTr("Uses about 2GB. For simple wallet use.")
        recommended: true
        checked: true
+        onClicked: {
+            options.prune = true


Suggested change

options.prune = true

optionsModel.prune = true

johnny9 · 2023-01-14T19:15:18Z

src/qml/components/StorageOptions.qml

@@ -19,11 +19,18 @@ ColumnLayout {
        description: qsTr("Uses about 2GB. For simple wallet use.")
        recommended: true
        checked: true
+        onClicked: {
+            options.prune = true
+            options.pruneSizeGB = 2


Suggested change

options.pruneSizeGB = 2

optionsModel.pruneSizeGB = 2

jarolrod · 2023-01-17T01:57:56Z

updated from d72ac4c to cc96bd1, compare

Changes:

addressed feedback on naming
Added logic to set default prune values when the SettingsStorage page finishes loading. This is needed because if the user does not click on the prune button then the prune value will not actually get set in settings.json, even though the prune box is checked.

hebasto · 2023-01-17T09:27:10Z

Please rebase :)

Wires both the easy and advanced configuration options related to storage amount to the options model backend. Additionally, this removes an unused and unwanted storage location setting from the advanced storage amount settings table.

jarolrod · 2023-01-17T17:13:20Z

Updated from cc96bd1 to 63162b0

Changes: rebased over main

A note on implications of setting the default prune values when the page is loaded and in relation to #219:

If we have an approach where we are only loading one page at a time, that means if a user goes back or forwards, the page gets loaded again. This means that if the user had configured a prune target of 8gb as a custom setting, continued on to the next page then decided to go back and change the prune target, the prune target would be reset to 2gb. This can be mitigated with detection of settings already set, which is needed anyways.

Alternatively, the logic here can be changed into a form, where when the user finally finishes onboarding, then the settings get written. This is probably preferable anyways, for several cases such as quiting the application during onboarding; if we write settings, we wouldn't show onboarding again, but if we only write settings when onboarding is finished, the onboarding wizard will show on subsequent gui startups until the user completes onboarding.

johnny9

ACK 63162b0

Built and tested. Changes look good.

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

Wires both the easy and advanced configuration options related to storage amount to the options model backend. Additionally, this removes an unused and unwanted storage location setting from the advanced storage amount settings table. Github-Pull: bitcoin-core#207 Rebased-From: 63162b0

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

Wires both the easy and advanced configuration options related to storage amount to the options model backend. Additionally, this removes an unused and unwanted storage location setting from the advanced storage amount settings table. Github-Pull: bitcoin-core#207 Rebased-From: 63162b0

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

Wires both the easy and advanced configuration options related to storage amount to the options model backend. Additionally, this removes an unused and unwanted storage location setting from the advanced storage amount settings table. Github-Pull: bitcoin-core#207 Rebased-From: 63162b0

johnny9 reviewed Dec 14, 2022

View reviewed changes

hebasto added the Needs rebase label Dec 17, 2022

shaavan reviewed Dec 20, 2022

View reviewed changes

jarolrod force-pushed the storage-options-model branch from 12cbdc9 to d72ac4c Compare January 13, 2023 07:02

hebasto removed the Needs rebase label Jan 14, 2023

hebasto requested a review from johnny9 January 14, 2023 11:34

johnny9 reviewed Jan 14, 2023

View reviewed changes

jarolrod force-pushed the storage-options-model branch from d72ac4c to cc96bd1 Compare January 17, 2023 01:53

hebasto added the Needs rebase label Jan 17, 2023

hebasto and others added 3 commits January 17, 2023 11:40

qml, build: Add OptionsQmlModel class with basic implementation

4c6562e

qml: Add "-prune" settings to OptionsQmlModel class

93f78f8

jarolrod force-pushed the storage-options-model branch from cc96bd1 to 63162b0 Compare January 17, 2023 17:07

johnny9 approved these changes Jan 17, 2023

View reviewed changes

hebasto merged commit 56957d4 into bitcoin-core:main Jan 17, 2023

jarolrod deleted the storage-options-model branch January 17, 2023 19:56

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 8, 2025

qml, build: Add OptionsQmlModel class with basic implementation

7374ca4

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 8, 2025

qml: Add "-prune" settings to OptionsQmlModel class

e086bcd

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

qml, build: Add OptionsQmlModel class with basic implementation

72745b5

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

qml: Add "-prune" settings to OptionsQmlModel class

6674e27

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

qml, build: Add OptionsQmlModel class with basic implementation

d703688

Github-Pull: bitcoin-core#207 Rebased-From: 4c6562e

hebasto added a commit to hebasto/gui-qml that referenced this pull request Jun 9, 2025

qml: Add "-prune" settings to OptionsQmlModel class

bb3dfd5

Github-Pull: bitcoin-core#207 Rebased-From: 93f78f8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce OptionsModel backend, Wire up Storage Amount settings to backend #207

Introduce OptionsModel backend, Wire up Storage Amount settings to backend #207

Uh oh!

jarolrod commented Dec 14, 2022 •

edited by hebasto

Loading

Uh oh!

johnny9 Dec 14, 2022 •

edited

Loading

Uh oh!

shaavan Dec 20, 2022

Uh oh!

jarolrod Jan 13, 2023

Uh oh!

hebasto commented Dec 17, 2022

Uh oh!

shaavan left a comment

Uh oh!

jarolrod commented Dec 21, 2022

Uh oh!

jarolrod commented Jan 13, 2023

Uh oh!

hebasto commented Jan 14, 2023

Uh oh!

johnny9 Jan 14, 2023

Uh oh!

johnny9 Jan 14, 2023

Uh oh!

johnny9 Jan 14, 2023

Uh oh!

jarolrod commented Jan 17, 2023

Uh oh!

hebasto commented Jan 17, 2023

Uh oh!

jarolrod commented Jan 17, 2023

Uh oh!

johnny9 left a comment

Uh oh!

Uh oh!

	engine.rootContext()->setContextProperty("options", &options_model);
	engine.rootContext()->setContextProperty("optionsModel", &options_model);

Introduce OptionsModel backend, Wire up Storage Amount settings to backend #207

Introduce OptionsModel backend, Wire up Storage Amount settings to backend #207

Uh oh!

Conversation

jarolrod commented Dec 14, 2022 • edited by hebasto Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnny9 Dec 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shaavan Dec 20, 2022

Choose a reason for hiding this comment

Uh oh!

jarolrod Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

hebasto commented Dec 17, 2022

Uh oh!

shaavan left a comment

Choose a reason for hiding this comment

Uh oh!

jarolrod commented Dec 21, 2022

Uh oh!

jarolrod commented Jan 13, 2023

Uh oh!

hebasto commented Jan 14, 2023

Uh oh!

johnny9 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

johnny9 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

johnny9 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

jarolrod commented Jan 17, 2023

Uh oh!

hebasto commented Jan 17, 2023

Uh oh!

jarolrod commented Jan 17, 2023

Uh oh!

johnny9 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jarolrod commented Dec 14, 2022 •

edited by hebasto

Loading

johnny9 Dec 14, 2022 •

edited

Loading