iota-sdk 1.0.1

The IOTA SDK provides developers with a seamless experience to develop on IOTA by providing account abstractions and clients to interact with node APIs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284

// Copyright 2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::cmp;

use crate::{
    client::secret::{GenerateAddressOptions, SecretManage},
    wallet::account::{operations::syncing::SyncOptions, types::AddressWithUnspentOutputs, Account},
};

impl<S: 'static + SecretManage> Account<S>
where
    crate::wallet::Error: From<S::Error>,
{
    /// Search addresses with unspent outputs
    /// `address_gap_limit`: The number of addresses to search for, after the last address with unspent outputs
    /// Addresses that got crated during this operation and have a higher key_index than the latest one with outputs,
    /// will be removed again, to keep the account size smaller
    pub(crate) async fn search_addresses_with_outputs(
        &self,
        mut address_gap_limit: u32,
        sync_options: Option<SyncOptions>,
    ) -> crate::wallet::Result<usize> {
        log::debug!("[search_addresses_with_outputs]");
        let mut sync_options = match sync_options {
            Some(opt) => opt,
            None => self.default_sync_options().await.clone(),
        };

        // store the current index, so we can remove new addresses with higher indexes later again, if they don't have
        // outputs
        let (highest_public_address_index, highest_internal_address_index) = {
            let account_details = self.details().await;
            (
                account_details
                    .public_addresses
                    .last()
                    .map(|a| a.key_index)
                    .expect("account needs to have a public address"),
                account_details.internal_addresses.last().map(|a| a.key_index),
            )
        };

        // public addresses
        if sync_options.address_start_index != 0 {
            let mut address_amount_to_generate =
                sync_options.address_start_index.abs_diff(highest_public_address_index);
            // -1 if it's larger than 0, to get the correct amount, because the address with the actual start index
            // gets generated later
            address_amount_to_generate = address_amount_to_generate.saturating_sub(1);
            log::debug!(
                "[search_addresses_with_outputs] generate {address_amount_to_generate} public addresses below the start index"
            );
            self.generate_ed25519_addresses(address_amount_to_generate, None)
                .await?;
        }
        // internal addresses
        if sync_options.address_start_index_internal != 0 {
            let mut address_amount_to_generate = sync_options
                .address_start_index_internal
                .abs_diff(highest_internal_address_index.unwrap_or(0));
            // -1 if it's larger than 0, to get the correct amount, because the address with the actual start index
            // gets generated later
            if address_amount_to_generate > 0 && highest_internal_address_index.is_some() {
                address_amount_to_generate -= 1;
            }
            log::debug!(
                "[search_addresses_with_outputs] generate {address_amount_to_generate} internal addresses below the start index"
            );
            self.generate_ed25519_addresses(address_amount_to_generate, Some(GenerateAddressOptions::internal()))
                .await?;
        }

        let mut address_gap_limit_internal = address_gap_limit;

        let mut latest_outputs_count = 0;
        loop {
            // Also needs to be in the loop so it gets updated every round for internal use without modifying the values
            // outside
            let (highest_public_address_index, highest_internal_address_index) = {
                let account_details = self.details().await;
                (
                    account_details
                        .public_addresses
                        .last()
                        .map(|a| a.key_index)
                        .expect("account needs to have a public address"),
                    account_details.internal_addresses.last().map(|a| a.key_index),
                )
            };
            log::debug!(
                "[search_addresses_with_outputs] address_gap_limit: {address_gap_limit}, address_gap_limit_internal: {address_gap_limit_internal}"
            );
            // generate public and internal addresses
            let addresses = self.generate_ed25519_addresses(address_gap_limit, None).await?;
            let internal_addresses = self
                .generate_ed25519_addresses(address_gap_limit_internal, Some(GenerateAddressOptions::internal()))
                .await?;

            let address_start_index = addresses
                .first()
                .map(|a| {
                    // If the index is 1, then we only have the single address before we got during account creation
                    // To also sync that, we set the index to 0
                    if a.key_index == 1 { 0 } else { a.key_index }
                })
                // +1, because we don't want to sync the latest address again
                .unwrap_or(highest_public_address_index + 1);

            let address_start_index_internal = internal_addresses
                .first()
                .map(|a| a.key_index)
                // +1, because we don't want to sync the latest address again
                .unwrap_or_else(|| highest_internal_address_index.unwrap_or(0) + 1);

            sync_options.force_syncing = true;
            sync_options.address_start_index = address_start_index;
            sync_options.address_start_index_internal = address_start_index_internal;
            self.sync(Some(sync_options.clone())).await?;

            let output_count = self.details().await.unspent_outputs.len();

            // break if we didn't find more outputs with the new addresses
            if output_count <= latest_outputs_count {
                break;
            }

            latest_outputs_count = output_count;

            // Update address_gap_limit to only generate the amount of addresses we need to have `address_gap_limit`
            // amount of empty addresses after the latest one with outputs

            let account_details = self.details().await;

            let highest_address_index = account_details
                .public_addresses
                .iter()
                .max_by_key(|a| *a.key_index())
                .map(|a| *a.key_index())
                .expect("account needs to have at least one public address");

            let highest_address_index_internal = account_details
                .internal_addresses
                .iter()
                .max_by_key(|a| *a.key_index())
                .map(|a| *a.key_index())
                .unwrap_or(0);

            drop(account_details);

            let addresses_with_unspent_outputs = self.addresses_with_unspent_outputs().await?;

            let (addresses_with_outputs_internal, address_with_outputs): (
                Vec<&AddressWithUnspentOutputs>,
                Vec<&AddressWithUnspentOutputs>,
            ) = addresses_with_unspent_outputs.iter().partition(|a| a.internal);

            let latest_address_index_with_outputs = address_with_outputs
                .iter()
                .max_by_key(|a| *a.key_index())
                .map(|a| *a.key_index() as i64)
                // -1 as default, because we will subtract this value and want to have the amount of empty addresses in
                // a row and not the address index
                .unwrap_or(-1);

            let latest_address_index_with_outputs_internal = addresses_with_outputs_internal
                .iter()
                .max_by_key(|a| *a.key_index())
                .map(|a| *a.key_index() as i64)
                // -1 as default, because we will subtract this value and want to have the amount of empty addresses in
                // a row and not the address index
                .unwrap_or(-1);

            log::debug!(
                "new highest_address_index: {highest_address_index}, internal: {highest_address_index_internal}"
            );
            log::debug!(
                "new latest_address_index_with_outputs: {latest_address_index_with_outputs:?}, internal: {latest_address_index_with_outputs_internal:?}"
            );

            let empty_addresses_in_row = (highest_address_index as i64 - latest_address_index_with_outputs) as u32;

            let empty_addresses_in_row_internal =
                (highest_address_index_internal as i64 - latest_address_index_with_outputs_internal) as u32;

            log::debug!(
                "new empty_addresses_in_row: {empty_addresses_in_row}, internal: {empty_addresses_in_row_internal}"
            );

            if empty_addresses_in_row > address_gap_limit {
                log::debug!("empty_addresses_in_row: {empty_addresses_in_row}, setting address_gap_limit to 0");
                address_gap_limit = 0;
            } else {
                address_gap_limit -= empty_addresses_in_row;
            }
            if empty_addresses_in_row_internal > address_gap_limit_internal {
                log::debug!(
                    "empty_addresses_in_row_internal: {empty_addresses_in_row_internal}, setting address_gap_limit_internal to 0"
                );
                address_gap_limit_internal = 0;
            } else {
                address_gap_limit_internal -= empty_addresses_in_row_internal;
            }

            log::debug!("new address_gap_limit: {address_gap_limit}, internal: {address_gap_limit_internal}");

            if address_gap_limit == 0 && address_gap_limit_internal == 0 {
                break;
            }
        }

        self.clean_account_after_recovery(highest_public_address_index, highest_internal_address_index)
            .await;

        #[cfg(feature = "storage")]
        {
            log::debug!(
                "[search_addresses_with_outputs] storing account {} with new synced data",
                self.alias().await
            );
            self.save(None).await?;
        }

        Ok(latest_outputs_count)
    }

    /// During search_addresses_with_outputs we created new addresses that don't have funds, so we remove them again.
    // `old_highest_public_address_index` is not optional, because we need to have at least one public address in the
    // account
    async fn clean_account_after_recovery(
        &self,
        old_highest_public_address_index: u32,
        old_highest_internal_address_index: Option<u32>,
    ) {
        let mut account_details = self.details_mut().await;

        let (internal_addresses_with_unspent_outputs, public_addresses_with_spent_outputs): (
            Vec<&AddressWithUnspentOutputs>,
            Vec<&AddressWithUnspentOutputs>,
        ) = account_details
            .addresses_with_unspent_outputs()
            .iter()
            .partition(|address| address.internal);

        let highest_public_index_with_outputs = public_addresses_with_spent_outputs
            .iter()
            .map(|a| a.key_index)
            .max()
            // We want to have at least one public address
            .unwrap_or(0);

        let highest_internal_index_with_outputs = internal_addresses_with_unspent_outputs
            .iter()
            .map(|a| a.key_index)
            .max();

        // The new highest index should be either the old one before we searched for funds or if we found addresses with
        // funds the highest index from an address with outputs
        let new_latest_public_index = cmp::max(highest_public_index_with_outputs, old_highest_public_address_index);
        account_details.public_addresses = account_details
            .public_addresses
            .clone()
            .into_iter()
            .filter(|a| a.key_index <= new_latest_public_index)
            .collect();

        account_details.internal_addresses =
            if old_highest_internal_address_index.is_none() && highest_internal_index_with_outputs.is_none() {
                // For internal addresses we don't leave an empty address, that's only required for the public address
                Vec::new()
            } else {
                let new_latest_internal_index = cmp::max(
                    highest_internal_index_with_outputs.unwrap_or(0),
                    old_highest_internal_address_index.unwrap_or(0),
                );
                account_details
                    .internal_addresses
                    .clone()
                    .into_iter()
                    .filter(|a| a.key_index <= new_latest_internal_index)
                    .collect()
            };
    }
}