-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(contract-verifier): Support Vyper toolchain for EVM bytecodes (#…
…3251) ## What ❔ - Supports the Vyper toolchain for EVM bytecodes in the contract verifier. - Adds some more unit tests for the verifier (e.g., testing multi-file inputs, Yul contracts, abstract contract errors etc.). ## Why ❔ Part of preparations to support EVM bytecodes throughout the codebase. ## Checklist - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [x] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zkstack dev fmt` and `zkstack dev lint`.
- Loading branch information
Showing
12 changed files
with
720 additions
and
132 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| use std::{collections::HashMap, mem, path::PathBuf, process::Stdio}; | ||
|
|
||
| use anyhow::Context; | ||
| use tokio::io::AsyncWriteExt; | ||
| use zksync_queued_job_processor::async_trait; | ||
| use zksync_types::contract_verification_api::{ | ||
| CompilationArtifacts, SourceCodeData, VerificationIncomingRequest, | ||
| }; | ||
|
|
||
| use super::{parse_standard_json_output, process_contract_name, Settings, Source, StandardJson}; | ||
| use crate::{error::ContractVerifierError, resolver::Compiler}; | ||
|
|
||
| #[derive(Debug)] | ||
| pub(crate) struct VyperInput { | ||
| pub contract_name: String, | ||
| pub file_name: String, | ||
| pub sources: HashMap<String, String>, | ||
| pub optimizer_mode: Option<String>, | ||
| } | ||
|
|
||
| impl VyperInput { | ||
| pub fn new(req: VerificationIncomingRequest) -> Result<Self, ContractVerifierError> { | ||
| let (file_name, contract_name) = process_contract_name(&req.contract_name, "vy"); | ||
|
|
||
| let sources = match req.source_code_data { | ||
| SourceCodeData::VyperMultiFile(s) => s, | ||
| other => unreachable!("unexpected `SourceCodeData` variant: {other:?}"), | ||
| }; | ||
| Ok(Self { | ||
| contract_name, | ||
| file_name, | ||
| sources, | ||
| optimizer_mode: if req.optimization_used { | ||
| req.optimizer_mode | ||
| } else { | ||
| // `none` mode is not the default mode (which is `gas`), so we must specify it explicitly here | ||
| Some("none".to_owned()) | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| fn take_standard_json(&mut self) -> StandardJson { | ||
| let sources = mem::take(&mut self.sources); | ||
| let sources = sources | ||
| .into_iter() | ||
| .map(|(name, content)| (name, Source { content })); | ||
|
|
||
| StandardJson { | ||
| language: "Vyper".to_owned(), | ||
| sources: sources.collect(), | ||
| settings: Settings { | ||
| output_selection: Some(serde_json::json!({ | ||
| "*": [ "abi", "evm.bytecode", "evm.deployedBytecode" ], | ||
| })), | ||
| other: serde_json::json!({ | ||
| "optimize": self.optimizer_mode.as_deref(), | ||
| }), | ||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub(crate) struct Vyper { | ||
| path: PathBuf, | ||
| } | ||
|
|
||
| impl Vyper { | ||
| pub fn new(path: PathBuf) -> Self { | ||
| Self { path } | ||
| } | ||
| } | ||
|
|
||
| #[async_trait] | ||
| impl Compiler<VyperInput> for Vyper { | ||
| async fn compile( | ||
| self: Box<Self>, | ||
| mut input: VyperInput, | ||
| ) -> Result<CompilationArtifacts, ContractVerifierError> { | ||
| let mut command = tokio::process::Command::new(&self.path); | ||
| let mut child = command | ||
| .arg("--standard-json") | ||
| .stdin(Stdio::piped()) | ||
| .stdout(Stdio::piped()) | ||
| .stderr(Stdio::piped()) | ||
| .spawn() | ||
| .context("cannot spawn vyper")?; | ||
| let mut stdin = child.stdin.take().unwrap(); | ||
| let standard_json = input.take_standard_json(); | ||
| let content = serde_json::to_vec(&standard_json) | ||
| .context("cannot encode standard JSON input for vyper")?; | ||
| stdin | ||
| .write_all(&content) | ||
| .await | ||
| .context("failed writing standard JSON to vyper stdin")?; | ||
| stdin | ||
| .flush() | ||
| .await | ||
| .context("failed flushing standard JSON to vyper")?; | ||
| drop(stdin); | ||
|
|
||
| let output = child.wait_with_output().await.context("vyper failed")?; | ||
| if output.status.success() { | ||
| let output = | ||
| serde_json::from_slice(&output.stdout).context("vyper output is not valid JSON")?; | ||
| parse_standard_json_output(&output, input.contract_name, input.file_name, true) | ||
| } else { | ||
| Err(ContractVerifierError::CompilerError( | ||
| "vyper", | ||
| String::from_utf8_lossy(&output.stderr).to_string(), | ||
| )) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.