Struct hotshot::traits::implementations::Libp2pNetwork

pub struct Libp2pNetwork<T: NodeType> {
    inner: Arc<Libp2pNetworkInner<T>>,
}

Networking implementation that uses libp2p generic over M which is the message type

Fields

inner: Arc<Libp2pNetworkInner<T>>

holds the state of the libp2p network

Implementations

impl<T: NodeType> Libp2pNetwork<T>

pub async fn from_config( config: NetworkConfig<T::SignatureKey>, membership: Arc<RwLock<T::Membership>>, gossip_config: GossipConfig, request_response_config: RequestResponseConfig, bind_address: Multiaddr, pub_key: &T::SignatureKey, priv_key: &<T::SignatureKey as SignatureKey>::PrivateKey, metrics: Libp2pMetricsValue, ) -> Result<Self>

Create and return a Libp2p network from a network config file and various other configuration-specific values.

Errors

If we are unable to parse a Multiaddress

Panics

If we are unable to calculate the replication factor

pub fn is_ready(&self) -> bool

Returns whether or not the network is currently ready.

pub async fn wait_for_ready(&self)

Returns only when the network is ready.

pub async fn new( metrics: Libp2pMetricsValue, config: NetworkNodeConfig<T>, pk: T::SignatureKey, lookup_record_value: RecordValue<T::SignatureKey>, bootstrap_addrs: Arc<RwLock<Vec<(PeerId, Multiaddr)>>>, id: usize, reliability_config: Option<Box<dyn NetworkReliability>>, ) -> Result<Libp2pNetwork<T>, NetworkError>

Constructs new network for a node. Note that this network is unconnected. One must call connect in order to connect.

• config: the configuration of the node
• pk: public key associated with the node
• bootstrap_addrs: rwlock containing the bootstrap addrs

Errors

Returns error in the event that the underlying libp2p network is unable to create a network.

Panics

This will panic if there are less than 5 bootstrap nodes

fn spawn_node_lookup( &self, node_lookup_recv: Receiver<Option<(ViewNumber, T::SignatureKey)>>, )

Spawns task for looking up nodes pre-emptively

fn spawn_connect( &mut self, id: usize, lookup_record_value: RecordValue<T::SignatureKey>, )

Initiates connection to the outside world

fn handle_recvd_events( &self, msg: NetworkEvent, sender: &Sender<Vec<u8>>, ) -> Result<(), NetworkError>

Handle events

fn handle_event_generator( &self, sender: Sender<Vec<u8>>, network_rx: NetworkNodeReceiver, )

task to propagate messages to handlers terminates on shut down of network

Trait Implementations

impl<T: Clone + NodeType> Clone for Libp2pNetwork<T>

fn clone(&self) -> Libp2pNetwork<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: NodeType> ConnectedNetwork<<T as NodeType>::SignatureKey> for Libp2pNetwork<T>

fn recv_message<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receive one or many messages from the underlying network.

Errors

If there is a network-related failure.

fn update_view<'a, 'async_trait, TYPES>( &'a self, view: u64, epoch: u64, membership: Arc<RwLock<TYPES::Membership>>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where TYPES: NodeType<SignatureKey = T::SignatureKey> + 'a + 'async_trait, Self: 'async_trait, 'a: 'async_trait,

The libp2p view update is a special operation intrinsic to its internal behavior.

Libp2p needs to do a lookup because a libp2p address is not related to hotshot keys. So in libp2p we store a mapping of HotShot key to libp2p address in a distributed hash table.

This means to directly message someone on libp2p we need to lookup in the hash table what their libp2p address is, using their HotShot public key as the key.

So the logic with libp2p is to prefetch upcoming leaders libp2p address to save time when we later need to direct message the leader our vote. Hence the use of the future view and leader to queue the lookups.

fn wait_for_ready<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Blocks until the network is successfully initialized

fn pause(&self)

Pauses the underlying network

fn resume(&self)

Resumes the underlying network

fn shut_down<'a, 'b>(&'a self) -> BoxSyncFuture<'b, ()>

where Self: 'b, 'a: 'b,

Blocks until the network is shut down

fn broadcast_message<'life0, 'async_trait>( &'life0 self, message: Vec<u8>, topic: Topic, _broadcast_delay: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

broadcast message to some subset of nodes blocking

fn da_broadcast_message<'life0, 'async_trait>( &'life0 self, message: Vec<u8>, recipients: Vec<T::SignatureKey>, _broadcast_delay: BroadcastDelay, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

broadcast a message only to a DA committee blocking

fn direct_message<'life0, 'async_trait>( &'life0 self, message: Vec<u8>, recipient: T::SignatureKey, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a direct message to a specific node blocking

fn queue_node_lookup( &self, view_number: ViewNumber, pk: T::SignatureKey, ) -> Result<(), TrySendError<Option<(ViewNumber, T::SignatureKey)>>>

queues lookup of a node

fn vid_broadcast_message<'life0, 'async_trait>( &'life0 self, messages: HashMap<K, Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

send messages with vid shares to its recipients blocking

fn is_primary_down(&self) -> bool

Is primary network down? Makes sense only for combined network

impl<T: NodeType> Debug for Libp2pNetwork<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: NodeType> TestableNetworkingImplementation<T> for Libp2pNetwork<T>

fn generator( expected_node_count: usize, num_bootstrap: usize, _network_id: usize, da_committee_size: usize, reliability_config: Option<Box<dyn NetworkReliability>>, _secondary_network_delay: Duration, ) -> AsyncGenerator<Arc<Self>>

Returns a boxed function f(node_id, public_key) -> Libp2pNetwork with the purpose of generating libp2p networks. Generates num_bootstrap bootstrap nodes. The remainder of nodes are normal nodes with sane defaults.

Panics

Returned function may panic either:

• An invalid configuration (probably an issue with the defaults of this function)
• An inability to spin up the replica’s network

fn in_flight_message_count(&self) -> Option<usize>

Get the number of messages in-flight.