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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
use crate::util;
use anyhow::{anyhow, Context, Error, Result};
use ethcontract_common::Address;
use std::borrow::Cow;
use std::env;
use std::fs;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use url::Url;
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum Source {
Local(PathBuf),
Http(Url),
Etherscan(Address),
Npm(String),
}
impl Source {
pub fn parse(source: &str) -> Result<Self> {
let root = env::current_dir()?.canonicalize()?;
Source::with_root(root, source)
}
pub fn with_root(root: impl AsRef<Path>, source: &str) -> Result<Self> {
let base = Url::from_directory_path(root)
.map_err(|_| anyhow!("root path '{}' is not absolute"))?;
let url = base.join(source.as_ref())?;
match url.scheme() {
"file" => Ok(Source::local(url.path())),
"http" | "https" => match url.host_str() {
Some("etherscan.io") => Source::etherscan(
url.path()
.rsplit('/')
.next()
.ok_or_else(|| anyhow!("HTTP URL does not have a path"))?,
),
_ => Ok(Source::Http(url)),
},
"etherscan" => Source::etherscan(url.path()),
"npm" => Ok(Source::npm(url.path())),
_ => Err(anyhow!("unsupported URL '{}'", url)),
}
}
pub fn local(path: impl AsRef<Path>) -> Self {
Source::Local(path.as_ref().into())
}
pub fn http(url: &str) -> Result<Self> {
Ok(Source::Http(Url::parse(url)?))
}
pub fn etherscan(address: &str) -> Result<Self> {
util::parse_address(address)
.context("failed to parse address for Etherscan source")
.map(Source::Etherscan)
}
pub fn npm(package_path: impl Into<String>) -> Self {
Source::Npm(package_path.into())
}
pub fn artifact_json(&self) -> Result<String> {
match self {
Source::Local(path) => get_local_contract(path),
Source::Http(url) => get_http_contract(url),
Source::Etherscan(address) => get_etherscan_contract(*address),
Source::Npm(package) => get_npm_contract(package),
}
}
}
impl FromStr for Source {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
Source::parse(s)
}
}
fn get_local_contract(path: &Path) -> Result<String> {
let path = if path.is_relative() {
let absolute_path = path.canonicalize().with_context(|| {
format!(
"unable to canonicalize file from working dir {} with path {}",
env::current_dir()
.map(|cwd| cwd.display().to_string())
.unwrap_or_else(|err| format!("??? ({})", err)),
path.display(),
)
})?;
Cow::Owned(absolute_path)
} else {
Cow::Borrowed(path)
};
let json = fs::read_to_string(path).context("failed to read artifact JSON file")?;
Ok(abi_or_artifact(json))
}
fn get_http_contract(url: &Url) -> Result<String> {
let json = util::http_get(url.as_str())
.with_context(|| format!("failed to retrieve JSON from {}", url))?;
Ok(abi_or_artifact(json))
}
fn get_etherscan_contract(address: Address) -> Result<String> {
let api_key = env::var("ETHERSCAN_API_KEY")
.map(|key| format!("&apikey={}", key))
.unwrap_or_default();
let abi_url = format!(
"http://api.etherscan.io/api\
?module=contract&action=getabi&address={:?}&format=raw{}",
address, api_key,
);
let abi = util::http_get(&abi_url).context("failed to retrieve ABI from Etherscan.io")?;
let json = format!(
r#"{{"abi":{},"networks":{{"1":{{"address":"{:?}"}}}}}}"#,
abi, address,
);
Ok(json)
}
fn get_npm_contract(package: &str) -> Result<String> {
let unpkg_url = format!("https://unpkg.com/{}", package);
let json = util::http_get(&unpkg_url)
.with_context(|| format!("failed to retrieve JSON from for npm package {}", package))?;
Ok(abi_or_artifact(json))
}
fn abi_or_artifact(json: String) -> String {
if json.trim().starts_with('[') {
format!(r#"{{"abi":{}}}"#, json.trim())
} else {
json
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parse_source() {
let root = "/rooted";
for (url, expected) in &[
(
"relative/Contract.json",
Source::local("/rooted/relative/Contract.json"),
),
(
"/absolute/Contract.json",
Source::local("/absolute/Contract.json"),
),
(
"https://my.domain.eth/path/to/Contract.json",
Source::http("https://my.domain.eth/path/to/Contract.json").unwrap(),
),
(
"etherscan:0x0001020304050607080910111213141516171819",
Source::etherscan("0x0001020304050607080910111213141516171819").unwrap(),
),
(
"https://etherscan.io/address/0x0001020304050607080910111213141516171819",
Source::etherscan("0x0001020304050607080910111213141516171819").unwrap(),
),
(
"npm:@openzeppelin/contracts@2.5.0/build/contracts/IERC20.json",
Source::npm("@openzeppelin/contracts@2.5.0/build/contracts/IERC20.json"),
),
] {
let source = Source::with_root(root, url).unwrap();
assert_eq!(source, *expected);
}
}
}