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

feat(solc): add source map access functions #1253

Merged
merged 1 commit into from
May 12, 2022
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
17 changes: 17 additions & 0 deletions ethers-solc/src/artifact_output/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ use crate::{
SourceFile,
},
compile::output::{contracts::VersionedContracts, sources::VersionedSourceFiles},
sourcemap::{SourceMap, SyntaxError},
};
pub use configurable::*;

Expand Down Expand Up @@ -398,6 +399,22 @@ pub trait Artifact {
fn get_abi(&self) -> Option<Cow<Abi>> {
self.get_contract_bytecode().abi
}

/// Returns the `sourceMap` of the contract
///
/// Returns `None` if no `sourceMap` string was included in the compiler output
/// Returns `Some(Err)` if parsing the sourcemap failed
fn get_source_map(&self) -> Option<std::result::Result<SourceMap, SyntaxError>> {
self.get_bytecode()?.source_map()
}

/// Returns the `sourceMap` as str if it was included in the compiler output
fn get_source_map_str(&self) -> Option<Cow<str>> {
match self.get_bytecode()? {
Cow::Borrowed(code) => code.source_map.as_deref().map(Cow::Borrowed),
Cow::Owned(code) => code.source_map.map(Cow::Owned),
}
}
}

impl<T> Artifact for T
Expand Down
7 changes: 7 additions & 0 deletions ethers-solc/src/artifacts/bytecode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ pub struct CompactBytecode {
}

impl CompactBytecode {
/// Returns the parsed source map
///
/// See also <https://docs.soliditylang.org/en/v0.8.10/internals/source_mappings.html>
pub fn source_map(&self) -> Option<Result<SourceMap, SyntaxError>> {
self.source_map.as_ref().map(|map| sourcemap::parse(map))
}

/// Tries to link the bytecode object with the `file` and `library` name.
/// Replaces all library placeholders with the given address.
///
Expand Down