Add Cold Staking customisation UI

index.template.html

@@ -893,6 +893,12 @@ <h3 class="noselect balance-title">
                               <span class="reload noselect" onclick="MPW.refreshChainData()"><i id="balanceReloadStaking" class="fa-solid fa-rotate-right cur-pointer"></i></span>
                             </h3>
                           </div>
+
+                          <div class="col-6 d-flex dcWallet-topRightMenu" style="justify-content: flex-end;">
+                            <div class="btn-group dropleft">
+                              <i class="fa-solid fa-gear" style="width: 20px;" onclick="MPW.guiSetColdStakingAddress()"></i>
+                            </div>
+                          </div>
                         </div>
 
                         Staking<br>

scripts/global.js

@@ -10,7 +10,7 @@
     decryptWallet,
     getNewAddress,
     getDerivationPath,
     LegacyMasterKey,
 } from './wallet.js';
 import { getNetwork, HistoricalTxType } from './network.js';
 import {
@@ -19,6 +19,8 @@
     debug,
     cMarket,
     strCurrency,
+    setColdStakingAddress,
+    strColdStakingAddress,
 } from './settings.js';
 import { createAndSendTransaction, signTransaction } from './transactions.js';
 import {
@@ -434,9 +436,6 @@
 export const mempool = new Mempool();
 let exportHidden = false;
 
-//                        PIVX Labs' Cold Pool
-export let cachedColdStakeAddr = 'SdgQDpS8jDRJDX8yK8m9KnTMarsE84zdsy';
-
 /**
  * Open a UI 'tab' menu, and close all other tabs, intended for frontend use
  * @param {Event} evt - The click event target
@@ -1638,19 +1637,6 @@
     domID.style.display = domID.style.display === 'block' ? 'none' : 'block';
 }
 
-export function askForCSAddr(force = false) {
-    if (force) cachedColdStakeAddr = null;
-    if (cachedColdStakeAddr === '' || cachedColdStakeAddr === null) {
-        cachedColdStakeAddr = prompt(
-            'Please provide a Cold Staking address (either from your own node, or a 3rd-party!)'
-        ).trim();
-        if (cachedColdStakeAddr) return true;
-    } else {
-        return true;
-    }
-    return false;
-}
-
 export function isMasternodeUTXO(cUTXO, cMasternode) {
     if (cMasternode?.collateralTxId) {
         const { collateralTxId, outidx } = cMasternode;
@@ -1660,6 +1646,47 @@
     }
 }
 
+/**
+ * Creates a GUI popup for the user to check or customise their Cold Address
+ */
+export async function guiSetColdStakingAddress() {
+    if (
+        await confirmPopup({
+            title: 'Set your Cold Staking address',
+            html: `<p>Current address:<br><span class="mono">${strColdStakingAddress}</span><br><br><span style="opacity: 0.65; margin: 10px;">A Cold Address stakes coins on your behalf, it cannot spend coins, so it's even safe to use a stranger's Cold Address!</span></p><br><input type="text" id="newColdAddress" placeholder="Example: ${strColdStakingAddress.substring(
+                0,
+                6
+            )}..." style="text-align: center;">`,
+        })
+    ) {
+        // Fetch address from the popup input
+        const strColdAddress = document.getElementById('newColdAddress').value;
+
+        // If it's empty, just return false
+        if (!strColdAddress) return false;
+
+        // Sanity-check, and set!
+        if (
+            strColdAddress[0] === cChainParams.current.STAKING_PREFIX &&
+            strColdAddress.length === 34
+        ) {
+            await setColdStakingAddress(strColdAddress);
+            createAlert(
+                'info',
+                '<b>Cold Address set!</b><br>Future stakes will use this address.',
+                [],
+                5000
+            );
+            return true;
+        } else {
+            createAlert('warning', 'Invalid Cold Staking address!', [], 2500);
+            return false;
+        }
+    } else {
+        return false;
+    }
+}
+
 export async function wipePrivateData() {
     const isEncrypted = await hasEncryptedWallet();
     const title = isEncrypted

scripts/index.js

@@ -18,6 +18,7 @@ export {
     openTab,
     accessOrImportWallet,
     guiImportWallet,
+    guiSetColdStakingAddress,
     onPrivateKeyChanged,
     toClipboard,
     toggleExportUI,

scripts/settings.js

@@ -37,6 +37,8 @@ export let cExplorer = cChainParams.current.Explorers[0];
 export let cNode = cChainParams.current.Nodes[0];
 /** A mode which allows MPW to automatically select it's data sources */
 export let fAutoSwitch = true;
+/** The active Cold Staking address: default is the PIVX Labs address */
+export let strColdStakingAddress = 'SdgQDpS8jDRJDX8yK8m9KnTMarsE84zdsy';
 
 let transparencyReport;
 
@@ -57,6 +59,10 @@ export class Settings {
      * @type {Boolean} The Auto-Switch mode state
      */
     autoswitch;
+    /**
+     * @type {String} The user's active Cold Staking address
+     */
+    coldAddress;
     /**
      * @type {String} translation to use
      */
@@ -70,13 +76,15 @@ export class Settings {
         explorer,
         node,
         autoswitch = true,
+        coldAddress = strColdStakingAddress,
         translation = 'en',
         displayCurrency = 'usd',
     } = {}) {
         this.analytics = analytics;
         this.explorer = explorer;
         this.node = node;
         this.autoswitch = autoswitch;
+        this.coldAddress = coldAddress;
         this.translation = translation;
         this.displayCurrency = displayCurrency;
     }
@@ -165,8 +173,14 @@ export async function start() {
     const database = await Database.getInstance();
 
     // Fetch settings from Database
-    const { analytics: strSettingAnalytics, autoswitch } =
-        await database.getSettings();
+    const {
+        analytics: strSettingAnalytics,
+        autoswitch,
+        coldAddress,
+    } = await database.getSettings();
+
+    // Set the Cold Staking address
+    strColdStakingAddress = coldAddress;
 
     // Set any Toggles to their default or DB state
     fAutoSwitch = autoswitch;
@@ -277,6 +291,16 @@ async function setCurrency(currency) {
     getBalance(true);
 }
 
+/**
+ * Sets and saves the active Cold Staking address
+ * @param {string} strColdAddress - The Cold Staking address
+ */
+export async function setColdStakingAddress(strColdAddress) {
+    strColdStakingAddress = strColdAddress;
+    const database = await Database.getInstance();
+    database.setSettings({ coldAddress: strColdAddress });
+}
+
 /**
  * Fills the translation dropbox on the settings page
  */

scripts/transactions.js

@@ -1,21 +1,19 @@
 import bitjs from './bitTrx.js';
-import { debug } from './settings.js';
+import { debug, strColdStakingAddress } from './settings.js';
 import { ALERTS } from './i18n.js';
 import {
     doms,
     getBalance,
     mempool,
     isMasternodeUTXO,
-    askForCSAddr,
-    cachedColdStakeAddr,
     restoreWallet,
     toggleBottomMenu,
+    guiSetColdStakingAddress,
 } from './global.js';
 import {
     hasWalletUnlocked,
     masterKey,
     getNewAddress,
-    isYourAddress,
     cHardwareWallet,
     strHardwareName,
 } from './wallet.js';
@@ -149,21 +147,17 @@ export async function delegateGUI() {
     if (!validateAmount(nAmount, COIN)) return;
 
     // Ensure the user has an address set - if not, request one!
-    if (!askForCSAddr()) return;
-
-    // Sanity
     if (
-        cachedColdStakeAddr.length !== 34 ||
-        !cachedColdStakeAddr.startsWith(cChainParams.current.STAKING_PREFIX)
-    ) {
-        askForCSAddr(true);
-        return createAlert('success', ALERTS.SUCCESS_STAKING_ADDR_SET, []);
-    }
+        (!strColdStakingAddress ||
+            strColdStakingAddress[0] !== cChainParams.current.STAKING_PREFIX) &&
+        (await guiSetColdStakingAddress()) === false
+    )
+        return;
 
     // Perform the TX
     const cTxRes = await createAndSendTransaction({
         amount: nAmount,
-        address: cachedColdStakeAddr,
+        address: strColdStakingAddress,
         isDelegation: true,
         useDelegatedInputs: false,
     });
@@ -211,11 +205,11 @@ export async function undelegateGUI() {
         isDelegation: false,
         useDelegatedInputs: true,
         delegateChange: true,
-        changeDelegationAddress: cachedColdStakeAddr,
+        changeDelegationAddress: strColdStakingAddress,
     });
 
     if (!cTxRes.ok && cTxRes.err === 'No change addr') {
-        askForCSAddr(true);
+        await guiSetColdStakingAddress();
         await undelegateGUI();
     } else {
         // If successful, reset the inputs
@@ -290,7 +284,7 @@ export async function createAndSendTransaction({
     if (nChange > 0) {
         if (delegateChange && nChange > 1.01 * COIN) {
             if (!changeDelegationAddress)
-                return { ok: false, error: 'No change addr' };
+                return { ok: false, err: 'No change addr' };
             cTx.addcoldstakingoutput(
                 changeAddress,
                 changeDelegationAddress,