Add network rotation on bad sapling root (#557)

Author: Duddino

scripts/network/network.js

@@ -35,6 +35,10 @@ import { Transaction } from '../transaction.js';
  *
  */
 export class Network {
+    /**
+     * @type{boolean}
+     */
+    isRpc;
     constructor() {
         if (this.constructor === Network) {
             throw new Error('Initializing virtual class');
@@ -156,6 +160,7 @@ export class RPCNodeNetwork extends Network {
          * @public
          */
         this.strUrl = strUrl;
+        this.isRpc = true;
     }
     /**
      * A Fetch wrapper which uses the current Node's base URL
@@ -393,6 +398,7 @@ export class ExplorerNetwork extends Network {
          * @public
          */
         this.strUrl = strUrl;
+        this.isRpc = false;
     }
 
     /**

scripts/network/network_manager.js

@@ -55,6 +55,42 @@ class NetworkManager {
         } else {
             this.#currentExplorer = found;
         }
+
+        getEventEmitter().emit(
+            isRPC ? 'rpc_changed' : 'explorer_changed',
+            strUrl
+        );
+    }
+
+    /**
+     * Changes RPC and explorer to next one
+     * To be called in case of an error believed to be a network one
+     * e.g. wrong sapling root
+     */
+    rotateNetworks() {
+        const currentExplorerIndex = this.#networks.findIndex(
+            (n) => n === this.#currentExplorer
+        );
+        const currentNodeIndex = this.#networks.findIndex(
+            (n) => n === this.#currentNode
+        );
+        const indices = [currentExplorerIndex, currentNodeIndex];
+        for (let j = 0; j < indices.length; j++) {
+            for (let i = 1; i < this.#networks.length; i++) {
+                const isRpc = j === 1;
+                const index = indices[j];
+                const tryNetwork =
+                    this.#networks[(index + i) % this.#networks.length];
+                if (tryNetwork.isRpc === isRpc) {
+                    if (isRpc) {
+                        this.#currentNode = tryNetwork;
+                    } else {
+                        this.#currentExplorer = tryNetwork;
+                    }
+                    break;
+                }
+            }
+        }
     }
 
     /**

scripts/settings.js

@@ -203,6 +203,14 @@ function subscribeToNetworkEvents() {
     getEventEmitter().on('currency-loaded', async (mapCurrencies) => {
         await fillCurrencySelect(mapCurrencies);
     });
+    getEventEmitter().on('explorer_changed', (url) => {
+        // Update the selector UI
+        doms.domExplorerSelect.value = url;
+    });
+    getEventEmitter().on('rpc_changed', (url) => {
+        // Update the selector UI
+        doms.domNodeSelect.value = url;
+    });
 }
 
 // --- Settings Functions
@@ -211,27 +219,20 @@ export async function setExplorer(explorer, fSilent = false) {
     await database.setSettings({ explorer: explorer.url });
     getNetwork().setNetwork(explorer.url, false);
 
-    // Update the selector UI
-    doms.domExplorerSelect.value = explorer.url;
-
     if (!fSilent) {
         createAlert(
             'success',
             tr(ALERTS.SWITCHED_EXPLORERS, [{ explorerName: explorer.name }]),
             2250
         );
     }
-    getEventEmitter().emit('explorer_changed', explorer.url);
 }
 
 export async function setNode(node, fSilent = false) {
     getNetwork().setNetwork(node.url, true);
     const database = await Database.getInstance();
     database.setSettings({ node: node.url });
 
-    // Update the selector UI
-    doms.domNodeSelect.value = node.url;
-
     if (!fSilent)
         createAlert(
             'success',

scripts/wallet.js

@@ -1062,6 +1062,16 @@ export class Wallet {
         );
         // If explorer sapling root is different from ours, there must be a sync error
         if (saplingRoot !== networkSaplingRoot) {
+            const db = await Database.getInstance();
+
+            // Reset shield sync data, it might be corrupted
+            await db.setShieldSyncData({
+                shieldData: null,
+                lastSyncedBlock: null,
+            });
+            // Try to rotate networks to see if another RPC/explorer has the correct data
+            getNetwork().rotateNetworks();
+
             createAlert('warning', translation.badSaplingRoot, 5000);
             return false;
         }