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
//! Runtime OFf-chain Logic (ROFL).
use std::sync::Arc;
use anyhow::{bail, Result};
use async_trait::async_trait;
use crate::{
consensus::roothash,
dispatcher::{Initializer, PostInitState, PreInitState},
host::Host,
};
/// A ROFL application.
#[allow(unused_variables)]
#[async_trait]
pub trait App: Send + Sync {
/// Whether dispatch is supported.
fn is_supported(&self) -> bool {
true
}
/// Called on application initialization.
fn on_init(&mut self, host: Arc<dyn Host>) -> Result<()> {
// Default implementation does nothing.
Ok(())
}
/// Called on new runtime block being received.
async fn on_runtime_block(&self, blk: &roothash::AnnotatedBlock) -> Result<()> {
// Default implementation does nothing.
Ok(())
}
/// Called on new runtime event being detected.
async fn on_runtime_event(
&self,
blk: &roothash::AnnotatedBlock,
tags: &[Vec<u8>],
) -> Result<()> {
// Default implementation does nothing.
Ok(())
}
/// Called for runtime queries.
async fn query(&self, method: &str, args: Vec<u8>) -> Result<Vec<u8>> {
// Default implementation rejects all requests.
bail!("method not supported");
}
}
/// An application which doesn't do anything.
pub struct NoopApp;
#[async_trait]
impl App for NoopApp {
fn is_supported(&self) -> bool {
false
}
}
/// Create a new ROFL runtime for an application.
pub fn new(app: Box<dyn App>) -> Box<dyn Initializer> {
Box::new(|_state: PreInitState<'_>| -> PostInitState {
PostInitState {
app: Some(app),
..Default::default()
}
})
}