Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: debugger breaks when source file has multiple contract definitions #7550

Merged
merged 3 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 34 additions & 17 deletions crates/common/src/compile.rs
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,10 @@ impl ProjectCompiler {
pub struct ContractSources {
/// Map over artifacts' contract names -> vector of file IDs
pub ids_by_name: HashMap<String, Vec<u32>>,
/// Map over file_id -> (source code, contract)
pub sources_by_id: FxHashMap<u32, (String, ContractBytecodeSome)>,
/// Map over file_id -> source code
pub sources_by_id: FxHashMap<u32, String>,
/// Map over file_id -> contract name -> bytecode
pub artifacts_by_id: FxHashMap<u32, HashMap<String, ContractBytecodeSome>>,
}

impl ContractSources {
Expand Down Expand Up @@ -327,30 +329,45 @@ impl ContractSources {
bytecode: ContractBytecodeSome,
) {
self.ids_by_name.entry(artifact_id.name.clone()).or_default().push(file_id);
self.sources_by_id.insert(file_id, (source, bytecode));
self.sources_by_id.insert(file_id, source);
self.artifacts_by_id.entry(file_id).or_default().insert(artifact_id.name.clone(), bytecode);
}

/// Returns the source for a contract by file ID.
pub fn get(&self, id: u32) -> Option<&(String, ContractBytecodeSome)> {
pub fn get(&self, id: u32) -> Option<&String> {
self.sources_by_id.get(&id)
}

/// Returns all sources for a contract by name.
pub fn get_sources(
&self,
name: &str,
) -> Option<impl Iterator<Item = (u32, &(String, ContractBytecodeSome))>> {
self.ids_by_name
.get(name)
.map(|ids| ids.iter().filter_map(|id| Some((*id, self.sources_by_id.get(id)?))))
}

/// Returns all (name, source) pairs.
pub fn entries(&self) -> impl Iterator<Item = (String, &(String, ContractBytecodeSome))> {
self.ids_by_name.iter().flat_map(|(name, ids)| {
ids.iter().filter_map(|id| self.sources_by_id.get(id).map(|s| (name.clone(), s)))
pub fn get_sources<'a>(
&'a self,
name: &'a str,
) -> Option<impl Iterator<Item = (u32, &'_ str, &'_ ContractBytecodeSome)>> {
self.ids_by_name.get(name).map(|ids| {
ids.iter().filter_map(|id| {
Some((
*id,
self.sources_by_id.get(id)?.as_ref(),
self.artifacts_by_id.get(id)?.get(name)?,
))
})
})
}

/// Returns all (name, source, bytecode) sets.
pub fn entries(&self) -> impl Iterator<Item = (&str, &str, &ContractBytecodeSome)> {
self.artifacts_by_id
.iter()
.filter_map(|(id, artifacts)| {
let source = self.sources_by_id.get(id)?;
Some(
artifacts
.iter()
.map(move |(name, bytecode)| (name.as_ref(), source.as_ref(), bytecode)),
)
})
.flatten()
}
}

// https://eips.ethereum.org/EIPS/eip-170
Expand Down
4 changes: 2 additions & 2 deletions crates/debugger/src/tui/draw.rs
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ impl DebuggerContext<'_> {
let is_create = matches!(self.call_kind(), CallKind::Create | CallKind::Create2);
let pc = self.current_step().pc;
let Some((source_element, source_code)) =
files_source_code.find_map(|(file_id, (source_code, contract_source))| {
files_source_code.find_map(|(file_id, source_code, contract_source)| {
let bytecode = if is_create {
&contract_source.bytecode
} else {
Expand All @@ -369,7 +369,7 @@ impl DebuggerContext<'_> {
.contracts_sources
.sources_by_id
.get(&(source_element.index?))
.map(|(source_code, _)| (source_element.clone(), source_code))
.map(|source_code| (source_element.clone(), source_code.as_ref()))
})
})
else {
Expand Down
4 changes: 2 additions & 2 deletions crates/debugger/src/tui/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ impl Debugger {
) -> Self {
let pc_ic_maps = contracts_sources
.entries()
.filter_map(|(contract_name, (_, contract))| {
.filter_map(|(contract_name, _, contract)| {
Some((
contract_name.clone(),
contract_name.to_owned(),
(
PcIcMap::new(SpecId::LATEST, contract.bytecode.bytes()?),
PcIcMap::new(SpecId::LATEST, contract.deployed_bytecode.bytes()?),
Expand Down
Loading