pub trait Network<D>: Send {
fn send(&self, data: D, recipient: Recipient);
fn next_event<'life0, 'async_trait>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Option<D>> + Send + 'async_trait, Global>>
where
'life0: 'async_trait,
Self: 'async_trait;
}Expand description
Network represents an interface for sending and receiving NetworkData.
Note on Rate Control: it is assumed that Network implements a rate control mechanism guaranteeing that no node is allowed to spam messages without limits. We do not specify details yet, but in future releases we plan to publish recommended upper bounds for the amounts of bandwidth and number of messages allowed per node per a unit of time. These bounds must be carefully crafted based upon the number of nodes N and the configured delays between subsequent Dag rounds, so that at the same time spammers are cut off but honest nodes are able function correctly within these bounds.
Note on Network Reliability: it is not assumed that each message that AlephBFT orders to send reaches its intended recipient, there are some built-in reliability mechanisms within AlephBFT that will automatically detect certain failures and resend messages as needed. Clearly, the less reliable the network is, the worse the performarmence of AlephBFT will be (generally slower to produce output). Also, not surprisingly if the percentage of dropped messages is too high AlephBFT might stop making progress, but from what we observe in tests, this happens only when the reliability is extremely bad, i.e., drops below 50% (which means there is some significant issue with the network).
We refer to the documentation https://cardinal-cryptography.github.io/AlephBFT/aleph_bft_api.html Section 3.1.2 for a discussion of the required guarantees of this trait’s implementation.
Required Methods
Send a message to a single node or everyone, depending on the value of the recipient argument.
Note on the implementation: this function should be implemented in a non-blocking manner. Otherwise, the performance might be affected negatively or the execution may end up in a deadlock.