rings-core 0.20.0

Chord DHT implementation with ICE
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

#![deny(missing_docs)]
//! Implementation of Ring's DHT
//! which is based on CHORD, ref: <https://pdos.csail.mit.edu/papers/ton:chord/paper-ton.pdf>
//! With high probability, the number of nodes that must be contacted to find a successor in an N-node network is O(log N).

mod chord;
pub mod did;
/// Storage entry model used by Chord-backed DHT storage.
pub mod entry;
/// Finger table for Rings
pub mod finger;
mod stabilization;
mod storage;
pub mod successor;
/// Pure Chord topology transition model.
pub mod topology;
pub mod types;
/// Chord-style virtual positions for storage ownership.
pub mod virtual_node;

pub use chord::EntryStorage;
pub use chord::PeerRing;
pub use chord::PeerRingAction;
pub use chord::RemoteAction as PeerRingRemoteAction;
pub use chord::TopoInfo;
pub use did::Did;
pub use finger::FingerTable;
pub use finger::DEFAULT_FINGER_TABLE_SIZE;
#[cfg(all(test, target_family = "wasm"))]
pub(crate) use stabilization::maintenance_phase_trace_for_test;
#[cfg(all(test, target_family = "wasm"))]
pub(crate) use stabilization::reset_maintenance_phase_trace_for_test;
#[cfg(all(test, target_family = "wasm"))]
pub(crate) use stabilization::MaintenancePhaseEvent;
#[cfg(all(test, target_family = "wasm"))]
pub(crate) use stabilization::MaintenancePhaseKind;
pub use stabilization::Stabilizer;
pub use stabilization::StorageRepairOutcome;
pub(crate) use storage::StorageSyncDelivery;
pub(crate) use storage::StorageSyncDeliveryCursor;
pub use storage::StorageSyncDestination;
pub use storage::StorageSyncPurpose;
pub use storage::StorageSyncRoute;
pub use successor::SuccessorReader;
pub use types::Chord;
pub use types::ChordStorage;
pub use types::ChordStorageCache;
pub use types::ChordStorageRepair;
pub use types::ChordStorageSync;
pub use types::CorrectChord;
pub use types::LiveDid;
pub use virtual_node::default_storage_virtual_positions_per_owner;
pub use virtual_node::StorageVirtualNodes;
pub use virtual_node::VirtualNode;
pub use virtual_node::VirtualNodeConfig;
pub use virtual_node::DEFAULT_STORAGE_VIRTUAL_POSITIONS_PER_OWNER;
pub use virtual_node::MAX_STORAGE_VIRTUAL_POSITIONS_PER_OWNER;

#[cfg(test)]
pub mod tests {
    //! test
    use super::*;
    use crate::ecc::tests::gen_ordered_keys;

    /// Test get ordered did list
    pub fn gen_ordered_dids(n: usize) -> Vec<Did> {
        gen_ordered_keys(n)
            .iter()
            .map(|x| x.address().into())
            .collect()
    }
}