ethers_solc/
hh.rs

1//! Hardhat support
2
3use crate::{
4    artifacts::{
5        bytecode::{Bytecode, BytecodeObject, DeployedBytecode},
6        contract::{CompactContract, CompactContractBytecode, Contract, ContractBytecode},
7        CompactContractBytecodeCow, LosslessAbi, Offsets,
8    },
9    ArtifactOutput, SourceFile, VersionedSourceFile,
10};
11use serde::{Deserialize, Serialize};
12use std::{borrow::Cow, collections::btree_map::BTreeMap};
13
14const HH_ARTIFACT_VERSION: &str = "hh-sol-artifact-1";
15
16/// A hardhat artifact
17#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
18#[serde(rename_all = "camelCase")]
19pub struct HardhatArtifact {
20    #[serde(rename = "_format")]
21    pub format: String,
22    /// A string with the contract's name.
23    pub contract_name: String,
24    /// The source name of this contract in the workspace like `contracts/Greeter.sol`
25    pub source_name: String,
26    /// The contract's ABI
27    pub abi: LosslessAbi,
28    /// A "0x"-prefixed hex string of the unlinked deployment bytecode. If the contract is not
29    /// deployable, this has the string "0x"
30    pub bytecode: Option<BytecodeObject>,
31    /// A "0x"-prefixed hex string of the unlinked runtime/deployed bytecode. If the contract is
32    /// not deployable, this has the string "0x"
33    pub deployed_bytecode: Option<BytecodeObject>,
34    /// The bytecode's link references object as returned by solc. If the contract doesn't need to
35    /// be linked, this value contains an empty object.
36    #[serde(default)]
37    pub link_references: BTreeMap<String, BTreeMap<String, Vec<Offsets>>>,
38    /// The deployed bytecode's link references object as returned by solc. If the contract doesn't
39    /// need to be linked, this value contains an empty object.
40    #[serde(default)]
41    pub deployed_link_references: BTreeMap<String, BTreeMap<String, Vec<Offsets>>>,
42}
43
44impl<'a> From<&'a HardhatArtifact> for CompactContractBytecodeCow<'a> {
45    fn from(artifact: &'a HardhatArtifact) -> Self {
46        let c: ContractBytecode = artifact.clone().into();
47        CompactContractBytecodeCow {
48            abi: Some(Cow::Borrowed(&artifact.abi.abi)),
49            bytecode: c.bytecode.map(|b| Cow::Owned(b.into())),
50            deployed_bytecode: c.deployed_bytecode.map(|b| Cow::Owned(b.into())),
51        }
52    }
53}
54
55impl From<HardhatArtifact> for CompactContract {
56    fn from(artifact: HardhatArtifact) -> Self {
57        CompactContract {
58            abi: Some(artifact.abi.abi),
59            bin: artifact.bytecode,
60            bin_runtime: artifact.deployed_bytecode,
61        }
62    }
63}
64
65impl From<HardhatArtifact> for ContractBytecode {
66    fn from(artifact: HardhatArtifact) -> Self {
67        let bytecode: Option<Bytecode> = artifact.bytecode.as_ref().map(|t| {
68            let mut bcode: Bytecode = t.clone().into();
69            bcode.link_references = artifact.link_references.clone();
70            bcode
71        });
72
73        let deployed_bytecode: Option<DeployedBytecode> = artifact.bytecode.as_ref().map(|t| {
74            let mut bcode: Bytecode = t.clone().into();
75            bcode.link_references = artifact.deployed_link_references.clone();
76            bcode.into()
77        });
78
79        ContractBytecode { abi: Some(artifact.abi.abi), bytecode, deployed_bytecode }
80    }
81}
82
83impl From<HardhatArtifact> for CompactContractBytecode {
84    fn from(artifact: HardhatArtifact) -> Self {
85        let c: ContractBytecode = artifact.into();
86
87        c.into()
88    }
89}
90
91/// Hardhat style artifacts handler
92#[derive(Debug, Copy, Clone, Eq, PartialEq, Default)]
93pub struct HardhatArtifacts {
94    _priv: (),
95}
96
97impl ArtifactOutput for HardhatArtifacts {
98    type Artifact = HardhatArtifact;
99
100    fn contract_to_artifact(
101        &self,
102        file: &str,
103        name: &str,
104        contract: Contract,
105        _source_file: Option<&SourceFile>,
106    ) -> Self::Artifact {
107        let (bytecode, link_references, deployed_bytecode, deployed_link_references) =
108            if let Some(evm) = contract.evm {
109                let (deployed_bytecode, deployed_link_references) =
110                    if let Some(code) = evm.deployed_bytecode.and_then(|code| code.bytecode) {
111                        (Some(code.object), code.link_references)
112                    } else {
113                        (None, Default::default())
114                    };
115
116                let (bytecode, link_ref) = if let Some(bc) = evm.bytecode {
117                    (Some(bc.object), bc.link_references)
118                } else {
119                    (None, Default::default())
120                };
121
122                (bytecode, link_ref, deployed_bytecode, deployed_link_references)
123            } else {
124                (Default::default(), Default::default(), None, Default::default())
125            };
126
127        HardhatArtifact {
128            format: HH_ARTIFACT_VERSION.to_string(),
129            contract_name: name.to_string(),
130            source_name: file.to_string(),
131            abi: contract.abi.unwrap_or_default(),
132            bytecode,
133            deployed_bytecode,
134            link_references,
135            deployed_link_references,
136        }
137    }
138
139    fn standalone_source_file_to_artifact(
140        &self,
141        _path: &str,
142        _file: &VersionedSourceFile,
143    ) -> Option<Self::Artifact> {
144        None
145    }
146}
147
148#[cfg(test)]
149mod tests {
150    use super::*;
151    use crate::Artifact;
152
153    #[test]
154    fn can_parse_hh_artifact() {
155        let s = include_str!("../test-data/hh-greeter-artifact.json");
156        let artifact = serde_json::from_str::<HardhatArtifact>(s).unwrap();
157        let compact = artifact.into_compact_contract();
158        assert!(compact.abi.is_some());
159        assert!(compact.bin.is_some());
160        assert!(compact.bin_runtime.is_some());
161    }
162}
ethers_solc/hh.rs

ethers_solc/
hh.rs
