feat(wallet) save/load collectibles user handled state in DB

Add a separation layer for save/load/clear/reset to ManageTokensModel so that we can save/load from external sources. The layer uses JSON as protocol and forwards that to current QSettings for storybook and NIM controllers for StatusQ. - [ ] Separate the dynamic private user data from static state settings (ArrangeByCommunity, ArrangeByCollection) - [ ] Handle HiddenCommunityGroups and HiddenCollectionGroups in DB Updates #13313
status-im · Mar 8, 2024 · a725576 · a725576
1 parent a9b5d8f
commit a725576
Show file tree

Hide file tree

Showing 18 changed files with 469 additions and 214 deletions.
diff --git a/src/backend/collectibles_types.nim b/src/backend/collectibles_types.nim
@@ -87,14 +87,14 @@ type
     contractAddress*: string
     owners*: seq[CollectibleOwner]
 
-  # see status-go/services/wallet/collectibles/service.go CollectibleDataType
+  # Mirrors status-go/multiaccounts/settings_wallet/database.go CollectiblePreferencesType
   CollectiblePreferencesItemType* {.pure.} = enum
-    NonCommunityCollectible = 1, 
-    CommunityCollectible, 
-    Collection, 
+    NonCommunityCollectible = 1,
+    CommunityCollectible,
+    Collection,
     Community
 
-  # Mirrors services/wallet/thirdparty/collectible_types.go CollectibleContractOwnership
+  # Mirrors status-go/multiaccounts/settings_wallet/database.go CollectiblePreferences
   CollectiblePreferences* = ref object of RootObj
     itemType* {.serializedFieldName("type").}: CollectiblePreferencesItemType
     key* {.serializedFieldName("key").}: string

diff --git a/storybook/pages/AssetsViewPage.qml b/storybook/pages/AssetsViewPage.qml
@@ -104,6 +104,10 @@ SplitView {
             controller: ManageTokensController {
                 sourceModel: d.walletAssetStore.groupedAccountAssetsModel
                 settingsKey: "WalletAssets"
+
+                onRequestLoadSettings: loadFromQSettings()
+                onRequestClearSettings: clearQSettings()
+
                 onTokenHidden: (symbol, name) => Global.displayToastMessage(
                                    qsTr("%1 (%2) was successfully hidden").arg(name).arg(symbol), "", "checkmark-circle",
                                    false, Constants.ephemeralNotificationType.success, "")

diff --git a/storybook/pages/CollectiblesViewPage.qml b/storybook/pages/CollectiblesViewPage.qml
@@ -82,6 +82,10 @@ SplitView {
         controller: ManageTokensController {
             sourceModel: renamedModel
             settingsKey: "WalletCollectibles"
+
+            onRequestLoadSettings: loadFromQSettings()
+            onRequestClearSettings: clearQSettings()
+
             onTokenHidden: (symbol, name) => Global.displayToastMessage(
                                qsTr("%1 was successfully hidden").arg(name), "", "checkmark-circle",
                                false, Constants.ephemeralNotificationType.success, "")

diff --git a/storybook/pages/ManageAssetsPanelPage.qml b/storybook/pages/ManageAssetsPanelPage.qml
@@ -50,6 +50,9 @@ SplitView {
         controller: ManageTokensController {
             sourceModel: ctrlEmptyModel.checked ? null : walletAssetStore.groupedAccountAssetsModel
             settingsKey: "WalletAssets"
+
+            onRequestLoadSettings: loadFromQSettings()
+            onRequestClearSettings: clearQSettings()
         }
     }
 

diff --git a/storybook/pages/ManageCollectiblesPanelPage.qml b/storybook/pages/ManageCollectiblesPanelPage.qml
@@ -44,6 +44,8 @@ SplitView {
         controller: ManageTokensController {
             sourceModel: renamedModel
             settingsKey: "WalletCollectibles"
+
+            onRequestLoadSettings: loadFromQSettings()onRequestClearSettings: clearQSettings()
         }
     }
 

diff --git a/storybook/pages/ManageHiddenPanelPage.qml b/storybook/pages/ManageHiddenPanelPage.qml
@@ -44,12 +44,18 @@ SplitView {
         id: assetsController
         sourceModel: ctrlEmptyModel.checked ? null : walletAssetStore.groupedAccountAssetsModel
         settingsKey: "WalletAssets"
+
+        onRequestLoadSettings: loadFromQSettings()
+        onRequestClearSettings: clearQSettings()
     }
 
     ManageTokensController {
         id: collectiblesController
         sourceModel: ctrlEmptyModel.checked ? null : renamedModel
         settingsKey: "WalletCollectibles"
+
+        onRequestLoadSettings: loadFromQSettings()
+        onRequestClearSettings: clearQSettings()
     }
 
     ManageHiddenPanel {

diff --git a/storybook/qmlTests/tests/tst_ManageCollectiblesPanel.qml b/storybook/qmlTests/tests/tst_ManageCollectiblesPanel.qml
@@ -37,10 +37,18 @@ Item {
             controller: ManageTokensController {
                 sourceModel: renamedModel
                 settingsKey: "WalletCollectibles"
+
+                onRequestLoadSettings: loadFromQSettings()
+                onRequestClearSettings: clearQSettings()
+
                 onCommunityTokenGroupHidden: (communityName) => Global.displayToastMessage(
                                                  qsTr("%1 community collectibles successfully hidden").arg(communityName), "", "checkmark-circle",
                                                  false, Constants.ephemeralNotificationType.success, "")
             }
+
+            function clearSettings() {
+                controller.clearQSettings()
+            }
         }
     }
 

diff --git a/ui/StatusQ/CMakeLists.txt b/ui/StatusQ/CMakeLists.txt
@@ -141,6 +141,8 @@ add_library(StatusQ SHARED
         src/wallet/managetokenscontroller.h
         src/wallet/managetokensmodel.cpp
         src/wallet/managetokensmodel.h
+        src/wallet/tokendata.cpp
+        src/wallet/tokendata.h
         )
 
 set_target_properties(StatusQ PROPERTIES

diff --git a/ui/StatusQ/src/wallet/TODO-externalize-data-store.md b/ui/StatusQ/src/wallet/TODO-externalize-data-store.md
@@ -0,0 +1,27 @@
+# TODO for externalizing data storage for ManageTokensController
+
+Task [#13313](https://github.com/status-im/status-desktop/issues/13313)
+
+## Solution
+
+Extend interface of `ManageTokensController` to allow bidirectional save and load of data. The in/out structure should be a mirror of the json struct in status-go provided through a RPC api call
+
+### C++ integration
+
+Only Nim is setup to use the RPC api, therefore the best way to connect `ManageTokensController` status-go backend is through two plain Nim calls (save and load) via QML signals and slots.
+
+collectible_preferences_table
+
+- [x] Which Nim module is best to provide save/load api?
+  - Collectible service already exposes `updateCollectiblePreferences`
+
+### status-go
+
+- [x] Which module should be used to provide the data? Settings? Wallet?
+  - Already done in `accounts` module that calls `messenger` module for storing the data
+- [x] Which DB should store the table with the data
+  - We use `collectible_preferences` that is already setup
+
+## Prev history
+
+`ManageTokensController` serializes and saves the tokens using a `QSettings` app instance