sof 0.17.0

Solana Observer Framework for low-latency shred ingestion and plugin-driven transaction observation
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! SOF runtime example with transaction and dataset plugins.
#![doc(hidden)]

use async_trait::async_trait;
use sof::{
    event::TxKind,
    framework::{
        DatasetEvent, Plugin, PluginConfig, PluginContext, PluginHost, PluginSetupError,
        TransactionEvent,
    },
};
use thiserror::Error;

#[derive(Debug, Clone, Copy, Default)]
struct NonVoteTxLoggerPlugin;

#[async_trait]
impl Plugin for NonVoteTxLoggerPlugin {
    fn name(&self) -> &'static str {
        "non-vote-tx-logger"
    }

    fn config(&self) -> PluginConfig {
        PluginConfig::new().with_transaction()
    }

    async fn setup(&self, ctx: PluginContext) -> Result<(), PluginSetupError> {
        tracing::info!(plugin = ctx.plugin_name, "plugin startup completed");
        Ok(())
    }

    async fn on_transaction(&self, event: &TransactionEvent) {
        if event.kind == TxKind::VoteOnly {
            return;
        }

        let signature = event
            .signature
            .map(|signature| signature.to_string())
            .unwrap_or_else(|| "NO_SIGNATURE".to_owned());

        tracing::info!(
            slot = event.slot,
            signature = %signature,
            tx_kind = ?event.kind,
            "non-vote transaction observed"
        );
    }

    async fn shutdown(&self, ctx: PluginContext) {
        tracing::info!(plugin = ctx.plugin_name, "plugin shutdown completed");
    }
}

#[derive(Debug, Clone, Copy, Default)]
struct DatasetLoggerPlugin;

#[async_trait]
impl Plugin for DatasetLoggerPlugin {
    fn name(&self) -> &'static str {
        "dataset-logger"
    }

    fn config(&self) -> PluginConfig {
        PluginConfig::new().with_dataset()
    }

    async fn on_dataset(&self, event: DatasetEvent) {
        tracing::info!(
            slot = event.slot,
            start = event.start_index,
            end = event.end_index,
            tx_count = event.tx_count,
            payload_len = event.payload_len,
            "dataset reconstructed"
        );
    }
}

#[derive(Debug, Error)]
enum ObserverWithMultiplePluginsError {
    #[error("examples are release-only; run with `{command}`")]
    ReleaseModeRequired { command: &'static str },
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error(transparent)]
    Runtime(#[from] sof::runtime::RuntimeError),
}

const fn require_release_mode() -> Result<(), ObserverWithMultiplePluginsError> {
    if cfg!(debug_assertions) {
        return Err(ObserverWithMultiplePluginsError::ReleaseModeRequired {
            command: "cargo run --release -p sof --example observer_with_multiple_plugins",
        });
    }
    Ok(())
}

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), ObserverWithMultiplePluginsError> {
    require_release_mode()?;

    let host = PluginHost::builder()
        .add_plugin(NonVoteTxLoggerPlugin)
        .add_plugin(DatasetLoggerPlugin)
        .build();

    tracing::info!(plugins = ?host.plugin_names(), "starting SOF runtime with plugin host");
    Ok(sof::runtime::ObserverRuntime::new()
        .with_plugin_host(host)
        .run_until_termination_signal()
        .await?)
}