mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-29 01:58:00 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ec4ec43a5c | |||
| cec67056ae |
Generated
-1
@@ -4012,7 +4012,6 @@ version = "0.1.0"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"alloy",
|
"alloy",
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"futures",
|
|
||||||
"once_cell",
|
"once_cell",
|
||||||
"tokio",
|
"tokio",
|
||||||
"tracing",
|
"tracing",
|
||||||
|
|||||||
@@ -25,7 +25,6 @@ alloy-primitives = "1.2.1"
|
|||||||
alloy-sol-types = "1.2.1"
|
alloy-sol-types = "1.2.1"
|
||||||
anyhow = "1.0"
|
anyhow = "1.0"
|
||||||
clap = { version = "4", features = ["derive"] }
|
clap = { version = "4", features = ["derive"] }
|
||||||
futures = { version = "0.3.31" }
|
|
||||||
hex = "0.4.3"
|
hex = "0.4.3"
|
||||||
reqwest = { version = "0.12.15", features = ["blocking", "json"] }
|
reqwest = { version = "0.12.15", features = ["blocking", "json"] }
|
||||||
once_cell = "1.21"
|
once_cell = "1.21"
|
||||||
|
|||||||
@@ -44,8 +44,6 @@ pub trait SolidityCompiler {
|
|||||||
pub struct CompilerInput<T: PartialEq + Eq + Hash> {
|
pub struct CompilerInput<T: PartialEq + Eq + Hash> {
|
||||||
pub extra_options: T,
|
pub extra_options: T,
|
||||||
pub input: SolcStandardJsonInput,
|
pub input: SolcStandardJsonInput,
|
||||||
pub allow_paths: Vec<PathBuf>,
|
|
||||||
pub base_path: Option<PathBuf>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The generic compilation output configuration.
|
/// The generic compilation output configuration.
|
||||||
@@ -85,8 +83,8 @@ where
|
|||||||
pub struct Compiler<T: SolidityCompiler> {
|
pub struct Compiler<T: SolidityCompiler> {
|
||||||
input: SolcStandardJsonInput,
|
input: SolcStandardJsonInput,
|
||||||
extra_options: T::Options,
|
extra_options: T::Options,
|
||||||
allow_paths: Vec<PathBuf>,
|
allow_paths: Vec<String>,
|
||||||
base_path: Option<PathBuf>,
|
base_path: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for Compiler<solc::Solc> {
|
impl Default for Compiler<solc::Solc> {
|
||||||
@@ -147,12 +145,12 @@ where
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn allow_path(mut self, path: PathBuf) -> Self {
|
pub fn allow_path(mut self, path: String) -> Self {
|
||||||
self.allow_paths.push(path);
|
self.allow_paths.push(path);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn base_path(mut self, base_path: PathBuf) -> Self {
|
pub fn base_path(mut self, base_path: String) -> Self {
|
||||||
self.base_path = Some(base_path);
|
self.base_path = Some(base_path);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
@@ -161,8 +159,6 @@ where
|
|||||||
T::new(solc_path).build(CompilerInput {
|
T::new(solc_path).build(CompilerInput {
|
||||||
extra_options: self.extra_options,
|
extra_options: self.extra_options,
|
||||||
input: self.input,
|
input: self.input,
|
||||||
allow_paths: self.allow_paths,
|
|
||||||
base_path: self.base_path,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -23,27 +23,13 @@ impl SolidityCompiler for Resolc {
|
|||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
input: CompilerInput<Self::Options>,
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
let mut command = Command::new(&self.resolc_path);
|
let mut child = Command::new(&self.resolc_path)
|
||||||
command
|
.arg("--standard-json")
|
||||||
|
.args(&input.extra_options)
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.arg("--standard-json");
|
.spawn()?;
|
||||||
|
|
||||||
if let Some(ref base_path) = input.base_path {
|
|
||||||
command.arg("--base-path").arg(base_path);
|
|
||||||
}
|
|
||||||
if !input.allow_paths.is_empty() {
|
|
||||||
command.arg("--allow-paths").arg(
|
|
||||||
input
|
|
||||||
.allow_paths
|
|
||||||
.iter()
|
|
||||||
.map(|path| path.display().to_string())
|
|
||||||
.collect::<Vec<_>>()
|
|
||||||
.join(","),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
let mut child = command.spawn()?;
|
|
||||||
|
|
||||||
let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
|
let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
|
||||||
serde_json::to_writer(stdin_pipe, &input.input)?;
|
serde_json::to_writer(stdin_pipe, &input.input)?;
|
||||||
@@ -69,22 +55,13 @@ impl SolidityCompiler for Resolc {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let parsed = serde_json::from_slice::<SolcStandardJsonOutput>(&stdout).map_err(|e| {
|
let parsed: SolcStandardJsonOutput = serde_json::from_slice(&stdout).map_err(|e| {
|
||||||
anyhow::anyhow!(
|
anyhow::anyhow!(
|
||||||
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
String::from_utf8_lossy(&stderr)
|
String::from_utf8_lossy(&stderr)
|
||||||
)
|
)
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
// Detecting if the compiler output contained errors and reporting them through logs and
|
|
||||||
// errors instead of returning the compiler output that might contain errors.
|
|
||||||
for error in parsed.errors.iter().flatten() {
|
|
||||||
if error.severity == "error" {
|
|
||||||
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
|
||||||
anyhow::bail!("Encountered an error in the compilation: {error}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
Ok(CompilerOutput {
|
||||||
input,
|
input,
|
||||||
output: parsed,
|
output: parsed,
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ use std::{
|
|||||||
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_solc_binaries::download_solc;
|
use revive_dt_solc_binaries::download_solc;
|
||||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
|
||||||
|
|
||||||
pub struct Solc {
|
pub struct Solc {
|
||||||
solc_path: PathBuf,
|
solc_path: PathBuf,
|
||||||
@@ -22,27 +21,12 @@ impl SolidityCompiler for Solc {
|
|||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
input: CompilerInput<Self::Options>,
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
let mut command = Command::new(&self.solc_path);
|
let mut child = Command::new(&self.solc_path)
|
||||||
command
|
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.arg("--standard-json");
|
.arg("--standard-json")
|
||||||
|
.spawn()?;
|
||||||
if let Some(ref base_path) = input.base_path {
|
|
||||||
command.arg("--base-path").arg(base_path);
|
|
||||||
}
|
|
||||||
if !input.allow_paths.is_empty() {
|
|
||||||
command.arg("--allow-paths").arg(
|
|
||||||
input
|
|
||||||
.allow_paths
|
|
||||||
.iter()
|
|
||||||
.map(|path| path.display().to_string())
|
|
||||||
.collect::<Vec<_>>()
|
|
||||||
.join(","),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
let mut child = command.spawn()?;
|
|
||||||
|
|
||||||
let stdin = child.stdin.as_mut().expect("should be piped");
|
let stdin = child.stdin.as_mut().expect("should be piped");
|
||||||
serde_json::to_writer(stdin, &input.input)?;
|
serde_json::to_writer(stdin, &input.input)?;
|
||||||
@@ -58,26 +42,9 @@ impl SolidityCompiler for Solc {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let parsed =
|
|
||||||
serde_json::from_slice::<SolcStandardJsonOutput>(&output.stdout).map_err(|e| {
|
|
||||||
anyhow::anyhow!(
|
|
||||||
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
|
||||||
String::from_utf8_lossy(&output.stdout)
|
|
||||||
)
|
|
||||||
})?;
|
|
||||||
|
|
||||||
// Detecting if the compiler output contained errors and reporting them through logs and
|
|
||||||
// errors instead of returning the compiler output that might contain errors.
|
|
||||||
for error in parsed.errors.iter().flatten() {
|
|
||||||
if error.severity == "error" {
|
|
||||||
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
|
||||||
anyhow::bail!("Encountered an error in the compilation: {error}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
Ok(CompilerOutput {
|
||||||
input,
|
input,
|
||||||
output: parsed,
|
output: serde_json::from_slice(&output.stdout)?,
|
||||||
error: None,
|
error: None,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+39
-112
@@ -1,11 +1,11 @@
|
|||||||
//! The test driver handles the compilation and execution of the test cases.
|
//! The test driver handles the compilation and execution of the test cases.
|
||||||
|
|
||||||
use alloy::json_abi::JsonAbi;
|
use alloy::json_abi::JsonAbi;
|
||||||
use alloy::network::TransactionBuilder;
|
use alloy::primitives::Bytes;
|
||||||
use alloy::rpc::types::TransactionReceipt;
|
|
||||||
use alloy::rpc::types::trace::geth::GethTrace;
|
use alloy::rpc::types::trace::geth::GethTrace;
|
||||||
|
use alloy::rpc::types::{TransactionInput, TransactionReceipt};
|
||||||
use alloy::{
|
use alloy::{
|
||||||
primitives::{Address, map::HashMap},
|
primitives::{Address, TxKind, map::HashMap},
|
||||||
rpc::types::{
|
rpc::types::{
|
||||||
TransactionRequest,
|
TransactionRequest,
|
||||||
trace::geth::{AccountState, DiffMode},
|
trace::geth::{AccountState, DiffMode},
|
||||||
@@ -69,13 +69,14 @@ where
|
|||||||
anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
|
anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
|
||||||
};
|
};
|
||||||
|
|
||||||
let compiler = Compiler::<T::Compiler>::new()
|
let mut compiler = Compiler::<T::Compiler>::new()
|
||||||
.allow_path(metadata.directory()?)
|
.base_path(metadata.directory()?.display().to_string())
|
||||||
.solc_optimizer(mode.solc_optimize());
|
.solc_optimizer(mode.solc_optimize());
|
||||||
|
|
||||||
let compiler = FilesWithExtensionIterator::new(metadata.directory()?)
|
for (file, _contract) in metadata.contract_sources()?.values() {
|
||||||
.with_allowed_extension("sol")
|
tracing::debug!("contract source {}", file.display());
|
||||||
.try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
|
compiler = compiler.with_source(file)?;
|
||||||
|
}
|
||||||
|
|
||||||
let mut task = CompilationTask {
|
let mut task = CompilationTask {
|
||||||
json_input: compiler.input(),
|
json_input: compiler.input(),
|
||||||
@@ -134,17 +135,21 @@ where
|
|||||||
std::any::type_name::<T>()
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
|
|
||||||
let tx =
|
let tx = match input.legacy_transaction(
|
||||||
match input.legacy_transaction(nonce, &self.deployed_contracts, &self.deployed_abis) {
|
self.config.network_id,
|
||||||
Ok(tx) => {
|
nonce,
|
||||||
tracing::debug!("Legacy transaction data: {tx:#?}");
|
&self.deployed_contracts,
|
||||||
tx
|
&self.deployed_abis,
|
||||||
}
|
) {
|
||||||
Err(err) => {
|
Ok(tx) => {
|
||||||
tracing::error!("Failed to construct legacy transaction: {err:?}");
|
tracing::debug!("Legacy transaction data: {tx:#?}");
|
||||||
return Err(err);
|
tx
|
||||||
}
|
}
|
||||||
};
|
Err(err) => {
|
||||||
|
tracing::error!("Failed to construct legacy transaction: {err:?}");
|
||||||
|
return Err(err);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
tracing::trace!("Executing transaction for input: {input:?}");
|
tracing::trace!("Executing transaction for input: {input:?}");
|
||||||
|
|
||||||
@@ -179,15 +184,12 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn deploy_contracts(&mut self, input: &Input, node: &T::Blockchain) -> anyhow::Result<()> {
|
pub fn deploy_contracts(&mut self, input: &Input, node: &T::Blockchain) -> anyhow::Result<()> {
|
||||||
let tracing_span = tracing::debug_span!(
|
tracing::debug!(
|
||||||
"Deploying contracts",
|
"Deploying contracts {}, having address {} on node: {}",
|
||||||
?input,
|
&input.instance,
|
||||||
node = std::any::type_name::<T>()
|
&input.caller,
|
||||||
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
let _guard = tracing_span.enter();
|
|
||||||
|
|
||||||
tracing::debug!(number_of_contracts_to_deploy = self.contracts.len());
|
|
||||||
|
|
||||||
for output in self.contracts.values() {
|
for output in self.contracts.values() {
|
||||||
let Some(contract_map) = &output.contracts else {
|
let Some(contract_map) = &output.contracts else {
|
||||||
tracing::debug!(
|
tracing::debug!(
|
||||||
@@ -199,9 +201,6 @@ where
|
|||||||
|
|
||||||
for contracts in contract_map.values() {
|
for contracts in contract_map.values() {
|
||||||
for (contract_name, contract) in contracts {
|
for (contract_name, contract) in contracts {
|
||||||
let tracing_span = tracing::info_span!("Deploying contract", contract_name);
|
|
||||||
let _guard = tracing_span.enter();
|
|
||||||
|
|
||||||
tracing::debug!(
|
tracing::debug!(
|
||||||
"Contract name is: {:?} and the input name is: {:?}",
|
"Contract name is: {:?} and the input name is: {:?}",
|
||||||
&contract_name,
|
&contract_name,
|
||||||
@@ -229,14 +228,16 @@ where
|
|||||||
std::any::type_name::<T>()
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
|
|
||||||
// We are using alloy for building and submitting the transactions and it will
|
let tx = TransactionRequest {
|
||||||
// automatically fill in all of the missing fields from the provider that we
|
from: Some(input.caller),
|
||||||
// are using.
|
to: Some(TxKind::Create),
|
||||||
let code = alloy::hex::decode(&code)?;
|
gas_price: Some(5_000_000),
|
||||||
let tx = TransactionRequest::default()
|
gas: Some(5_000_000),
|
||||||
.nonce(nonce)
|
chain_id: Some(self.config.network_id),
|
||||||
.from(input.caller)
|
nonce: Some(nonce),
|
||||||
.with_deploy_code(code);
|
input: TransactionInput::new(Bytes::from(code.into_bytes())),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
let receipt = match node.execute_transaction(tx) {
|
let receipt = match node.execute_transaction(tx) {
|
||||||
Ok(receipt) => receipt,
|
Ok(receipt) => receipt,
|
||||||
@@ -478,77 +479,3 @@ where
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// An iterator that finds files of a certain extension in the provided directory. You can think of
|
|
||||||
/// this a glob pattern similar to: `${path}/**/*.md`
|
|
||||||
struct FilesWithExtensionIterator {
|
|
||||||
/// The set of allowed extensions that that match the requirement and that should be returned
|
|
||||||
/// when found.
|
|
||||||
allowed_extensions: std::collections::HashSet<std::borrow::Cow<'static, str>>,
|
|
||||||
|
|
||||||
/// The set of directories to visit next. This iterator does BFS and so these directories will
|
|
||||||
/// only be visited if we can't find any files in our state.
|
|
||||||
directories_to_search: Vec<std::path::PathBuf>,
|
|
||||||
|
|
||||||
/// The set of files matching the allowed extensions that were found. If there are entries in
|
|
||||||
/// this vector then they will be returned when the [`Iterator::next`] method is called. If not
|
|
||||||
/// then we visit one of the next directories to visit.
|
|
||||||
///
|
|
||||||
/// [`Iterator`]: std::iter::Iterator
|
|
||||||
files_matching_allowed_extensions: Vec<std::path::PathBuf>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FilesWithExtensionIterator {
|
|
||||||
fn new(root_directory: std::path::PathBuf) -> Self {
|
|
||||||
Self {
|
|
||||||
allowed_extensions: Default::default(),
|
|
||||||
directories_to_search: vec![root_directory],
|
|
||||||
files_matching_allowed_extensions: Default::default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn with_allowed_extension(
|
|
||||||
mut self,
|
|
||||||
allowed_extension: impl Into<std::borrow::Cow<'static, str>>,
|
|
||||||
) -> Self {
|
|
||||||
self.allowed_extensions.insert(allowed_extension.into());
|
|
||||||
self
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Iterator for FilesWithExtensionIterator {
|
|
||||||
type Item = std::path::PathBuf;
|
|
||||||
|
|
||||||
fn next(&mut self) -> Option<Self::Item> {
|
|
||||||
if let Some(file_path) = self.files_matching_allowed_extensions.pop() {
|
|
||||||
return Some(file_path);
|
|
||||||
};
|
|
||||||
|
|
||||||
let directory_to_search = self.directories_to_search.pop()?;
|
|
||||||
|
|
||||||
// Read all of the entries in the directory. If we failed to read this dir's entires then we
|
|
||||||
// elect to just ignore it and look in the next directory, we do that by calling the next
|
|
||||||
// method again on the iterator, which is an intentional decision that we made here instead
|
|
||||||
// of panicking.
|
|
||||||
let Ok(dir_entries) = std::fs::read_dir(directory_to_search) else {
|
|
||||||
return self.next();
|
|
||||||
};
|
|
||||||
|
|
||||||
for entry in dir_entries.flatten() {
|
|
||||||
let entry_path = entry.path();
|
|
||||||
if entry_path.is_dir() {
|
|
||||||
self.directories_to_search.push(entry_path)
|
|
||||||
} else if entry_path.is_file()
|
|
||||||
&& entry_path.extension().is_some_and(|ext| {
|
|
||||||
self.allowed_extensions
|
|
||||||
.iter()
|
|
||||||
.any(|allowed| ext.eq_ignore_ascii_case(allowed.as_ref()))
|
|
||||||
})
|
|
||||||
{
|
|
||||||
self.files_matching_allowed_extensions.push(entry_path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
self.next()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
+24
-18
@@ -3,9 +3,8 @@ use std::collections::HashMap;
|
|||||||
use alloy::{
|
use alloy::{
|
||||||
hex,
|
hex,
|
||||||
json_abi::{Function, JsonAbi},
|
json_abi::{Function, JsonAbi},
|
||||||
network::TransactionBuilder,
|
primitives::{Address, Bytes, TxKind},
|
||||||
primitives::{Address, Bytes},
|
rpc::types::{TransactionInput, TransactionRequest},
|
||||||
rpc::types::TransactionRequest,
|
|
||||||
};
|
};
|
||||||
use alloy_primitives::U256;
|
use alloy_primitives::U256;
|
||||||
use alloy_sol_types::SolValue;
|
use alloy_sol_types::SolValue;
|
||||||
@@ -123,14 +122,9 @@ impl Input {
|
|||||||
return Ok(Bytes::default()); // fallback or deployer — no input
|
return Ok(Bytes::default()); // fallback or deployer — no input
|
||||||
};
|
};
|
||||||
|
|
||||||
let Some(abi) = deployed_abis.get(&self.instance) else {
|
let abi = deployed_abis
|
||||||
tracing::error!(
|
.get(&self.instance)
|
||||||
contract_name = self.instance,
|
.ok_or_else(|| anyhow::anyhow!("ABI for instance '{}' not found", &self.instance))?;
|
||||||
available_abis = ?deployed_abis.keys().collect::<Vec<_>>(),
|
|
||||||
"Attempted to lookup ABI of contract but it wasn't found"
|
|
||||||
);
|
|
||||||
anyhow::bail!("ABI for instance '{}' not found", &self.instance);
|
|
||||||
};
|
|
||||||
|
|
||||||
tracing::trace!("ABI found for instance: {}", &self.instance);
|
tracing::trace!("ABI found for instance: {}", &self.instance);
|
||||||
|
|
||||||
@@ -226,18 +220,30 @@ impl Input {
|
|||||||
/// Parse this input into a legacy transaction.
|
/// Parse this input into a legacy transaction.
|
||||||
pub fn legacy_transaction(
|
pub fn legacy_transaction(
|
||||||
&self,
|
&self,
|
||||||
|
chain_id: u64,
|
||||||
nonce: u64,
|
nonce: u64,
|
||||||
deployed_contracts: &HashMap<String, Address>,
|
deployed_contracts: &HashMap<String, Address>,
|
||||||
deployed_abis: &HashMap<String, JsonAbi>,
|
deployed_abis: &HashMap<String, JsonAbi>,
|
||||||
) -> anyhow::Result<TransactionRequest> {
|
) -> anyhow::Result<TransactionRequest> {
|
||||||
|
let to = match self.method {
|
||||||
|
Method::Deployer => Some(TxKind::Create),
|
||||||
|
_ => Some(TxKind::Call(
|
||||||
|
self.instance_to_address(&self.instance, deployed_contracts)?,
|
||||||
|
)),
|
||||||
|
};
|
||||||
|
|
||||||
let input_data = self.encoded_input(deployed_abis, deployed_contracts)?;
|
let input_data = self.encoded_input(deployed_abis, deployed_contracts)?;
|
||||||
let transaction_request = TransactionRequest::default().nonce(nonce);
|
|
||||||
match self.method {
|
Ok(TransactionRequest {
|
||||||
Method::Deployer => Ok(transaction_request.with_deploy_code(input_data)),
|
from: Some(self.caller),
|
||||||
_ => Ok(transaction_request
|
to,
|
||||||
.to(self.instance_to_address(&self.instance, deployed_contracts)?)
|
nonce: Some(nonce),
|
||||||
.input(input_data.into())),
|
chain_id: Some(chain_id),
|
||||||
}
|
gas_price: Some(5_000_000),
|
||||||
|
gas: Some(5_000_000),
|
||||||
|
input: TransactionInput::new(input_data),
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ rust-version.workspace = true
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
alloy = { workspace = true }
|
alloy = { workspace = true }
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
futures = { workspace = true }
|
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
once_cell = { workspace = true }
|
once_cell = { workspace = true }
|
||||||
tokio = { workspace = true }
|
tokio = { workspace = true }
|
||||||
|
|||||||
@@ -1,221 +0,0 @@
|
|||||||
//! The alloy crate __requires__ a tokio runtime.
|
|
||||||
//! We contain any async rust right here.
|
|
||||||
|
|
||||||
use std::{any::Any, panic::AssertUnwindSafe, pin::Pin, thread};
|
|
||||||
|
|
||||||
use futures::FutureExt;
|
|
||||||
use once_cell::sync::Lazy;
|
|
||||||
use tokio::{
|
|
||||||
runtime::Builder,
|
|
||||||
sync::{mpsc::UnboundedSender, oneshot},
|
|
||||||
};
|
|
||||||
|
|
||||||
/// A blocking async executor.
|
|
||||||
///
|
|
||||||
/// This struct exposes the abstraction of a blocking async executor. It is a global and static
|
|
||||||
/// executor which means that it doesn't require for new instances of it to be created, it's a
|
|
||||||
/// singleton and can be accessed by any thread that wants to perform some async computation on the
|
|
||||||
/// blocking executor thread.
|
|
||||||
///
|
|
||||||
/// The API of the blocking executor is created in a way so that it's very natural, simple to use,
|
|
||||||
/// and unbounded to specific tasks or return types. The following is an example of using this
|
|
||||||
/// executor to drive an async computation:
|
|
||||||
///
|
|
||||||
/// ```rust
|
|
||||||
/// use revive_dt_node_interaction::*;
|
|
||||||
///
|
|
||||||
/// fn blocking_function() {
|
|
||||||
/// let result = BlockingExecutor::execute(async move {
|
|
||||||
/// tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
/// 0xFFu8
|
|
||||||
/// })
|
|
||||||
/// .expect("Computation failed");
|
|
||||||
///
|
|
||||||
/// assert_eq!(result, 0xFF);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Users get to pass in their async tasks without needing to worry about putting them in a [`Box`],
|
|
||||||
/// [`Pin`], needing to perform down-casting, or the internal channel mechanism used by the runtime.
|
|
||||||
/// To the user, it just looks like a function that converts some async code into sync code.
|
|
||||||
///
|
|
||||||
/// This struct also handled panics that occur in the passed futures and converts them into errors
|
|
||||||
/// that can be handled by the user. This is done to allow the executor to be robust.
|
|
||||||
///
|
|
||||||
/// Internally, the executor communicates with the tokio runtime thread through channels which carry
|
|
||||||
/// the [`TaskMessage`] and the results of the execution.
|
|
||||||
pub struct BlockingExecutor;
|
|
||||||
|
|
||||||
impl BlockingExecutor {
|
|
||||||
pub fn execute<R>(future: impl Future<Output = R> + Send + 'static) -> Result<R, anyhow::Error>
|
|
||||||
where
|
|
||||||
R: Send + 'static,
|
|
||||||
{
|
|
||||||
// Note: The blocking executor is a singleton and therefore we store its state in a static
|
|
||||||
// so that it's assigned only once. Additionally, when we set the state of the executor we
|
|
||||||
// spawn the thread where the async runtime runs.
|
|
||||||
static STATE: Lazy<ExecutorState> = Lazy::new(|| {
|
|
||||||
tracing::trace!("Initializing the BlockingExecutor state");
|
|
||||||
|
|
||||||
// All communication with the tokio runtime thread happens over mspc channels where the
|
|
||||||
// producers here are the threads that want to run async tasks and the consumer here is
|
|
||||||
// the tokio runtime thread.
|
|
||||||
let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<TaskMessage>();
|
|
||||||
|
|
||||||
thread::spawn(move || {
|
|
||||||
let runtime = Builder::new_current_thread()
|
|
||||||
.enable_all()
|
|
||||||
.build()
|
|
||||||
.expect("Failed to create the async runtime");
|
|
||||||
|
|
||||||
runtime.block_on(async move {
|
|
||||||
while let Some(TaskMessage {
|
|
||||||
future: task,
|
|
||||||
response_tx: response_channel,
|
|
||||||
}) = rx.recv().await
|
|
||||||
{
|
|
||||||
tracing::trace!("Received a new future to execute");
|
|
||||||
tokio::spawn(async move {
|
|
||||||
// One of the things that the blocking executor does is that it allows
|
|
||||||
// us to catch panics if they occur. By wrapping the given future in an
|
|
||||||
// AssertUnwindSafe::catch_unwind we are able to catch all panic unwinds
|
|
||||||
// in the given future and convert them into errors.
|
|
||||||
let task = AssertUnwindSafe(task).catch_unwind();
|
|
||||||
|
|
||||||
let result = task.await;
|
|
||||||
let _ = response_channel.send(result);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
ExecutorState { tx }
|
|
||||||
});
|
|
||||||
|
|
||||||
// We need to perform blocking synchronous communication between the current thread and the
|
|
||||||
// tokio runtime thread with the result of the async computation and the oneshot channels
|
|
||||||
// from tokio allows us to do that. The sender side of the channel will be given to the
|
|
||||||
// tokio runtime thread to send the result when the computation is completed and the receive
|
|
||||||
// side of the channel will be kept with this thread to await for the response of the async
|
|
||||||
// task to come back.
|
|
||||||
let (response_tx, response_rx) =
|
|
||||||
oneshot::channel::<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>();
|
|
||||||
|
|
||||||
// The tokio runtime thread expects a Future<Output = Box<dyn Any + Send>> + Send to be
|
|
||||||
// sent to it to execute. However, this function has a typed Future<Output = R> + Send and
|
|
||||||
// therefore we need to change the type of the future to fit what the runtime thread expects
|
|
||||||
// in the task message. In doing this conversion, we lose some of the type information since
|
|
||||||
// we're converting R => dyn Any. However, we will perform down-casting on the result to
|
|
||||||
// convert it back into R.
|
|
||||||
let future = Box::pin(async move { Box::new(future.await) as Box<dyn Any + Send> });
|
|
||||||
|
|
||||||
let task = TaskMessage::new(future, response_tx);
|
|
||||||
if let Err(error) = STATE.tx.send(task) {
|
|
||||||
tracing::error!(?error, "Failed to send the task to the blocking executor");
|
|
||||||
anyhow::bail!("Failed to send the task to the blocking executor: {error:?}")
|
|
||||||
}
|
|
||||||
|
|
||||||
let result = match response_rx.blocking_recv() {
|
|
||||||
Ok(result) => result,
|
|
||||||
Err(error) => {
|
|
||||||
tracing::error!(
|
|
||||||
?error,
|
|
||||||
"Failed to get the response from the blocking executor"
|
|
||||||
);
|
|
||||||
anyhow::bail!("Failed to get the response from the blocking executor: {error:?}")
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
match result.map(|result| {
|
|
||||||
*result
|
|
||||||
.downcast::<R>()
|
|
||||||
.expect("Type mismatch in the downcast")
|
|
||||||
}) {
|
|
||||||
Ok(result) => Ok(result),
|
|
||||||
Err(error) => {
|
|
||||||
tracing::error!(
|
|
||||||
?error,
|
|
||||||
"Failed to downcast the returned result into the expected type"
|
|
||||||
);
|
|
||||||
anyhow::bail!(
|
|
||||||
"Failed to downcast the returned result into the expected type: {error:?}"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents the state of the async runtime. This runtime is designed to be a singleton runtime
|
|
||||||
/// which means that in the current running program there's just a single thread that has an async
|
|
||||||
/// runtime.
|
|
||||||
struct ExecutorState {
|
|
||||||
/// The sending side of the task messages channel. This is used by all of the other threads to
|
|
||||||
/// communicate with the async runtime thread.
|
|
||||||
tx: UnboundedSender<TaskMessage>,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents a message that contains an asynchronous task that's to be executed by the runtime
|
|
||||||
/// as well as a way for the runtime to report back on the result of the execution.
|
|
||||||
struct TaskMessage {
|
|
||||||
/// The task that's being requested to run. This is a future that returns an object that does
|
|
||||||
/// implement [`Any`] and [`Send`] to allow it to be sent between the requesting thread and the
|
|
||||||
/// async thread.
|
|
||||||
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
|
||||||
|
|
||||||
/// A one shot sender channel where the sender of the task is expecting to hear back on the
|
|
||||||
/// result of the task.
|
|
||||||
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TaskMessage {
|
|
||||||
pub fn new(
|
|
||||||
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
|
||||||
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
|
||||||
) -> Self {
|
|
||||||
Self {
|
|
||||||
future,
|
|
||||||
response_tx,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod test {
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn simple_future_works() {
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
0xFFu8
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert_eq!(result, 0xFFu8);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[allow(unreachable_code, clippy::unreachable)]
|
|
||||||
fn panics_in_futures_are_caught() {
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
panic!("This is a panic!");
|
|
||||||
0xFFu8
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert!(result.is_err());
|
|
||||||
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
0xFFu8
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert_eq!(result, 0xFFu8)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -3,9 +3,12 @@
|
|||||||
use alloy::primitives::Address;
|
use alloy::primitives::Address;
|
||||||
use alloy::rpc::types::trace::geth::{DiffMode, GethTrace};
|
use alloy::rpc::types::trace::geth::{DiffMode, GethTrace};
|
||||||
use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
|
use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
|
||||||
|
use tokio_runtime::TO_TOKIO;
|
||||||
|
|
||||||
mod blocking_executor;
|
pub mod nonce;
|
||||||
pub use blocking_executor::*;
|
mod tokio_runtime;
|
||||||
|
pub mod trace;
|
||||||
|
pub mod transaction;
|
||||||
|
|
||||||
/// An interface for all interactions with Ethereum compatible nodes.
|
/// An interface for all interactions with Ethereum compatible nodes.
|
||||||
pub trait EthereumNode {
|
pub trait EthereumNode {
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
use std::pin::Pin;
|
||||||
|
|
||||||
|
use alloy::{
|
||||||
|
primitives::Address,
|
||||||
|
providers::{Provider, ProviderBuilder},
|
||||||
|
};
|
||||||
|
use tokio::sync::oneshot;
|
||||||
|
|
||||||
|
use crate::{TO_TOKIO, tokio_runtime::AsyncNodeInteraction};
|
||||||
|
|
||||||
|
pub type Task = Pin<Box<dyn Future<Output = anyhow::Result<u64>> + Send>>;
|
||||||
|
|
||||||
|
pub(crate) struct Nonce {
|
||||||
|
sender: oneshot::Sender<anyhow::Result<u64>>,
|
||||||
|
task: Task,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsyncNodeInteraction for Nonce {
|
||||||
|
type Output = anyhow::Result<u64>;
|
||||||
|
|
||||||
|
fn split(
|
||||||
|
self,
|
||||||
|
) -> (
|
||||||
|
std::pin::Pin<Box<dyn Future<Output = Self::Output> + Send>>,
|
||||||
|
oneshot::Sender<Self::Output>,
|
||||||
|
) {
|
||||||
|
(self.task, self.sender)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This is like `trace_transaction`, just for nonces.
|
||||||
|
pub fn fetch_onchain_nonce(
|
||||||
|
connection: String,
|
||||||
|
wallet: alloy::network::EthereumWallet,
|
||||||
|
address: Address,
|
||||||
|
) -> anyhow::Result<u64> {
|
||||||
|
let sender = TO_TOKIO.lock().unwrap().nonce_sender.clone();
|
||||||
|
|
||||||
|
let (tx, rx) = oneshot::channel();
|
||||||
|
let task: Task = Box::pin(async move {
|
||||||
|
let provider = ProviderBuilder::new()
|
||||||
|
.wallet(wallet)
|
||||||
|
.connect(&connection)
|
||||||
|
.await?;
|
||||||
|
let onchain = provider.get_transaction_count(address).await?;
|
||||||
|
Ok(onchain)
|
||||||
|
});
|
||||||
|
|
||||||
|
sender
|
||||||
|
.blocking_send(Nonce { task, sender: tx })
|
||||||
|
.expect("not in async context");
|
||||||
|
|
||||||
|
rx.blocking_recv()
|
||||||
|
.unwrap_or_else(|err| anyhow::bail!("nonce fetch failed: {err}"))
|
||||||
|
}
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
//! 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::nonce::Nonce;
|
||||||
|
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>,
|
||||||
|
pub(crate) nonce_sender: mpsc::Sender<Nonce>,
|
||||||
|
}
|
||||||
|
|
||||||
|
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);
|
||||||
|
let (nonce_sender, nonce_receiver) = mpsc::channel::<Nonce>(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));
|
||||||
|
let nonce_task = spawn(interaction::<Nonce>(nonce_receiver));
|
||||||
|
|
||||||
|
if let Err(error) = transaction_task.await {
|
||||||
|
tracing::error!("tokio transaction task failed: {error}");
|
||||||
|
}
|
||||||
|
if let Err(error) = trace_task.await {
|
||||||
|
tracing::error!("tokio trace transaction task failed: {error}");
|
||||||
|
}
|
||||||
|
if let Err(error) = nonce_task.await {
|
||||||
|
tracing::error!("tokio nonce task failed: {error}");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
Self {
|
||||||
|
transaction_sender,
|
||||||
|
trace_sender,
|
||||||
|
nonce_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(())
|
||||||
|
}
|
||||||
@@ -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}"))
|
||||||
|
}
|
||||||
@@ -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}"))
|
||||||
|
}
|
||||||
+45
-119
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
collections::HashMap,
|
collections::HashMap,
|
||||||
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
fs::{File, create_dir_all, remove_dir_all},
|
||||||
io::{BufRead, BufReader, Read, Write},
|
io::{BufRead, BufReader, Read, Write},
|
||||||
path::PathBuf,
|
path::PathBuf,
|
||||||
process::{Child, Command, Stdio},
|
process::{Child, Command, Stdio},
|
||||||
@@ -10,6 +10,7 @@ use std::{
|
|||||||
Mutex,
|
Mutex,
|
||||||
atomic::{AtomicU32, Ordering},
|
atomic::{AtomicU32, Ordering},
|
||||||
},
|
},
|
||||||
|
thread,
|
||||||
time::{Duration, Instant},
|
time::{Duration, Instant},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -23,8 +24,10 @@ use alloy::{
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
use revive_dt_node_interaction::{
|
||||||
use tracing::Level;
|
EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
|
||||||
|
transaction::execute_transaction,
|
||||||
|
};
|
||||||
|
|
||||||
use crate::Node;
|
use crate::Node;
|
||||||
|
|
||||||
@@ -42,7 +45,6 @@ pub struct Instance {
|
|||||||
connection_string: String,
|
connection_string: String,
|
||||||
base_directory: PathBuf,
|
base_directory: PathBuf,
|
||||||
data_directory: PathBuf,
|
data_directory: PathBuf,
|
||||||
logs_directory: PathBuf,
|
|
||||||
geth: PathBuf,
|
geth: PathBuf,
|
||||||
id: u32,
|
id: u32,
|
||||||
handle: Option<Child>,
|
handle: Option<Child>,
|
||||||
@@ -50,17 +52,11 @@ pub struct Instance {
|
|||||||
start_timeout: u64,
|
start_timeout: u64,
|
||||||
wallet: EthereumWallet,
|
wallet: EthereumWallet,
|
||||||
nonces: Mutex<HashMap<Address, u64>>,
|
nonces: Mutex<HashMap<Address, u64>>,
|
||||||
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
|
||||||
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
|
||||||
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
|
||||||
/// what it belongs to, we just want to flush them on [`Drop`] of the node.
|
|
||||||
logs_file_to_flush: Vec<File>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Instance {
|
impl Instance {
|
||||||
const BASE_DIRECTORY: &str = "geth";
|
const BASE_DIRECTORY: &str = "geth";
|
||||||
const DATA_DIRECTORY: &str = "data";
|
const DATA_DIRECTORY: &str = "data";
|
||||||
const LOGS_DIRECTORY: &str = "logs";
|
|
||||||
|
|
||||||
const IPC_FILE: &str = "geth.ipc";
|
const IPC_FILE: &str = "geth.ipc";
|
||||||
const GENESIS_JSON_FILE: &str = "genesis.json";
|
const GENESIS_JSON_FILE: &str = "genesis.json";
|
||||||
@@ -68,14 +64,9 @@ impl Instance {
|
|||||||
const READY_MARKER: &str = "IPC endpoint opened";
|
const READY_MARKER: &str = "IPC endpoint opened";
|
||||||
const ERROR_MARKER: &str = "Fatal:";
|
const ERROR_MARKER: &str = "Fatal:";
|
||||||
|
|
||||||
const GETH_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
|
|
||||||
const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
|
||||||
|
|
||||||
/// Create the node directory and call `geth init` to configure the genesis.
|
/// Create the node directory and call `geth init` to configure the genesis.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
||||||
create_dir_all(&self.base_directory)?;
|
create_dir_all(&self.base_directory)?;
|
||||||
create_dir_all(&self.logs_directory)?;
|
|
||||||
|
|
||||||
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
||||||
File::create(&genesis_path)?.write_all(genesis.as_bytes())?;
|
File::create(&genesis_path)?.write_all(genesis.as_bytes())?;
|
||||||
@@ -105,24 +96,8 @@ impl Instance {
|
|||||||
|
|
||||||
/// Spawn the go-ethereum node child process.
|
/// Spawn the go-ethereum node child process.
|
||||||
///
|
///
|
||||||
/// [Instance::init] must be called prior.
|
/// [Instance::init] must be called priorly.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
|
fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
// This is the `OpenOptions` that we wish to use for all of the log files that we will be
|
|
||||||
// opening in this method. We need to construct it in this way to:
|
|
||||||
// 1. Be consistent
|
|
||||||
// 2. Less verbose and more dry
|
|
||||||
// 3. Because the builder pattern uses mutable references so we need to get around that.
|
|
||||||
let open_options = {
|
|
||||||
let mut options = OpenOptions::new();
|
|
||||||
options.create(true).truncate(true).write(true);
|
|
||||||
options
|
|
||||||
};
|
|
||||||
|
|
||||||
let stdout_logs_file = open_options
|
|
||||||
.clone()
|
|
||||||
.open(self.geth_stdout_log_file_path())?;
|
|
||||||
let stderr_logs_file = open_options.open(self.geth_stderr_log_file_path())?;
|
|
||||||
self.handle = Command::new(&self.geth)
|
self.handle = Command::new(&self.geth)
|
||||||
.arg("--dev")
|
.arg("--dev")
|
||||||
.arg("--datadir")
|
.arg("--datadir")
|
||||||
@@ -134,67 +109,49 @@ impl Instance {
|
|||||||
.arg("--nodiscover")
|
.arg("--nodiscover")
|
||||||
.arg("--maxpeers")
|
.arg("--maxpeers")
|
||||||
.arg("0")
|
.arg("0")
|
||||||
.stderr(stderr_logs_file.try_clone()?)
|
.stderr(Stdio::piped())
|
||||||
.stdout(stdout_logs_file.try_clone()?)
|
.stdout(Stdio::null())
|
||||||
.spawn()?
|
.spawn()?
|
||||||
.into();
|
.into();
|
||||||
|
|
||||||
if let Err(error) = self.wait_ready() {
|
|
||||||
tracing::error!(?error, "Failed to start geth, shutting down gracefully");
|
|
||||||
self.shutdown()?;
|
|
||||||
return Err(error);
|
|
||||||
}
|
|
||||||
|
|
||||||
self.logs_file_to_flush
|
|
||||||
.extend([stderr_logs_file, stdout_logs_file]);
|
|
||||||
|
|
||||||
Ok(self)
|
Ok(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Wait for the g-ethereum node child process getting ready.
|
/// Wait for the g-ethereum node child process getting ready.
|
||||||
///
|
///
|
||||||
/// [Instance::spawn_process] must be called priorly.
|
/// [Instance::spawn_process] must be called priorly.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
|
fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
|
// Thanks clippy but geth is a server; we don't `wait` but eventually kill it.
|
||||||
|
#[allow(clippy::zombie_processes)]
|
||||||
|
let mut child = self.handle.take().expect("should be spawned");
|
||||||
let start_time = Instant::now();
|
let start_time = Instant::now();
|
||||||
|
|
||||||
let logs_file = OpenOptions::new()
|
|
||||||
.read(true)
|
|
||||||
.write(false)
|
|
||||||
.append(false)
|
|
||||||
.truncate(false)
|
|
||||||
.open(self.geth_stderr_log_file_path())?;
|
|
||||||
|
|
||||||
let maximum_wait_time = Duration::from_millis(self.start_timeout);
|
let maximum_wait_time = Duration::from_millis(self.start_timeout);
|
||||||
let mut stderr = BufReader::new(logs_file).lines();
|
let mut stderr = BufReader::new(child.stderr.take().expect("should be piped")).lines();
|
||||||
loop {
|
let error = loop {
|
||||||
if let Some(Ok(line)) = stderr.next() {
|
let Some(Ok(line)) = stderr.next() else {
|
||||||
if line.contains(Self::ERROR_MARKER) {
|
break "child process stderr reading error".to_string();
|
||||||
anyhow::bail!("Failed to start geth {line}");
|
};
|
||||||
}
|
if line.contains(Self::ERROR_MARKER) {
|
||||||
if line.contains(Self::READY_MARKER) {
|
break line;
|
||||||
return Ok(self);
|
}
|
||||||
}
|
if line.contains(Self::READY_MARKER) {
|
||||||
|
// Keep stderr alive
|
||||||
|
// https://github.com/alloy-rs/alloy/issues/2091#issuecomment-2676134147
|
||||||
|
thread::spawn(move || for _ in stderr.by_ref() {});
|
||||||
|
|
||||||
|
self.handle = child.into();
|
||||||
|
return Ok(self);
|
||||||
}
|
}
|
||||||
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
||||||
anyhow::bail!("Timeout in starting geth");
|
break "spawn timeout".to_string();
|
||||||
}
|
}
|
||||||
}
|
};
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
let _ = child.kill();
|
||||||
fn geth_stdout_log_file_path(&self) -> PathBuf {
|
anyhow::bail!("geth node #{} spawn error: {error}", self.id)
|
||||||
self.logs_directory.join(Self::GETH_STDOUT_LOG_FILE_NAME)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn geth_stderr_log_file_path(&self) -> PathBuf {
|
|
||||||
self.logs_directory.join(Self::GETH_STDERR_LOG_FILE_NAME)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl EthereumNode for Instance {
|
impl EthereumNode for Instance {
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn execute_transaction(
|
fn execute_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: TransactionRequest,
|
transaction: TransactionRequest,
|
||||||
@@ -202,7 +159,7 @@ impl EthereumNode for Instance {
|
|||||||
let connection_string = self.connection_string();
|
let connection_string = self.connection_string();
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
BlockingExecutor::execute(async move {
|
execute_transaction(Box::pin(async move {
|
||||||
let outer_span = tracing::debug_span!("Submitting transaction", ?transaction,);
|
let outer_span = tracing::debug_span!("Submitting transaction", ?transaction,);
|
||||||
let _outer_guard = outer_span.enter();
|
let _outer_guard = outer_span.enter();
|
||||||
|
|
||||||
@@ -281,10 +238,9 @@ impl EthereumNode for Instance {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})?
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn trace_transaction(
|
fn trace_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: TransactionReceipt,
|
transaction: TransactionReceipt,
|
||||||
@@ -297,17 +253,16 @@ impl EthereumNode for Instance {
|
|||||||
});
|
});
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
BlockingExecutor::execute(async move {
|
trace_transaction(Box::pin(async move {
|
||||||
Ok(ProviderBuilder::new()
|
Ok(ProviderBuilder::new()
|
||||||
.wallet(wallet)
|
.wallet(wallet)
|
||||||
.connect(&connection_string)
|
.connect(&connection_string)
|
||||||
.await?
|
.await?
|
||||||
.debug_trace_transaction(transaction.transaction_hash, trace_options)
|
.debug_trace_transaction(transaction.transaction_hash, trace_options)
|
||||||
.await?)
|
.await?)
|
||||||
})?
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn state_diff(
|
fn state_diff(
|
||||||
&self,
|
&self,
|
||||||
transaction: alloy::rpc::types::TransactionReceipt,
|
transaction: alloy::rpc::types::TransactionReceipt,
|
||||||
@@ -321,20 +276,11 @@ impl EthereumNode for Instance {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
|
fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
|
||||||
let connection_string = self.connection_string.clone();
|
let connection_string = self.connection_string.clone();
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
|
let onchain_nonce = fetch_onchain_nonce(connection_string, wallet, address)?;
|
||||||
ProviderBuilder::new()
|
|
||||||
.wallet(wallet)
|
|
||||||
.connect(&connection_string)
|
|
||||||
.await?
|
|
||||||
.get_transaction_count(address)
|
|
||||||
.await
|
|
||||||
.map_err(Into::into)
|
|
||||||
})??;
|
|
||||||
|
|
||||||
let mut nonces = self.nonces.lock().unwrap();
|
let mut nonces = self.nonces.lock().unwrap();
|
||||||
let current = nonces.entry(address).or_insert(onchain_nonce);
|
let current = nonces.entry(address).or_insert(onchain_nonce);
|
||||||
@@ -353,7 +299,6 @@ impl Node for Instance {
|
|||||||
Self {
|
Self {
|
||||||
connection_string: base_directory.join(Self::IPC_FILE).display().to_string(),
|
connection_string: base_directory.join(Self::IPC_FILE).display().to_string(),
|
||||||
data_directory: base_directory.join(Self::DATA_DIRECTORY),
|
data_directory: base_directory.join(Self::DATA_DIRECTORY),
|
||||||
logs_directory: base_directory.join(Self::LOGS_DIRECTORY),
|
|
||||||
base_directory,
|
base_directory,
|
||||||
geth: config.geth.clone(),
|
geth: config.geth.clone(),
|
||||||
id,
|
id,
|
||||||
@@ -362,46 +307,22 @@ impl Node for Instance {
|
|||||||
start_timeout: config.geth_start_timeout,
|
start_timeout: config.geth_start_timeout,
|
||||||
wallet: config.wallet(),
|
wallet: config.wallet(),
|
||||||
nonces: Mutex::new(HashMap::new()),
|
nonces: Mutex::new(HashMap::new()),
|
||||||
// We know that we only need to be storing 2 files so we can specify that when creating
|
|
||||||
// the vector. It's the stdout and stderr of the geth node.
|
|
||||||
logs_file_to_flush: Vec::with_capacity(2),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn connection_string(&self) -> String {
|
fn connection_string(&self) -> String {
|
||||||
self.connection_string.clone()
|
self.connection_string.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
fn shutdown(self) -> anyhow::Result<()> {
|
||||||
fn shutdown(&mut self) -> anyhow::Result<()> {
|
|
||||||
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
|
||||||
if let Some(mut child) = self.handle.take() {
|
|
||||||
child
|
|
||||||
.kill()
|
|
||||||
.map_err(|error| anyhow::anyhow!("Failed to kill the geth process: {error:?}"))?;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Flushing the files that we're using for keeping the logs before shutdown.
|
|
||||||
for file in self.logs_file_to_flush.iter_mut() {
|
|
||||||
file.flush()?
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove the node's database so that subsequent runs do not run on the same database. We
|
|
||||||
// ignore the error just in case the directory didn't exist in the first place and therefore
|
|
||||||
// there's nothing to be deleted.
|
|
||||||
let _ = remove_dir_all(self.base_directory.join(Self::DATA_DIRECTORY));
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
||||||
self.init(genesis)?.spawn_process()?;
|
self.init(genesis)?.spawn_process()?.wait_ready()?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn version(&self) -> anyhow::Result<String> {
|
fn version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.geth)
|
let output = Command::new(&self.geth)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
@@ -416,9 +337,14 @@ impl Node for Instance {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for Instance {
|
impl Drop for Instance {
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
self.shutdown().expect("Failed to shutdown")
|
tracing::info!(id = self.id, "Dropping node");
|
||||||
|
if let Some(child) = self.handle.as_mut() {
|
||||||
|
let _ = child.kill();
|
||||||
|
}
|
||||||
|
if self.base_directory.exists() {
|
||||||
|
let _ = remove_dir_all(&self.base_directory);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+44
-158
@@ -1,8 +1,8 @@
|
|||||||
use std::{
|
use std::{
|
||||||
collections::HashMap,
|
collections::HashMap,
|
||||||
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
fs::create_dir_all,
|
||||||
io::{BufRead, Write},
|
io::BufRead,
|
||||||
path::{Path, PathBuf},
|
path::PathBuf,
|
||||||
process::{Child, Command, Stdio},
|
process::{Child, Command, Stdio},
|
||||||
sync::{
|
sync::{
|
||||||
Mutex,
|
Mutex,
|
||||||
@@ -24,10 +24,12 @@ use alloy::{
|
|||||||
use serde_json::{Value as JsonValue, json};
|
use serde_json::{Value as JsonValue, json};
|
||||||
use sp_core::crypto::Ss58Codec;
|
use sp_core::crypto::Ss58Codec;
|
||||||
use sp_runtime::AccountId32;
|
use sp_runtime::AccountId32;
|
||||||
use tracing::Level;
|
|
||||||
|
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
use revive_dt_node_interaction::{
|
||||||
|
EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
|
||||||
|
transaction::execute_transaction,
|
||||||
|
};
|
||||||
|
|
||||||
use crate::Node;
|
use crate::Node;
|
||||||
|
|
||||||
@@ -41,22 +43,13 @@ pub struct KitchensinkNode {
|
|||||||
rpc_url: String,
|
rpc_url: String,
|
||||||
wallet: EthereumWallet,
|
wallet: EthereumWallet,
|
||||||
base_directory: PathBuf,
|
base_directory: PathBuf,
|
||||||
logs_directory: PathBuf,
|
|
||||||
process_substrate: Option<Child>,
|
process_substrate: Option<Child>,
|
||||||
process_proxy: Option<Child>,
|
process_proxy: Option<Child>,
|
||||||
nonces: Mutex<HashMap<Address, u64>>,
|
nonces: Mutex<HashMap<Address, u64>>,
|
||||||
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
|
||||||
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
|
||||||
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
|
||||||
/// what it belongs to, we just want to flush them on [`Drop`] of the node.
|
|
||||||
logs_file_to_flush: Vec<File>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl KitchensinkNode {
|
impl KitchensinkNode {
|
||||||
const BASE_DIRECTORY: &str = "kitchensink";
|
const BASE_DIRECTORY: &str = "kitchensink";
|
||||||
const LOGS_DIRECTORY: &str = "logs";
|
|
||||||
const DATA_DIRECTORY: &str = "chains";
|
|
||||||
|
|
||||||
const SUBSTRATE_READY_MARKER: &str = "Running JSON-RPC server";
|
const SUBSTRATE_READY_MARKER: &str = "Running JSON-RPC server";
|
||||||
const ETH_PROXY_READY_MARKER: &str = "Running JSON-RPC server";
|
const ETH_PROXY_READY_MARKER: &str = "Running JSON-RPC server";
|
||||||
const CHAIN_SPEC_JSON_FILE: &str = "template_chainspec.json";
|
const CHAIN_SPEC_JSON_FILE: &str = "template_chainspec.json";
|
||||||
@@ -66,21 +59,11 @@ impl KitchensinkNode {
|
|||||||
const SUBSTRATE_LOG_ENV: &str = "error,evm=debug,sc_rpc_server=info,runtime::revive=debug";
|
const SUBSTRATE_LOG_ENV: &str = "error,evm=debug,sc_rpc_server=info,runtime::revive=debug";
|
||||||
const PROXY_LOG_ENV: &str = "info,eth-rpc=debug";
|
const PROXY_LOG_ENV: &str = "info,eth-rpc=debug";
|
||||||
|
|
||||||
const KITCHENSINK_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
|
|
||||||
const KITCHENSINK_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
|
||||||
|
|
||||||
const PROXY_STDOUT_LOG_FILE_NAME: &str = "proxy_stdout.log";
|
|
||||||
const PROXY_STDERR_LOG_FILE_NAME: &str = "proxy_stderr.log";
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn init(&mut self, genesis: &str) -> anyhow::Result<&mut Self> {
|
fn init(&mut self, genesis: &str) -> anyhow::Result<&mut Self> {
|
||||||
create_dir_all(&self.base_directory)?;
|
create_dir_all(&self.base_directory)?;
|
||||||
create_dir_all(&self.logs_directory)?;
|
|
||||||
|
|
||||||
let template_chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
let template_chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
||||||
|
|
||||||
// Note: we do not pipe the logs of this process to a separate file since this is just a
|
|
||||||
// once-off export of the default chain spec and not part of the long-running node process.
|
|
||||||
let output = Command::new(&self.substrate_binary)
|
let output = Command::new(&self.substrate_binary)
|
||||||
.arg("export-chain-spec")
|
.arg("export-chain-spec")
|
||||||
.arg("--chain")
|
.arg("--chain")
|
||||||
@@ -129,7 +112,6 @@ impl KitchensinkNode {
|
|||||||
Ok(self)
|
Ok(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn spawn_process(&mut self) -> anyhow::Result<()> {
|
fn spawn_process(&mut self) -> anyhow::Result<()> {
|
||||||
let substrate_rpc_port = Self::BASE_SUBSTRATE_RPC_PORT + self.id as u16;
|
let substrate_rpc_port = Self::BASE_SUBSTRATE_RPC_PORT + self.id as u16;
|
||||||
let proxy_rpc_port = Self::BASE_PROXY_RPC_PORT + self.id as u16;
|
let proxy_rpc_port = Self::BASE_PROXY_RPC_PORT + self.id as u16;
|
||||||
@@ -138,25 +120,8 @@ impl KitchensinkNode {
|
|||||||
|
|
||||||
let chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
let chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
||||||
|
|
||||||
// This is the `OpenOptions` that we wish to use for all of the log files that we will be
|
|
||||||
// opening in this method. We need to construct it in this way to:
|
|
||||||
// 1. Be consistent
|
|
||||||
// 2. Less verbose and more dry
|
|
||||||
// 3. Because the builder pattern uses mutable references so we need to get around that.
|
|
||||||
let open_options = {
|
|
||||||
let mut options = OpenOptions::new();
|
|
||||||
options.create(true).truncate(true).write(true);
|
|
||||||
options
|
|
||||||
};
|
|
||||||
|
|
||||||
// Start Substrate node
|
// Start Substrate node
|
||||||
let kitchensink_stdout_logs_file = open_options
|
let mut substrate_process = Command::new(&self.substrate_binary)
|
||||||
.clone()
|
|
||||||
.open(self.kitchensink_stdout_log_file_path())?;
|
|
||||||
let kitchensink_stderr_logs_file = open_options
|
|
||||||
.clone()
|
|
||||||
.open(self.kitchensink_stderr_log_file_path())?;
|
|
||||||
self.process_substrate = Command::new(&self.substrate_binary)
|
|
||||||
.arg("--chain")
|
.arg("--chain")
|
||||||
.arg(chainspec_path)
|
.arg(chainspec_path)
|
||||||
.arg("--base-path")
|
.arg("--base-path")
|
||||||
@@ -171,61 +136,40 @@ impl KitchensinkNode {
|
|||||||
.arg("--rpc-cors")
|
.arg("--rpc-cors")
|
||||||
.arg("all")
|
.arg("all")
|
||||||
.env("RUST_LOG", Self::SUBSTRATE_LOG_ENV)
|
.env("RUST_LOG", Self::SUBSTRATE_LOG_ENV)
|
||||||
.stdout(kitchensink_stdout_logs_file.try_clone()?)
|
.stdout(Stdio::null())
|
||||||
.stderr(kitchensink_stderr_logs_file.try_clone()?)
|
.stderr(Stdio::piped())
|
||||||
.spawn()?
|
.spawn()?;
|
||||||
.into();
|
|
||||||
|
|
||||||
// Give the node a moment to boot
|
// Give the node a moment to boot
|
||||||
if let Err(error) = Self::wait_ready(
|
Self::wait_ready(
|
||||||
self.kitchensink_stderr_log_file_path().as_path(),
|
&mut substrate_process,
|
||||||
Self::SUBSTRATE_READY_MARKER,
|
Self::SUBSTRATE_READY_MARKER,
|
||||||
Duration::from_secs(30),
|
Duration::from_secs(30),
|
||||||
) {
|
)?;
|
||||||
tracing::error!(
|
|
||||||
?error,
|
|
||||||
"Failed to start substrate, shutting down gracefully"
|
|
||||||
);
|
|
||||||
self.shutdown()?;
|
|
||||||
return Err(error);
|
|
||||||
};
|
|
||||||
|
|
||||||
let eth_proxy_stdout_logs_file = open_options
|
let mut proxy_process = Command::new(&self.eth_proxy_binary)
|
||||||
.clone()
|
|
||||||
.open(self.proxy_stdout_log_file_path())?;
|
|
||||||
let eth_proxy_stderr_logs_file = open_options.open(self.proxy_stderr_log_file_path())?;
|
|
||||||
self.process_proxy = Command::new(&self.eth_proxy_binary)
|
|
||||||
.arg("--dev")
|
.arg("--dev")
|
||||||
.arg("--rpc-port")
|
.arg("--rpc-port")
|
||||||
.arg(proxy_rpc_port.to_string())
|
.arg(proxy_rpc_port.to_string())
|
||||||
.arg("--node-rpc-url")
|
.arg("--node-rpc-url")
|
||||||
.arg(format!("ws://127.0.0.1:{substrate_rpc_port}"))
|
.arg(format!("ws://127.0.0.1:{substrate_rpc_port}"))
|
||||||
.env("RUST_LOG", Self::PROXY_LOG_ENV)
|
.env("RUST_LOG", Self::PROXY_LOG_ENV)
|
||||||
.stdout(eth_proxy_stdout_logs_file.try_clone()?)
|
.stdout(Stdio::null())
|
||||||
.stderr(eth_proxy_stderr_logs_file.try_clone()?)
|
.stderr(Stdio::piped())
|
||||||
.spawn()?
|
.spawn()?;
|
||||||
.into();
|
|
||||||
|
|
||||||
if let Err(error) = Self::wait_ready(
|
Self::wait_ready(
|
||||||
self.proxy_stderr_log_file_path().as_path(),
|
&mut proxy_process,
|
||||||
Self::ETH_PROXY_READY_MARKER,
|
Self::ETH_PROXY_READY_MARKER,
|
||||||
Duration::from_secs(30),
|
Duration::from_secs(30),
|
||||||
) {
|
)?;
|
||||||
tracing::error!(?error, "Failed to start proxy, shutting down gracefully");
|
|
||||||
self.shutdown()?;
|
|
||||||
return Err(error);
|
|
||||||
};
|
|
||||||
|
|
||||||
self.logs_file_to_flush.extend([
|
self.process_substrate = Some(substrate_process);
|
||||||
kitchensink_stdout_logs_file,
|
self.process_proxy = Some(proxy_process);
|
||||||
kitchensink_stderr_logs_file,
|
|
||||||
eth_proxy_stdout_logs_file,
|
|
||||||
eth_proxy_stderr_logs_file,
|
|
||||||
]);
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn extract_balance_from_genesis_file(
|
fn extract_balance_from_genesis_file(
|
||||||
&self,
|
&self,
|
||||||
genesis_str: &str,
|
genesis_str: &str,
|
||||||
@@ -266,30 +210,27 @@ impl KitchensinkNode {
|
|||||||
Ok(account_id.to_ss58check())
|
Ok(account_id.to_ss58check())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn wait_ready(logs_file_path: &Path, marker: &str, timeout: Duration) -> anyhow::Result<()> {
|
fn wait_ready(child: &mut Child, marker: &str, timeout: Duration) -> anyhow::Result<()> {
|
||||||
let start_time = std::time::Instant::now();
|
let start_time = std::time::Instant::now();
|
||||||
let logs_file = OpenOptions::new()
|
let stderr = child.stderr.take().expect("stderr must be piped");
|
||||||
.read(true)
|
|
||||||
.write(false)
|
|
||||||
.append(false)
|
|
||||||
.truncate(false)
|
|
||||||
.open(logs_file_path)?;
|
|
||||||
|
|
||||||
let mut lines = std::io::BufReader::new(logs_file).lines();
|
let mut lines = std::io::BufReader::new(stderr).lines();
|
||||||
loop {
|
loop {
|
||||||
if let Some(Ok(line)) = lines.next() {
|
if let Some(Ok(line)) = lines.next() {
|
||||||
|
println!("Kitchensink log: {line:?}");
|
||||||
if line.contains(marker) {
|
if line.contains(marker) {
|
||||||
|
std::thread::spawn(move || for _ in lines.by_ref() {});
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if start_time.elapsed() > timeout {
|
if start_time.elapsed() > timeout {
|
||||||
|
let _ = child.kill();
|
||||||
anyhow::bail!("Timeout waiting for process readiness: {marker}");
|
anyhow::bail!("Timeout waiting for process readiness: {marker}");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
pub fn eth_rpc_version(&self) -> anyhow::Result<String> {
|
pub fn eth_rpc_version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.eth_proxy_binary)
|
let output = Command::new(&self.eth_proxy_binary)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
@@ -301,32 +242,9 @@ impl KitchensinkNode {
|
|||||||
.stdout;
|
.stdout;
|
||||||
Ok(String::from_utf8_lossy(&output).trim().to_string())
|
Ok(String::from_utf8_lossy(&output).trim().to_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn kitchensink_stdout_log_file_path(&self) -> PathBuf {
|
|
||||||
self.logs_directory
|
|
||||||
.join(Self::KITCHENSINK_STDOUT_LOG_FILE_NAME)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn kitchensink_stderr_log_file_path(&self) -> PathBuf {
|
|
||||||
self.logs_directory
|
|
||||||
.join(Self::KITCHENSINK_STDERR_LOG_FILE_NAME)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn proxy_stdout_log_file_path(&self) -> PathBuf {
|
|
||||||
self.logs_directory.join(Self::PROXY_STDOUT_LOG_FILE_NAME)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn proxy_stderr_log_file_path(&self) -> PathBuf {
|
|
||||||
self.logs_directory.join(Self::PROXY_STDERR_LOG_FILE_NAME)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl EthereumNode for KitchensinkNode {
|
impl EthereumNode for KitchensinkNode {
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn execute_transaction(
|
fn execute_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: alloy::rpc::types::TransactionRequest,
|
transaction: alloy::rpc::types::TransactionRequest,
|
||||||
@@ -337,7 +255,7 @@ impl EthereumNode for KitchensinkNode {
|
|||||||
tracing::debug!("Submitting transaction: {transaction:#?}");
|
tracing::debug!("Submitting transaction: {transaction:#?}");
|
||||||
|
|
||||||
tracing::info!("Submitting tx to kitchensink");
|
tracing::info!("Submitting tx to kitchensink");
|
||||||
let receipt = BlockingExecutor::execute(async move {
|
let receipt = execute_transaction(Box::pin(async move {
|
||||||
Ok(ProviderBuilder::new()
|
Ok(ProviderBuilder::new()
|
||||||
.wallet(wallet)
|
.wallet(wallet)
|
||||||
.connect(&url)
|
.connect(&url)
|
||||||
@@ -346,12 +264,11 @@ impl EthereumNode for KitchensinkNode {
|
|||||||
.await?
|
.await?
|
||||||
.get_receipt()
|
.get_receipt()
|
||||||
.await?)
|
.await?)
|
||||||
})?;
|
}));
|
||||||
tracing::info!(?receipt, "Submitted tx to kitchensink");
|
tracing::info!(?receipt, "Submitted tx to kitchensink");
|
||||||
receipt
|
receipt
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn trace_transaction(
|
fn trace_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: TransactionReceipt,
|
transaction: TransactionReceipt,
|
||||||
@@ -365,17 +282,16 @@ impl EthereumNode for KitchensinkNode {
|
|||||||
|
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
BlockingExecutor::execute(async move {
|
trace_transaction(Box::pin(async move {
|
||||||
Ok(ProviderBuilder::new()
|
Ok(ProviderBuilder::new()
|
||||||
.wallet(wallet)
|
.wallet(wallet)
|
||||||
.connect(&url)
|
.connect(&url)
|
||||||
.await?
|
.await?
|
||||||
.debug_trace_transaction(transaction.transaction_hash, trace_options)
|
.debug_trace_transaction(transaction.transaction_hash, trace_options)
|
||||||
.await?)
|
.await?)
|
||||||
})?
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn state_diff(&self, transaction: TransactionReceipt) -> anyhow::Result<DiffMode> {
|
fn state_diff(&self, transaction: TransactionReceipt) -> anyhow::Result<DiffMode> {
|
||||||
match self
|
match self
|
||||||
.trace_transaction(transaction)?
|
.trace_transaction(transaction)?
|
||||||
@@ -386,20 +302,11 @@ impl EthereumNode for KitchensinkNode {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
|
fn fetch_add_nonce(&self, address: Address) -> anyhow::Result<u64> {
|
||||||
let url = self.rpc_url.clone();
|
let url = self.rpc_url.clone();
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
|
let onchain_nonce = fetch_onchain_nonce(url, wallet, address)?;
|
||||||
ProviderBuilder::new()
|
|
||||||
.wallet(wallet)
|
|
||||||
.connect(&url)
|
|
||||||
.await?
|
|
||||||
.get_transaction_count(address)
|
|
||||||
.await
|
|
||||||
.map_err(Into::into)
|
|
||||||
})??;
|
|
||||||
|
|
||||||
let mut nonces = self.nonces.lock().unwrap();
|
let mut nonces = self.nonces.lock().unwrap();
|
||||||
let current = nonces.entry(address).or_insert(onchain_nonce);
|
let current = nonces.entry(address).or_insert(onchain_nonce);
|
||||||
@@ -414,7 +321,6 @@ impl Node for KitchensinkNode {
|
|||||||
let kitchensink_directory = config.directory().join(Self::BASE_DIRECTORY);
|
let kitchensink_directory = config.directory().join(Self::BASE_DIRECTORY);
|
||||||
let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
|
let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
|
||||||
let base_directory = kitchensink_directory.join(id.to_string());
|
let base_directory = kitchensink_directory.join(id.to_string());
|
||||||
let logs_directory = base_directory.join(Self::LOGS_DIRECTORY);
|
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
id,
|
id,
|
||||||
@@ -423,54 +329,30 @@ impl Node for KitchensinkNode {
|
|||||||
rpc_url: String::new(),
|
rpc_url: String::new(),
|
||||||
wallet: config.wallet(),
|
wallet: config.wallet(),
|
||||||
base_directory,
|
base_directory,
|
||||||
logs_directory,
|
|
||||||
process_substrate: None,
|
process_substrate: None,
|
||||||
process_proxy: None,
|
process_proxy: None,
|
||||||
nonces: Mutex::new(HashMap::new()),
|
nonces: Mutex::new(HashMap::new()),
|
||||||
// We know that we only need to be storing 4 files so we can specify that when creating
|
|
||||||
// the vector. It's the stdout and stderr of the substrate-node and the eth-rpc.
|
|
||||||
logs_file_to_flush: Vec::with_capacity(4),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn connection_string(&self) -> String {
|
fn connection_string(&self) -> String {
|
||||||
self.rpc_url.clone()
|
self.rpc_url.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
fn shutdown(mut self) -> anyhow::Result<()> {
|
||||||
fn shutdown(&mut self) -> anyhow::Result<()> {
|
|
||||||
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
|
||||||
if let Some(mut child) = self.process_proxy.take() {
|
if let Some(mut child) = self.process_proxy.take() {
|
||||||
child
|
let _ = child.kill();
|
||||||
.kill()
|
|
||||||
.map_err(|error| anyhow::anyhow!("Failed to kill the proxy process: {error:?}"))?;
|
|
||||||
}
|
}
|
||||||
if let Some(mut child) = self.process_substrate.take() {
|
if let Some(mut child) = self.process_substrate.take() {
|
||||||
child.kill().map_err(|error| {
|
let _ = child.kill();
|
||||||
anyhow::anyhow!("Failed to kill the substrate process: {error:?}")
|
|
||||||
})?;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Flushing the files that we're using for keeping the logs before shutdown.
|
|
||||||
for file in self.logs_file_to_flush.iter_mut() {
|
|
||||||
file.flush()?
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove the node's database so that subsequent runs do not run on the same database. We
|
|
||||||
// ignore the error just in case the directory didn't exist in the first place and therefore
|
|
||||||
// there's nothing to be deleted.
|
|
||||||
let _ = remove_dir_all(self.base_directory.join(Self::DATA_DIRECTORY));
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
||||||
self.init(&genesis)?.spawn_process()
|
self.init(&genesis)?.spawn_process()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn version(&self) -> anyhow::Result<String> {
|
fn version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.substrate_binary)
|
let output = Command::new(&self.substrate_binary)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
@@ -485,9 +367,13 @@ impl Node for KitchensinkNode {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for KitchensinkNode {
|
impl Drop for KitchensinkNode {
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
self.shutdown().expect("Failed to shutdown")
|
if let Some(mut child) = self.process_proxy.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
}
|
||||||
|
if let Some(mut child) = self.process_substrate.take() {
|
||||||
|
let _ = child.kill();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ pub trait Node: EthereumNode {
|
|||||||
/// Prune the node instance and related data.
|
/// Prune the node instance and related data.
|
||||||
///
|
///
|
||||||
/// Blocking until it's completely stopped.
|
/// Blocking until it's completely stopped.
|
||||||
fn shutdown(&mut self) -> anyhow::Result<()>;
|
fn shutdown(self) -> anyhow::Result<()>;
|
||||||
|
|
||||||
/// Returns the nodes connection string.
|
/// Returns the nodes connection string.
|
||||||
fn connection_string(&self) -> String;
|
fn connection_string(&self) -> String;
|
||||||
|
|||||||
Reference in New Issue
Block a user