Clean up wallet syncing code

bindings/core/src/method/wallet.rs

@@ -45,7 +45,7 @@ use crate::OmittedDebug;
 #[non_exhaustive]
 pub enum WalletMethod {
     /// Returns the accounts of the wallet.
-    /// Expected response: [`OutputsData`](crate::Response::OutputsData)
+    /// Expected response: [`OutputsWithExtendedMetadata`](crate::Response::OutputsWithExtendedMetadata)
     Accounts,
     /// Backup storage. Password must be the current one, when Stronghold is used as SecretManager.
     /// Expected response: [`Ok`](crate::Response::Ok)
@@ -139,8 +139,8 @@ pub enum WalletMethod {
     /// Expected response: [`Transaction`](crate::Response::Transaction)
     #[serde(rename_all = "camelCase")]
     GetIncomingTransaction { transaction_id: TransactionId },
-    /// Get the [`OutputData`](iota_sdk::wallet::types::OutputData) of an output stored in the wallet.
-    /// Expected response: [`OutputData`](crate::Response::OutputData)
+    /// Get the [`OutputWithExtendedMetadata`](iota_sdk::wallet::types::OutputWithExtendedMetadata) of an output stored
+    /// in the wallet. Expected response: [`OutputWithExtendedMetadata`](crate::Response::OutputWithExtendedMetadata)
     #[serde(rename_all = "camelCase")]
     GetOutput { output_id: OutputId },
     // /// Expected response: [`ParticipationEvent`](crate::Response::ParticipationEvent)
@@ -199,13 +199,13 @@ pub enum WalletMethod {
         bip_path: Option<Bip44>,
     },
     /// Returns the implicit accounts of the wallet.
-    /// Expected response: [`OutputsData`](crate::Response::OutputsData)
+    /// Expected response: [`OutputsWithExtendedMetadata`](crate::Response::OutputsWithExtendedMetadata)
     ImplicitAccounts,
     /// Returns all incoming transactions of the wallet.
     /// Expected response: [`Transactions`](crate::Response::Transactions)
     IncomingTransactions,
     /// Returns all outputs of the wallet.
-    /// Expected response: [`OutputsData`](crate::Response::OutputsData)
+    /// Expected response: [`OutputsWithExtendedMetadata`](crate::Response::OutputsWithExtendedMetadata)
     #[serde(rename_all = "camelCase")]
     Outputs { filter_options: Option<FilterOptions> },
     /// Returns all pending transactions of the wallet.
@@ -452,7 +452,7 @@ pub enum WalletMethod {
     /// Expected response: [`Transactions`](crate::Response::Transactions)
     Transactions,
     /// Returns all unspent outputs of the wallet
-    /// Expected response: [`OutputsData`](crate::Response::OutputsData)
+    /// Expected response: [`OutputsWithExtendedMetadata`](crate::Response::OutputsWithExtendedMetadata)
     #[serde(rename_all = "camelCase")]
     UnspentOutputs { filter_options: Option<FilterOptions> },
     /// Emits an event for testing if the event system is working

bindings/core/src/method_handler/wallet.rs

@@ -18,7 +18,7 @@ pub(crate) async fn call_wallet_method_internal(
     method: WalletMethod,
 ) -> Result<Response, crate::Error> {
     let response = match method {
-        WalletMethod::Accounts => Response::OutputsData(wallet.ledger().await.accounts().cloned().collect()),
+        WalletMethod::Accounts => Response::OutputsWithData(wallet.ledger().await.accounts().cloned().collect()),
         #[cfg(feature = "stronghold")]
         WalletMethod::BackupToStrongholdSnapshot { destination, password } => {
             wallet.backup_to_stronghold_snapshot(destination, password).await?;
@@ -203,7 +203,7 @@ pub(crate) async fn call_wallet_method_internal(
             Response::PreparedTransaction(data)
         }
         WalletMethod::ImplicitAccounts => {
-            Response::OutputsData(wallet.ledger().await.implicit_accounts().cloned().collect())
+            Response::OutputsWithData(wallet.ledger().await.implicit_accounts().cloned().collect())
         }
         WalletMethod::IncomingTransactions => Response::Transactions(
             wallet
@@ -216,7 +216,7 @@ pub(crate) async fn call_wallet_method_internal(
         ),
         WalletMethod::Outputs { filter_options } => {
             let wallet_ledger = wallet.ledger().await;
-            Response::OutputsData(if let Some(filter) = filter_options {
+            Response::OutputsWithData(if let Some(filter) = filter_options {
                 wallet_ledger.filtered_outputs(filter).cloned().collect()
             } else {
                 wallet_ledger.outputs().values().cloned().collect()
@@ -420,7 +420,7 @@ pub(crate) async fn call_wallet_method_internal(
         ),
         WalletMethod::UnspentOutputs { filter_options } => {
             let wallet_ledger = wallet.ledger().await;
-            Response::OutputsData(if let Some(filter) = filter_options {
+            Response::OutputsWithData(if let Some(filter) = filter_options {
                 wallet_ledger.filtered_unspent_outputs(filter).cloned().collect()
             } else {
                 wallet_ledger.unspent_outputs().values().cloned().collect()

bindings/core/src/response.rs

@@ -308,7 +308,7 @@ pub enum Response {
     /// Response for:
     /// - [`Outputs`](crate::method::WalletMethod::Outputs),
     /// - [`UnspentOutputs`](crate::method::WalletMethod::UnspentOutputs)
-    OutputsData(Vec<OutputData>),
+    OutputsWithData(Vec<OutputData>),
     /// Response for:
     /// - [`PrepareBurn`](crate::method::WalletMethod::PrepareBurn),
     /// - [`PrepareClaimOutputs`](crate::method::WalletMethod::PrepareClaimOutputs)

bindings/core/tests/combined.rs

@@ -57,7 +57,7 @@ async fn create_wallet() -> Result<(), Error> {
         .await;
 
     match response {
-        Response::OutputsData(_) => {}
+        Response::OutputsWithData(_) => {}
         _ => panic!("unexpected response {response:?}"),
     }
 

bindings/nodejs/examples/how_tos/wallet/consolidate-outputs.ts

@@ -1,7 +1,7 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import { CommonOutput, Utils, Wallet, initLogger } from '@iota/sdk';
+import { CommonOutput, Wallet, initLogger } from '@iota/sdk';
 
 // This example uses secrets in environment variables for simplicity which should not be done in production.
 require('dotenv').config({ path: '.env' });
@@ -46,11 +46,10 @@ async function run() {
         const outputs = await wallet.unspentOutputs();
         console.log('Outputs BEFORE consolidation:');
 
-        outputs.forEach(({ output, address }, i) => {
+        outputs.forEach(({ output }, i) => {
             console.log(`OUTPUT #${i}`);
             console.log(
-                '- address: %s\n- amount: %d\n- native token: %s',
-                Utils.addressToBech32(address, 'rms'),
+                '- amount: %d\n- native token: %s',
                 output.getAmount(),
                 output instanceof CommonOutput
                     ? (output as CommonOutput).getNativeToken() ?? []
@@ -80,11 +79,10 @@ async function run() {
 
         // Outputs after consolidation
         console.log('Outputs AFTER consolidation:');
-        outputs.forEach(({ output, address }, i) => {
+        outputs.forEach(({ output }, i) => {
             console.log(`OUTPUT #${i}`);
             console.log(
-                '- address: %s\n- amount: %d\n- native tokens: %s',
-                Utils.addressToBech32(address, 'rms'),
+                '- amount: %d\n- native tokens: %s',
                 output.getAmount(),
                 output instanceof CommonOutput
                     ? (output as CommonOutput).getNativeToken()

bindings/nodejs/lib/types/wallet/event.ts

@@ -1,7 +1,7 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-import type { OutputData } from './output';
+import type { OutputWithExtendedMetadata } from './output';
 import { InclusionState } from './transaction';
 import { InputSigningData, Remainder } from '../client';
 import { Transaction, SignedTransactionPayload, TransactionId } from '../block';
@@ -57,7 +57,7 @@ class LedgerAddressGenerationWalletEvent extends WalletEvent {
  * A 'new output' wallet event.
  */
 class NewOutputWalletEvent extends WalletEvent {
-    output: OutputData;
+    output: OutputWithExtendedMetadata;
     transaction?: SignedTransactionPayload;
     transactionInputs?: OutputWithMetadata[];
 
@@ -67,7 +67,7 @@ class NewOutputWalletEvent extends WalletEvent {
      * @param transactionInputs The inputs for the transaction that created the output. Might be pruned and not available.
      */
     constructor(
-        output: OutputData,
+        output: OutputWithExtendedMetadata,
         transaction?: SignedTransactionPayload,
         transactionInputs?: OutputWithMetadata[],
     ) {
@@ -82,12 +82,12 @@ class NewOutputWalletEvent extends WalletEvent {
  * A 'spent output' wallet event.
  */
 class SpentOutputWalletEvent extends WalletEvent {
-    output: OutputData;
+    output: OutputWithExtendedMetadata;
 
     /**
      * @param output The spent output.
      */
-    constructor(output: OutputData) {
+    constructor(output: OutputWithExtendedMetadata) {
         super(WalletEventType.SpentOutput);
         this.output = output;
     }

bindings/nodejs/lib/types/wallet/output.ts

@@ -2,9 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Type } from 'class-transformer';
-import { Address, AddressDiscriminator } from '../block/address';
 import { Output, OutputDiscriminator, OutputId } from '../block/output';
-import { OutputMetadataResponse } from '../models/api';
+import { OutputIdProof, OutputMetadataResponse } from '../models/api';
 
 /** Output to claim */
 export enum OutputsToClaim {
@@ -15,28 +14,23 @@ export enum OutputsToClaim {
     All = 'All',
 }
 
-/** An output with metadata */
-export class OutputData {
-    /** The identifier of an Output */
-    outputId!: OutputId;
-    /** The metadata of the output */
-    metadata!: OutputMetadataResponse;
-    /** The actual Output */
+/** An output with extended metadata */
+export class OutputWithExtendedMetadata {
+    /** The output itself */
     @Type(() => Output, {
         discriminator: OutputDiscriminator,
     })
     output!: Output;
-    /** Associated account address */
-    @Type(() => Address, {
-        discriminator: AddressDiscriminator,
-    })
-    address!: Address;
-    /** Network ID */
+    /** The metadata of the output */
+    metadata!: OutputMetadataResponse;
+    /** The output ID proof */
+    OutputIdProof!: OutputIdProof;
+    /** The corresponding output ID */
+    outputId!: OutputId;
+    /** The network ID the output belongs to */
     networkId!: string;
-    /** Remainder */
+    /** Whether the output represents a remainder amount */
     remainder!: boolean;
-    /** BIP32 path */
-    chain?: Segment[];
 }
 
 /** A Segment of the BIP32 path*/

bindings/nodejs/lib/wallet/wallet.ts

@@ -12,7 +12,7 @@ import {
     FilterOptions,
     CreateNativeTokenParams,
     MintNftParams,
-    OutputData,
+    OutputWithExtendedMetadata,
     OutputParams,
     OutputsToClaim,
     TransactionWithMetadata,
@@ -303,13 +303,15 @@ export class Wallet {
      *
      * @returns The accounts of the wallet.
      */
-    async accounts(): Promise<OutputData[]> {
+    async accounts(): Promise<OutputWithExtendedMetadata[]> {
         const response = await this.methodHandler.callMethod({
             name: 'accounts',
         });
 
-        const parsed = JSON.parse(response) as Response<OutputData[]>;
-        return plainToInstance(OutputData, parsed.payload);
+        const parsed = JSON.parse(response) as Response<
+            OutputWithExtendedMetadata[]
+        >;
+        return plainToInstance(OutputWithExtendedMetadata, parsed.payload);
     }
 
     /**
@@ -701,17 +703,19 @@ export class Wallet {
     /**
      * Get the data for an output.
      * @param outputId The output to get.
-     * @returns The `OutputData`.
+     * @returns The `OutputWithExtendedMetadata`.
      */
-    async getOutput(outputId: OutputId): Promise<OutputData> {
+    async getOutput(outputId: OutputId): Promise<OutputWithExtendedMetadata> {
         const response = await this.methodHandler.callMethod({
             name: 'getOutput',
             data: {
                 outputId,
             },
         });
-        const parsed = JSON.parse(response) as Response<OutputData>;
-        return plainToInstance(OutputData, parsed.payload);
+        const parsed = JSON.parse(
+            response,
+        ) as Response<OutputWithExtendedMetadata>;
+        return plainToInstance(OutputWithExtendedMetadata, parsed.payload);
     }
 
     /**
@@ -873,14 +877,18 @@ export class Wallet {
      * @param filterOptions Options to filter the to be returned outputs.
      * @returns The outputs with metadata.
      */
-    async outputs(filterOptions?: FilterOptions): Promise<OutputData[]> {
+    async outputs(
+        filterOptions?: FilterOptions,
+    ): Promise<OutputWithExtendedMetadata[]> {
         const response = await this.methodHandler.callMethod({
             name: 'outputs',
             data: { filterOptions },
         });
 
-        const parsed = JSON.parse(response) as Response<OutputData[]>;
-        return plainToInstance(OutputData, parsed.payload);
+        const parsed = JSON.parse(response) as Response<
+            OutputWithExtendedMetadata[]
+        >;
+        return plainToInstance(OutputWithExtendedMetadata, parsed.payload);
     }
 
     /**
@@ -951,13 +959,15 @@ export class Wallet {
      *
      * @returns The implicit accounts of the wallet.
      */
-    async implicitAccounts(): Promise<OutputData[]> {
+    async implicitAccounts(): Promise<OutputWithExtendedMetadata[]> {
         const response = await this.methodHandler.callMethod({
             name: 'implicitAccounts',
         });
 
-        const parsed = JSON.parse(response) as Response<OutputData[]>;
-        return plainToInstance(OutputData, parsed.payload);
+        const parsed = JSON.parse(response) as Response<
+            OutputWithExtendedMetadata[]
+        >;
+        return plainToInstance(OutputWithExtendedMetadata, parsed.payload);
     }
 
     /**
@@ -996,13 +1006,17 @@ export class Wallet {
      * @param filterOptions Options to filter the to be returned outputs.
      * @returns The outputs with metadata.
      */
-    async unspentOutputs(filterOptions?: FilterOptions): Promise<OutputData[]> {
+    async unspentOutputs(
+        filterOptions?: FilterOptions,
+    ): Promise<OutputWithExtendedMetadata[]> {
         const response = await this.methodHandler.callMethod({
             name: 'unspentOutputs',
             data: { filterOptions },
         });
-        const parsed = JSON.parse(response) as Response<OutputData[]>;
-        return plainToInstance(OutputData, parsed.payload);
+        const parsed = JSON.parse(response) as Response<
+            OutputWithExtendedMetadata[]
+        >;
+        return plainToInstance(OutputWithExtendedMetadata, parsed.payload);
     }
 
     /**

bindings/python/iota_sdk/__init__.py

@@ -37,11 +37,11 @@
 from .types.native_token import *
 from .types.node_info import *
 from .types.output import *
-from .types.output_data import *
 from .types.output_id import *
 from .types.output_id_proof import *
 from .types.output_metadata import *
 from .types.output_params import *
+from .types.output_with_extended_metadata import *
 from .types.payload import *
 from .types.send_params import *
 from .types.slot import *

bindings/python/iota_sdk/types/output_data.py → bindings/python/iota_sdk/types/output_with_extended_metadata.py

@@ -12,20 +12,20 @@
 
 @json
 @dataclass
-class OutputData:
-    """Output data.
+class OutputWithExtendedMetadata:
+    """Output with extended metadata.
 
     Attributes:
-        output_id: With the output data corresponding output ID.
-        metadata: With the output corresponding metadata.
-        output: The output object itself.
+        output: The output itself.
+        metadata: The metadata of the output.
         output_id_proof: The output ID proof.
+        output_id: The corresponding output ID.
         network_id: The network ID the output belongs to.
         remainder: Whether the output represents a remainder amount.
     """
-    output_id: OutputId
-    metadata: OutputMetadata
     output: Output
+    metadata: OutputMetadata
     output_id_proof: OutputIdProof
+    output_id: OutputId
     network_id: str
     remainder: bool