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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
// Copyright 2021 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use super::{
    interaction::push_state,
    messaging::{send, send_error, send_support, send_to_nodes},
    role::{AdultRole, Role},
};
use crate::{
    chunks::Chunks,
    event_mapping::MsgContext,
    node_ops::{NodeDuties, NodeDuty},
    section_funds::{reward_stage::RewardStage, Credits, SectionFunds},
    Error, Node, Result,
};
use log::{debug, info};
use sn_messaging::{
    client::{Cmd, ProcessMsg},
    node::{NodeMsg, NodeQuery},
    Aggregation, MessageId,
};
use sn_routing::ELDER_SIZE;
use std::sync::Arc;
use tokio::{sync::RwLock, task::JoinHandle};
use xor_name::XorName;

const DATA_SECTION_TARGET_COUNT: usize = 3;

pub enum NodeTask {
    None,
    Result(Box<(NodeDuties, Option<MsgContext>)>),
    Thread(JoinHandle<Result<NodeTask>>),
}

impl From<NodeDuties> for NodeTask {
    fn from(duties: NodeDuties) -> Self {
        Self::Result(Box::new((duties, None)))
    }
}

impl Node {
    ///
    pub async fn handle(&mut self, duty: NodeDuty) -> Result<NodeTask> {
        if !matches!(duty, NodeDuty::NoOp) {
            debug!("Handling NodeDuty: {:?}", duty);
        }

        match duty {
            NodeDuty::Genesis => {
                self.level_up().await?;
                let elder = self.role.as_elder_mut()?;
                *elder.received_initial_sync.write().await = true;
                Ok(NodeTask::None)
            }
            NodeDuty::EldersChanged {
                our_key,
                our_prefix,
                new_elders,
                newbie,
            } => {
                if newbie {
                    info!("Promoted to Elder on Churn");
                    self.level_up().await?;
                    if self.network_api.our_prefix().await.is_empty()
                        && self.network_api.section_chain().await.len() <= ELDER_SIZE
                    {
                        let elder = self.role.as_elder_mut()?;
                        *elder.received_initial_sync.write().await = true;
                    }
                    Ok(NodeTask::None)
                } else {
                    info!("Updating our replicas on Churn");
                    let elder = self.role.as_elder_mut()?.clone();
                    let network = self.network_api.clone();
                    let handle = tokio::spawn(async move {
                        Self::update_replicas(&elder, &network).await?;
                        let msg_id =
                            MessageId::combine(&[our_prefix.name().0, XorName::from(our_key).0]);
                        let ops = vec![push_state(&elder, our_prefix, msg_id, new_elders).await?];
                        let our_adults = network.our_adults().await;
                        elder
                            .meta_data
                            .write()
                            .await
                            .retain_members_only(our_adults)
                            .await?;
                        Ok(NodeTask::from(ops))
                    });
                    Ok(NodeTask::Thread(handle))
                }
            }
            NodeDuty::AdultsChanged {
                added,
                removed,
                remaining,
            } => {
                let our_name = self.our_name().await;
                let mut adult_role = self.role.as_adult()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(
                        adult_role
                            .reorganize_chunks(our_name, added, removed, remaining)
                            .await,
                    ))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SectionSplit {
                our_key,
                our_prefix,
                our_new_elders,
                their_new_elders,
                sibling_key,
                newbie,
            } => {
                debug!(
                    "@@@@@@ SPLIT: Our prefix: {:?}, neighbour: {:?}",
                    our_prefix,
                    our_prefix.sibling(),
                );
                debug!(
                    "@@@@@@ SPLIT: Our key: {:?}, neighbour: {:?}",
                    our_key, sibling_key
                );
                if newbie {
                    info!("Beginning split as Newbie");
                    self.begin_split_as_newbie(our_key, our_prefix).await?;
                    Ok(NodeTask::None)
                } else {
                    info!("Beginning split as Oldie");
                    let elder = self.role.as_elder()?.clone();
                    let network = self.network_api.clone();
                    let handle = tokio::spawn(async move {
                        Ok(NodeTask::from(
                            Self::begin_split_as_oldie(
                                &elder,
                                &network,
                                our_prefix,
                                our_key,
                                sibling_key,
                                our_new_elders,
                                their_new_elders,
                            )
                            .await?,
                        ))
                    });
                    Ok(NodeTask::Thread(handle))
                }
            }
            NodeDuty::ProposeOffline(unresponsive_adults) => {
                for adult in unresponsive_adults {
                    self.network_api.propose_offline(adult).await?;
                }
                Ok(NodeTask::None)
            }
            // a remote section asks for the replicas of their wallet
            NodeDuty::GetSectionElders { msg_id, origin } => {
                let network = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(
                        Self::get_section_elders(&network, msg_id, origin).await?,
                    ))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ReceiveRewardProposal(proposal) => {
                info!("Handling Churn proposal as an Elder");
                let elder = self.role.as_elder_mut()?;
                let mut churn_process = elder
                    .section_funds
                    .write()
                    .await
                    .as_churning_mut()?
                    .0
                    .clone();
                let duties = vec![churn_process.receive_churn_proposal(proposal).await?];
                Ok(NodeTask::Result(Box::new((duties, None))))
            }
            NodeDuty::ReceiveRewardAccumulation(accumulation) => {
                let elder = self.role.as_elder_mut()?.clone();
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    let mut section_funds = elder.section_funds.write().await;
                    let (churn_process, reward_wallets) = section_funds.as_churning_mut()?;

                    let mut ops = vec![
                        churn_process
                            .clone()
                            .receive_wallet_accumulation(accumulation)
                            .await?,
                    ];

                    if let RewardStage::Completed(credit_proofs) = churn_process.stage().clone() {
                        let reward_sum = credit_proofs.sum();
                        ops.extend(Self::propagate_credits(credit_proofs)?);
                        // update state
                        *section_funds = SectionFunds::KeepingNodeWallets(reward_wallets.clone());
                        let section_key = network_api.section_public_key().await?;
                        info!(
                            "COMPLETED SPLIT. New section: ({}). Total rewards paid: {}.",
                            section_key, reward_sum
                        );
                        ops.push(NodeDuty::SetNodeJoinsAllowed(true));
                    }

                    Ok(NodeTask::from(ops))
                });
                Ok(NodeTask::Thread(handle))
            }
            //
            // ------- reward reg -------
            NodeDuty::SetNodeWallet { wallet_id, node_id } => {
                let elder = self.role.as_elder_mut()?.clone();
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    let members = network_api.our_members().await;
                    let result = if let Some(age) = members.get(&node_id) {
                        elder
                            .section_funds
                            .write()
                            .await
                            .set_node_wallet(node_id, wallet_id, *age);
                        Ok(vec![])
                    } else {
                        debug!(
                            "{:?}: Couldn't find node id {} when adding wallet {}",
                            network_api.our_prefix().await,
                            node_id,
                            wallet_id
                        );
                        Err(Error::NodeNotFoundForReward)
                    }?;
                    Ok(NodeTask::from(result))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::GetNodeWalletKey { node_name, .. } => {
                let elder = self.role.as_elder_mut()?.clone();
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    let members = network_api.our_members().await;
                    let result = if members.get(&node_name).is_some() {
                        let _wallet = elder.section_funds.read().await.get_node_wallet(&node_name);
                        Ok(vec![]) // not yet implemented
                    } else {
                        debug!(
                            "{:?}: Couldn't find node {} when getting wallet.",
                            network_api.our_prefix().await,
                            node_name,
                        );
                        Err(Error::NodeNotFoundForReward)
                    }?;
                    Ok(NodeTask::from(result))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ProcessLostMember { name, .. } => {
                info!("Member Lost: {:?}", name);
                let elder = self.role.as_elder_mut()?.clone();
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    elder.section_funds.write().await.remove_node_wallet(name);
                    let our_adults = network_api.our_adults().await;
                    elder
                        .meta_data
                        .write()
                        .await
                        .retain_members_only(our_adults)
                        .await?;
                    Ok(NodeTask::from(vec![NodeDuty::SetNodeJoinsAllowed(true)]))
                });
                Ok(NodeTask::Thread(handle))
            }
            //
            // ---------- Levelling --------------
            NodeDuty::SynchState {
                node_rewards,
                user_wallets,
                metadata,
            } => {
                let elder = self.role.as_elder()?.clone();
                let network_api = self.network_api.clone();
                let reward_key = self.node_info.reward_key;
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        Self::synch_state(
                            &elder,
                            reward_key,
                            &network_api,
                            node_rewards,
                            user_wallets,
                            metadata,
                        )
                        .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::LevelDown => {
                info!("Getting Demoted");
                let capacity = self.used_space.max_capacity().await;
                self.role = Role::Adult(AdultRole {
                    chunks: Arc::new(RwLock::new(
                        Chunks::new(self.node_info.root_dir.as_path(), capacity).await?,
                    )),
                });
                Ok(NodeTask::None)
            }
            //
            // ----------- Transfers -----------
            NodeDuty::GetTransferReplicaEvents { msg_id, origin } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .all_events(msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::PropagateTransfer {
                proof,
                msg_id,
                origin,
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .receive_propagated(&proof, msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ValidateClientTransfer {
                signed_transfer,
                msg_id,
                origin,
            } => {
                let elder = self.role.as_elder()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .validate(signed_transfer, msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SimulatePayout { transfer, .. } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .write()
                            .await
                            .credit_without_proof(transfer)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::GetTransfersHistory {
                at, msg_id, origin, ..
            } => {
                // TODO: add limit with since_version
                let elder = self.role.as_elder()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .history(&at, msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::GetBalance { at, msg_id, origin } => {
                let elder = self.role.as_elder()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .balance(at, msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::GetStoreCost {
                bytes,
                msg_id,
                origin,
                ..
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(
                        elder
                            .transfers
                            .read()
                            .await
                            .get_store_cost(bytes, msg_id, origin)
                            .await,
                    ))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::RegisterTransfer {
                proof,
                msg_id,
                origin,
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .transfers
                            .read()
                            .await
                            .register(&proof, msg_id, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            //
            // -------- Immutable chunks --------
            NodeDuty::ReadChunk { read, msg_id } => {
                let adult = self.role.as_adult()?.clone();
                let handle = tokio::spawn(async move {
                    let mut ops = vec![adult.chunks.read().await.read(&read, msg_id)];
                    ops.extend(adult.chunks.read().await.check_storage().await?);
                    Ok(NodeTask::from(ops))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::WriteChunk {
                write,
                msg_id,
                client_signed,
            } => {
                let adult = self.role.as_adult()?.clone();
                let handle = tokio::spawn(async move {
                    let mut ops = vec![
                        adult
                            .chunks
                            .write()
                            .await
                            .write(&write, msg_id, client_signed.public_key)
                            .await?,
                    ];
                    ops.extend(adult.chunks.read().await.check_storage().await?);
                    Ok(NodeTask::from(ops))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ProcessRepublish { chunk, msg_id, .. } => {
                info!("Processing republish with MessageId: {:?}", msg_id);
                let elder = self.role.as_elder()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder.meta_data.write().await.republish_chunk(chunk).await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ReachingMaxCapacity => {
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        Self::notify_section_of_our_storage(&network_api).await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            //
            // ------- Misc ------------
            NodeDuty::IncrementFullNodeCount { node_id } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    elder
                        .meta_data
                        .write()
                        .await
                        .increase_full_node_count(node_id)
                        .await;
                    // Accept a new node in place for the full node.
                    Ok(NodeTask::from(vec![NodeDuty::SetNodeJoinsAllowed(true)]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::Send(msg) => {
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    send(msg, &network_api).await?;
                    Ok(NodeTask::None)
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SendError(msg) => {
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    send_error(msg, &network_api).await?;
                    Ok(NodeTask::None)
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SendSupport(msg) => {
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    send_support(msg, &network_api).await?;
                    Ok(NodeTask::None)
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SendToNodes {
                msg,
                targets,
                aggregation,
            } => {
                let network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    send_to_nodes(&msg, targets, aggregation, &network_api).await?;
                    Ok(NodeTask::None)
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::SetNodeJoinsAllowed(joins_allowed) => {
                let mut network_api = self.network_api.clone();
                let handle = tokio::spawn(async move {
                    network_api
                        .set_joins_allowed(cfg!(feature = "always-joinable") || joins_allowed)
                        .await?;
                    Ok(NodeTask::None)
                });
                Ok(NodeTask::Thread(handle))
            }
            //
            // ------- Data ------------
            NodeDuty::ProcessRead {
                query,
                msg_id,
                client_signed,
                origin,
            } => {
                // TODO: remove this conditional branching
                // routing should take care of this
                let data_section_addr = query.dst_address();
                let network_api = self.network_api.clone();
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    let duties = if network_api.our_prefix().await.matches(&data_section_addr) {
                        vec![
                            elder
                                .meta_data
                                // this is a write here as we write the liveness check for each adult
                                .write()
                                .await
                                .read(query, msg_id, client_signed.public_key, origin)
                                .await?,
                        ]
                    } else {
                        let targets = network_api
                            .get_closest_elders_to(
                                &data_section_addr,
                                msg_id,
                                DATA_SECTION_TARGET_COUNT,
                            )
                            .await?;
                        vec![NodeDuty::SendToNodes {
                            msg: NodeMsg::NodeQuery {
                                query: NodeQuery::Metadata {
                                    query,
                                    client_signed,
                                    origin,
                                },
                                id: msg_id,
                            },
                            targets,
                            aggregation: Aggregation::None,
                        }]
                    };
                    Ok(NodeTask::from(duties))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ProcessWrite {
                cmd,
                msg_id,
                origin,
                client_signed,
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        elder
                            .meta_data
                            .write()
                            .await
                            .write(cmd, msg_id, client_signed, origin)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            // --- Completion of Adult operations ---
            NodeDuty::RecordAdultReadLiveness {
                response,
                correlation_id,
                src,
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(
                        elder
                            .meta_data
                            .write()
                            .await
                            .record_adult_read_liveness(correlation_id, response, src)
                            .await?,
                    ))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ProcessDataPayment {
                msg:
                    ProcessMsg::Cmd {
                        id,
                        cmd: Cmd::Data { payment, cmd },
                        client_signed,
                    },
                origin,
                ..
            } => {
                let elder = self.role.as_elder_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(
                        elder
                            .transfers
                            .write()
                            .await
                            .process_payment(id, payment, cmd, client_signed, origin)
                            .await?,
                    ))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::ProcessDataPayment { .. } => Ok(NodeTask::None),
            NodeDuty::ReplicateChunk { data, .. } => {
                let adult = self.role.as_adult_mut()?.clone();
                let handle = tokio::spawn(async move {
                    Ok(NodeTask::from(vec![
                        adult
                            .chunks
                            .write()
                            .await
                            .store_for_replication(data)
                            .await?,
                    ]))
                });
                Ok(NodeTask::Thread(handle))
            }
            NodeDuty::NoOp => Ok(NodeTask::None),
        }
    }
}