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
// Copyright 2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0
use std::collections::HashMap;
use crate::{
client::{secret::SecretManage, ClientError},
types::{
api::core::TransactionState,
block::{input::Input, output::OutputId, BlockId},
},
wallet::{
core::WalletLedger,
types::{InclusionState, TransactionWithMetadata},
Wallet, WalletError,
},
};
// ignore outputs and transactions from other networks
// check if outputs are unspent
// also revalidate that the locked outputs needs to be there, maybe there was a conflict or the transaction got
// confirmed, then they should get removed
impl<S: 'static + SecretManage> Wallet<S>
where
WalletError: From<S::Error>,
ClientError: From<S::Error>,
{
/// Sync transactions. Returns the transaction with updated metadata and spent
/// output ids that don't need to be locked anymore
/// Return true if a transaction got confirmed for which we don't have an output already, based on this outputs will
/// be synced again
pub(crate) async fn sync_pending_transactions(&self) -> Result<bool, WalletError> {
log::debug!("[SYNC] sync pending transactions");
let network_id = self.client().get_network_id().await?;
let wallet_ledger = self.ledger().await;
// only set to true if a transaction got confirmed for which we don't have an output
// (transaction_output.is_none())
let mut confirmed_unknown_output = false;
if wallet_ledger.pending_transactions.is_empty() {
return Ok(confirmed_unknown_output);
}
let mut updated_transactions = Vec::new();
let mut spent_output_ids = Vec::new();
// Inputs from conflicting transactions that are unspent, but should be removed from the locked outputs so they
// are available again
let mut output_ids_to_unlock = Vec::new();
let pending_transactions = wallet_ledger
.pending_transactions
.iter()
.copied()
.map(|id| {
(
id,
wallet_ledger
.transactions
.get(&id)
// panic during development to easier detect if something is wrong, should be handled different
// later
.expect("transaction id stored, but transaction is missing")
.clone(),
)
})
.collect::<HashMap<_, _>>();
drop(wallet_ledger);
for (transaction_id, transaction) in pending_transactions {
log::debug!("[SYNC] sync pending transaction {transaction_id}");
// only check transaction from the network we're connected to
if transaction.network_id != network_id {
continue;
}
// check if we have an output (remainder, if not sending to an own address) that got created by this
// transaction, if that's the case, then the transaction got confirmed
let transaction_output = self
.ledger()
.await
.outputs
.keys()
.find(|o| o.transaction_id() == &transaction_id)
.copied();
if let Some(transaction_output) = transaction_output {
{
let wallet_ledger = self.ledger().await;
// Safe to unwrap, we just got the output
let confirmed_output_data = wallet_ledger.outputs.get(&transaction_output).expect("output exists");
log::debug!(
"[SYNC] confirmed transaction {transaction_id} in block {}",
confirmed_output_data.metadata.block_id()
);
updated_transaction_and_outputs(
transaction,
Some(*confirmed_output_data.metadata.block_id()),
InclusionState::Confirmed,
&mut updated_transactions,
&mut spent_output_ids,
);
}
continue;
}
// Check if the inputs of the transaction are still unspent
let mut input_got_spent = false;
for input in transaction.payload.transaction().inputs() {
let Input::Utxo(input) = input;
if let Some(input) = self.ledger().await.outputs.get(input.output_id()) {
if input.metadata.is_spent() {
input_got_spent = true;
}
}
}
match self.client().get_transaction_metadata(&transaction_id).await {
Ok(metadata) => {
match metadata.transaction_state {
// TODO: Separate TransactionState::Finalized, TransactionState::Accepted? https://github.com/iotaledger/iota-sdk/issues/1814
TransactionState::Accepted | TransactionState::Committed | TransactionState::Finalized => {
log::debug!(
"[SYNC] confirmed transaction {transaction_id} in slot {}",
metadata.earliest_attachment_slot
);
confirmed_unknown_output = true;
let mut block_id = transaction.block_id;
if transaction.block_id.is_none() {
if let Ok(metadata) = self
.client()
.get_included_block_metadata(&transaction.payload.transaction().id())
.await
{
block_id.replace(metadata.block_id);
}
}
updated_transaction_and_outputs(
transaction,
block_id,
InclusionState::Confirmed,
&mut updated_transactions,
&mut spent_output_ids,
);
}
TransactionState::Failed => {
// try to get the included block, because maybe only this attachment is
// conflicting because it got confirmed in another block
if let Ok(included_block) = self
.client()
.get_included_block(&transaction.payload.transaction().id())
.await
{
confirmed_unknown_output = true;
updated_transaction_and_outputs(
transaction,
Some(self.client().block_id(&included_block).await?),
// block metadata was Conflicting, but it's confirmed in another attachment
InclusionState::Confirmed,
&mut updated_transactions,
&mut spent_output_ids,
);
} else {
log::debug!("[SYNC] conflicting transaction {transaction_id}");
let mut block_id = transaction.block_id;
if transaction.block_id.is_none() {
if let Ok(metadata) = self
.client()
.get_included_block_metadata(&transaction.payload.transaction().id())
.await
{
block_id.replace(metadata.block_id);
}
}
updated_transaction_and_outputs(
transaction,
block_id,
InclusionState::Conflicting,
&mut updated_transactions,
&mut spent_output_ids,
);
}
}
// Do nothing, just need to wait a bit more
TransactionState::Pending => {}
}
}
Err(ClientError::Node(crate::client::node_api::error::Error::NotFound(_))) => {
if input_got_spent {
process_transaction_with_unknown_state(
&*self.ledger().await,
transaction,
&mut updated_transactions,
&mut output_ids_to_unlock,
)?;
} else {
log::debug!(
"[SYNC] setting transaction {transaction_id} without block as conflicting so inputs get available again"
);
for input in transaction.payload.transaction().inputs() {
let Input::Utxo(input) = input;
output_ids_to_unlock.push(*input.output_id());
}
updated_transaction_and_outputs(
transaction,
None,
// No block with this transaction, set it as conflicting so the inputs get available again
InclusionState::Conflicting,
&mut updated_transactions,
&mut spent_output_ids,
);
}
}
Err(e) => return Err(e.into()),
}
}
// updates account with balances, output ids, outputs
self.update_with_transactions(updated_transactions, spent_output_ids, output_ids_to_unlock)
.await?;
Ok(confirmed_unknown_output)
}
}
// Set the outputs as spent so they will not be used as input again
fn updated_transaction_and_outputs(
mut transaction: TransactionWithMetadata,
block_id: Option<BlockId>,
inclusion_state: InclusionState,
updated_transactions: &mut Vec<TransactionWithMetadata>,
spent_output_ids: &mut Vec<OutputId>,
) {
if block_id.is_some() {
transaction.block_id = block_id;
}
transaction.inclusion_state = inclusion_state;
// get spent inputs
for input in transaction.payload.transaction().inputs() {
let Input::Utxo(input) = input;
spent_output_ids.push(*input.output_id());
}
updated_transactions.push(transaction);
}
// When a transaction got pruned, the inputs and outputs are also not available, then this could mean that it was
// confirmed and the created outputs got also already spent and pruned or the inputs got spent in another transaction
fn process_transaction_with_unknown_state(
wallet_ledger: &WalletLedger,
mut transaction: TransactionWithMetadata,
updated_transactions: &mut Vec<TransactionWithMetadata>,
output_ids_to_unlock: &mut Vec<OutputId>,
) -> Result<(), WalletError> {
let mut all_inputs_spent = true;
for input in transaction.payload.transaction().inputs() {
let Input::Utxo(input) = input;
if let Some(output_data) = wallet_ledger.outputs.get(input.output_id()) {
if !output_data.is_spent() {
// unspent output needs to be made available again
output_ids_to_unlock.push(*input.output_id());
all_inputs_spent = false;
}
} else {
all_inputs_spent = false;
}
}
// If only a part of the inputs got spent, then it couldn't happen with this transaction, so it's conflicting
if all_inputs_spent {
transaction.inclusion_state = InclusionState::UnknownPruned;
} else {
log::debug!("[SYNC] conflicting transaction {}", transaction.transaction_id);
transaction.inclusion_state = InclusionState::Conflicting;
}
updated_transactions.push(transaction);
Ok(())
}