feat(solc): add Contract Info structs (#1407)

This commit is contained in:
Matthias Seitz 2022-06-23 04:37:39 +02:00 committed by GitHub
parent 2ebdef68d2
commit 3d77f44066
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 120 additions and 1 deletions

View File

@ -14,7 +14,7 @@ use std::{
};
pub mod many;
pub mod output;
pub use output::{contracts, sources};
pub use output::{contracts, info, sources};
pub mod project;
/// The name of the `solc` binary on the system

View File

@ -0,0 +1,118 @@
//! Commonly used identifiers for contracts in the compiled output
use std::{convert::TryFrom, fmt, str::FromStr};
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
#[error("{0}")]
pub struct ParseContractInfoError(String);
/// Represents the common contract argument pattern for `<path>:<contractname>` where `<path>:` is
/// optional.
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct ContractInfo {
/// Location of the contract
pub path: Option<String>,
/// Name of the contract
pub name: String,
}
// === impl ContractInfo ===
impl ContractInfo {
/// Creates a new `ContractInfo` from the `info` str.
///
/// This will attempt `ContractInfo::from_str`, if `info` matches the `<path>:<name>` format,
/// the `ContractInfo`'s `path` will be set.
///
/// otherwise the `name` of the new object will be `info`.
///
/// # Example
///
/// ```
/// use ethers_solc::info::ContractInfo;
/// let info = ContractInfo::new("src/Greeter.sol:Greeter");
/// assert_eq!(info, ContractInfo {path: Some("src/Greeter.sol".to_string()), name: "Greeter".to_string()});
/// ```
pub fn new(info: impl AsRef<str>) -> Self {
let info = info.as_ref();
info.parse().unwrap_or_else(|_| ContractInfo { path: None, name: info.to_string() })
}
}
impl fmt::Display for ContractInfo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if let Some(ref path) = self.path {
write!(f, "{}:{}", path, self.name)
} else {
write!(f, "{}", self.name)
}
}
}
impl FromStr for ContractInfo {
type Err = ParseContractInfoError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let err = || {
ParseContractInfoError(
"contract source info format must be `<path>:<contractname>` or `<contractname>`"
.to_string(),
)
};
let mut iter = s.rsplit(':');
let name = iter.next().ok_or_else(err)?.trim().to_string();
let path = iter.next().map(str::to_string);
if name.ends_with(".sol") || name.contains('/') {
return Err(err())
}
Ok(Self { path, name })
}
}
impl From<FullContractInfo> for ContractInfo {
fn from(info: FullContractInfo) -> Self {
let FullContractInfo { path, name } = info;
ContractInfo { path: Some(path), name }
}
}
/// Represents the common contract argument pattern `<path>:<contractname>`
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct FullContractInfo {
/// Location of the contract
pub path: String,
/// Name of the contract
pub name: String,
}
impl fmt::Display for FullContractInfo {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}:{}", self.path, self.name)
}
}
impl FromStr for FullContractInfo {
type Err = ParseContractInfoError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let (path, name) = s.split_once(':').ok_or_else(|| {
ParseContractInfoError("Expected `<path>:<contractname>`, got `{s}`".to_string())
})?;
Ok(Self { path: path.to_string(), name: name.trim().to_string() })
}
}
impl TryFrom<ContractInfo> for FullContractInfo {
type Error = ParseContractInfoError;
fn try_from(value: ContractInfo) -> Result<Self, Self::Error> {
let ContractInfo { path, name } = value;
Ok(FullContractInfo {
path: path.ok_or_else(|| {
ParseContractInfoError("path to contract must be present".to_string())
})?,
name,
})
}
}

View File

@ -15,6 +15,7 @@ use std::{collections::BTreeMap, fmt, path::Path};
use tracing::trace;
pub mod contracts;
pub mod info;
pub mod sources;
/// Contains a mixture of already compiled/cached artifacts and the input set of sources that still