Local events

scripts/composables/use_wallet.js

@@ -84,7 +84,7 @@ export const useWallet = defineStore('wallet', () => {
         pendingShieldBalance.value = await wallet.getPendingShieldBalance();
         isSynced.value = wallet.isSynced;
     };
-    getEventEmitter().on('shield-loaded-from-disk', () => {
+    wallet.onShieldLoadedFromDisk(() => {
         hasShield.value = wallet.hasShield();
     });
     const createAndSendTransaction = lockableFunction(
@@ -166,7 +166,7 @@ export const useWallet = defineStore('wallet', () => {
         publicMode.value = fPublicMode;
     });
 
-    getEventEmitter().on('balance-update', async () => {
+    wallet.onBalanceUpdate(async () => {
         balance.value = wallet.balance;
         immatureBalance.value = wallet.immatureBalance;
         immatureColdBalance.value = wallet.immatureColdBalance;
@@ -183,6 +183,22 @@ export const useWallet = defineStore('wallet', () => {
         blockCount.value = rawBlockCount;
     });
 
+    const onNewTx = (fun) => {
+        return wallet.onNewTx(fun);
+    };
+
+    const onTransparentSyncStatusUpdate = (fun) => {
+        return wallet.onTransparentSyncStatusUpdate(fun);
+    };
+
+    const onShieldSyncStatusUpdate = (fun) => {
+        return wallet.onShieldSyncStatusUpdate(fun);
+    };
+
+    const onShieldTransactionCreationUpdate = (fun) => {
+        return wallet.onShieldTransactionCreationUpdate(fun);
+    };
+
     return {
         publicMode,
         isImported,
@@ -221,5 +237,9 @@ export const useWallet = defineStore('wallet', () => {
         blockCount,
         lockCoin,
         unlockCoin,
+        onNewTx,
+        onTransparentSyncStatusUpdate,
+        onShieldSyncStatusUpdate,
+        onShieldTransactionCreationUpdate,
     };
 });

scripts/dashboard/Activity.vue

@@ -7,7 +7,6 @@ import { translation } from '../i18n.js';
 import { Database } from '../database.js';
 import { HistoricalTx, HistoricalTxType } from '../historical_tx.js';
 import { getNameOrAddress } from '../contacts-book.js';
-import { getEventEmitter } from '../event_bus';
 
 import iCheck from '../../assets/icons/icon-check.svg';
 import iHourglass from '../../assets/icons/icon-hourglass.svg';

scripts/dashboard/Dashboard.vue

@@ -453,7 +453,7 @@ getEventEmitter().on('sync-status', (status) => {
     if (status === 'stop') activity?.value?.update();
 });
 
-getEventEmitter().on('new-tx', () => {
+wallet.onNewTx(() => {
     activity?.value?.update();
 });
 

scripts/dashboard/WalletBalance.vue

@@ -3,7 +3,7 @@ import { cChainParams, COIN } from '../chain_params.js';
 import { translation, tr } from '../i18n';
 import { ref, computed, toRefs } from 'vue';
 import { beautifyNumber } from '../misc';
-import { getEventEmitter } from '../event_bus';
+import { useWallet } from '../composables/use_wallet';
 import { optimiseCurrencyLocale } from '../global';
 import { renderWalletBreakdown } from '../charting.js';
 import { guiRenderCurrentReceiveModal } from '../contacts-book';
@@ -61,6 +61,8 @@ const {
     publicMode,
 } = toRefs(props);
 
+const wallet = useWallet();
+
 // Transparent sync status
 const transparentSyncing = ref(false);
 const percentage = ref(0.0);
@@ -129,35 +131,28 @@ const emit = defineEmits([
     'restoreWallet',
 ]);
 
-getEventEmitter().on(
-    'transparent-sync-status-update',
-    (i, totalPages, finished) => {
-        const str = tr(translation.syncStatusHistoryProgress, [
-            { current: totalPages - i + 1 },
-            { total: totalPages },
-        ]);
-        const progress = ((totalPages - i) / totalPages) * 100;
-        syncTStr.value = str;
-        percentage.value = progress;
-        transparentSyncing.value = !finished;
-    }
-);
+wallet.onTransparentSyncStatusUpdate((i, totalPages, finished) => {
+    const str = tr(translation.syncStatusHistoryProgress, [
+        { current: totalPages - i + 1 },
+        { total: totalPages },
+    ]);
+    const progress = ((totalPages - i) / totalPages) * 100;
+    syncTStr.value = str;
+    percentage.value = progress;
+    transparentSyncing.value = !finished;
+});
 
-getEventEmitter().on(
-    'shield-sync-status-update',
-    (bytes, totalBytes, finished) => {
-        percentage.value = Math.round((100 * bytes) / totalBytes);
-        const mb = bytes / 1_000_000;
-        const totalMb = totalBytes / 1_000_000;
-        shieldSyncingStr.value = `Syncing Shield (${mb.toFixed(
-            1
-        )}MB/${totalMb.toFixed(1)}MB)`;
-        shieldSyncing.value = !finished;
-    }
-);
+wallet.onShieldSyncStatusUpdate((bytes, totalBytes, finished) => {
+    percentage.value = Math.round((100 * bytes) / totalBytes);
+    const mb = bytes / 1_000_000;
+    const totalMb = totalBytes / 1_000_000;
+    shieldSyncingStr.value = `Syncing Shield (${mb.toFixed(
+        1
+    )}MB/${totalMb.toFixed(1)}MB)`;
+    shieldSyncing.value = !finished;
+});
 
-getEventEmitter().on(
-    'shield-transaction-creation-update',
+wallet.onShieldTransactionCreationUpdate(
     // state: 0 = loading shield params
     //        1 = proving tx
     //        2 = finished

scripts/event_bus.js

@@ -4,7 +4,7 @@ import { EventEmitter } from 'events';
  * Wrapper class around EventEmitter that allow to enable/disable specific events.
  * By defaults all events are enabled, and can be disabled by calling disableEvent
  */
-class EventEmitterWrapper {
+export class EventEmitterWrapper {
     /** @type{EventEmitter} */
     #internalEmitter;
     /**
@@ -16,8 +16,16 @@ class EventEmitterWrapper {
         this.#internalEmitter = new EventEmitter();
     }
 
+    /**
+     * @param {string} eventName
+     * @param {Function} listener
+     * @returns {()=>void} A function that removes the attached listener when called
+     */
     on(eventName, listener) {
-        this.#internalEmitter.on(eventName, listener);
+        const a = this.#internalEmitter.on(eventName, listener);
+        return () => {
+            a.removeListener(eventName, listener);
+        };
     }
 
     emit(eventName, ...args) {

scripts/mempool.js

@@ -1,4 +1,3 @@
-import { getEventEmitter } from './event_bus.js';
 import { COutpoint, UTXO } from './transaction.js';
 
 export const OutpointState = {
@@ -31,6 +30,22 @@ export class Mempool {
         immatureColdBalance: new CachableBalance(),
     };
 
+    /**
+     * @type{Function}
+     */
+    #emitter;
+
+    /**
+     * @param {Function} emitter - Calling this function emits the balance-update event
+     */
+    constructor(emitter = () => {}) {
+        this.#emitter = emitter;
+    }
+
+    setEmitter(emitter) {
+        this.#emitter = emitter;
+    }
+
     /**
      * Add a transaction to the mempool
      * And mark the input as spent.
@@ -238,7 +253,7 @@ export class Mempool {
         this.#balances.immatureBalance.invalidate();
         this.#balances.balance.invalidate();
         this.#balances.coldBalance.invalidate();
-        getEventEmitter().emit('balance-update');
+        this.#emitter();
     }
 
     /**

scripts/sapling_params.js

@@ -1,4 +1,4 @@
 import { getEventEmitter } from './event_bus.js';
 /**
  * Manages fetching, caching and loading bar updates of sapling params
  */
@@ -39,7 +39,7 @@
     /**
      * @param {import('pivx-shield').PIVXShield} shield
      */
-    async fetch(shield) {
+    async fetch(shield, emitter = () => {}) {
         if (await this.#getFromDatabase(shield)) return;
         const streams = [
             {
@@ -64,8 +64,7 @@
                 const { done, value } = await reader.read();
                 if (value) {
                     percentage += (100 * ratio * value.length) / totalBytes;
-                    getEventEmitter().emit(
-                        'shield-transaction-creation-update',
+                    emitter(
                         percentage,
                         // state: 0 = loading shield params
                         //        1 = proving tx