Skip to content

Commit

Permalink
feat(solc): add source map access functions (gakonst#1253)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattsse authored May 12, 2022
1 parent 1e2b029 commit 494af08
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
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

0 comments on commit 494af08

Please sign in to comment.