rns-core 0.1.9

Wire protocol, transport routing, and link/resource engine for the Reticulum Network Stack
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
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
689
690
691
692
extern crate rns_core;
extern crate rns_crypto;

use rns_core::buffer::types::NoopCompressor;
use rns_core::constants::*;
use rns_core::resource::receiver::ResourceReceiver;
use rns_core::resource::sender::ResourceSender;
use rns_core::resource::types::*;

fn identity_encrypt(data: &[u8]) -> Vec<u8> {
    data.to_vec()
}

fn identity_decrypt(data: &[u8]) -> Result<Vec<u8>, ()> {
    Ok(data.to_vec())
}

/// Full sender↔receiver cycle for small data (single part).
#[test]
fn test_full_cycle_single_part() {
    let data = b"Hello, Resource!";
    let mut rng = rns_crypto::FixedRng::new(&[0x42; 64]);

    let mut sender = ResourceSender::new(
        data,
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    // Advertise
    let _adv_actions = sender.advertise(1000.0);
    assert_eq!(sender.status, ResourceStatus::Advertised);
    let adv_data = sender.get_advertisement(0);

    // Receiver creates from advertisement
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    // Accept
    let req_actions = receiver.accept(1001.0);
    assert_eq!(receiver.status, ResourceStatus::Transferring);

    let request_data = req_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    // Sender handles request → sends parts
    let send_actions = sender.handle_request(&request_data, 1002.0);

    // Feed all parts to receiver
    receiver.req_sent = 1001.0;
    for action in &send_actions {
        if let ResourceAction::SendPart(part_data) = action {
            receiver.receive_part(part_data, 1003.0);
        }
    }

    assert_eq!(receiver.received_count, receiver.total_parts);

    // Assemble
    let assemble_actions = receiver.assemble(&identity_decrypt, &NoopCompressor);

    // Verify proof, data, completion
    let proof_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendProof(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    let received_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::DataReceived { data, .. } => Some(data.clone()),
            _ => None,
        })
        .unwrap();

    assert_eq!(received_data, data);

    // Sender validates proof
    let proof_result = sender.handle_proof(&proof_data, 1004.0);
    assert_eq!(sender.status, ResourceStatus::Complete);
    assert!(proof_result
        .iter()
        .any(|a| matches!(a, ResourceAction::Completed)));
}

/// Full cycle with multi-part data (> 3 * SDU).
#[test]
fn test_full_cycle_multi_part() {
    // Create data that needs 4+ parts: 4 * 464 = 1856 > SDU
    // Use data where each SDU-chunk is unique (identity_encrypt doesn't transform data,
    // so identical parts produce identical map hashes, causing unavoidable collisions)
    let data: Vec<u8> = (0..1500u32).map(|i| (i ^ (i >> 8)) as u8).collect();
    let seed: Vec<u8> = (0..=255).collect();
    let mut rng = rns_crypto::FixedRng::new(&seed);

    let mut sender = ResourceSender::new(
        &data,
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    // Data is: 4 (random) + 1500 = 1504 bytes → ceil(1504/464) = 4 parts
    assert!(sender.total_parts() >= 3);

    let adv_data = sender.get_advertisement(0);
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    // Transfer loop
    let req_actions = receiver.accept(1001.0);
    let mut request_data = req_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    let mut iteration = 0;
    loop {
        iteration += 1;
        if iteration > 20 {
            panic!("Transfer loop exceeded max iterations");
        }

        let send_actions = sender.handle_request(&request_data, 1002.0 + iteration as f64);

        receiver.req_sent = 1001.0 + iteration as f64;
        let mut any_part_sent = false;
        for action in &send_actions {
            if let ResourceAction::SendPart(part_data) = action {
                receiver.receive_part(part_data, 1003.0 + iteration as f64);
                any_part_sent = true;
            }
        }

        if receiver.received_count == receiver.total_parts {
            break;
        }

        // Get next request if window is done
        if receiver.outstanding_parts == 0 {
            let next_req = receiver.request_next(1004.0 + iteration as f64);
            if let Some(rd) = next_req.iter().find_map(|a| match a {
                ResourceAction::SendRequest(d) => Some(d.clone()),
                _ => None,
            }) {
                request_data = rd;
            } else {
                break;
            }
        } else if !any_part_sent {
            break; // No progress
        }
    }

    assert_eq!(receiver.received_count, receiver.total_parts);

    // Assemble and verify
    let assemble_actions = receiver.assemble(&identity_decrypt, &NoopCompressor);
    let received_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::DataReceived { data, .. } => Some(data.clone()),
            _ => None,
        })
        .unwrap();
    assert_eq!(received_data, data);

    // Validate proof
    let proof_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendProof(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();
    sender.handle_proof(&proof_data, 2000.0);
    assert_eq!(sender.status, ResourceStatus::Complete);
}

