Scaffold utility and library (#3)

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
Signed-off-by: xermicus <bigcyrill@hotmail.com>

crates/node-interaction/src/lib.rs

@@ -0,0 +1,21 @@
+//! This crate implements all node interactions.
+
+use alloy::rpc::types::trace::geth::GethTrace;
+use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
+use tokio_runtime::TO_TOKIO;
+
+mod tokio_runtime;
+pub mod trace;
+pub mod transaction;
+
+/// An interface for all interactions with Ethereum compatible nodes.
+pub trait EthereumNode {
+    /// Execute the [TransactionRequest] and return a [TransactionReceipt].
+    fn execute_transaction(
+        &self,
+        transaction: TransactionRequest,
+    ) -> anyhow::Result<TransactionReceipt>;
+
+    /// Trace the transaction in the [TransactionReceipt] and return a [GethTrace].
+    fn trace_transaction(&self, transaction: TransactionReceipt) -> anyhow::Result<GethTrace>;
+}

crates/node-interaction/src/tokio_runtime.rs

@@ -0,0 +1,79 @@
+//! The alloy crate __requires__ a tokio runtime.
+//! We contain any async rust right here.
+
+use once_cell::sync::Lazy;
+use std::pin::Pin;
+use std::sync::Mutex;
+use std::thread;
+use tokio::runtime::Runtime;
+use tokio::spawn;
+use tokio::sync::{mpsc, oneshot};
+use tokio::task::JoinError;
+
+use crate::trace::Trace;
+use crate::transaction::Transaction;
+
+pub(crate) static TO_TOKIO: Lazy<Mutex<TokioRuntime>> =
+    Lazy::new(|| Mutex::new(TokioRuntime::spawn()));
+
+/// Common interface for executing async node interactions from a non-async context.
+#[allow(clippy::type_complexity)]
+pub(crate) trait AsyncNodeInteraction: Send + 'static {
+    type Output: Send;
+
+    //// Returns the task and the output sender.
+    fn split(
+        self,
+    ) -> (
+        Pin<Box<dyn Future<Output = Self::Output> + Send>>,
+        oneshot::Sender<Self::Output>,
+    );
+}
+
+pub(crate) struct TokioRuntime {
+    pub(crate) transaction_sender: mpsc::Sender<Transaction>,
+    pub(crate) trace_sender: mpsc::Sender<Trace>,
+}
+
+impl TokioRuntime {
+    fn spawn() -> Self {
+        let rt = Runtime::new().expect("should be able to create the tokio runtime");
+        let (transaction_sender, transaction_receiver) = mpsc::channel::<Transaction>(1024);
+        let (trace_sender, trace_receiver) = mpsc::channel::<Trace>(1024);
+
+        thread::spawn(move || {
+            rt.block_on(async move {
+                let transaction_task = spawn(interaction::<Transaction>(transaction_receiver));
+                let trace_task = spawn(interaction::<Trace>(trace_receiver));
+
+                if let Err(error) = transaction_task.await {
+                    log::error!("tokio transaction task failed: {error}");
+                }
+                if let Err(error) = trace_task.await {
+                    log::error!("tokio trace transaction task failed: {error}");
+                }
+            });
+        });
+
+        Self {
+            transaction_sender,
+            trace_sender,
+        }
+    }
+}
+
+async fn interaction<T>(mut receiver: mpsc::Receiver<T>) -> Result<(), JoinError>
+where
+    T: AsyncNodeInteraction,
+{
+    while let Some(task) = receiver.recv().await {
+        spawn(async move {
+            let (task, sender) = task.split();
+            sender
+                .send(task.await)
+                .unwrap_or_else(|_| panic!("failed to send task output"));
+        });
+    }
+
+    Ok(())
+}

crates/node-interaction/src/trace.rs

@@ -0,0 +1,43 @@
+//! Trace transactions in a sync context.
+
+use std::pin::Pin;
+
+use alloy::rpc::types::trace::geth::GethTrace;
+use tokio::sync::oneshot;
+
+use crate::TO_TOKIO;
+use crate::tokio_runtime::AsyncNodeInteraction;
+
+pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<GethTrace>> + Send>>;
+
+pub(crate) struct Trace {
+    sender: oneshot::Sender<anyhow::Result<GethTrace>>,
+    task: Task,
+}
+
+impl AsyncNodeInteraction for Trace {
+    type Output = anyhow::Result<GethTrace>;
+
+    fn split(
+        self,
+    ) -> (
+        std::pin::Pin<Box<dyn Future<Output = Self::Output> + Send>>,
+        oneshot::Sender<Self::Output>,
+    ) {
+        (self.task, self.sender)
+    }
+}
+
+/// Execute some [Task] that return a [GethTrace] result.
+pub fn trace_transaction(task: Task) -> anyhow::Result<GethTrace> {
+    let task_sender = TO_TOKIO.lock().unwrap().trace_sender.clone();
+    let (sender, receiver) = oneshot::channel();
+
+    task_sender
+        .blocking_send(Trace { task, sender })
+        .expect("we are not calling this from an async context");
+
+    receiver
+        .blocking_recv()
+        .unwrap_or_else(|error| anyhow::bail!("no trace received: {error}"))
+}

crates/node-interaction/src/transaction.rs

@@ -0,0 +1,46 @@
+//! Execute transactions in a sync context.
+
+use std::pin::Pin;
+
+use alloy::rpc::types::TransactionReceipt;
+use tokio::sync::oneshot;
+
+use crate::TO_TOKIO;
+use crate::tokio_runtime::AsyncNodeInteraction;
+
+pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<TransactionReceipt>> + Send>>;
+
+pub(crate) struct Transaction {
+    receipt_sender: oneshot::Sender<anyhow::Result<TransactionReceipt>>,
+    task: Task,
+}
+
+impl AsyncNodeInteraction for Transaction {
+    type Output = anyhow::Result<TransactionReceipt>;
+
+    fn split(
+        self,
+    ) -> (
+        Pin<Box<dyn Future<Output = Self::Output> + Send>>,
+        oneshot::Sender<Self::Output>,
+    ) {
+        (self.task, self.receipt_sender)
+    }
+}
+
+/// Execute some [Task] that returns a [TransactionReceipt].
+pub fn execute_transaction(task: Task) -> anyhow::Result<TransactionReceipt> {
+    let request_sender = TO_TOKIO.lock().unwrap().transaction_sender.clone();
+    let (receipt_sender, receipt_receiver) = oneshot::channel();
+
+    request_sender
+        .blocking_send(Transaction {
+            receipt_sender,
+            task,
+        })
+        .expect("we are not calling this from an async context");
+
+    receipt_receiver
+        .blocking_recv()
+        .unwrap_or_else(|error| anyhow::bail!("no receipt received: {error}"))
+}