ethrex-sdk-contract-utils 17.0.0

Solidity contract compilation and git dependency helpers for the ethrex Ethereum execution client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use std::{
    path::{Path, PathBuf},
    process::Command,
};

#[derive(Debug, thiserror::Error)]
pub enum ContractCompilationError {
    #[error("The path is not a valid utf-8 string")]
    FailedToGetStringFromPath,
    #[error("Deployer compilation error: {0}")]
    CompilationError(String),
}

pub fn compile_contract(
    output_dir: &Path,
    contract_path: &Path,
    runtime_bin: bool,
    abi_json: bool,
    remappings: Option<&[(&str, PathBuf)]>,
    allow_paths: &[&Path],
    optimize_runs: Option<u64>,
) -> Result<(), ContractCompilationError> {
    let bin_flag = if runtime_bin {
        "--bin-runtime"
    } else {
        "--bin"
    };

    let mut cmd = Command::new("solc");
    cmd.arg(bin_flag);

    if abi_json {
        cmd.arg("--abi");
    }

    apply_remappings(&mut cmd, remappings)?;

    if let Some(optimize_runs) = optimize_runs {
        cmd.arg("--optimize")
            .arg("--optimize-runs")
            .arg(format!("{optimize_runs}"));
    }

    cmd.arg(
        contract_path
            .to_str()
            .ok_or(ContractCompilationError::FailedToGetStringFromPath)?,
    )
    .arg("--via-ir")
    .arg("-o")
    .arg(
        output_dir
            .join("solc_out")
            .to_str()
            .ok_or(ContractCompilationError::FailedToGetStringFromPath)?,
    )
    .arg("--overwrite")
    .arg("--no-cbor-metadata");

    if !allow_paths.is_empty() {
        apply_allow_paths(&mut cmd, allow_paths)?;
    }

    let cmd_succeeded = cmd
        .spawn()
        .map_err(|err| {
            ContractCompilationError::CompilationError(format!("Failed to spawn solc: {err}"))
        })?
        .wait()
        .map_err(|err| {
            ContractCompilationError::CompilationError(format!("Failed to wait for solc: {err}"))
        })?
        .success();

    if !cmd_succeeded {
        return Err(ContractCompilationError::CompilationError(format!(
            "Failed to compile {contract_path:?}"
        )));
    }

    Ok(())
}

fn apply_remappings(
    cmd: &mut Command,
    remappings: Option<&[(&str, PathBuf)]>,
) -> Result<(), ContractCompilationError> {
    if let Some(remaps) = remappings {
        for (prefix, path) in remaps {
            let path_str = path
                .to_str()
                .ok_or(ContractCompilationError::FailedToGetStringFromPath)?;
            cmd.arg(format!("{prefix}={path_str}"));
        }
    }
    Ok(())
}

fn apply_allow_paths(
    cmd: &mut Command,
    allow_paths: &[&Path],
) -> Result<(), ContractCompilationError> {
    cmd.arg("--allow-paths");
    let joined_paths = allow_paths
        .iter()
        .map(|p| {
            p.to_str()
                .ok_or(ContractCompilationError::FailedToGetStringFromPath)
        })
        .collect::<Result<Vec<_>, _>>()?
        .join(",");
    cmd.arg(joined_paths);
    Ok(())
}