hashtree_network/
lib.rs

1//! Mesh transport primitives for HashTree.
2//!
3//! This crate provides the reusable router, signaling, peer-link, and store
4//! layers for hashtree mesh networking. The default production composition uses
5//! Nostr websockets for signaling and WebRTC for direct links, but the same
6//! abstractions support LAN buses, Bluetooth transports, and simulation.
7//!
8//! # Overview
9//!
10//! - **Storage Backend**: Any [`hashtree_core::Store`] implementation
11//! - **Peer Discovery**: Any [`SignalingTransport`] implementation
12//! - **Data Exchange**: Any [`PeerLink`] / [`PeerLinkFactory`] implementation
13//! - **Protocol**: Request/response with hash-based addressing
14//! - **Adaptive Selection**: Intelligent peer selection based on performance
15//!
16//! # Example
17//!
18//! ```rust,no_run
19//! use hashtree_core::MemoryStore;
20//! use hashtree_network::{MeshStore, MeshStoreConfig};
21//! use nostr_sdk::prelude::*;
22//! use std::sync::Arc;
23//!
24//! #[tokio::main]
25//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
26//!     let local_store = Arc::new(MemoryStore::new());
27//!     let config = MeshStoreConfig::default();
28//!
29//!     let mut store = MeshStore::new(local_store, config);
30//!
31//!     // Generate or load Nostr keys
32//!     let keys = Keys::generate();
33//!
34//!     // Start P2P network
35//!     store.start(keys).await?;
36//!
37//!     // Now store.get() will try local first, then fetch from peers
38//!
39//!     Ok(())
40//! }
41//! ```
42
43pub mod channel;
44pub mod mesh_store_core;
45pub mod mock;
46pub mod nostr;
47pub mod peer_selector;
48pub mod protocol;
49pub mod real_factory;
50pub mod signaling;
51pub mod store;
52pub mod transport;
53pub mod types;
54
55pub use channel::{ChannelError, LatencyChannel, MockChannel, PeerChannel};
56pub use mesh_store_core::{
57    build_hedged_wave_plan, normalize_dispatch_config, run_hedged_waves, sync_selector_peers,
58    DataPumpStats, HedgedWaveAction, MeshRoutingConfig, MeshStoreCore, ProductionMeshStore,
59    RequestDispatchConfig, ResponseBehaviorConfig, SimMeshStore,
60};
61pub use mock::{
62    clear_channel_registry, MockConnectionFactory, MockDataChannel, MockLatencyMode, MockRelay,
63    MockRelayTransport,
64};
65pub use nostr::{decode_signaling_event, encode_signaling_event, NostrRelayTransport};
66pub use peer_selector::{
67    peer_principal, PeerMetadataSnapshot, PeerSelector, PeerStats, PersistedPeerMetadata,
68    SelectionStrategy, SelectorSummary, PEER_METADATA_SNAPSHOT_VERSION,
69};
70pub use protocol::{
71    bytes_to_hash, create_fragment_response, create_quote_request, create_quote_response_available,
72    create_quote_response_unavailable, create_request, create_request_with_quote, create_response,
73    encode_quote_request, encode_quote_response, encode_request, encode_response, hash_to_bytes,
74    hash_to_key, is_fragmented, parse_message, DataMessage, DataQuoteRequest, DataQuoteResponse,
75    DataRequest, DataResponse, FRAGMENT_SIZE, MSG_TYPE_QUOTE_REQUEST, MSG_TYPE_QUOTE_RESPONSE,
76    MSG_TYPE_REQUEST, MSG_TYPE_RESPONSE,
77};
78pub use real_factory::WebRtcPeerLinkFactory;
79pub use signaling::{MeshRouter, PeerEntry};
80pub use store::{MeshStore, MeshStoreError};
81pub use transport::{PeerLink, PeerLinkFactory, SignalingTransport, TransportError};
82pub use types::{
83    classifier_channel, decrement_htl_with_policy, is_polite_peer, should_forward,
84    should_forward_htl, validate_mesh_frame, ClassifierRx, ClassifierTx, ClassifyRequest, HtlMode,
85    HtlPolicy, IceCandidate, MeshNostrFrame, MeshNostrPayload, MeshStats, MeshStoreConfig,
86    PeerHTLConfig, PeerId, PeerPool, PeerState, PoolConfig, PoolSettings, SignalingMessage,
87    TimedSeenSet, WebRTCStats, BLOB_REQUEST_POLICY, DATA_CHANNEL_LABEL, DECREMENT_AT_MAX_PROB,
88    DECREMENT_AT_MIN_PROB, MAX_HTL, MESH_DEFAULT_HTL, MESH_EVENT_POLICY, MESH_MAX_HTL,
89    MESH_PROTOCOL, MESH_PROTOCOL_VERSION, MESH_SIGNALING_EVENT_KIND, NOSTR_KIND_HASHTREE,
90};
hashtree_network/lib.rs

hashtree_network/
lib.rs
