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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
use super::Client;
use crate::{Error, Result};
use sn_dbc::{DbcTransaction, PublicKey, SpentProof, SpentProofShare};
use sn_interface::{
messaging::data::{
DataCmd, DataQuery, Error as NetworkDataError, QueryResponse, SpentbookCmd, SpentbookQuery,
},
types::SpentbookAddress,
};
use std::collections::BTreeSet;
use xor_name::XorName;
const MAX_SPEND_DBC_ATTEMPS: u8 = 5;
impl Client {
#[instrument(skip(self, tx, spent_proofs), level = "debug")]
pub async fn spend_dbc(
&self,
public_key: PublicKey,
tx: DbcTransaction,
spent_proofs: BTreeSet<SpentProof>,
spent_transactions: BTreeSet<DbcTransaction>,
) -> Result<()> {
let mut network_knowledge = None;
let mut attempts = 1;
debug!(
"Attempting DBC spend request. Will reattempt if spent proof was signed \
with a section key that is unknown to the processing section."
);
loop {
let cmd = SpentbookCmd::Spend {
public_key,
tx: tx.clone(),
spent_proofs: spent_proofs.clone(),
spent_transactions: spent_transactions.clone(),
network_knowledge,
};
let result = self.send_cmd(DataCmd::Spentbook(cmd)).await;
if let Err(Error::CmdError {
source: NetworkDataError::SpentProofUnknownSectionKey(unknown_section_key),
..
}) = result
{
debug!(
"Encountered unknown section key during spend request. \
Will obtain updated network knowledge and retry. \
Attempts made: {attempts}"
);
if attempts >= MAX_SPEND_DBC_ATTEMPS {
error!("DBC spend request failed after {attempts} attempts");
return Err(Error::DbcSpendRetryAttemptsExceeded {
attempts,
public_key,
});
}
let network = self.session.network.read().await;
let (proof_chain, _) = network
.get_sections_dag()
.single_branch_dag_for_key(&unknown_section_key)
.map_err(|_| Error::SectionsDagKeyNotFound(unknown_section_key))?;
let signed_sap = network
.get_signed_by_key(&unknown_section_key)
.ok_or(Error::SignedSapNotFound(unknown_section_key))?;
network_knowledge = Some((proof_chain, signed_sap.clone()));
attempts += 1;
} else {
return result;
}
}
}
#[instrument(skip(self), level = "debug")]
pub async fn spent_proof_shares(&self, public_key: PublicKey) -> Result<Vec<SpentProofShare>> {
let address = SpentbookAddress::new(XorName::from_content(&public_key.to_bytes()));
let query = DataQuery::Spentbook(SpentbookQuery::SpentProofShares(address));
let response = self.send_query(query.clone()).await?;
match response {
QueryResponse::SpentProofShares(res) => {
res.map_err(|err| Error::ErrorMsg { source: err })
}
other => Err(Error::UnexpectedQueryResponse {
query,
response: other,
}),
}
}
}
#[cfg(test)]
mod tests {
use crate::utils::test_utils::{
create_test_client_with, init_logger, read_genesis_dbc_from_first_node,
};
use crate::Client;
use sn_dbc::{rng, DbcTransaction, Hash, OwnerOnce, TransactionBuilder};
use sn_interface::messaging::data::Error as ErrorMsg;
use eyre::{bail, Result};
use std::collections::{BTreeSet, HashSet};
use tokio::time::Duration;
const MAX_ATTEMPTS: u8 = 5;
const SLEEP_DURATION: Duration = Duration::from_secs(3);
const NUM_OF_DBC_REISSUE_ATTEMPTS: u8 = 5;
async fn verify_spent_proof_share(
public_key: bls::PublicKey,
tx: DbcTransaction,
client: &Client,
) -> Result<()> {
let mut attempts = 0;
loop {
attempts += 1;
let spent_proof_shares = client.spent_proof_shares(public_key).await?;
let num_of_spent_proof_shares = spent_proof_shares
.iter()
.filter(|proof| proof.content.transaction_hash == Hash::from(tx.hash()))
.count();
if (5..=7).contains(&num_of_spent_proof_shares) {
break Ok(());
} else if attempts == MAX_ATTEMPTS {
bail!(
"Failed to obtained enough spent proof shares after {} attempts, {} retrieved in last attempt",
MAX_ATTEMPTS, num_of_spent_proof_shares
);
}
tokio::time::sleep(SLEEP_DURATION).await;
}
}
#[tokio::test(flavor = "multi_thread")]
async fn test_spentbook_spend_dbc() -> Result<()> {
init_logger();
let _outer_span = tracing::info_span!("test__spentbook_spend_dbc").entered();
let (
client,
SpendDetails {
public_key,
genesis_dbc,
tx,
},
) = setup(false).await?;
client
.spend_dbc(
public_key,
tx.clone(),
genesis_dbc.spent_proofs,
genesis_dbc.spent_transactions,
)
.await?;
verify_spent_proof_share(public_key, tx, &client).await
}
#[tokio::test(flavor = "multi_thread")]
async fn spentbook_spend_spent_proof_with_invalid_pk_should_return_spentbook_error(
) -> Result<()> {
init_logger();
let _outer_span = tracing::info_span!(
"test__spentbook_spend_spent_proof_with_invalid_pk_should_return_spentbook_error"
)
.entered();
let (
client,
SpendDetails {
public_key,
genesis_dbc,
tx,
},
) = setup(false).await?;
let invalid_pk = bls::SecretKey::random().public_key();
let invalid_spent_proofs = genesis_dbc
.spent_proofs
.into_iter()
.map(|mut proof| {
proof.spentbook_pub_key = invalid_pk;
proof
})
.collect();
let result = client
.spend_dbc(
public_key,
tx.clone(),
invalid_spent_proofs,
genesis_dbc.spent_transactions,
)
.await;
match result {
Ok(_) => bail!("We expected an error to be returned"),
Err(crate::Error::CmdError {
source: ErrorMsg::InvalidOperation(error_string),
..
}) => {
let correct_error_str =
format!("SpentbookError(\"Spent proof signature {invalid_pk:?} is invalid\"");
assert!(
error_string.contains(&correct_error_str),
"A different SpentbookError error was expected for this case. What we got: {error_string:?}"
);
Ok(())
}
Err(error) => bail!("We expected a different error to be returned. Actual: {error:?}"),
}
}
#[tokio::test(flavor = "multi_thread")]
async fn spentbook_spend_spent_proof_with_key_not_in_section_chain_should_return_cmd_error_response(
) -> Result<()> {
init_logger();
let _outer_span = tracing::info_span!("test__spentbook_spend_spent_proof_with_key_not_in_section_chain_should_return_cmd_error_response").entered();
let (
client,
SpendDetails {
public_key,
genesis_dbc,
tx,
},
) = setup(true).await?; let genesis_dbc_owner_pk = genesis_dbc.owner_base().public_key();
let result = client
.spend_dbc(
public_key,
tx.clone(),
genesis_dbc.spent_proofs,
genesis_dbc.spent_transactions,
)
.await;
match result {
Ok(_) => bail!("We expected an error to be returned"),
Err(crate::Error::SectionsDagKeyNotFound(section_key)) => {
assert_eq!(
section_key, genesis_dbc_owner_pk,
"We expected {genesis_dbc_owner_pk:?} in the error but got {section_key:?}"
);
Ok(())
}
Err(error) => bail!("We expected a different error to be returned. Actual: {error:?}"),
}
}
#[tokio::test(flavor = "multi_thread")]
async fn spentbook_spend_spent_proofs_do_not_relate_to_input_dbcs_should_return_spentbook_error(
) -> Result<()> {
init_logger();
let _outer_span = tracing::info_span!("test__spentbook_spend_spent_proofs_do_not_relate_to_input_dbcs_should_return_spentbook_error").entered();
let (client, SpendDetails { genesis_dbc, .. }) = setup(false).await?;
let spend_amount_1 = 10;
let recipient_owneronce_1 =
OwnerOnce::from_owner_base(client.dbc_owner().clone(), &mut rng::thread_rng());
let outputs_1 = vec![(
sn_dbc::Token::from_nano(spend_amount_1),
recipient_owneronce_1,
)];
let (output_dbcs_1, _change_dbc_1) = reissue_dbcs(
&client,
vec![genesis_dbc.clone()],
outputs_1,
sn_dbc::Token::from_nano(sn_interface::dbcs::GENESIS_DBC_AMOUNT - spend_amount_1),
)
.await?;
let (output_dbc_1, _output_owneronce_1, _amount_secrects_1) = output_dbcs_1[0].clone();
let pk = output_dbc_1
.public_key_bearer()
.expect("unexpectedly failed to get DBC public key");
let spend_amount_2 = 5;
let recipient_owneronce_2 =
OwnerOnce::from_owner_base(client.dbc_owner().clone(), &mut rng::thread_rng());
let outputs_2 = vec![(
sn_dbc::Token::from_nano(spend_amount_2),
recipient_owneronce_2,
)];
let (output_dbcs_2, _change_dbc_2) = reissue_dbcs(
&client,
vec![output_dbc_1],
outputs_2,
sn_dbc::Token::from_nano(spend_amount_1 - spend_amount_2),
)
.await?;
let (output_dbc_2, output_owneronce_2, _amount_secrects_2) = output_dbcs_2[0].clone();
let result = client
.spend_dbc(
output_owneronce_2.as_owner().public_key(),
output_dbc_2.transaction.clone(),
genesis_dbc.spent_proofs.clone(),
genesis_dbc.spent_transactions,
)
.await;
match result {
Ok(_) => bail!("We expected an error to be returned"),
Err(crate::Error::CmdError {
source: ErrorMsg::InvalidOperation(error_string),
..
}) => {
let correct_error_str =
format!("{:?}", sn_dbc::Error::MissingCommitmentForPubkey(pk));
assert!(
error_string.contains(&correct_error_str),
"A different SpentbookError error was expected for this case. What we got: {error_string:?}, expected: {correct_error_str:?}"
);
Ok(())
}
Err(error) => bail!("We expected a different error to be returned. Actual: {error:?}"),
}
}
#[tokio::test(flavor = "multi_thread")]
async fn spentbook_spend_with_random_public_key_should_return_spentbook_error() -> Result<()> {
init_logger();
let _outer_span = tracing::info_span!(
"test__spentbook_spend_with_random_public_key_should_return_spentbook_error"
)
.entered();
let (
client,
SpendDetails {
genesis_dbc, tx, ..
},
) = setup(false).await?;
let random_public_key = bls::SecretKey::random().public_key();
let result = client
.spend_dbc(
random_public_key,
tx.clone(),
genesis_dbc.spent_proofs.clone(),
genesis_dbc.spent_transactions,
)
.await;
match result {
Ok(_) => bail!("We expected an error to be returned"),
Err(crate::Error::CmdError {
source: ErrorMsg::InvalidOperation(error_string),
..
}) => {
let correct_error_str =
format!("SpentbookError(\"There are no commitments for the given public key {random_public_key:?}\"");
assert!(
error_string.contains(&correct_error_str),
"A different SpentbookError error was expected for this case. What we got: {error_string:?}"
);
Ok(())
}
Err(error) => bail!("We expected a different error to be returned. Actual: {error:?}"),
}
}
struct SpendDetails {
genesis_dbc: sn_dbc::Dbc,
tx: DbcTransaction,
public_key: sn_dbc::PublicKey,
}
async fn setup(invalid_genesis_dbc: bool) -> Result<(Client, SpendDetails)> {
init_logger();
let genesis_dbc = if invalid_genesis_dbc {
let sk_set = bls::SecretKeySet::random(0, &mut rand::thread_rng());
sn_interface::dbcs::gen_genesis_dbc(&sk_set, &sk_set.secret_key())?
} else {
read_genesis_dbc_from_first_node()?
};
let dbc_owner = genesis_dbc.owner_base().clone();
let client = create_test_client_with(None, Some(dbc_owner.clone()), None).await?;
let genesis_public_key = genesis_dbc.public_key_bearer()?;
let output_owner = OwnerOnce::from_owner_base(dbc_owner, &mut rng::thread_rng());
let dbc_builder = TransactionBuilder::default().add_input_dbc_bearer(&genesis_dbc)?;
let inputs_amount_sum = dbc_builder.inputs_amount_sum();
let dbc_builder = dbc_builder
.add_output_by_amount(inputs_amount_sum, output_owner)
.build(rng::thread_rng())?;
assert_eq!(dbc_builder.inputs().len(), 1);
let (public_key, tx) = dbc_builder.inputs()[0].clone();
assert_eq!(genesis_public_key, public_key);
Ok((
client,
SpendDetails {
genesis_dbc,
tx,
public_key,
},
))
}
async fn reissue_dbcs(
client: &Client,
input_dbcs: Vec<sn_dbc::Dbc>,
outputs: Vec<(sn_dbc::Token, OwnerOnce)>,
change_amount: sn_dbc::Token,
) -> Result<(
Vec<(sn_dbc::Dbc, OwnerOnce, sn_dbc::AmountSecrets)>,
Option<sn_dbc::Dbc>,
)> {
let mut tx_builder = TransactionBuilder::default()
.add_inputs_dbc_bearer(input_dbcs.iter())?
.add_outputs_by_amount(outputs.into_iter().map(|(token, owner)| (token, owner)));
let change_owneronce =
OwnerOnce::from_owner_base(client.dbc_owner().clone(), &mut rng::thread_rng());
if change_amount.as_nano() > 0 {
tx_builder = tx_builder.add_output_by_amount(change_amount, change_owneronce.clone());
}
let spent_proofs: BTreeSet<sn_dbc::SpentProof> = input_dbcs
.iter()
.flat_map(|dbc| dbc.spent_proofs.clone())
.collect();
let spent_transactions: BTreeSet<DbcTransaction> = input_dbcs
.iter()
.flat_map(|dbc| dbc.spent_transactions.clone())
.collect();
let proof_key_verifier = SpentProofKeyVerifier { client };
let mut dbc_builder = tx_builder.build(rng::thread_rng())?;
for (public_key, tx) in dbc_builder.inputs() {
let tx_hash = Hash::from(tx.hash());
let mut attempts = 0;
loop {
attempts += 1;
client
.spend_dbc(
public_key,
tx.clone(),
spent_proofs.clone(),
spent_transactions.clone(),
)
.await?;
let spent_proof_shares = client.spent_proof_shares(public_key).await?;
let shares_for_current_tx: HashSet<sn_dbc::SpentProofShare> = spent_proof_shares
.into_iter()
.filter(|proof_share| proof_share.content.transaction_hash == tx_hash)
.collect();
match verify_spent_proof_shares_for_tx(
public_key,
tx_hash,
shares_for_current_tx.iter(),
&proof_key_verifier,
) {
Ok(()) => {
dbc_builder = dbc_builder
.add_spent_proof_shares(shares_for_current_tx.into_iter())
.add_spent_transaction(tx);
break;
}
Err(err) if attempts == NUM_OF_DBC_REISSUE_ATTEMPTS => {
bail!(format!(
"Failed to spend input, {} proof shares obtained from spentbook: {}",
shares_for_current_tx.len(),
err
))
}
Err(_) => {}
}
}
}
let mut output_dbcs = dbc_builder.build(&proof_key_verifier)?;
let mut change_dbc = None;
output_dbcs.retain(|(dbc, owneronce, _)| {
if owneronce == &change_owneronce && change_amount.as_nano() > 0 {
change_dbc = Some(dbc.clone());
false
} else {
true
}
});
Ok((output_dbcs, change_dbc))
}
fn verify_spent_proof_shares_for_tx<'a>(
public_key: sn_dbc::PublicKey,
tx_hash: Hash,
proof_shares: impl Iterator<Item = &'a sn_dbc::SpentProofShare>,
proof_key_verifier: &SpentProofKeyVerifier,
) -> Result<()> {
sn_dbc::SpentProof::try_from_proof_shares(public_key, tx_hash, proof_shares)
.and_then(|spent_proof| spent_proof.verify(tx_hash, proof_key_verifier))?;
Ok(())
}
struct SpentProofKeyVerifier<'a> {
client: &'a Client,
}
impl sn_dbc::SpentProofKeyVerifier for SpentProofKeyVerifier<'_> {
type Error = crate::Error;
fn verify_known_key(&self, key: &sn_dbc::PublicKey) -> crate::Result<()> {
if !futures::executor::block_on(self.client.is_known_section_key(key)) {
Err(crate::Error::SectionsDagKeyNotFound(*key))
} else {
Ok(())
}
}
}
}