/// Full cycle with metadata.
#[test]
fn test_full_cycle_with_metadata() {
    let data = b"resource data payload";
    let metadata = b"metadata bytes here";
    let mut rng = rns_crypto::FixedRng::new(&[0x99; 64]);

    let mut sender = ResourceSender::new(
        data,
        Some(metadata),
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    assert!(sender.flags.has_metadata);

    let adv_data = sender.get_advertisement(0);
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    assert!(receiver.has_metadata);

    // Transfer
    let req_actions = receiver.accept(1001.0);
    let request_data = req_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    let send_actions = sender.handle_request(&request_data, 1002.0);
    receiver.req_sent = 1001.0;
    for action in &send_actions {
        if let ResourceAction::SendPart(part_data) = action {
            receiver.receive_part(part_data, 1003.0);
        }
    }

    // Assemble
    let assemble_actions = receiver.assemble(&identity_decrypt, &NoopCompressor);

    let (recv_data, recv_meta) = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::DataReceived { data, metadata } => {
                Some((data.clone(), metadata.clone()))
            }
            _ => None,
        })
        .unwrap();

    assert_eq!(recv_data, data);
    assert_eq!(recv_meta.unwrap(), metadata);

    // Proof validation
    let proof_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendProof(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();
    sender.handle_proof(&proof_data, 1004.0);
    assert_eq!(sender.status, ResourceStatus::Complete);
}

