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
#[macro_export]
macro_rules! checksum {
($bytes: expr) => {
hex::encode(snarkvm_algorithms::crh::sha256::sha256($bytes))
};
}
#[macro_export]
macro_rules! checksum_error {
($expected: expr, $candidate: expr) => {
Err(crate::errors::ParameterError::ChecksumMismatch($expected, $candidate))
};
}
#[macro_export]
macro_rules! impl_params_local {
($name: ident, $test_name: ident, $local_dir: expr, $fname: tt, $size: tt) => {
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct $name;
impl crate::traits::Parameter for $name {
const CHECKSUM: &'static str = include_str!(concat!($local_dir, $fname, ".checksum"));
const SIZE: u64 = $size;
fn load_bytes() -> Result<Vec<u8>, crate::errors::ParameterError> {
let buffer = include_bytes!(concat!($local_dir, $fname, ".params"));
let checksum = checksum!(buffer);
match Self::CHECKSUM == checksum {
true => Ok(buffer.to_vec()),
false => checksum_error!(Self::CHECKSUM.into(), checksum),
}
}
}
#[cfg(test)]
#[test]
fn $test_name() {
use crate::traits::Parameter;
let parameters = $name::load_bytes().expect("failed to load parameters");
assert_eq!($name::SIZE, parameters.len() as u64);
}
};
}
#[macro_export]
macro_rules! impl_params_remote {
($name: ident, $remote_url: tt, $local_dir: expr, $fname: tt, $size: tt) => {
pub struct $name;
impl crate::traits::Parameter for $name {
const CHECKSUM: &'static str = include_str!(concat!($local_dir, $fname, ".checksum"));
const SIZE: u64 = $size;
fn load_bytes() -> Result<Vec<u8>, crate::errors::ParameterError> {
let filename = Self::versioned_filename();
let mut file_path = std::path::PathBuf::from(file!());
file_path.pop();
file_path.push($local_dir);
file_path.push(&filename);
let relative_path = if file_path.strip_prefix("parameters").is_ok() {
file_path.strip_prefix("parameters")?
} else {
&file_path
};
let mut absolute_path = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"));
absolute_path.push(&relative_path);
let buffer = if relative_path.exists() {
std::fs::read(relative_path)?
} else if absolute_path.exists() {
std::fs::read(absolute_path)?
} else {
eprintln!(
"\nWARNING - \"{}\" does not exist. snarkVM will download this file remotely and store it locally. Please ensure \"{}\" is stored in {:?}.\n",
filename, filename, file_path
);
let output = Self::load_remote()?;
match Self::store_bytes(&output, &relative_path, &absolute_path, &file_path) {
Ok(()) => output,
Err(_) => {
eprintln!(
"\nWARNING - Failed to store \"{}\" locally. Please download this file manually and ensure it is stored in {:?}.\n",
filename, file_path
);
output
}
}
};
let checksum = checksum!(&buffer);
match Self::CHECKSUM == checksum {
true => Ok(buffer),
false => checksum_error!(Self::CHECKSUM.into(), checksum),
}
}
}
impl $name {
#[cfg(any(test, feature = "remote"))]
pub fn load_remote() -> Result<Vec<u8>, crate::errors::ParameterError> {
use crate::traits::Parameter;
println!("{} - Downloading parameters...", module_path!());
let mut buffer = vec![];
let url = Self::remote_url();
Self::remote_fetch(&mut buffer, &url)?;
println!("\n{} - Download complete", module_path!());
let checksum = checksum!(&buffer);
match Self::CHECKSUM == checksum {
true => Ok(buffer),
false => checksum_error!(Self::CHECKSUM.into(), checksum),
}
}
#[cfg(not(any(test, feature = "remote")))]
pub fn load_remote() -> Result<Vec<u8>, crate::errors::ParameterError> {
Err(crate::errors::ParameterError::RemoteFetchDisabled)
}
fn versioned_filename() -> String {
use crate::traits::Parameter;
match Self::CHECKSUM.get(0..7) {
Some(sum) => format!("{}-{}.params", $fname, sum),
_ => concat!($fname, ".params",).to_string()
}
}
#[cfg(any(test, feature = "remote"))]
fn remote_url() -> String {
format!("{}/{}", $remote_url, Self::versioned_filename())
}
fn store_bytes(
buffer: &[u8],
relative_path: &std::path::Path,
absolute_path: &std::path::Path,
file_path: &std::path::Path,
) -> Result<(), crate::errors::ParameterError> {
use snarkvm_utilities::Write;
println!("{} - Storing parameters ({:?})", module_path!(), file_path);
if let Ok(mut file) = std::fs::File::create(relative_path) {
file.write_all(&buffer)?;
} else if let Ok(mut file) = std::fs::File::create(absolute_path) {
file.write_all(&buffer)?;
}
Ok(())
}
#[cfg(any(test, feature = "remote"))]
fn remote_fetch(buffer: &mut Vec<u8>, url: &str) -> Result<(), crate::errors::ParameterError> {
let mut easy = curl::easy::Easy::new();
easy.url(url)?;
easy.progress(true)?;
easy.progress_function(|total_download, current_download, _, _| {
let percent = (current_download / total_download) * 100.0;
let size_in_megabytes = total_download as u64 / 1_048_576;
print!(
"\r{} - {:.2}% complete ({:#} MB total)",
module_path!(),
percent,
size_in_megabytes
);
true
})?;
let mut transfer = easy.transfer();
transfer.write_function(|data| {
buffer.extend_from_slice(data);
Ok(data.len())
})?;
Ok(transfer.perform()?)
}
}
}
}