mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-25 22:07:59 +00:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4bf22f2d2b | |||
| baa11ad28f | |||
| c2e65f9e33 | |||
| 5f86ade1e0 | |||
| 43064022e8 | |||
| 4d4398f83e |
@@ -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,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+120
-55
@@ -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(),
|
||||||
@@ -180,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!(
|
||||||
@@ -280,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);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -476,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()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+125
-224
@@ -1,16 +1,13 @@
|
|||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
use alloy::{
|
use alloy::{
|
||||||
hex,
|
json_abi::JsonAbi,
|
||||||
json_abi::{Function, JsonAbi},
|
|
||||||
network::TransactionBuilder,
|
network::TransactionBuilder,
|
||||||
primitives::{Address, Bytes},
|
primitives::{Address, Bytes, U256},
|
||||||
rpc::types::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)]
|
||||||
@@ -20,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>,
|
||||||
@@ -48,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 {
|
||||||
@@ -119,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
|
||||||
)
|
)
|
||||||
})?;
|
})?;
|
||||||
@@ -161,61 +135,28 @@ 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.
|
||||||
@@ -244,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]
|
||||||
@@ -267,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()
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -294,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#"[
|
||||||
@@ -413,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()
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user