Update wallet events (#1789)

* initial wallet event pass * env fix * removed consolidationrequired * fix event example --------- Co-authored-by: /alex/ <[email protected]> Co-authored-by: Thoralf-M <[email protected]>
iotaledger · Jan 10, 2024 · a54b4f8 · a54b4f8
1 parent 5620e3d
commit a54b4f8
Show file tree

Hide file tree

Showing 15 changed files with 91 additions and 175 deletions.
diff --git a/bindings/nodejs/examples/exchange/4-listen-events.ts b/bindings/nodejs/examples/exchange/4-listen-events.ts
@@ -5,14 +5,14 @@
 // Run with command:
 // yarn run-example ./exchange/4-listen-events.ts
 
-import { Wallet, Event, WalletEventType } from '@iota/sdk';
+import { Wallet, WalletEvent, WalletEventType } from '@iota/sdk';
 
 // This example uses secrets in environment variables for simplicity which should not be done in production.
 require('dotenv').config({ path: '.env' });
 
 async function run() {
     try {
-        for (const envVar of ['WALLET_DB_PATH']) {
+        for (const envVar of ['WALLET_DB_PATH', 'FAUCET_URL']) {
             if (!(envVar in process.env)) {
                 throw new Error(
                     `.env ${envVar} is undefined, see .env.example`,
@@ -24,9 +24,8 @@ async function run() {
             storagePath: process.env.WALLET_DB_PATH,
         });
 
-        const callback = function (err: any, event: Event) {
-            console.log('AccountIndex:', event.accountIndex);
-            console.log('Event:', event.event);
+        const callback = function (err: any, event: WalletEvent) {
+            console.log('Event:', event);
 
             // Exit after receiving an event.
             process.exit(0);
@@ -37,7 +36,7 @@ async function run() {
 
         // Use the faucet to send testnet tokens to your address.
         console.log(
-            'Fill your address with the faucet: https://faucet.testnet.shimmer.network/',
+            `Fill your address with the faucet: ${process.env.FAUCET_URL}`,
         );
 
         const address = await wallet.address();

diff --git a/bindings/nodejs/examples/wallet/events.ts b/bindings/nodejs/examples/wallet/events.ts
@@ -2,8 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-    Event,
-    ConsolidationRequiredWalletEvent,
+    WalletEvent,
     TransactionProgressWalletEvent,
     SelectingInputsProgress,
 } from '@iota/sdk';
@@ -24,13 +23,12 @@ async function run() {
         // Create the wallet
         const wallet = await getUnlockedWallet();
 
-        const callback = function (err: any, event: Event) {
+        const callback = function (err: any, event: WalletEvent) {
             console.log('Event:', event);
         };
 
         await wallet.listen([], callback);
 
-        await wallet.emitTestEvent(new ConsolidationRequiredWalletEvent());
         await wallet.emitTestEvent(
             new TransactionProgressWalletEvent(new SelectingInputsProgress()),
         );

diff --git a/bindings/nodejs/lib/types/wallet/event.ts b/bindings/nodejs/lib/types/wallet/event.ts
@@ -13,45 +13,20 @@ import { HexEncodedString } from '../utils';
  */
 export type TransactionId = string;
 
-/**
- * An wallet account event.
- */
-class Event {
-    /**
-     * The account index for which the event was emitted.
-     */
-    accountIndex: number;
-    /**
-     * The wallet event.
-     */
-    event: WalletEvent;
-
-    /**
-     * @param accountIndex The account index.
-     * @param event The wallet event.
-     */
-    constructor(accountIndex: number, event: WalletEvent) {
-        this.accountIndex = accountIndex;
-        this.event = event;
-    }
-}
-
 /**
  * All of the wallet event types.
  */
 enum WalletEventType {
-    /** Consolidation is required. */
-    ConsolidationRequired = 0,
     /** Nano Ledger has generated an address. */
-    LedgerAddressGeneration = 1,
+    LedgerAddressGeneration = 0,
     /** A new output was created. */
-    NewOutput = 2,
+    NewOutput = 1,
     /** An output was spent. */
-    SpentOutput = 3,
+    SpentOutput = 2,
     /** A transaction was included into the ledger. */
-    TransactionInclusion = 4,
+    TransactionInclusion = 3,
     /** A progress update while submitting a transaction. */
-    TransactionProgress = 5,
+    TransactionProgress = 4,
 }
 
 /**
@@ -68,15 +43,6 @@ abstract class WalletEvent {
     }
 }
 
-/**
- * A 'consolidation required' wallet event.
- */
-class ConsolidationRequiredWalletEvent extends WalletEvent {
-    constructor() {
-        super(WalletEventType.ConsolidationRequired);
-    }
-}
-
 /**
  * A 'ledger address generation' wallet event.
  */
@@ -280,10 +246,8 @@ class BroadcastingProgress extends TransactionProgress {
 }
 
 export {
-    Event,
     WalletEventType,
     WalletEvent,
-    ConsolidationRequiredWalletEvent,
     LedgerAddressGenerationWalletEvent,
     NewOutputWalletEvent,
     SpentOutputWalletEvent,

diff --git a/bindings/nodejs/lib/wallet/wallet-method-handler.ts b/bindings/nodejs/lib/wallet/wallet-method-handler.ts
@@ -11,9 +11,9 @@ import {
 } from '../bindings';
 import {
     WalletEventType,
+    WalletEvent,
     WalletOptions,
     __WalletMethod__,
-    Event,
 } from '../types/wallet';
 import { Client, ClientMethodHandler } from '../client';
 import { SecretManager, SecretManagerMethodHandler } from '../secret_manager';
@@ -74,17 +74,17 @@ export class WalletMethodHandler {
      */
     async listen(
         eventTypes: WalletEventType[],
-        callback: (error: Error, event: Event) => void,
+        callback: (error: Error, event: WalletEvent) => void,
     ): Promise<void> {
         return listenWallet(
             this.methodHandler,
             eventTypes,
             function (err: any, data: string) {
-                const parsed = JSON.parse(data);
+                const parsed: WalletEvent = JSON.parse(data);
                 callback(
                     // Send back raw error instead of parsing
                     err,
-                    new Event(parsed.accountIndex, parsed.event),
+                    parsed,
                 );
             },
         ).catch((error: any) => {

diff --git a/bindings/nodejs/lib/wallet/wallet.ts b/bindings/nodejs/lib/wallet/wallet.ts
@@ -52,7 +52,6 @@ import type {
     WalletOptions,
     WalletEventType,
     WalletEvent,
-    Event,
 } from '../types/wallet';
 import { IAuth, IClientOptions, LedgerNanoStatus } from '../types/client';
 import { SecretManager } from '../secret_manager';
@@ -169,7 +168,7 @@ export class Wallet {
      */
     async listen(
         eventTypes: WalletEventType[],
-        callback: (error: Error, event: Event) => void,
+        callback: (error: Error, event: WalletEvent) => void,
     ): Promise<void> {
         return this.methodHandler.listen(eventTypes, callback);
     }

diff --git a/bindings/python/examples/exchange/4_listen_events.py b/bindings/python/examples/exchange/4_listen_events.py
@@ -27,9 +27,8 @@
 
 def callback(event):
     """Callback function for the event listener"""
-    event_dict = json.loads(event)
-    print('AccountIndex:', event_dict["accountIndex"])
-    print('Event:', event_dict["event"])
+    event = json.loads(event)
+    print('Event:', event)
 
     # Exit after receiving an event.
     # pylint: disable=global-statement

diff --git a/bindings/python/iota_sdk/types/event.py b/bindings/python/iota_sdk/types/event.py
@@ -8,16 +8,14 @@ class WalletEventType(IntEnum):
     """Types of wallet events.
 
     Attributes:
-        ConsolidationRequired (0): Consolidation is required.
-        LedgerAddressGeneration (1): Nano Ledger has generated an address.
-        NewOutput (2): A new output was created.
-        SpentOutput (3): An output was spent.
-        TransactionInclusion (4): A transaction was included into the ledger.
-        TransactionProgress (5): A progress update while submitting a transaction.
+        LedgerAddressGeneration (0): Nano Ledger has generated an address.
+        NewOutput (1): A new output was created.
+        SpentOutput (2): An output was spent.
+        TransactionInclusion (3): A transaction was included into the ledger.
+        TransactionProgress (4): A progress update while submitting a transaction.
     """
-    ConsolidationRequired = 0
-    LedgerAddressGeneration = 1
-    NewOutput = 2
-    SpentOutput = 3
-    TransactionInclusion = 4
-    TransactionProgress = 5
+    LedgerAddressGeneration = 0
+    NewOutput = 1
+    SpentOutput = 2
+    TransactionInclusion = 3
+    TransactionProgress = 4
diff --git a/sdk/src/client/error.rs b/sdk/src/client/error.rs
@@ -36,9 +36,6 @@ pub enum Error {
     /// Block types error
     #[error("{0}")]
     Block(#[from] crate::types::block::Error),
-    /// The wallet has enough funds, but split on too many outputs
-    #[error("the wallet has enough funds, but split on too many outputs: {0}, max. is 128, consolidate them")]
-    ConsolidationRequired(usize),
     /// Crypto.rs error
     #[error("{0}")]
     Crypto(#[from] crypto::Error),

diff --git a/sdk/src/wallet/core/builder.rs b/sdk/src/wallet/core/builder.rs
@@ -227,9 +227,6 @@ where
         #[cfg(feature = "storage")]
         self.save(&storage_manager).await?;
 
-        #[cfg(feature = "events")]
-        let event_emitter = tokio::sync::RwLock::new(EventEmitter::new());
-
         // It happened that inputs got locked, the transaction failed, but they weren't unlocked again, so we do this
         // here
         #[cfg(feature = "storage")]
@@ -253,7 +250,7 @@ where
             client,
             secret_manager: self.secret_manager.expect("make WalletInner::secret_manager optional?"),
             #[cfg(feature = "events")]
-            event_emitter,
+            event_emitter: tokio::sync::RwLock::new(EventEmitter::new()),
             #[cfg(feature = "storage")]
             storage_options,
             #[cfg(feature = "storage")]

diff --git a/sdk/src/wallet/core/operations/address_generation.rs b/sdk/src/wallet/core/operations/address_generation.rs
@@ -36,41 +36,34 @@ impl Wallet {
                 // needs to have it visible on the computer first, so we need to generate it without the
                 // prompt first
                 let options = options.into();
+                #[cfg(feature = "events")]
                 if options.as_ref().map_or(false, |o| o.ledger_nano_prompt) {
-                    #[cfg(feature = "events")]
-                    {
-                        let changed_options = options.map(|mut options| {
-                            // Change options so ledger will not show the prompt the first time
-                            options.ledger_nano_prompt = false;
-                            options
-                        });
-                        // Generate without prompt to be able to display it
-                        let address = ledger_nano
-                            .generate_ed25519_addresses(
-                                coin_type,
-                                account_index,
-                                address_index..address_index + 1,
-                                changed_options,
-                            )
-                            .await?;
+                    let changed_options = options.map(|mut options| {
+                        // Change options so ledger will not show the prompt the first time
+                        options.ledger_nano_prompt = false;
+                        options
+                    });
+                    // Generate without prompt to be able to display it
+                    let address = ledger_nano
+                        .generate_ed25519_addresses(
+                            coin_type,
+                            account_index,
+                            address_index..address_index + 1,
+                            changed_options,
+                        )
+                        .await?;
 
-                        let bech32_hrp = self.bech32_hrp().await;
+                    let bech32_hrp = self.bech32_hrp().await;
 
-                        self.emit(WalletEvent::LedgerAddressGeneration(AddressData {
-                            address: address[0].to_bech32(bech32_hrp),
-                        }))
-                        .await;
-                    }
-
-                    // Generate with prompt so the user can verify
-                    ledger_nano
-                        .generate_ed25519_addresses(coin_type, account_index, address_index..address_index + 1, options)
-                        .await?
-                } else {
-                    ledger_nano
-                        .generate_ed25519_addresses(coin_type, account_index, address_index..address_index + 1, options)
-                        .await?
+                    self.emit(WalletEvent::LedgerAddressGeneration(AddressData {
+                        address: address[0].to_bech32(bech32_hrp),
+                    }))
+                    .await;
                 }
+                // Generate with prompt so the user can verify
+                ledger_nano
+                    .generate_ed25519_addresses(coin_type, account_index, address_index..address_index + 1, options)
+                    .await?
             }
             #[cfg(feature = "stronghold")]
             SecretManager::Stronghold(stronghold) => {

diff --git a/sdk/src/wallet/error.rs b/sdk/src/wallet/error.rs
@@ -33,9 +33,6 @@ pub enum Error {
         new_bip_path: Option<Bip44>,
         old_bip_path: Option<Bip44>,
     },
-    /// Funds are spread over too many outputs
-    #[error("funds are spread over too many outputs {output_count}/{output_count_max}, consolidation required")]
-    ConsolidationRequired { output_count: usize, output_count_max: u16 },
     /// Crypto.rs error
     #[error("{0}")]
     Crypto(#[from] crypto::Error),