iota-sdk 0.3.0

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

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

use std::str::FromStr;

use crypto::keys::slip10::Chain;
use instant::Instant;

use crate::{
    client::Client,
    types::{
        api::core::response::OutputWithMetadataResponse,
        block::{
            input::Input,
            output::{dto::OutputDto, Output, OutputId},
            payload::{
                transaction::{TransactionEssence, TransactionId},
                Payload, TransactionPayload,
            },
        },
    },
    wallet::{
        account::{build_transaction_from_payload_and_inputs, types::OutputData, Account, AddressWithUnspentOutputs},
        task,
    },
};

impl Account {
    /// Convert OutputWithMetadataResponse to OutputData with the network_id added
    pub(crate) async fn output_response_to_output_data(
        &self,
        output_responses: Vec<OutputWithMetadataResponse>,
        associated_address: &AddressWithUnspentOutputs,
    ) -> crate::wallet::Result<Vec<OutputData>> {
        log::debug!("[SYNC] convert output_responses");
        // store outputs with network_id
        let network_id = self.client.get_network_id().await?;
        let mut outputs = Vec::new();
        let token_supply = self.client.get_token_supply().await?;
        let account_details = self.read().await;

        for output_response in output_responses {
            let output = Output::try_from_dto(&output_response.output, token_supply)?;
            let transaction_id = TransactionId::from_str(&output_response.metadata.transaction_id)?;
            // check if we know the transaction that created this output and if we created it (if we store incoming
            // transactions separated, then this check wouldn't be required)
            let remainder = account_details
                .transactions
                .get(&transaction_id)
                .map_or(false, |tx| !tx.incoming);

            // 44 is for BIP 44 (HD wallets) and 4218 is the registered index for IOTA https://github.com/satoshilabs/slips/blob/master/slip-0044.md
            let chain = Chain::from_u32_hardened(vec![
                44,
                account_details.coin_type,
                account_details.index,
                associated_address.internal as u32,
                associated_address.key_index,
            ]);

            outputs.push(OutputData {
                output_id: OutputId::new(transaction_id, output_response.metadata.output_index)?,
                metadata: output_response.metadata.clone(),
                output,
                is_spent: output_response.metadata.is_spent,
                address: associated_address.address.inner,
                network_id,
                remainder,
                chain: Some(chain),
            });
        }

        Ok(outputs)
    }

    /// Gets outputs by their id, already known outputs are not requested again, but loaded from the account set as
    /// unspent, because we wouldn't get them from the node if they were spent
    pub(crate) async fn get_outputs(
        &self,
        output_ids: Vec<OutputId>,
    ) -> crate::wallet::Result<Vec<OutputWithMetadataResponse>> {
        log::debug!("[SYNC] start get_outputs");
        let get_outputs_start_time = Instant::now();
        let mut outputs = Vec::new();
        let mut unknown_outputs = Vec::new();
        let mut unspent_outputs = Vec::new();
        let mut account_details = self.write().await;

        for output_id in output_ids {
            match account_details.outputs.get_mut(&output_id) {
                // set unspent
                Some(output_data) => {
                    output_data.is_spent = false;
                    unspent_outputs.push((output_id, output_data.clone()));
                    outputs.push(OutputWithMetadataResponse {
                        metadata: output_data.metadata.clone(),
                        output: OutputDto::from(&output_data.output),
                    });
                }
                None => unknown_outputs.push(output_id),
            }
        }
        // known output is unspent, so insert it to the unspent outputs again, because if it was an
        // alias/nft/foundry output it could have been removed when syncing without them
        for (output_id, output_data) in unspent_outputs {
            account_details.unspent_outputs.insert(output_id, output_data);
        }

        drop(account_details);

        if !unknown_outputs.is_empty() {
            outputs.extend(self.client.get_outputs(unknown_outputs).await?);
        }

        log::debug!(
            "[SYNC] finished get_outputs in {:.2?}",
            get_outputs_start_time.elapsed()
        );

        Ok(outputs)
    }

    // Try to get transactions and inputs for received outputs
    // Because the transactions and outputs are pruned, we might can not get them anymore, in that case errors are not
    // returned
    pub(crate) async fn request_incoming_transaction_data(
        &self,
        transaction_ids: Vec<TransactionId>,
    ) -> crate::wallet::Result<()> {
        log::debug!("[SYNC] request_incoming_transaction_data");

        // Limit parallel requests to 100, to avoid timeouts
        for transaction_ids_chunk in transaction_ids.chunks(100).map(|x: &[TransactionId]| x.to_vec()) {
            let mut tasks = Vec::new();
            let account_details = self.read().await;

            for transaction_id in transaction_ids_chunk {
                // Don't request known or inaccessible transactions again
                if account_details.transactions.contains_key(&transaction_id)
                    || account_details.incoming_transactions.contains_key(&transaction_id)
                    || account_details
                        .inaccessible_incoming_transactions
                        .contains(&transaction_id)
                {
                    continue;
                }

                let client = self.client.clone();
                tasks.push(async move {
                    task::spawn(async move {
                        match client.get_included_block(&transaction_id).await {
                            Ok(block) => {
                                if let Some(Payload::Transaction(transaction_payload)) = block.payload() {
                                    let inputs =
                                        get_inputs_for_transaction_payload(&client, transaction_payload).await?;

                                    let transaction = build_transaction_from_payload_and_inputs(
                                        transaction_id,
                                        *transaction_payload.clone(),
                                        inputs,
                                    )?;

                                    Ok((transaction_id, Some(transaction)))
                                } else {
                                    Ok((transaction_id, None))
                                }
                            }
                            Err(crate::client::Error::NotFound(_)) => Ok((transaction_id, None)),
                            Err(e) => Err(crate::wallet::Error::Client(e.into())),
                        }
                    })
                    .await
                });
            }

            drop(account_details);

            let results = futures::future::try_join_all(tasks).await?;
            // Update account with new transactions
            let mut account_details = self.write().await;
            for res in results {
                match res? {
                    (transaction_id, Some(transaction)) => {
                        account_details
                            .incoming_transactions
                            .insert(transaction_id, transaction);
                    }
                    (transaction_id, None) => {
                        log::debug!("[SYNC] adding {transaction_id} to inaccessible_incoming_transactions");
                        // Save transactions that weren't found by the node to avoid requesting them endlessly.
                        // Will be cleared when new client options are provided.
                        account_details
                            .inaccessible_incoming_transactions
                            .insert(transaction_id);
                    }
                }
            }
        }

        Ok(())
    }
}

// Try to fetch the inputs of the transaction
pub(crate) async fn get_inputs_for_transaction_payload(
    client: &Client,
    transaction_payload: &TransactionPayload,
) -> crate::wallet::Result<Vec<OutputWithMetadataResponse>> {
    let TransactionEssence::Regular(essence) = transaction_payload.essence();
    let mut output_ids = Vec::new();

    for input in essence.inputs() {
        if let Input::Utxo(input) = input {
            output_ids.push(*input.output_id());
        }
    }

    client.try_get_outputs(output_ids).await.map_err(|e| e.into())
}