Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

Commit

Permalink
feat: source map getters for deployed bytecode (#1348)
Browse files Browse the repository at this point in the history
* feat: source map getters for deployed bytecode

* fix: borrow checker
  • Loading branch information
onbjerg authored Jun 6, 2022
1 parent a532eb4 commit f561460
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
20 changes: 18 additions & 2 deletions ethers-solc/src/artifact_output/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -401,21 +401,37 @@ pub trait Artifact {
self.get_contract_bytecode().abi
}

/// Returns the `sourceMap` of the contract
/// Returns the `sourceMap` of the creation bytecode
///
/// 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
/// Returns the creation bytecode `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),
}
}

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

/// Returns the runtime bytecode `sourceMap` as str if it was included in the compiler output
fn get_source_map_deployed_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 @@ -411,6 +411,13 @@ impl CompactDeployedBytecode {
pub fn empty() -> Self {
Self { bytecode: Some(CompactBytecode::empty()), immutable_references: Default::default() }
}

/// 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.bytecode.as_ref().and_then(|bytecode| bytecode.source_map())
}
}

impl From<DeployedBytecode> for CompactDeployedBytecode {
Expand Down

0 comments on commit f561460

Please sign in to comment.