Expose db for oracle functions

README.md

@@ -87,10 +87,10 @@ void-toolkit = { version = "0.1", features = ["run", "oracle", "load-config"] }
 ### Basic Usage
 
 ```rust
-use void_oracle::{blocks_sse::State, db::Db};
 use void_toolkit::{
     load_config::load_config,
     oracle::oracle,
+    oracle::Db,
     oracle_types::config::Config,
     run::run_node,
     types::{Block, Lock},
@@ -99,6 +99,8 @@ use void_toolkit::{
 // Simple unit type that implements the required trait bound of `run_node` function
 pub struct StateUnit;
 
+pub struct State(pub u64);
+
 impl From<&mut State> for StateUnit {
     fn from(_: &mut State) -> Self {
         StateUnit
@@ -111,11 +113,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Start oracle to watch for cross-chain events
-    let blocks = oracle(config, 0);
+    let blocks = oracle(config, Db::memory(), 0);
 
     // Define your app's state and transition logic
-    let db = Db::memory();
-    let state = State::new(db.clone());
     let state_transition = |block: &Block, _state: &mut State| {
         // Process block and update state
         for _event in &block.events {
@@ -127,10 +127,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             );
         }
     };
-    let state = Lock::new(state);
+    let state = Lock::new(State(0));
 
     // Run your VOID node
-    run_node::<_, _, _, StateUnit>(blocks, state, state_transition).await;
+    run_node::<_, Lock<State>, _, StateUnit>(blocks, state, state_transition).await;
 
     Ok(())
 }
@@ -143,7 +143,7 @@ VOID provides different oracle modes for various deployment scenarios:
 ```rust
 use void_toolkit::{
     load_config::load_config,
-    oracle::{observer_oracle, oracle, publisher_oracle, relay_oracle},
+    oracle::{observer_oracle, oracle, publisher_oracle, relay_oracle, Db},
     oracle_types::config::{Config, OracleBlocksConfig},
 };
 
@@ -152,23 +152,27 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Basic oracle - watches events and produces blocks locally
-    let _blocks = oracle(config.clone(), 0);
+    let _blocks = oracle(config.clone(), Db::memory(), 0);
 
     // Publisher oracle - produces blocks and serves them over HTTP/SSE
     let _blocks = publisher_oracle(
         config.clone(),
+        Db::memory(),
         0,
         "127.0.0.1:8080".parse().unwrap(),
         100,
         None,
     );
 
     // Observer oracle - connects to existing producer, consumes blocks
-    let _blocks = observer_oracle(OracleBlocksConfig {
-        endpoint: "http://127.0.0.1:8080".to_string(),
-        height: 0,
-        public_key: None,
-    });
+    let _blocks = observer_oracle(
+        OracleBlocksConfig {
+            endpoint: "http://127.0.0.1:8080".to_string(),
+            height: 0,
+            public_key: None,
+        },
+        Db::memory(),
+    );
 
     // Relay oracle - connects to producer and also serves blocks to others
     let _blocks = relay_oracle(
@@ -177,6 +181,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             height: 0,
             public_key: None,
         },
+        Db::memory(),
         "127.0.0.1:8081".parse().unwrap(),
         100,
     );
@@ -277,7 +282,7 @@ Use the event decoder to handle events from different chains:
 use alloy::sol;
 use futures::StreamExt;
 use void_toolkit::{
-    load_config::load_config, oracle::oracle, oracle_decoder::decode_events,
+    load_config::load_config, oracle::oracle, oracle::Db, oracle_decoder::decode_events,
     oracle_types::config::Config,
 };
 
@@ -299,7 +304,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Start oracle to watch for cross-chain events
-    let blocks = oracle(config, 0);
+    let blocks = oracle(config, Db::memory(), 0);
 
     // Process decoded events in your state transition function
     blocks

crates/examples/Cargo.toml

@@ -23,5 +23,4 @@ path = "proof_generation.rs"
 alloy.workspace = true
 futures.workspace = true
 tokio.workspace = true
-void-oracle.workspace = true
 void-toolkit = { path = "../toolkit", features = ["oracle", "load-config", "oracle-decoder", "proof-host", "run"] }

crates/examples/basic_usage.rs

