kona-node-service 0.1.3

An implementation of the OP Stack consensus node service
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

//! [NodeActor] trait.

use async_trait::async_trait;
use tokio_util::sync::WaitForCancellationFuture;

/// The communication context used by the actor.
pub trait CancellableContext: Send {
    /// Returns a future that resolves when the actor is cancelled.
    fn cancelled(&self) -> WaitForCancellationFuture<'_>;
}

/// The [NodeActor] is an actor-like service for the node.
///
/// Actors may:
/// - Handle incoming messages.
///     - Perform background tasks.
/// - Emit new events for other actors to process.
#[async_trait]
pub trait NodeActor: Send + 'static {
    /// The error type for the actor.
    type Error: std::fmt::Debug;
    /// The communication context used by the actor.
    /// These are the channels that the actor will use to send messages to other actors.
    type OutboundData: CancellableContext;
    /// The inbound communication channels used by the actor.
    /// These are the channels that the actor will use to receive messages from other actors.
    type InboundData: Sized;
    /// The configuration needed to build the actor.
    type Builder;

    /// Builds the actor.
    fn build(builder: Self::Builder) -> (Self::InboundData, Self);

    /// Starts the actor.
    async fn start(self, inbound_context: Self::OutboundData) -> Result<(), Self::Error>;
}