mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-22 21:57:58 +00:00
Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4bf22f2d2b | |||
| baa11ad28f | |||
| c2e65f9e33 | |||
| 14888f9767 | |||
| 3e99d1c2a5 | |||
| 5f86ade1e0 | |||
| 43064022e8 | |||
| 4e234aa1bd | |||
| b204de5484 | |||
| 4d4398f83e |
Generated
+1
-1
@@ -3998,7 +3998,6 @@ dependencies = [
|
|||||||
"anyhow",
|
"anyhow",
|
||||||
"revive-dt-config",
|
"revive-dt-config",
|
||||||
"revive-dt-node-interaction",
|
"revive-dt-node-interaction",
|
||||||
"serde",
|
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"sp-core",
|
"sp-core",
|
||||||
"sp-runtime",
|
"sp-runtime",
|
||||||
@@ -4013,6 +4012,7 @@ version = "0.1.0"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"alloy",
|
"alloy",
|
||||||
"anyhow",
|
"anyhow",
|
||||||
|
"futures",
|
||||||
"once_cell",
|
"once_cell",
|
||||||
"tokio",
|
"tokio",
|
||||||
"tracing",
|
"tracing",
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ 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,9 +44,12 @@ 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.
|
||||||
|
#[derive(Debug)]
|
||||||
pub struct CompilerOutput<T: PartialEq + Eq + Hash> {
|
pub struct CompilerOutput<T: PartialEq + Eq + Hash> {
|
||||||
/// The solc standard JSON input.
|
/// The solc standard JSON input.
|
||||||
pub input: CompilerInput<T>,
|
pub input: CompilerInput<T>,
|
||||||
@@ -83,8 +86,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<String>,
|
allow_paths: Vec<PathBuf>,
|
||||||
base_path: Option<String>,
|
base_path: Option<PathBuf>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for Compiler<solc::Solc> {
|
impl Default for Compiler<solc::Solc> {
|
||||||
@@ -145,12 +148,12 @@ where
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn allow_path(mut self, path: String) -> Self {
|
pub fn allow_path(mut self, path: PathBuf) -> Self {
|
||||||
self.allow_paths.push(path);
|
self.allow_paths.push(path);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn base_path(mut self, base_path: String) -> Self {
|
pub fn base_path(mut self, base_path: PathBuf) -> Self {
|
||||||
self.base_path = Some(base_path);
|
self.base_path = Some(base_path);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
@@ -159,6 +162,8 @@ 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,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ use revive_dt_config::Arguments;
|
|||||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
use revive_solc_json_interface::SolcStandardJsonOutput;
|
||||||
|
|
||||||
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
||||||
|
#[derive(Debug)]
|
||||||
pub struct Resolc {
|
pub struct Resolc {
|
||||||
/// Path to the `resolc` executable
|
/// Path to the `resolc` executable
|
||||||
resolc_path: PathBuf,
|
resolc_path: PathBuf,
|
||||||
@@ -19,17 +20,32 @@ pub struct Resolc {
|
|||||||
impl SolidityCompiler for Resolc {
|
impl SolidityCompiler for Resolc {
|
||||||
type Options = Vec<String>;
|
type Options = Vec<String>;
|
||||||
|
|
||||||
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
fn build(
|
fn build(
|
||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
input: CompilerInput<Self::Options>,
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
let mut child = Command::new(&self.resolc_path)
|
let mut command = Command::new(&self.resolc_path);
|
||||||
.arg("--standard-json")
|
command
|
||||||
.args(&input.extra_options)
|
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.spawn()?;
|
.arg("--standard-json");
|
||||||
|
|
||||||
|
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)?;
|
||||||
@@ -55,12 +71,64 @@ impl SolidityCompiler for Resolc {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
let parsed: SolcStandardJsonOutput = serde_json::from_slice(&stdout).map_err(|e| {
|
let mut parsed =
|
||||||
anyhow::anyhow!(
|
serde_json::from_slice::<SolcStandardJsonOutput>(&stdout).map_err(|e| {
|
||||||
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
anyhow::anyhow!(
|
||||||
String::from_utf8_lossy(&stderr)
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
)
|
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}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// We need to do some post processing on the output to make it in the same format that solc
|
||||||
|
// outputs. More specifically, for each contract, the `.metadata` field should be replaced
|
||||||
|
// with the `.metadata.solc_metadata` field which contains the ABI and other information
|
||||||
|
// about the compiled contracts. We do this because we do not want any downstream logic to
|
||||||
|
// need to differentiate between which compiler is being used when extracting the ABI of the
|
||||||
|
// contracts.
|
||||||
|
if let Some(ref mut contracts) = parsed.contracts {
|
||||||
|
for (contract_path, contracts_map) in contracts.iter_mut() {
|
||||||
|
for (contract_name, contract_info) in contracts_map.iter_mut() {
|
||||||
|
let Some(metadata) = contract_info.metadata.take() else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Get the `solc_metadata` in the metadata of the contract.
|
||||||
|
let Some(solc_metadata) = metadata
|
||||||
|
.get("solc_metadata")
|
||||||
|
.and_then(|metadata| metadata.as_str())
|
||||||
|
else {
|
||||||
|
tracing::error!(
|
||||||
|
contract_path,
|
||||||
|
contract_name,
|
||||||
|
metadata = serde_json::to_string(&metadata).unwrap(),
|
||||||
|
"Encountered a contract compiled with resolc that has no solc_metadata"
|
||||||
|
);
|
||||||
|
anyhow::bail!(
|
||||||
|
"Contract {} compiled with resolc that has no solc_metadata",
|
||||||
|
contract_name
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Replace the original metadata with the new solc_metadata.
|
||||||
|
contract_info.metadata =
|
||||||
|
Some(serde_json::Value::String(solc_metadata.to_string()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!(
|
||||||
|
output = %serde_json::to_string(&parsed).unwrap(),
|
||||||
|
"Compiled successfully"
|
||||||
|
);
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
Ok(CompilerOutput {
|
||||||
input,
|
input,
|
||||||
|
|||||||
@@ -9,7 +9,9 @@ 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;
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
pub struct Solc {
|
pub struct Solc {
|
||||||
solc_path: PathBuf,
|
solc_path: PathBuf,
|
||||||
}
|
}
|
||||||
@@ -17,16 +19,32 @@ pub struct Solc {
|
|||||||
impl SolidityCompiler for Solc {
|
impl SolidityCompiler for Solc {
|
||||||
type Options = ();
|
type Options = ();
|
||||||
|
|
||||||
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
fn build(
|
fn build(
|
||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
input: CompilerInput<Self::Options>,
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
let mut child = Command::new(&self.solc_path)
|
let mut command = 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)?;
|
||||||
@@ -42,9 +60,31 @@ 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}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!(
|
||||||
|
output = %String::from_utf8_lossy(&output.stdout).to_string(),
|
||||||
|
"Compiled successfully"
|
||||||
|
);
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
Ok(CompilerOutput {
|
||||||
input,
|
input,
|
||||||
output: serde_json::from_slice(&output.stdout)?,
|
output: parsed,
|
||||||
error: None,
|
error: None,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+145
-83
@@ -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::primitives::Bytes;
|
use alloy::network::TransactionBuilder;
|
||||||
|
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, TxKind, map::HashMap},
|
primitives::{Address, map::HashMap},
|
||||||
rpc::types::{
|
rpc::types::{
|
||||||
TransactionRequest,
|
TransactionRequest,
|
||||||
trace::geth::{AccountState, DiffMode},
|
trace::geth::{AccountState, DiffMode},
|
||||||
@@ -69,14 +69,13 @@ where
|
|||||||
anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
|
anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
|
||||||
};
|
};
|
||||||
|
|
||||||
let mut compiler = Compiler::<T::Compiler>::new()
|
let compiler = Compiler::<T::Compiler>::new()
|
||||||
.base_path(metadata.directory()?.display().to_string())
|
.allow_path(metadata.directory()?)
|
||||||
.solc_optimizer(mode.solc_optimize());
|
.solc_optimizer(mode.solc_optimize());
|
||||||
|
|
||||||
for (file, _contract) in metadata.contract_sources()?.values() {
|
let compiler = FilesWithExtensionIterator::new(metadata.directory()?)
|
||||||
tracing::debug!("contract source {}", file.display());
|
.with_allowed_extension("sol")
|
||||||
compiler = compiler.with_source(file)?;
|
.try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
|
||||||
}
|
|
||||||
|
|
||||||
let mut task = CompilationTask {
|
let mut task = CompilationTask {
|
||||||
json_input: compiler.input(),
|
json_input: compiler.input(),
|
||||||
@@ -135,21 +134,17 @@ where
|
|||||||
std::any::type_name::<T>()
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
|
|
||||||
let tx = match input.legacy_transaction(
|
let tx =
|
||||||
self.config.network_id,
|
match input.legacy_transaction(nonce, &self.deployed_contracts, &self.deployed_abis) {
|
||||||
nonce,
|
Ok(tx) => {
|
||||||
&self.deployed_contracts,
|
tracing::debug!("Legacy transaction data: {tx:#?}");
|
||||||
&self.deployed_abis,
|
tx
|
||||||
) {
|
}
|
||||||
Ok(tx) => {
|
Err(err) => {
|
||||||
tracing::debug!("Legacy transaction data: {tx:#?}");
|
tracing::error!("Failed to construct legacy transaction: {err:?}");
|
||||||
tx
|
return Err(err);
|
||||||
}
|
}
|
||||||
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:?}");
|
||||||
|
|
||||||
@@ -184,12 +179,15 @@ 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<()> {
|
||||||
tracing::debug!(
|
let tracing_span = tracing::debug_span!(
|
||||||
"Deploying contracts {}, having address {} on node: {}",
|
"Deploying contracts",
|
||||||
&input.instance,
|
?input,
|
||||||
&input.caller,
|
node = std::any::type_name::<T>()
|
||||||
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!(
|
||||||
@@ -201,6 +199,9 @@ 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,
|
||||||
@@ -228,16 +229,14 @@ where
|
|||||||
std::any::type_name::<T>()
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
|
|
||||||
let tx = TransactionRequest {
|
// We are using alloy for building and submitting the transactions and it will
|
||||||
from: Some(input.caller),
|
// automatically fill in all of the missing fields from the provider that we
|
||||||
to: Some(TxKind::Create),
|
// are using.
|
||||||
gas_price: Some(5_000_000),
|
let code = alloy::hex::decode(&code)?;
|
||||||
gas: Some(5_000_000),
|
let tx = TransactionRequest::default()
|
||||||
chain_id: Some(self.config.network_id),
|
.nonce(nonce)
|
||||||
nonce: Some(nonce),
|
.from(input.caller)
|
||||||
input: TransactionInput::new(Bytes::from(code.into_bytes())),
|
.with_deploy_code(code);
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let receipt = match node.execute_transaction(tx) {
|
let receipt = match node.execute_transaction(tx) {
|
||||||
Ok(receipt) => receipt,
|
Ok(receipt) => receipt,
|
||||||
@@ -283,51 +282,40 @@ where
|
|||||||
std::any::type_name::<T>()
|
std::any::type_name::<T>()
|
||||||
);
|
);
|
||||||
|
|
||||||
if let Some(Value::String(metadata_json_str)) = &contract.metadata {
|
let Some(Value::String(metadata)) = &contract.metadata else {
|
||||||
tracing::trace!(
|
tracing::error!(?contract, "Contract does not have a metadata field");
|
||||||
"metadata found for contract {contract_name}, {metadata_json_str}"
|
anyhow::bail!("Contract does not have a metadata field: {contract:?}");
|
||||||
);
|
};
|
||||||
|
|
||||||
match serde_json::from_str::<serde_json::Value>(metadata_json_str) {
|
// Deserialize the solc metadata into a JSON object so we can get the ABI of the
|
||||||
Ok(metadata_json) => {
|
// contracts. If we fail to perform the deserialization then we return an error
|
||||||
if let Some(abi_value) =
|
// as there's no other way to handle this.
|
||||||
metadata_json.get("output").and_then(|o| o.get("abi"))
|
let Ok(metadata) = serde_json::from_str::<Value>(metadata) else {
|
||||||
{
|
tracing::error!(%metadata, "Failed to parse solc metadata into a structured value");
|
||||||
match serde_json::from_value::<JsonAbi>(abi_value.clone()) {
|
anyhow::bail!(
|
||||||
Ok(parsed_abi) => {
|
"Failed to parse solc metadata into a structured value {metadata}"
|
||||||
tracing::trace!(
|
);
|
||||||
"ABI found in metadata for contract {}",
|
};
|
||||||
&contract_name
|
|
||||||
);
|
// Accessing the ABI on the solc metadata and erroring if the accessing failed
|
||||||
self.deployed_abis
|
let Some(abi) = metadata.get("output").and_then(|value| value.get("abi"))
|
||||||
.insert(contract_name.clone(), parsed_abi);
|
else {
|
||||||
}
|
tracing::error!(%metadata, "Failed to access the .output.abi field of the solc metadata");
|
||||||
Err(err) => {
|
anyhow::bail!(
|
||||||
anyhow::bail!(
|
"Failed to access the .output.abi field of the solc metadata {metadata}"
|
||||||
"Failed to parse ABI from metadata for contract {}: {}",
|
);
|
||||||
contract_name,
|
};
|
||||||
err
|
|
||||||
);
|
// Deserialize the ABI object that we got from the unstructured JSON into a
|
||||||
}
|
// structured ABI object and error out if we fail.
|
||||||
}
|
let Ok(abi) = serde_json::from_value::<JsonAbi>(abi.clone()) else {
|
||||||
} else {
|
tracing::error!(%metadata, "Failed to deserialize ABI into a structured format");
|
||||||
anyhow::bail!(
|
anyhow::bail!(
|
||||||
"No ABI found in metadata for contract {}",
|
"Failed to deserialize ABI into a structured format {metadata}"
|
||||||
contract_name
|
);
|
||||||
);
|
};
|
||||||
}
|
|
||||||
}
|
self.deployed_abis.insert(contract_name.clone(), abi);
|
||||||
Err(err) => {
|
|
||||||
anyhow::bail!(
|
|
||||||
"Failed to parse metadata JSON string for contract {}: {}",
|
|
||||||
contract_name,
|
|
||||||
err
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
anyhow::bail!("No metadata found for contract {}", contract_name);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -479,3 +467,77 @@ 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()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+134
-244
@@ -1,15 +1,13 @@
|
|||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
use alloy::{
|
use alloy::{
|
||||||
hex,
|
json_abi::JsonAbi,
|
||||||
json_abi::{Function, JsonAbi},
|
network::TransactionBuilder,
|
||||||
primitives::{Address, Bytes, TxKind},
|
primitives::{Address, Bytes, U256},
|
||||||
rpc::types::{TransactionInput, TransactionRequest},
|
rpc::types::TransactionRequest,
|
||||||
};
|
};
|
||||||
use alloy_primitives::U256;
|
|
||||||
use alloy_sol_types::SolValue;
|
|
||||||
use semver::VersionReq;
|
use semver::VersionReq;
|
||||||
use serde::{Deserialize, de::Deserializer};
|
use serde::Deserialize;
|
||||||
use serde_json::Value;
|
use serde_json::Value;
|
||||||
|
|
||||||
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
||||||
@@ -19,7 +17,6 @@ pub struct Input {
|
|||||||
pub comment: Option<String>,
|
pub comment: Option<String>,
|
||||||
#[serde(default = "default_instance")]
|
#[serde(default = "default_instance")]
|
||||||
pub instance: String,
|
pub instance: String,
|
||||||
#[serde(deserialize_with = "deserialize_method")]
|
|
||||||
pub method: Method,
|
pub method: Method,
|
||||||
pub calldata: Option<Calldata>,
|
pub calldata: Option<Calldata>,
|
||||||
pub expected: Option<Expected>,
|
pub expected: Option<Expected>,
|
||||||
@@ -47,58 +44,28 @@ pub struct ExpectedOutput {
|
|||||||
#[serde(untagged)]
|
#[serde(untagged)]
|
||||||
pub enum Calldata {
|
pub enum Calldata {
|
||||||
Single(String),
|
Single(String),
|
||||||
Compound(Vec<CalldataArg>),
|
Compound(Vec<String>),
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
|
||||||
#[serde(untagged)]
|
|
||||||
pub enum CalldataArg {
|
|
||||||
Literal(String),
|
|
||||||
/// For example: `Contract.address`
|
|
||||||
AddressRef(String),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Specify how the contract is called.
|
/// Specify how the contract is called.
|
||||||
#[derive(Debug, Default, Clone, Eq, PartialEq)]
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
pub enum Method {
|
pub enum Method {
|
||||||
/// Initiate a deploy transaction, calling contracts constructor.
|
/// Initiate a deploy transaction, calling contracts constructor.
|
||||||
///
|
///
|
||||||
/// Indicated by `#deployer`.
|
/// Indicated by `#deployer`.
|
||||||
|
#[serde(rename = "#deployer")]
|
||||||
Deployer,
|
Deployer,
|
||||||
|
|
||||||
/// Does not calculate and insert a function selector.
|
/// Does not calculate and insert a function selector.
|
||||||
///
|
///
|
||||||
/// Indicated by `#fallback`.
|
/// Indicated by `#fallback`.
|
||||||
#[default]
|
#[default]
|
||||||
|
#[serde(rename = "#fallback")]
|
||||||
Fallback,
|
Fallback,
|
||||||
/// Call the public function with this selector.
|
|
||||||
///
|
|
||||||
/// Calculates the selector if neither deployer or fallback matches.
|
|
||||||
Function([u8; 4]),
|
|
||||||
}
|
|
||||||
|
|
||||||
fn deserialize_method<'de, D>(deserializer: D) -> Result<Method, D::Error>
|
/// Call the public function with the given name.
|
||||||
where
|
#[serde(untagged)]
|
||||||
D: Deserializer<'de>,
|
FunctionName(String),
|
||||||
{
|
|
||||||
Ok(match String::deserialize(deserializer)?.as_str() {
|
|
||||||
"#deployer" => Method::Deployer,
|
|
||||||
"#fallback" => Method::Fallback,
|
|
||||||
signature => {
|
|
||||||
let signature = if signature.ends_with(')') {
|
|
||||||
signature.to_string()
|
|
||||||
} else {
|
|
||||||
format!("{signature}()")
|
|
||||||
};
|
|
||||||
match Function::parse(&signature) {
|
|
||||||
Ok(function) => Method::Function(function.selector().0),
|
|
||||||
Err(error) => {
|
|
||||||
return Err(serde::de::Error::custom(format!(
|
|
||||||
"parsing function signature '{signature}' error: {error}"
|
|
||||||
)));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Input {
|
impl Input {
|
||||||
@@ -118,24 +85,32 @@ impl Input {
|
|||||||
deployed_abis: &HashMap<String, JsonAbi>,
|
deployed_abis: &HashMap<String, JsonAbi>,
|
||||||
deployed_contracts: &HashMap<String, Address>,
|
deployed_contracts: &HashMap<String, Address>,
|
||||||
) -> anyhow::Result<Bytes> {
|
) -> anyhow::Result<Bytes> {
|
||||||
let Method::Function(selector) = self.method else {
|
let Method::FunctionName(ref function_name) = self.method else {
|
||||||
return Ok(Bytes::default()); // fallback or deployer — no input
|
return Ok(Bytes::default()); // fallback or deployer — no input
|
||||||
};
|
};
|
||||||
|
|
||||||
let abi = deployed_abis
|
let Some(abi) = deployed_abis.get(&self.instance) else {
|
||||||
.get(&self.instance)
|
tracing::error!(
|
||||||
.ok_or_else(|| anyhow::anyhow!("ABI for instance '{}' not found", &self.instance))?;
|
contract_name = 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);
|
||||||
|
|
||||||
// Find function by selector
|
// We follow the same logic that's implemented in the matter-labs-tester where they resolve
|
||||||
|
// the function name into a function selector and they assume that he function doesn't have
|
||||||
|
// any existing overloads.
|
||||||
|
// https://github.com/matter-labs/era-compiler-tester/blob/1dfa7d07cba0734ca97e24704f12dd57f6990c2c/compiler_tester/src/test/case/input/mod.rs#L158-L190
|
||||||
let function = abi
|
let function = abi
|
||||||
.functions()
|
.functions()
|
||||||
.find(|f| f.selector().0 == selector)
|
.find(|function| function.name.starts_with(function_name))
|
||||||
.ok_or_else(|| {
|
.ok_or_else(|| {
|
||||||
anyhow::anyhow!(
|
anyhow::anyhow!(
|
||||||
"Function with selector {:?} not found in ABI for the instance {:?}",
|
"Function with name {:?} not found in ABI for the instance {:?}",
|
||||||
selector,
|
function_name,
|
||||||
&self.instance
|
&self.instance
|
||||||
)
|
)
|
||||||
})?;
|
})?;
|
||||||
@@ -160,90 +135,45 @@ impl Input {
|
|||||||
&self.instance
|
&self.instance
|
||||||
);
|
);
|
||||||
|
|
||||||
let mut encoded = selector.to_vec();
|
// Allocating a vector that we will be using for the calldata. The vector size will be:
|
||||||
|
// 4 bytes for the function selector.
|
||||||
|
// function.inputs.len() * 32 bytes for the arguments (each argument is a U256).
|
||||||
|
//
|
||||||
|
// We're using indices in the following code in order to avoid the need for us to allocate
|
||||||
|
// a new buffer for each one of the resolved arguments.
|
||||||
|
let mut calldata = Vec::<u8>::with_capacity(4 + calldata_args.len() * 32);
|
||||||
|
calldata.extend(function.selector().0);
|
||||||
|
|
||||||
for (i, param) in function.inputs.iter().enumerate() {
|
for (arg_idx, arg) in calldata_args.iter().enumerate() {
|
||||||
let arg = calldata_args.get(i).unwrap();
|
match resolve_argument(arg, deployed_contracts) {
|
||||||
let encoded_arg = match arg {
|
Ok(resolved) => {
|
||||||
CalldataArg::Literal(value) => match param.ty.as_str() {
|
calldata.extend(resolved.to_be_bytes::<32>());
|
||||||
"uint256" | "uint" => {
|
}
|
||||||
let val: U256 = value.parse()?;
|
Err(error) => {
|
||||||
val.abi_encode()
|
tracing::error!(arg, arg_idx, ?error, "Failed to resolve argument");
|
||||||
}
|
return Err(error);
|
||||||
"uint24" => {
|
|
||||||
let val: u32 = value.parse()?;
|
|
||||||
(val & 0xFFFFFF).abi_encode()
|
|
||||||
}
|
|
||||||
"bool" => {
|
|
||||||
let val: bool = value.parse()?;
|
|
||||||
val.abi_encode()
|
|
||||||
}
|
|
||||||
"address" => {
|
|
||||||
let addr: Address = value.parse()?;
|
|
||||||
addr.abi_encode()
|
|
||||||
}
|
|
||||||
"string" => value.abi_encode(),
|
|
||||||
"bytes32" => {
|
|
||||||
let val = hex::decode(value.trim_start_matches("0x"))?;
|
|
||||||
let mut fixed = [0u8; 32];
|
|
||||||
fixed[..val.len()].copy_from_slice(&val);
|
|
||||||
fixed.abi_encode()
|
|
||||||
}
|
|
||||||
"uint256[]" | "uint[]" => {
|
|
||||||
let nums: Vec<u64> = serde_json::from_str(value)?;
|
|
||||||
nums.abi_encode()
|
|
||||||
}
|
|
||||||
"bytes" => {
|
|
||||||
let val = hex::decode(value.trim_start_matches("0x"))?;
|
|
||||||
val.abi_encode()
|
|
||||||
}
|
|
||||||
_ => anyhow::bail!("Unsupported type: {}", param.ty),
|
|
||||||
},
|
|
||||||
CalldataArg::AddressRef(name) => {
|
|
||||||
let contract_name = name.trim_end_matches(".address");
|
|
||||||
let addr = deployed_contracts
|
|
||||||
.get(contract_name)
|
|
||||||
.copied()
|
|
||||||
.ok_or_else(|| {
|
|
||||||
anyhow::anyhow!("Address for '{}' not found", contract_name)
|
|
||||||
})?;
|
|
||||||
addr.abi_encode()
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
encoded.extend(encoded_arg);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(Bytes::from(encoded))
|
Ok(calldata.into())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// 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);
|
||||||
Ok(TransactionRequest {
|
match self.method {
|
||||||
from: Some(self.caller),
|
Method::Deployer => Ok(transaction_request.with_deploy_code(input_data)),
|
||||||
to,
|
_ => Ok(transaction_request
|
||||||
nonce: Some(nonce),
|
.to(self.instance_to_address(&self.instance, deployed_contracts)?)
|
||||||
chain_id: Some(chain_id),
|
.input(input_data.into())),
|
||||||
gas_price: Some(5_000_000),
|
}
|
||||||
gas: Some(5_000_000),
|
|
||||||
input: TransactionInput::new(input_data),
|
|
||||||
..Default::default()
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -255,12 +185,72 @@ fn default_caller() -> Address {
|
|||||||
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1".parse().unwrap()
|
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1".parse().unwrap()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// This function takes in the string calldata argument provided in the JSON input and resolves it
|
||||||
|
/// into a [`U256`] which is later used to construct the calldata.
|
||||||
|
///
|
||||||
|
/// # Note
|
||||||
|
///
|
||||||
|
/// This piece of code is taken from the matter-labs-tester repository which is licensed under MIT
|
||||||
|
/// or Apache. The original source code can be found here:
|
||||||
|
/// https://github.com/matter-labs/era-compiler-tester/blob/0ed598a27f6eceee7008deab3ff2311075a2ec69/compiler_tester/src/test/case/input/value.rs#L43-L146
|
||||||
|
fn resolve_argument(
|
||||||
|
value: &str,
|
||||||
|
deployed_contracts: &HashMap<String, Address>,
|
||||||
|
) -> anyhow::Result<U256> {
|
||||||
|
if let Some(instance) = value.strip_suffix(".address") {
|
||||||
|
Ok(U256::from_be_slice(
|
||||||
|
deployed_contracts
|
||||||
|
.get(instance)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("Instance `{}` not found", instance))?
|
||||||
|
.as_ref(),
|
||||||
|
))
|
||||||
|
} else if let Some(value) = value.strip_prefix('-') {
|
||||||
|
let value = U256::from_str_radix(value, 10)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid decimal literal after `-`: {}", error))?;
|
||||||
|
if value > U256::ONE << 255u8 {
|
||||||
|
anyhow::bail!("Decimal literal after `-` is too big");
|
||||||
|
}
|
||||||
|
let value = value
|
||||||
|
.checked_sub(U256::ONE)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("`-0` is invalid literal"))?;
|
||||||
|
Ok(U256::MAX.checked_sub(value).expect("Always valid"))
|
||||||
|
} else if let Some(value) = value.strip_prefix("0x") {
|
||||||
|
Ok(U256::from_str_radix(value, 16)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid hexadecimal literal: {}", error))?)
|
||||||
|
} else {
|
||||||
|
// TODO: This is a set of "variables" that we need to be able to resolve to be fully in
|
||||||
|
// compliance with the matter labs tester but we currently do not resolve them. We need to
|
||||||
|
// add logic that does their resolution in the future, perhaps through some kind of system
|
||||||
|
// context API that we pass down to the resolution function that allows it to make calls to
|
||||||
|
// the node to perform these resolutions.
|
||||||
|
let is_unsupported = [
|
||||||
|
"$CHAIN_ID",
|
||||||
|
"$GAS_LIMIT",
|
||||||
|
"$COINBASE",
|
||||||
|
"$DIFFICULTY",
|
||||||
|
"$BLOCK_HASH",
|
||||||
|
"$BLOCK_TIMESTAMP",
|
||||||
|
]
|
||||||
|
.iter()
|
||||||
|
.any(|var| value.starts_with(var));
|
||||||
|
|
||||||
|
if is_unsupported {
|
||||||
|
tracing::error!(value, "Unsupported variable used");
|
||||||
|
anyhow::bail!("Encountered {value} which is currently unsupported by the framework");
|
||||||
|
} else {
|
||||||
|
Ok(U256::from_str_radix(value, 10)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid decimal literal: {}", error))?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
use alloy::json_abi::JsonAbi;
|
use alloy::json_abi::JsonAbi;
|
||||||
use alloy_primitives::{address, keccak256};
|
use alloy_primitives::address;
|
||||||
|
use alloy_sol_types::SolValue;
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -278,16 +268,18 @@ mod tests {
|
|||||||
"#;
|
"#;
|
||||||
|
|
||||||
let parsed_abi: JsonAbi = serde_json::from_str(raw_metadata).unwrap();
|
let parsed_abi: JsonAbi = serde_json::from_str(raw_metadata).unwrap();
|
||||||
let selector = keccak256("store(uint256)".as_bytes())[0..4]
|
let selector = parsed_abi
|
||||||
.try_into()
|
.function("store")
|
||||||
.unwrap();
|
.unwrap()
|
||||||
|
.first()
|
||||||
|
.unwrap()
|
||||||
|
.selector()
|
||||||
|
.0;
|
||||||
|
|
||||||
let input = Input {
|
let input = Input {
|
||||||
instance: "Contract".to_string(),
|
instance: "Contract".to_string(),
|
||||||
method: Method::Function(selector),
|
method: Method::FunctionName("store".to_owned()),
|
||||||
calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
|
calldata: Some(Calldata::Compound(vec!["42".into()])),
|
||||||
"42".to_string(),
|
|
||||||
)])),
|
|
||||||
..Default::default()
|
..Default::default()
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -305,112 +297,6 @@ mod tests {
|
|||||||
assert_eq!(decoded.0, 42);
|
assert_eq!(decoded.0, 42);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_encoded_input_bool() {
|
|
||||||
let raw_abi = r#"[
|
|
||||||
{
|
|
||||||
"inputs": [{"name": "flag", "type": "bool"}],
|
|
||||||
"name": "toggle",
|
|
||||||
"outputs": [],
|
|
||||||
"stateMutability": "nonpayable",
|
|
||||||
"type": "function"
|
|
||||||
}
|
|
||||||
]"#;
|
|
||||||
|
|
||||||
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
|
||||||
let selector = keccak256("toggle(bool)".as_bytes())[0..4]
|
|
||||||
.try_into()
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
let input = Input {
|
|
||||||
instance: "Contract".to_string(),
|
|
||||||
method: Method::Function(selector),
|
|
||||||
calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
|
|
||||||
"true".to_string(),
|
|
||||||
)])),
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut abis = HashMap::new();
|
|
||||||
abis.insert("Contract".to_string(), parsed_abi);
|
|
||||||
let contracts = HashMap::new();
|
|
||||||
|
|
||||||
let encoded = input.encoded_input(&abis, &contracts).unwrap();
|
|
||||||
assert!(encoded.0.starts_with(&selector));
|
|
||||||
|
|
||||||
type T = (bool,);
|
|
||||||
let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
|
|
||||||
assert_eq!(decoded.0, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_encoded_input_string() {
|
|
||||||
let raw_abi = r#"[
|
|
||||||
{
|
|
||||||
"inputs": [{"name": "msg", "type": "string"}],
|
|
||||||
"name": "echo",
|
|
||||||
"outputs": [],
|
|
||||||
"stateMutability": "nonpayable",
|
|
||||||
"type": "function"
|
|
||||||
}
|
|
||||||
]"#;
|
|
||||||
|
|
||||||
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
|
||||||
let selector = keccak256("echo(string)".as_bytes())[0..4]
|
|
||||||
.try_into()
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
let input = Input {
|
|
||||||
instance: "Contract".to_string(),
|
|
||||||
method: Method::Function(selector),
|
|
||||||
calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
|
|
||||||
"hello".to_string(),
|
|
||||||
)])),
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut abis = HashMap::new();
|
|
||||||
abis.insert("Contract".to_string(), parsed_abi);
|
|
||||||
let contracts = HashMap::new();
|
|
||||||
|
|
||||||
let encoded = input.encoded_input(&abis, &contracts).unwrap();
|
|
||||||
assert!(encoded.0.starts_with(&selector));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_encoded_input_uint256_array() {
|
|
||||||
let raw_abi = r#"[
|
|
||||||
{
|
|
||||||
"inputs": [{"name": "arr", "type": "uint256[]"}],
|
|
||||||
"name": "sum",
|
|
||||||
"outputs": [],
|
|
||||||
"stateMutability": "nonpayable",
|
|
||||||
"type": "function"
|
|
||||||
}
|
|
||||||
]"#;
|
|
||||||
|
|
||||||
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
|
||||||
let selector = keccak256("sum(uint256[])".as_bytes())[0..4]
|
|
||||||
.try_into()
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
let input = Input {
|
|
||||||
instance: "Contract".to_string(),
|
|
||||||
method: Method::Function(selector),
|
|
||||||
calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
|
|
||||||
"[1,2,3]".to_string(),
|
|
||||||
)])),
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut abis = HashMap::new();
|
|
||||||
abis.insert("Contract".to_string(), parsed_abi);
|
|
||||||
let contracts = HashMap::new();
|
|
||||||
|
|
||||||
let encoded = input.encoded_input(&abis, &contracts).unwrap();
|
|
||||||
assert!(encoded.0.starts_with(&selector));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_encoded_input_address() {
|
fn test_encoded_input_address() {
|
||||||
let raw_abi = r#"[
|
let raw_abi = r#"[
|
||||||
@@ -424,16 +310,20 @@ mod tests {
|
|||||||
]"#;
|
]"#;
|
||||||
|
|
||||||
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
||||||
let selector = keccak256("send(address)".as_bytes())[0..4]
|
let selector = parsed_abi
|
||||||
.try_into()
|
.function("send")
|
||||||
.unwrap();
|
.unwrap()
|
||||||
|
.first()
|
||||||
|
.unwrap()
|
||||||
|
.selector()
|
||||||
|
.0;
|
||||||
|
|
||||||
let input = Input {
|
let input: Input = Input {
|
||||||
instance: "Contract".to_string(),
|
instance: "Contract".to_string(),
|
||||||
method: Method::Function(selector),
|
method: Method::FunctionName("send".to_owned()),
|
||||||
calldata: Some(Calldata::Compound(vec![CalldataArg::Literal(
|
calldata: Some(Calldata::Compound(vec![
|
||||||
"0x1000000000000000000000000000000000000001".to_string(),
|
"0x1000000000000000000000000000000000000001".to_string(),
|
||||||
)])),
|
])),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ 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 }
|
||||||
|
|||||||
@@ -0,0 +1,221 @@
|
|||||||
|
//! 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,12 +3,9 @@
|
|||||||
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;
|
|
||||||
|
|
||||||
pub mod nonce;
|
mod blocking_executor;
|
||||||
mod tokio_runtime;
|
pub use blocking_executor::*;
|
||||||
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 {
|
||||||
|
|||||||
@@ -1,55 +0,0 @@
|
|||||||
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}"))
|
|
||||||
}
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
//! 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(())
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
//! 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}"))
|
|
||||||
}
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
//! 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}"))
|
|
||||||
}
|
|
||||||
@@ -17,7 +17,6 @@ tokio = { workspace = true }
|
|||||||
revive-dt-node-interaction = { workspace = true }
|
revive-dt-node-interaction = { workspace = true }
|
||||||
revive-dt-config = { workspace = true }
|
revive-dt-config = { workspace = true }
|
||||||
|
|
||||||
serde = { workspace = true }
|
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
|
|
||||||
sp-core = { workspace = true }
|
sp-core = { workspace = true }
|
||||||
|
|||||||
+119
-45
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
collections::HashMap,
|
collections::HashMap,
|
||||||
fs::{File, create_dir_all, remove_dir_all},
|
fs::{File, OpenOptions, 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,7 +10,6 @@ use std::{
|
|||||||
Mutex,
|
Mutex,
|
||||||
atomic::{AtomicU32, Ordering},
|
atomic::{AtomicU32, Ordering},
|
||||||
},
|
},
|
||||||
thread,
|
|
||||||
time::{Duration, Instant},
|
time::{Duration, Instant},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -24,10 +23,8 @@ use alloy::{
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_node_interaction::{
|
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
||||||
EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
|
use tracing::Level;
|
||||||
transaction::execute_transaction,
|
|
||||||
};
|
|
||||||
|
|
||||||
use crate::Node;
|
use crate::Node;
|
||||||
|
|
||||||
@@ -45,6 +42,7 @@ 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>,
|
||||||
@@ -52,11 +50,17 @@ 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";
|
||||||
@@ -64,9 +68,14 @@ 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())?;
|
||||||
@@ -96,8 +105,24 @@ impl Instance {
|
|||||||
|
|
||||||
/// Spawn the go-ethereum node child process.
|
/// Spawn the go-ethereum node child process.
|
||||||
///
|
///
|
||||||
/// [Instance::init] must be called priorly.
|
/// [Instance::init] must be called prior.
|
||||||
|
#[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")
|
||||||
@@ -109,49 +134,67 @@ impl Instance {
|
|||||||
.arg("--nodiscover")
|
.arg("--nodiscover")
|
||||||
.arg("--maxpeers")
|
.arg("--maxpeers")
|
||||||
.arg("0")
|
.arg("0")
|
||||||
.stderr(Stdio::piped())
|
.stderr(stderr_logs_file.try_clone()?)
|
||||||
.stdout(Stdio::null())
|
.stdout(stdout_logs_file.try_clone()?)
|
||||||
.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 maximum_wait_time = Duration::from_millis(self.start_timeout);
|
|
||||||
let mut stderr = BufReader::new(child.stderr.take().expect("should be piped")).lines();
|
|
||||||
let error = loop {
|
|
||||||
let Some(Ok(line)) = stderr.next() else {
|
|
||||||
break "child process stderr reading error".to_string();
|
|
||||||
};
|
|
||||||
if line.contains(Self::ERROR_MARKER) {
|
|
||||||
break line;
|
|
||||||
}
|
|
||||||
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();
|
let logs_file = OpenOptions::new()
|
||||||
return Ok(self);
|
.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 mut stderr = BufReader::new(logs_file).lines();
|
||||||
|
loop {
|
||||||
|
if let Some(Ok(line)) = stderr.next() {
|
||||||
|
if line.contains(Self::ERROR_MARKER) {
|
||||||
|
anyhow::bail!("Failed to start geth {line}");
|
||||||
|
}
|
||||||
|
if line.contains(Self::READY_MARKER) {
|
||||||
|
return Ok(self);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
||||||
break "spawn timeout".to_string();
|
anyhow::bail!("Timeout in starting geth");
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let _ = child.kill();
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
||||||
anyhow::bail!("geth node #{} spawn error: {error}", self.id)
|
fn geth_stdout_log_file_path(&self) -> PathBuf {
|
||||||
|
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,
|
||||||
@@ -159,7 +202,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();
|
||||||
|
|
||||||
execute_transaction(Box::pin(async move {
|
BlockingExecutor::execute(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();
|
||||||
|
|
||||||
@@ -238,9 +281,10 @@ 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,
|
||||||
@@ -253,16 +297,17 @@ impl EthereumNode for Instance {
|
|||||||
});
|
});
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
trace_transaction(Box::pin(async move {
|
BlockingExecutor::execute(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,
|
||||||
@@ -276,11 +321,20 @@ 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 = fetch_onchain_nonce(connection_string, wallet, address)?;
|
let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
|
||||||
|
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);
|
||||||
@@ -299,6 +353,7 @@ 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,
|
||||||
@@ -307,22 +362,46 @@ 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()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn shutdown(self) -> anyhow::Result<()> {
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
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()?.wait_ready()?;
|
self.init(genesis)?.spawn_process()?;
|
||||||
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")
|
||||||
@@ -337,14 +416,9 @@ 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) {
|
||||||
tracing::info!(id = self.id, "Dropping node");
|
self.shutdown().expect("Failed to shutdown")
|
||||||
if let Some(child) = self.handle.as_mut() {
|
|
||||||
let _ = child.kill();
|
|
||||||
}
|
|
||||||
if self.base_directory.exists() {
|
|
||||||
let _ = remove_dir_all(&self.base_directory);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+160
-475
@@ -1,8 +1,8 @@
|
|||||||
use std::{
|
use std::{
|
||||||
collections::HashMap,
|
collections::HashMap,
|
||||||
fs::create_dir_all,
|
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
||||||
io::BufRead,
|
io::{BufRead, Write},
|
||||||
path::PathBuf,
|
path::{Path, PathBuf},
|
||||||
process::{Child, Command, Stdio},
|
process::{Child, Command, Stdio},
|
||||||
sync::{
|
sync::{
|
||||||
Mutex,
|
Mutex,
|
||||||
@@ -12,30 +12,22 @@ use std::{
|
|||||||
};
|
};
|
||||||
|
|
||||||
use alloy::{
|
use alloy::{
|
||||||
consensus::{BlockHeader, TxEnvelope},
|
|
||||||
hex,
|
hex,
|
||||||
network::{
|
network::EthereumWallet,
|
||||||
Ethereum, EthereumWallet, Network, TransactionBuilder, TransactionBuilderError,
|
primitives::Address,
|
||||||
UnbuiltTransactionError,
|
|
||||||
},
|
|
||||||
primitives::{Address, B64, B256, BlockNumber, Bloom, Bytes, U256},
|
|
||||||
providers::{Provider, ProviderBuilder, ext::DebugApi},
|
providers::{Provider, ProviderBuilder, ext::DebugApi},
|
||||||
rpc::types::{
|
rpc::types::{
|
||||||
TransactionReceipt,
|
TransactionReceipt,
|
||||||
eth::{Block, Header, Transaction},
|
|
||||||
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
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::{
|
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
||||||
EthereumNode, nonce::fetch_onchain_nonce, trace::trace_transaction,
|
|
||||||
transaction::execute_transaction,
|
|
||||||
};
|
|
||||||
|
|
||||||
use crate::Node;
|
use crate::Node;
|
||||||
|
|
||||||
@@ -49,13 +41,22 @@ 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";
|
||||||
@@ -65,11 +66,21 @@ 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")
|
||||||
@@ -118,6 +129,7 @@ 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;
|
||||||
@@ -126,8 +138,25 @@ 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 mut substrate_process = Command::new(&self.substrate_binary)
|
let kitchensink_stdout_logs_file = open_options
|
||||||
|
.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")
|
||||||
@@ -142,40 +171,61 @@ 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(Stdio::null())
|
.stdout(kitchensink_stdout_logs_file.try_clone()?)
|
||||||
.stderr(Stdio::piped())
|
.stderr(kitchensink_stderr_logs_file.try_clone()?)
|
||||||
.spawn()?;
|
.spawn()?
|
||||||
|
.into();
|
||||||
|
|
||||||
// Give the node a moment to boot
|
// Give the node a moment to boot
|
||||||
Self::wait_ready(
|
if let Err(error) = Self::wait_ready(
|
||||||
&mut substrate_process,
|
self.kitchensink_stderr_log_file_path().as_path(),
|
||||||
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 mut proxy_process = Command::new(&self.eth_proxy_binary)
|
let eth_proxy_stdout_logs_file = open_options
|
||||||
|
.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(Stdio::null())
|
.stdout(eth_proxy_stdout_logs_file.try_clone()?)
|
||||||
.stderr(Stdio::piped())
|
.stderr(eth_proxy_stderr_logs_file.try_clone()?)
|
||||||
.spawn()?;
|
.spawn()?
|
||||||
|
.into();
|
||||||
|
|
||||||
Self::wait_ready(
|
if let Err(error) = Self::wait_ready(
|
||||||
&mut proxy_process,
|
self.proxy_stderr_log_file_path().as_path(),
|
||||||
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.process_substrate = Some(substrate_process);
|
self.logs_file_to_flush.extend([
|
||||||
self.process_proxy = Some(proxy_process);
|
kitchensink_stdout_logs_file,
|
||||||
|
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,
|
||||||
@@ -216,27 +266,30 @@ impl KitchensinkNode {
|
|||||||
Ok(account_id.to_ss58check())
|
Ok(account_id.to_ss58check())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn wait_ready(child: &mut Child, marker: &str, timeout: Duration) -> anyhow::Result<()> {
|
fn wait_ready(logs_file_path: &Path, marker: &str, timeout: Duration) -> anyhow::Result<()> {
|
||||||
let start_time = std::time::Instant::now();
|
let start_time = std::time::Instant::now();
|
||||||
let stderr = child.stderr.take().expect("stderr must be piped");
|
let logs_file = OpenOptions::new()
|
||||||
|
.read(true)
|
||||||
|
.write(false)
|
||||||
|
.append(false)
|
||||||
|
.truncate(false)
|
||||||
|
.open(logs_file_path)?;
|
||||||
|
|
||||||
let mut lines = std::io::BufReader::new(stderr).lines();
|
let mut lines = std::io::BufReader::new(logs_file).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")
|
||||||
@@ -248,9 +301,32 @@ 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,
|
||||||
@@ -261,9 +337,8 @@ 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 = execute_transaction(Box::pin(async move {
|
let receipt = BlockingExecutor::execute(async move {
|
||||||
Ok(ProviderBuilder::new()
|
Ok(ProviderBuilder::new()
|
||||||
.network::<KitchenSinkNetwork>()
|
|
||||||
.wallet(wallet)
|
.wallet(wallet)
|
||||||
.connect(&url)
|
.connect(&url)
|
||||||
.await?
|
.await?
|
||||||
@@ -271,11 +346,12 @@ 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,
|
||||||
@@ -289,17 +365,17 @@ impl EthereumNode for KitchensinkNode {
|
|||||||
|
|
||||||
let wallet = self.wallet.clone();
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
trace_transaction(Box::pin(async move {
|
BlockingExecutor::execute(async move {
|
||||||
Ok(ProviderBuilder::new()
|
Ok(ProviderBuilder::new()
|
||||||
.network::<KitchenSinkNetwork>()
|
|
||||||
.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)?
|
||||||
@@ -310,11 +386,20 @@ 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 = fetch_onchain_nonce(url, wallet, address)?;
|
let onchain_nonce = BlockingExecutor::execute::<anyhow::Result<_>>(async move {
|
||||||
|
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);
|
||||||
@@ -329,6 +414,7 @@ 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,
|
||||||
@@ -337,30 +423,54 @@ 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()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn shutdown(mut self) -> anyhow::Result<()> {
|
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
||||||
|
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() {
|
||||||
let _ = child.kill();
|
child
|
||||||
|
.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() {
|
||||||
let _ = child.kill();
|
child.kill().map_err(|error| {
|
||||||
|
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")
|
||||||
@@ -375,434 +485,9 @@ 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) {
|
||||||
if let Some(mut child) = self.process_proxy.take() {
|
self.shutdown().expect("Failed to shutdown")
|
||||||
let _ = child.kill();
|
|
||||||
}
|
|
||||||
if let Some(mut child) = self.process_substrate.take() {
|
|
||||||
let _ = child.kill();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
||||||
struct KitchenSinkNetwork;
|
|
||||||
|
|
||||||
impl Network for KitchenSinkNetwork {
|
|
||||||
type TxType = <Ethereum as Network>::TxType;
|
|
||||||
|
|
||||||
type TxEnvelope = <Ethereum as Network>::TxEnvelope;
|
|
||||||
|
|
||||||
type UnsignedTx = <Ethereum as Network>::UnsignedTx;
|
|
||||||
|
|
||||||
type ReceiptEnvelope = <Ethereum as Network>::ReceiptEnvelope;
|
|
||||||
|
|
||||||
type Header = KitchenSinkHeader;
|
|
||||||
|
|
||||||
type TransactionRequest = <Ethereum as Network>::TransactionRequest;
|
|
||||||
|
|
||||||
type TransactionResponse = <Ethereum as Network>::TransactionResponse;
|
|
||||||
|
|
||||||
type ReceiptResponse = <Ethereum as Network>::ReceiptResponse;
|
|
||||||
|
|
||||||
type HeaderResponse = Header<KitchenSinkHeader>;
|
|
||||||
|
|
||||||
type BlockResponse = Block<Transaction<TxEnvelope>, Header<KitchenSinkHeader>>;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TransactionBuilder<KitchenSinkNetwork> for <Ethereum as Network>::TransactionRequest {
|
|
||||||
fn chain_id(&self) -> Option<alloy::primitives::ChainId> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::chain_id(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_chain_id(&mut self, chain_id: alloy::primitives::ChainId) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_chain_id(
|
|
||||||
self, chain_id,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn nonce(&self) -> Option<u64> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::nonce(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_nonce(&mut self, nonce: u64) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_nonce(
|
|
||||||
self, nonce,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn input(&self) -> Option<&alloy::primitives::Bytes> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::input(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_input<T: Into<alloy::primitives::Bytes>>(&mut self, input: T) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_input(
|
|
||||||
self, input,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn from(&self) -> Option<Address> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::from(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_from(&mut self, from: Address) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_from(
|
|
||||||
self, from,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn kind(&self) -> Option<alloy::primitives::TxKind> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::kind(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn clear_kind(&mut self) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::clear_kind(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_kind(&mut self, kind: alloy::primitives::TxKind) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_kind(
|
|
||||||
self, kind,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn value(&self) -> Option<alloy::primitives::U256> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::value(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_value(&mut self, value: alloy::primitives::U256) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_value(
|
|
||||||
self, value,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn gas_price(&self) -> Option<u128> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::gas_price(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_gas_price(&mut self, gas_price: u128) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_gas_price(
|
|
||||||
self, gas_price,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn max_fee_per_gas(&self) -> Option<u128> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::max_fee_per_gas(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_max_fee_per_gas(&mut self, max_fee_per_gas: u128) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_max_fee_per_gas(
|
|
||||||
self, max_fee_per_gas
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn max_priority_fee_per_gas(&self) -> Option<u128> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::max_priority_fee_per_gas(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_max_priority_fee_per_gas(&mut self, max_priority_fee_per_gas: u128) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_max_priority_fee_per_gas(
|
|
||||||
self, max_priority_fee_per_gas
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn gas_limit(&self) -> Option<u64> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::gas_limit(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_gas_limit(&mut self, gas_limit: u64) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_gas_limit(
|
|
||||||
self, gas_limit,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn access_list(&self) -> Option<&alloy::rpc::types::AccessList> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::access_list(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_access_list(&mut self, access_list: alloy::rpc::types::AccessList) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::set_access_list(
|
|
||||||
self,
|
|
||||||
access_list,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn complete_type(
|
|
||||||
&self,
|
|
||||||
ty: <KitchenSinkNetwork as Network>::TxType,
|
|
||||||
) -> Result<(), Vec<&'static str>> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::complete_type(
|
|
||||||
self, ty,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn can_submit(&self) -> bool {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::can_submit(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn can_build(&self) -> bool {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::can_build(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn output_tx_type(&self) -> <KitchenSinkNetwork as Network>::TxType {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::output_tx_type(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn output_tx_type_checked(&self) -> Option<<KitchenSinkNetwork as Network>::TxType> {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::output_tx_type_checked(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn prep_for_submission(&mut self) {
|
|
||||||
<<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::prep_for_submission(
|
|
||||||
self,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn build_unsigned(
|
|
||||||
self,
|
|
||||||
) -> alloy::network::BuildResult<<KitchenSinkNetwork as Network>::UnsignedTx, KitchenSinkNetwork>
|
|
||||||
{
|
|
||||||
let result = <<Ethereum as Network>::TransactionRequest as TransactionBuilder<Ethereum>>::build_unsigned(
|
|
||||||
self,
|
|
||||||
);
|
|
||||||
match result {
|
|
||||||
Ok(unsigned_tx) => Ok(unsigned_tx),
|
|
||||||
Err(UnbuiltTransactionError { request, error }) => {
|
|
||||||
Err(UnbuiltTransactionError::<KitchenSinkNetwork> {
|
|
||||||
request,
|
|
||||||
error: match error {
|
|
||||||
TransactionBuilderError::InvalidTransactionRequest(tx_type, items) => {
|
|
||||||
TransactionBuilderError::InvalidTransactionRequest(tx_type, items)
|
|
||||||
}
|
|
||||||
TransactionBuilderError::UnsupportedSignatureType => {
|
|
||||||
TransactionBuilderError::UnsupportedSignatureType
|
|
||||||
}
|
|
||||||
TransactionBuilderError::Signer(error) => {
|
|
||||||
TransactionBuilderError::Signer(error)
|
|
||||||
}
|
|
||||||
TransactionBuilderError::Custom(error) => {
|
|
||||||
TransactionBuilderError::Custom(error)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn build<W: alloy::network::NetworkWallet<KitchenSinkNetwork>>(
|
|
||||||
self,
|
|
||||||
wallet: &W,
|
|
||||||
) -> Result<
|
|
||||||
<KitchenSinkNetwork as Network>::TxEnvelope,
|
|
||||||
TransactionBuilderError<KitchenSinkNetwork>,
|
|
||||||
> {
|
|
||||||
Ok(wallet.sign_request(self).await?)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
|
||||||
#[serde(rename_all = "camelCase")]
|
|
||||||
pub struct KitchenSinkHeader {
|
|
||||||
/// The Keccak 256-bit hash of the parent
|
|
||||||
/// block’s header, in its entirety; formally Hp.
|
|
||||||
pub parent_hash: B256,
|
|
||||||
/// The Keccak 256-bit hash of the ommers list portion of this block; formally Ho.
|
|
||||||
#[serde(rename = "sha3Uncles", alias = "ommersHash")]
|
|
||||||
pub ommers_hash: B256,
|
|
||||||
/// The 160-bit address to which all fees collected from the successful mining of this block
|
|
||||||
/// be transferred; formally Hc.
|
|
||||||
#[serde(rename = "miner", alias = "beneficiary")]
|
|
||||||
pub beneficiary: Address,
|
|
||||||
/// The Keccak 256-bit hash of the root node of the state trie, after all transactions are
|
|
||||||
/// executed and finalisations applied; formally Hr.
|
|
||||||
pub state_root: B256,
|
|
||||||
/// The Keccak 256-bit hash of the root node of the trie structure populated with each
|
|
||||||
/// transaction in the transactions list portion of the block; formally Ht.
|
|
||||||
pub transactions_root: B256,
|
|
||||||
/// The Keccak 256-bit hash of the root node of the trie structure populated with the receipts
|
|
||||||
/// of each transaction in the transactions list portion of the block; formally He.
|
|
||||||
pub receipts_root: B256,
|
|
||||||
/// The Bloom filter composed from indexable information (logger address and log topics)
|
|
||||||
/// contained in each log entry from the receipt of each transaction in the transactions list;
|
|
||||||
/// formally Hb.
|
|
||||||
pub logs_bloom: Bloom,
|
|
||||||
/// A scalar value corresponding to the difficulty level of this block. This can be calculated
|
|
||||||
/// from the previous block’s difficulty level and the timestamp; formally Hd.
|
|
||||||
pub difficulty: U256,
|
|
||||||
/// A scalar value equal to the number of ancestor blocks. The genesis block has a number of
|
|
||||||
/// zero; formally Hi.
|
|
||||||
#[serde(with = "alloy::serde::quantity")]
|
|
||||||
pub number: BlockNumber,
|
|
||||||
/// A scalar value equal to the current limit of gas expenditure per block; formally Hl.
|
|
||||||
// This is the main difference over the Ethereum network implementation. We use u128 here and
|
|
||||||
// not u64.
|
|
||||||
#[serde(with = "alloy::serde::quantity")]
|
|
||||||
pub gas_limit: u128,
|
|
||||||
/// A scalar value equal to the total gas used in transactions in this block; formally Hg.
|
|
||||||
#[serde(with = "alloy::serde::quantity")]
|
|
||||||
pub gas_used: u64,
|
|
||||||
/// A scalar value equal to the reasonable output of Unix’s time() at this block’s inception;
|
|
||||||
/// formally Hs.
|
|
||||||
#[serde(with = "alloy::serde::quantity")]
|
|
||||||
pub timestamp: u64,
|
|
||||||
/// An arbitrary byte array containing data relevant to this block. This must be 32 bytes or
|
|
||||||
/// fewer; formally Hx.
|
|
||||||
pub extra_data: Bytes,
|
|
||||||
/// A 256-bit hash which, combined with the
|
|
||||||
/// nonce, proves that a sufficient amount of computation has been carried out on this block;
|
|
||||||
/// formally Hm.
|
|
||||||
pub mix_hash: B256,
|
|
||||||
/// A 64-bit value which, combined with the mixhash, proves that a sufficient amount of
|
|
||||||
/// computation has been carried out on this block; formally Hn.
|
|
||||||
pub nonce: B64,
|
|
||||||
/// A scalar representing EIP1559 base fee which can move up or down each block according
|
|
||||||
/// to a formula which is a function of gas used in parent block and gas target
|
|
||||||
/// (block gas limit divided by elasticity multiplier) of parent block.
|
|
||||||
/// The algorithm results in the base fee per gas increasing when blocks are
|
|
||||||
/// above the gas target, and decreasing when blocks are below the gas target. The base fee per
|
|
||||||
/// gas is burned.
|
|
||||||
#[serde(
|
|
||||||
default,
|
|
||||||
with = "alloy::serde::quantity::opt",
|
|
||||||
skip_serializing_if = "Option::is_none"
|
|
||||||
)]
|
|
||||||
pub base_fee_per_gas: Option<u64>,
|
|
||||||
/// The Keccak 256-bit hash of the withdrawals list portion of this block.
|
|
||||||
/// <https://eips.ethereum.org/EIPS/eip-4895>
|
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
||||||
pub withdrawals_root: Option<B256>,
|
|
||||||
/// The total amount of blob gas consumed by the transactions within the block, added in
|
|
||||||
/// EIP-4844.
|
|
||||||
#[serde(
|
|
||||||
default,
|
|
||||||
with = "alloy::serde::quantity::opt",
|
|
||||||
skip_serializing_if = "Option::is_none"
|
|
||||||
)]
|
|
||||||
pub blob_gas_used: Option<u64>,
|
|
||||||
/// A running total of blob gas consumed in excess of the target, prior to the block. Blocks
|
|
||||||
/// with above-target blob gas consumption increase this value, blocks with below-target blob
|
|
||||||
/// gas consumption decrease it (bounded at 0). This was added in EIP-4844.
|
|
||||||
#[serde(
|
|
||||||
default,
|
|
||||||
with = "alloy::serde::quantity::opt",
|
|
||||||
skip_serializing_if = "Option::is_none"
|
|
||||||
)]
|
|
||||||
pub excess_blob_gas: Option<u64>,
|
|
||||||
/// The hash of the parent beacon block's root is included in execution blocks, as proposed by
|
|
||||||
/// EIP-4788.
|
|
||||||
///
|
|
||||||
/// This enables trust-minimized access to consensus state, supporting staking pools, bridges,
|
|
||||||
/// and more.
|
|
||||||
///
|
|
||||||
/// The beacon roots contract handles root storage, enhancing Ethereum's functionalities.
|
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
||||||
pub parent_beacon_block_root: Option<B256>,
|
|
||||||
/// The Keccak 256-bit hash of the an RLP encoded list with each
|
|
||||||
/// [EIP-7685] request in the block body.
|
|
||||||
///
|
|
||||||
/// [EIP-7685]: https://eips.ethereum.org/EIPS/eip-7685
|
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
||||||
pub requests_hash: Option<B256>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl BlockHeader for KitchenSinkHeader {
|
|
||||||
fn parent_hash(&self) -> B256 {
|
|
||||||
self.parent_hash
|
|
||||||
}
|
|
||||||
|
|
||||||
fn ommers_hash(&self) -> B256 {
|
|
||||||
self.ommers_hash
|
|
||||||
}
|
|
||||||
|
|
||||||
fn beneficiary(&self) -> Address {
|
|
||||||
self.beneficiary
|
|
||||||
}
|
|
||||||
|
|
||||||
fn state_root(&self) -> B256 {
|
|
||||||
self.state_root
|
|
||||||
}
|
|
||||||
|
|
||||||
fn transactions_root(&self) -> B256 {
|
|
||||||
self.transactions_root
|
|
||||||
}
|
|
||||||
|
|
||||||
fn receipts_root(&self) -> B256 {
|
|
||||||
self.receipts_root
|
|
||||||
}
|
|
||||||
|
|
||||||
fn withdrawals_root(&self) -> Option<B256> {
|
|
||||||
self.withdrawals_root
|
|
||||||
}
|
|
||||||
|
|
||||||
fn logs_bloom(&self) -> Bloom {
|
|
||||||
self.logs_bloom
|
|
||||||
}
|
|
||||||
|
|
||||||
fn difficulty(&self) -> U256 {
|
|
||||||
self.difficulty
|
|
||||||
}
|
|
||||||
|
|
||||||
fn number(&self) -> BlockNumber {
|
|
||||||
self.number
|
|
||||||
}
|
|
||||||
|
|
||||||
// There's sadly nothing that we can do about this. We're required to implement this trait on
|
|
||||||
// any type that represents a header and the gas limit type used here is a u64.
|
|
||||||
fn gas_limit(&self) -> u64 {
|
|
||||||
self.gas_limit.try_into().unwrap_or(u64::MAX)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn gas_used(&self) -> u64 {
|
|
||||||
self.gas_used
|
|
||||||
}
|
|
||||||
|
|
||||||
fn timestamp(&self) -> u64 {
|
|
||||||
self.timestamp
|
|
||||||
}
|
|
||||||
|
|
||||||
fn mix_hash(&self) -> Option<B256> {
|
|
||||||
Some(self.mix_hash)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn nonce(&self) -> Option<B64> {
|
|
||||||
Some(self.nonce)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn base_fee_per_gas(&self) -> Option<u64> {
|
|
||||||
self.base_fee_per_gas
|
|
||||||
}
|
|
||||||
|
|
||||||
fn blob_gas_used(&self) -> Option<u64> {
|
|
||||||
self.blob_gas_used
|
|
||||||
}
|
|
||||||
|
|
||||||
fn excess_blob_gas(&self) -> Option<u64> {
|
|
||||||
self.excess_blob_gas
|
|
||||||
}
|
|
||||||
|
|
||||||
fn parent_beacon_block_root(&self) -> Option<B256> {
|
|
||||||
self.parent_beacon_block_root
|
|
||||||
}
|
|
||||||
|
|
||||||
fn requests_hash(&self) -> Option<B256> {
|
|
||||||
self.requests_hash
|
|
||||||
}
|
|
||||||
|
|
||||||
fn extra_data(&self) -> &Bytes {
|
|
||||||
&self.extra_data
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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(self) -> anyhow::Result<()>;
|
fn shutdown(&mut 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