/// Sender cancel mid-transfer.
#[test]
fn test_cancel_from_sender() {
    let mut rng = rns_crypto::FixedRng::new(&[0xAA; 64]);
    let mut sender = ResourceSender::new(
        b"data",
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    sender.advertise(1000.0);

    let cancel_actions = sender.cancel();
    assert_eq!(sender.status, ResourceStatus::Failed);
    assert!(cancel_actions
        .iter()
        .any(|a| matches!(a, ResourceAction::SendCancelInitiator(_))));

    // Receiver gets the cancel
    let adv_data = {
        let mut rng2 = rns_crypto::FixedRng::new(&[0xAA; 64]);
        let s = ResourceSender::new(
            b"data",
            None,
            RESOURCE_SDU,
            &identity_encrypt,
            &NoopCompressor,
            &mut rng2,
            1000.0,
            false,
            false,
            None,
            1,
            1,
            None,
            0.5,
            6.0,
        )
        .unwrap();
        s.get_advertisement(0)
    };
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();
    receiver.accept(1001.0);

    let _cancel_result = receiver.handle_cancel();
    assert_eq!(receiver.status, ResourceStatus::Failed);
}

/// Receiver reject.
#[test]
fn test_reject_from_receiver() {
    let mut rng = rns_crypto::FixedRng::new(&[0xBB; 64]);
    let mut sender = ResourceSender::new(
        b"data",
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    let adv_data = sender.get_advertisement(0);
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    let reject_actions = receiver.reject();
    assert_eq!(receiver.status, ResourceStatus::Rejected);
    assert!(reject_actions
        .iter()
        .any(|a| matches!(a, ResourceAction::SendCancelReceiver(_))));

    // Sender handles the rejection
    let _reject_result = sender.handle_reject();
    assert_eq!(sender.status, ResourceStatus::Rejected);
}

/// Simulated packet loss — receiver doesn't get one part, requests retry.
#[test]
fn test_simulated_packet_loss() {
    // Use data where each SDU-chunk is unique (identity_encrypt doesn't transform data)
    let data: Vec<u8> = (0..1000u32).map(|i| (i ^ (i >> 8)) as u8).collect(); // ~3 parts
    let seed: Vec<u8> = (0..=255).collect();
    let mut rng = rns_crypto::FixedRng::new(&seed);

    let mut sender = ResourceSender::new(
        &data,
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    let adv_data = sender.get_advertisement(0);
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    // Accept
    let req_actions = receiver.accept(1001.0);
    let request_data = req_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    // Sender sends parts, but we "lose" the first one
    let send_actions = sender.handle_request(&request_data, 1002.0);
    let parts: Vec<_> = send_actions
        .iter()
        .filter_map(|a| match a {
            ResourceAction::SendPart(d) => Some(d.clone()),
            _ => None,
        })
        .collect();

    assert!(!parts.is_empty());

    // Only deliver parts after the first one (simulate loss)
    receiver.req_sent = 1001.0;
    for part_data in &parts[1..] {
        receiver.receive_part(part_data, 1003.0);
    }

    // Receiver still waiting for first part, outstanding_parts > 0
    assert!(receiver.received_count < receiver.total_parts);

    // Receiver re-requests (simulating timeout path)
    // The receiver should re-request the missing parts
    let retry_actions = receiver.request_next(1005.0);
    let retry_request = retry_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    // Sender handles retry request
    let retry_send = sender.handle_request(&retry_request, 1006.0);
    receiver.req_sent = 1005.0;
    for action in &retry_send {
        if let ResourceAction::SendPart(part_data) = action {
            receiver.receive_part(part_data, 1007.0);
        }
    }

    // Now all parts should be received
    assert_eq!(receiver.received_count, receiver.total_parts);

    // Assemble and verify
    let assemble_actions = receiver.assemble(&identity_decrypt, &NoopCompressor);
    let received_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::DataReceived { data, .. } => Some(data.clone()),
            _ => None,
        })
        .unwrap();
    assert_eq!(received_data, data);
}

/// Test with request_id (is_response flow).
#[test]
fn test_with_request_id() {
    let data = b"response data";
    let request_id = vec![0xDE, 0xAD, 0xBE, 0xEF];
    let mut rng = rns_crypto::FixedRng::new(&[0xEE; 64]);

    let sender = ResourceSender::new(
        data,
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        true, // is_response
        Some(request_id.clone()),
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    assert!(sender.flags.is_response);
    assert!(!sender.flags.is_request);
    assert_eq!(sender.request_id, Some(request_id));
}

/// Hashmap exhaustion and HMU cycle.
#[test]
fn test_hashmap_exhaustion_and_hmu() {
    // Create data large enough that hashmap gets segmented
    // Need > HASHMAP_MAX_LEN(74) parts = 74 * 464 = 34,336 bytes
    // Use data where each SDU-sized chunk is unique (identity_encrypt doesn't transform data,
    // so identical parts would always have identical map hashes).
    // Write the part index into each SDU boundary to guarantee uniqueness.
    let mut data = vec![0u8; 35000];
    for (i, byte) in data.iter_mut().enumerate() {
        // Mix in the byte position using multiple octets to avoid periodicity
        let pos = i as u32;
        *byte = (pos ^ (pos >> 8) ^ (pos >> 16)) as u8;
    }
    // Need a large unique seed for 76+ parts to avoid hash collisions
    let seed: Vec<u8> = (0u8..=255)
        .cycle()
        .take(1024)
        .enumerate()
        .map(|(i, b)| b.wrapping_add(i as u8))
        .collect();
    let mut rng = rns_crypto::FixedRng::new(&seed);

    let mut sender = ResourceSender::new(
        &data,
        None,
        RESOURCE_SDU,
        &identity_encrypt,
        &NoopCompressor,
        &mut rng,
        1000.0,
        false,
        false,
        None,
        1,
        1,
        None,
        0.5,
        6.0,
    )
    .unwrap();

    // Should have > 74 parts
    assert!(
        sender.total_parts() > RESOURCE_HASHMAP_MAX_LEN,
        "Expected > 74 parts, got {}",
        sender.total_parts()
    );

    let adv_data = sender.get_advertisement(0);
    let mut receiver =
        ResourceReceiver::from_advertisement(&adv_data, RESOURCE_SDU, 0.5, 1000.0, None, None)
            .unwrap();

    // Accept and start transfer loop
    let req_actions = receiver.accept(1001.0);
    let first_request = req_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendRequest(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();

    let mut iteration = 0;
    let mut hmu_count = 0;
    let mut pending_requests: Vec<Vec<u8>> = vec![first_request];

    loop {
        iteration += 1;
        if iteration > 200 {
            panic!(
                "Transfer loop exceeded max iterations at received={}/{}",
                receiver.received_count, receiver.total_parts
            );
        }

        if pending_requests.is_empty() {
            // No pending requests — request more
            let next_req = receiver.request_next(1004.0 + iteration as f64);
            for a in &next_req {
                if let ResourceAction::SendRequest(rd) = a {
                    pending_requests.push(rd.clone());
                }
            }
            if pending_requests.is_empty() {
                if receiver.waiting_for_hmu {
                    // Need to send a request with exhaustion flag to trigger HMU
                    receiver.waiting_for_hmu = false;
                    let req = receiver.request_next(1004.0 + iteration as f64);
                    for a in &req {
                        if let ResourceAction::SendRequest(rd) = a {
                            pending_requests.push(rd.clone());
                        }
                    }
                }
                if pending_requests.is_empty() {
                    panic!("No progress: no pending requests and not waiting for HMU at received={}/{}",
                        receiver.received_count, receiver.total_parts);
                }
            }
        }

        let request_data = pending_requests.remove(0);
        let send_actions = sender.handle_request(&request_data, 1002.0 + iteration as f64);

        // Check for HMU
        for action in &send_actions {
            if let ResourceAction::SendHmu(hmu_data) = action {
                hmu_count += 1;
                let hmu_actions =
                    receiver.handle_hashmap_update(hmu_data, 1003.0 + iteration as f64);
                for ha in &hmu_actions {
                    if let ResourceAction::SendRequest(rd) = ha {
                        pending_requests.push(rd.clone());
                    }
                }
            }
        }

        // Feed parts and collect any new requests generated by receive_part
        receiver.req_sent = 1001.0 + iteration as f64;
        for action in &send_actions {
            if let ResourceAction::SendPart(part_data) = action {
                let recv_actions = receiver.receive_part(part_data, 1003.0 + iteration as f64);
                for ra in &recv_actions {
                    if let ResourceAction::SendRequest(rd) = ra {
                        pending_requests.push(rd.clone());
                    }
                }
            }
        }

        if receiver.received_count == receiver.total_parts {
            break;
        }
    }

    assert!(hmu_count > 0, "Expected at least one HMU, got 0");
    assert_eq!(receiver.received_count, receiver.total_parts);

    // Assemble and verify
    let assemble_actions = receiver.assemble(&identity_decrypt, &NoopCompressor);
    let received_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::DataReceived { data, .. } => Some(data.clone()),
            _ => None,
        })
        .unwrap();
    assert_eq!(received_data, data);

    // Validate proof
    let proof_data = assemble_actions
        .iter()
        .find_map(|a| match a {
            ResourceAction::SendProof(d) => Some(d.clone()),
            _ => None,
        })
        .unwrap();
    sender.handle_proof(&proof_data, 2000.0);
    assert_eq!(sender.status, ResourceStatus::Complete);
}