335 lines
11 KiB
Rust
335 lines
11 KiB
Rust
use std::collections::HashMap;
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use ethers_core::abi::{Abi, Address};
|
|
|
|
use crate::{Client, Response, Result};
|
|
|
|
/// Arguments for verifying contracts
|
|
#[derive(Debug, Clone, Serialize)]
|
|
pub struct VerifyContract {
|
|
pub address: Address,
|
|
pub source: String,
|
|
#[serde(rename = "codeformat")]
|
|
pub code_format: CodeFormat,
|
|
/// if codeformat=solidity-standard-json-input, then expected as
|
|
/// `erc20.sol:erc20`
|
|
#[serde(rename = "contractname", skip_serializing_if = "Option::is_none")]
|
|
pub contract_name: Option<String>,
|
|
#[serde(rename = "compilerversion")]
|
|
pub compiler_version: String,
|
|
/// applicable when codeformat=solidity-single-file
|
|
#[serde(rename = "optimizationUsed", skip_serializing_if = "Option::is_none")]
|
|
optimization_used: Option<String>,
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub runs: Option<String>,
|
|
/// NOTE: there is a typo in the etherscan API `constructorArguements`
|
|
#[serde(rename = "constructorArguements", skip_serializing_if = "Option::is_none")]
|
|
pub constructor_arguments: Option<String>,
|
|
#[serde(rename = "evmversion")]
|
|
pub evm_version: Option<String>,
|
|
#[serde(flatten)]
|
|
pub other: HashMap<String, String>,
|
|
}
|
|
|
|
impl VerifyContract {
|
|
pub fn new(address: Address, source: String, compiler_version: String) -> Self {
|
|
Self {
|
|
address,
|
|
source,
|
|
code_format: Default::default(),
|
|
contract_name: None,
|
|
compiler_version,
|
|
optimization_used: None,
|
|
runs: None,
|
|
constructor_arguments: None,
|
|
evm_version: None,
|
|
other: Default::default(),
|
|
}
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn contract_name(mut self, name: impl Into<String>) -> Self {
|
|
self.contract_name = Some(name.into());
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn runs(mut self, runs: u32) -> Self {
|
|
self.runs = Some(format!("{}", runs));
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn optimization(self, optimization: bool) -> Self {
|
|
if optimization {
|
|
self.optimized()
|
|
} else {
|
|
self.not_optimized()
|
|
}
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn optimized(mut self) -> Self {
|
|
self.optimization_used = Some("1".to_string());
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn not_optimized(mut self) -> Self {
|
|
self.optimization_used = Some("0".to_string());
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn code_format(mut self, code_format: CodeFormat) -> Self {
|
|
self.code_format = code_format;
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn evm_version(mut self, evm_version: impl Into<String>) -> Self {
|
|
self.evm_version = Some(evm_version.into());
|
|
self
|
|
}
|
|
|
|
#[must_use]
|
|
pub fn constructor_arguments(
|
|
mut self,
|
|
constructor_arguments: Option<impl Into<String>>,
|
|
) -> Self {
|
|
self.constructor_arguments = constructor_arguments.map(|s| {
|
|
s.into()
|
|
// TODO is this correct?
|
|
.trim_start_matches("0x")
|
|
.to_string()
|
|
});
|
|
self
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
|
|
pub enum CodeFormat {
|
|
#[serde(rename = "solidity-single-file")]
|
|
SingleFile,
|
|
#[serde(rename = "solidity-standard-json-input")]
|
|
StandardJsonInput,
|
|
}
|
|
|
|
impl AsRef<str> for CodeFormat {
|
|
fn as_ref(&self) -> &str {
|
|
match self {
|
|
CodeFormat::SingleFile => "solidity-single-file",
|
|
CodeFormat::StandardJsonInput => "solidity-standard-json-input",
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Default for CodeFormat {
|
|
fn default() -> Self {
|
|
CodeFormat::SingleFile
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct ContractMetadata {
|
|
#[serde(flatten)]
|
|
pub items: Vec<Metadata>,
|
|
}
|
|
|
|
impl IntoIterator for ContractMetadata {
|
|
type Item = Metadata;
|
|
type IntoIter = std::vec::IntoIter<Metadata>;
|
|
|
|
fn into_iter(self) -> Self::IntoIter {
|
|
self.items.into_iter()
|
|
}
|
|
}
|
|
|
|
impl ContractMetadata {
|
|
/// All ABI from all contracts in the source file
|
|
pub fn abis(&self) -> Result<Vec<Abi>> {
|
|
let mut abis = Vec::with_capacity(self.items.len());
|
|
for item in &self.items {
|
|
abis.push(serde_json::from_str(&item.abi)?);
|
|
}
|
|
Ok(abis)
|
|
}
|
|
|
|
/// Combined source code of all contracts
|
|
pub fn source_code(&self) -> String {
|
|
self.items.iter().map(|c| c.source_code.as_str()).collect::<Vec<_>>().join("\n")
|
|
}
|
|
}
|
|
|
|
/// Etherscan contract metadata
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct Metadata {
|
|
#[serde(rename = "SourceCode")]
|
|
pub source_code: String,
|
|
#[serde(rename = "ABI")]
|
|
pub abi: String,
|
|
#[serde(rename = "ContractName")]
|
|
pub contract_name: String,
|
|
#[serde(rename = "CompilerVersion")]
|
|
pub compiler_version: String,
|
|
#[serde(rename = "OptimizationUsed")]
|
|
pub optimization_used: String,
|
|
#[serde(rename = "Runs")]
|
|
pub runs: String,
|
|
#[serde(rename = "ConstructorArguments")]
|
|
pub constructor_arguments: String,
|
|
#[serde(rename = "EVMVersion")]
|
|
pub evm_version: String,
|
|
#[serde(rename = "Library")]
|
|
pub library: String,
|
|
#[serde(rename = "LicenseType")]
|
|
pub license_type: String,
|
|
#[serde(rename = "Proxy")]
|
|
pub proxy: String,
|
|
#[serde(rename = "Implementation")]
|
|
pub implementation: String,
|
|
#[serde(rename = "SwarmSource")]
|
|
pub swarm_source: String,
|
|
}
|
|
|
|
impl Client {
|
|
/// Submit Source Code for Verification
|
|
pub async fn submit_contract_verification(
|
|
&self,
|
|
contract: &VerifyContract,
|
|
) -> Result<Response<String>> {
|
|
let body = self.create_query("contract", "verifysourcecode", contract);
|
|
self.post_form(&body).await
|
|
}
|
|
|
|
/// Check Source Code Verification Status with receipt received from
|
|
/// `[Self::submit_contract_verification]`
|
|
pub async fn check_contract_verification_status(
|
|
&self,
|
|
guid: impl AsRef<str>,
|
|
) -> Result<Response<String>> {
|
|
let body = self.create_query(
|
|
"contract",
|
|
"checkverifystatus",
|
|
HashMap::from([("guid", guid.as_ref())]),
|
|
);
|
|
self.post_form(&body).await
|
|
}
|
|
|
|
/// Returns the contract ABI of a verified contract
|
|
///
|
|
/// ```no_run
|
|
/// # use ethers_etherscan::Client;
|
|
/// # use ethers_core::types::Chain;
|
|
///
|
|
/// # #[tokio::main]
|
|
/// # async fn main() {
|
|
/// let client = Client::new(Chain::Mainnet, "API_KEY").unwrap();
|
|
/// let abi = client
|
|
/// .contract_abi("0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413".parse().unwrap())
|
|
/// .await.unwrap();
|
|
/// # }
|
|
/// ```
|
|
pub async fn contract_abi(&self, address: Address) -> Result<Abi> {
|
|
let query = self.create_query("contract", "getabi", HashMap::from([("address", address)]));
|
|
let resp: Response<String> = self.get_json(&query).await?;
|
|
Ok(serde_json::from_str(&resp.result)?)
|
|
}
|
|
|
|
/// Get Contract Source Code for Verified Contract Source Codes
|
|
/// ```no_run
|
|
/// # use ethers_etherscan::Client;
|
|
/// # use ethers_core::types::Chain;
|
|
///
|
|
/// # #[tokio::main]
|
|
/// # async fn main() {
|
|
/// let client = Client::new(Chain::Mainnet, "API_KEY").unwrap();
|
|
/// let meta = client
|
|
/// .contract_source_code("0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413".parse().unwrap())
|
|
/// .await.unwrap();
|
|
/// let code = meta.source_code();
|
|
/// # }
|
|
/// ```
|
|
pub async fn contract_source_code(&self, address: Address) -> Result<ContractMetadata> {
|
|
let query =
|
|
self.create_query("contract", "getsourcecode", HashMap::from([("address", address)]));
|
|
let response: Response<Vec<Metadata>> = self.get_json(&query).await?;
|
|
Ok(ContractMetadata { items: response.result })
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::{path::PathBuf, time::Duration};
|
|
|
|
use serial_test::serial;
|
|
|
|
use ethers_core::types::Chain;
|
|
use ethers_solc::{MinimalCombinedArtifacts, Project, ProjectPathsConfig};
|
|
|
|
use crate::{contract::VerifyContract, tests::run_at_least_duration, Client};
|
|
|
|
#[tokio::test]
|
|
#[serial]
|
|
#[ignore]
|
|
async fn can_fetch_contract_abi() {
|
|
run_at_least_duration(Duration::from_millis(250), async {
|
|
let client = Client::new_from_env(Chain::Mainnet).unwrap();
|
|
|
|
let _abi = client
|
|
.contract_abi("0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413".parse().unwrap())
|
|
.await
|
|
.unwrap();
|
|
})
|
|
.await;
|
|
}
|
|
|
|
#[tokio::test]
|
|
#[serial]
|
|
#[ignore]
|
|
async fn can_fetch_contract_source_code() {
|
|
run_at_least_duration(Duration::from_millis(250), async {
|
|
let client = Client::new_from_env(Chain::Mainnet).unwrap();
|
|
|
|
let _meta = client
|
|
.contract_source_code("0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413".parse().unwrap())
|
|
.await
|
|
.unwrap();
|
|
})
|
|
.await
|
|
}
|
|
|
|
#[tokio::test]
|
|
#[serial]
|
|
async fn can_flatten_and_verify_contract() {
|
|
run_at_least_duration(Duration::from_millis(250), async {
|
|
let root = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("resources");
|
|
let paths = ProjectPathsConfig::builder()
|
|
.sources(&root)
|
|
.build()
|
|
.expect("failed to resolve project paths");
|
|
let project = Project::<MinimalCombinedArtifacts>::builder()
|
|
.paths(paths)
|
|
.build()
|
|
.expect("failed to build the project");
|
|
|
|
let address = "0x9e744c9115b74834c0f33f4097f40c02a9ac5c33".parse().unwrap();
|
|
let compiler_version = "v0.5.17+commit.d19bba13";
|
|
let constructor_args = "0x000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000005f5e1000000000000000000000000000000000000000000000000000000000000000007596179537761700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000035941590000000000000000000000000000000000000000000000000000000000";
|
|
let contract = project.flatten(&root.join("UniswapExchange.sol")).expect("failed to flatten contract");
|
|
|
|
let client = Client::new_from_env(Chain::Mainnet).unwrap();
|
|
|
|
let contract =
|
|
VerifyContract::new(address, contract, compiler_version.to_string())
|
|
.constructor_arguments(Some(constructor_args))
|
|
.optimization(true)
|
|
.runs(200);
|
|
let _resp = client.submit_contract_verification(&contract).await;
|
|
})
|
|
.await
|
|
}
|
|
}
|