@@ -1,7 +1,7 @@
-use void_oracle::{blocks_sse::State, db::Db};
 use void_toolkit::{
     load_config::load_config,
     oracle::oracle,
+    oracle::Db,
     oracle_types::config::Config,
     run::run_node,
     types::{Block, Lock},
@@ -10,6 +10,8 @@ use void_toolkit::{
 // Simple unit type that implements the required trait bound of `run_node` function
 pub struct StateUnit;
 
+pub struct State(pub u64);
+
 impl From<&mut State> for StateUnit {
     fn from(_: &mut State) -> Self {
         StateUnit
@@ -22,11 +24,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Start oracle to watch for cross-chain events
-    let blocks = oracle(config, 0);
+    let blocks = oracle(config, Db::memory(), 0);
 
     // Define your app's state and transition logic
-    let db = Db::memory();
-    let state = State::new(db.clone());
     let state_transition = |block: &Block, _state: &mut State| {
         // Process block and update state
         for _event in &block.events {
@@ -38,10 +38,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             );
         }
     };
-    let state = Lock::new(state);
+    let state = Lock::new(State(0));
 
     // Run your VOID node
-    run_node::<_, _, _, StateUnit>(blocks, state, state_transition).await;
+    run_node::<_, Lock<State>, _, StateUnit>(blocks, state, state_transition).await;
 
     Ok(())
 }

crates/examples/event_processing.rs

@@ -1,7 +1,7 @@
 use alloy::sol;
 use futures::StreamExt;
 use void_toolkit::{
-    load_config::load_config, oracle::oracle, oracle_decoder::decode_events,
+    load_config::load_config, oracle::oracle, oracle::Db, oracle_decoder::decode_events,
     oracle_types::config::Config,
 };
 
@@ -23,7 +23,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Start oracle to watch for cross-chain events
-    let blocks = oracle(config, 0);
+    let blocks = oracle(config, Db::memory(), 0);
 
     // Process decoded events in your state transition function
     blocks

crates/examples/oracle_modes.rs

@@ -1,6 +1,6 @@
 use void_toolkit::{
     load_config::load_config,
-    oracle::{observer_oracle, oracle, publisher_oracle, relay_oracle},
+    oracle::{observer_oracle, oracle, publisher_oracle, relay_oracle, Db},
     oracle_types::config::{Config, OracleBlocksConfig},
 };
 
@@ -9,23 +9,27 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config: Config = load_config("config.yaml")?;
 
     // Basic oracle - watches events and produces blocks locally
-    let _blocks = oracle(config.clone(), 0);
+    let _blocks = oracle(config.clone(), Db::memory(), 0);
 
     // Publisher oracle - produces blocks and serves them over HTTP/SSE
     let _blocks = publisher_oracle(
         config.clone(),
+        Db::memory(),
         0,
         "127.0.0.1:8080".parse().unwrap(),
         100,
         None,
     );
 
     // Observer oracle - connects to existing producer, consumes blocks
-    let _blocks = observer_oracle(OracleBlocksConfig {
-        endpoint: "http://127.0.0.1:8080".to_string(),
-        height: 0,
-        public_key: None,
-    });
+    let _blocks = observer_oracle(
+        OracleBlocksConfig {
+            endpoint: "http://127.0.0.1:8080".to_string(),
+            height: 0,
+            public_key: None,
+        },
+        Db::memory(),
+    );
 
     // Relay oracle - connects to producer and also serves blocks to others
     let _blocks = relay_oracle(
@@ -34,6 +38,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             height: 0,
             public_key: None,
         },
+        Db::memory(),
         "127.0.0.1:8081".parse().unwrap(),
         100,
     );

crates/toolkit/Cargo.toml

@@ -36,6 +36,8 @@ app = ["dep:void-app"]
 
 load-config = ["dep:thiserror", "dep:serde", "dep:serde_json", "dep:serde_yaml_ng"]
 oracle = ["dep:futures", "dep:void-oracle", "dep:tokio", "dep:alloy"]
+oracle-rqlite = ["dep:futures", "dep:void-oracle", "dep:tokio", "dep:alloy", "void-oracle/rqlite"]
+oracle-sqlite = ["dep:futures", "dep:void-oracle", "dep:tokio", "dep:alloy", "void-oracle/sqlite"]
 oracle-decoder = ["dep:void-oracle-decoder"]
 run = ["dep:futures", "dep:void-app"]