Rename sync options, docs

iotaledger · Nov 8, 2023 · 9fbff3b · 9fbff3b
1 parent f813e3c
commit 9fbff3b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 11 deletions.
diff --git a/bindings/nodejs/lib/types/wallet/prepared-transaction.ts b/bindings/nodejs/lib/types/wallet/prepared-transaction.ts
@@ -20,7 +20,7 @@ export class PreparedTransaction {
 
     /**
      * @param preparedData Prepared data to sign and submit a transaction.
-     * @param wallet A wallet wallet.
+     * @param wallet A wallet.
      */
     constructor(preparedData: PreparedTransactionData, wallet: Wallet) {
         this._preparedData = preparedData;

diff --git a/bindings/nodejs/lib/types/wallet/wallet.ts b/bindings/nodejs/lib/types/wallet/wallet.ts
@@ -91,21 +91,20 @@ export interface SyncOptions {
     syncIncomingTransactions?: boolean;
     /** Checks pending transactions and reissues them if necessary. Default: true. */
     syncPendingTransactions?: boolean;
-    /** Specifies what outputs should be synced for the ed25519 addresses from the account. */
-    account?: AccountSyncOptions;
+    /** Specifies what outputs should be synced for the ed25519 address from the wallet. */
+    wallet?: WalletSyncOptions;
     /** Specifies what outputs should be synced for the address of an account output. */
-    // TODO Rename when we are done with Account changes https://github.com/iotaledger/iota-sdk/issues/647.
-    alias?: AliasSyncOptions;
+    account?: AccountSyncOptions;
     /** Specifies what outputs should be synced for the address of an nft output. */
     nft?: NftSyncOptions;
-    /** Specifies if only basic outputs with an AddressUnlockCondition alone should be synced, will overwrite `account`, `alias` and `nft` options. Default: false. */
+    /** Specifies if only basic outputs with an AddressUnlockCondition alone should be synced, will overwrite `wallet`, `account` and `nft` options. Default: false. */
     syncOnlyMostBasicOutputs?: boolean;
     /** Sync native token foundries, so their metadata can be returned in the balance. Default: false. */
     syncNativeTokenFoundries?: boolean;
 }
 
-/** Specifies what outputs should be synced for the ed25519 addresses from the account. */
-export interface AccountSyncOptions {
+/** Specifies what outputs should be synced for the ed25519 address from the wallet. */
+export interface WalletSyncOptions {
     /** Whether to sync Basic outputs. */
     basicOutputs?: boolean;
     /** Whether to sync Account outputs. */
@@ -115,7 +114,7 @@ export interface AccountSyncOptions {
 }
 
 /** Specifies what outputs should be synced for the address of an account output. */
-export interface AliasSyncOptions {
+export interface AccountSyncOptions {
     /** Whether to sync Basic outputs. */
     basicOutputs?: boolean;
     /** Whether to sync Account outputs. */

diff --git a/sdk/src/wallet/operations/syncing/options.rs b/sdk/src/wallet/operations/syncing/options.rs
@@ -25,7 +25,7 @@ pub struct SyncOptions {
     /// Checks pending transactions and reissues them if necessary.
     #[serde(default = "default_sync_pending_transactions")]
     pub sync_pending_transactions: bool,
-    /// Specifies what outputs should be synced for the ed25519 addresses from the wallet.
+    /// Specifies what outputs should be synced for the ed25519 address from the wallet.
     #[serde(default)]
     pub wallet: WalletSyncOptions,
     /// Specifies what outputs should be synced for the address of an account output.
@@ -35,7 +35,7 @@ pub struct SyncOptions {
     #[serde(default)]
     pub nft: NftSyncOptions,
     /// Specifies if only basic outputs with an AddressUnlockCondition alone should be synced, will overwrite
-    /// `account`, `alias` and `nft` options.
+    /// `wallet`, `account` and `nft` options.
     #[serde(default = "default_sync_only_most_basic_outputs")]
     pub sync_only_most_basic_outputs: bool,
     /// Sync native token foundries, so their metadata can be returned in the balance.