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
use crate::StatusCode;
use super::Prover;
use sp1_core_executor::{ExecutionError, ExecutionReport, HookEnv, SP1ContextBuilder};
use sp1_core_machine::io::SP1Stdin;
use sp1_primitives::{io::SP1PublicValues, Elf};
/// A request for executing a program.
pub struct ExecuteRequest<'a, P: Prover> {
pub(crate) prover: &'a P,
pub(crate) elf: Elf,
pub(crate) stdin: SP1Stdin,
pub(crate) context_builder: SP1ContextBuilder<'static>,
}
impl<'a, P: Prover> ExecuteRequest<'a, P> {
pub(crate) fn new(prover: &'a P, elf: Elf, stdin: SP1Stdin) -> Self {
Self { prover, elf, stdin, context_builder: SP1ContextBuilder::new() }
}
/// Add a executor [`sp1_core_executor::Hook`] into the context.
///
/// # Arguments
/// * `fd` - The file descriptor that triggers this execution hook.
/// * `f` - The function to invoke when the hook is triggered.
///
/// # Details
/// Hooks may be invoked from within SP1 by writing to the specified file descriptor `fd`
/// with [`sp1_zkvm::io::write`], returning a list of arbitrary data that may be read
/// with successive calls to [`sp1_zkvm::io::read`].
///
/// # Example
/// ```rust,no_run
/// use sp1_sdk::blocking::{Elf, Prover, ProverClient, SP1Stdin};
///
/// let elf = Elf::Static(&[1, 2, 3]);
/// let stdin = SP1Stdin::new();
///
/// let client = ProverClient::builder().cpu().build();
/// let builder = client
/// .execute(elf, stdin)
/// .with_hook(1, |env, data| {
/// println!("Hook triggered with data: {:?}", data);
/// vec![vec![1, 2, 3]]
/// })
/// .run();
/// ```
#[must_use]
pub fn with_hook(
mut self,
fd: u32,
f: impl FnMut(HookEnv, &[u8]) -> Vec<Vec<u8>> + Send + Sync + 'static,
) -> Self {
self.context_builder.hook(fd, f);
self
}
/// Set the maximum number of cpu cycles to use for execution.
///
/// # Arguments
/// * `max_cycles` - The maximum number of cycles to use for execution.
///
/// # Details
/// If the cycle limit is exceeded, execution will fail with the
/// [`sp1_core_executor::ExecutionError::ExceededCycleLimit`]. This is useful for preventing
/// infinite loops in the and limiting the execution time of the program.
///
/// # Example
/// ```rust,no_run
/// use sp1_sdk::blocking::{Elf, Prover, ProverClient, SP1Stdin};
///
/// let elf = Elf::Static(&[1, 2, 3]);
/// let stdin = SP1Stdin::new();
///
/// let client = ProverClient::builder().cpu().build();
/// let result = client.execute(elf, stdin).cycle_limit(1000000).run();
/// ```
#[must_use]
pub fn cycle_limit(mut self, max_cycles: u64) -> Self {
self.context_builder.max_cycles(max_cycles);
self
}
/// Whether to enable deferred proof verification in the executor.
///
/// # Arguments
/// * `value` - Whether to enable deferred proof verification in the executor.
///
/// # Details
/// Default: `true`. If set to `false`, the executor will skip deferred proof verification.
/// This is useful for reducing the execution time of the program and optimistically assuming
/// that the deferred proofs are correct. Can also be used for mock proof setups that require
/// verifying mock compressed proofs.
///
/// # Example
/// ```rust,no_run
/// use sp1_sdk::blocking::{Elf, Prover, ProverClient, SP1Stdin};
///
/// let elf = Elf::Static(&[1, 2, 3]);
/// let stdin = SP1Stdin::new();
///
/// let client = ProverClient::builder().cpu().build();
/// let result = client.execute(elf, stdin).deferred_proof_verification(false).run();
/// ```
#[must_use]
pub fn deferred_proof_verification(mut self, value: bool) -> Self {
self.context_builder.set_deferred_proof_verification(value);
self
}
/// Whether to enable gas calculation in the executor.
///
/// # Arguments
/// * `value` - Whether to enable gas calculation in the executor.
///
/// # Details
/// Default: `true`. If set to `false`, the executor will not calculate gas.
/// This is useful for reducing the execution time of the program, since gas calculation
/// must perform extra work to simulate parts of the proving process.
///
/// Gas may be retrieved through the [`ExecutionReport`] available through [`Self::run`].
/// It will be `None` if and only if this option is disabled.
///
/// # Example
/// ```rust,no_run
/// use sp1_sdk::blocking::{Elf, Prover, ProverClient, SP1Stdin};
///
/// let elf = Elf::Static(&[1, 2, 3]);
/// let stdin = SP1Stdin::new();
///
/// let client = ProverClient::builder().cpu().build();
/// let result = client.execute(elf, stdin).calculate_gas(false).run();
/// ```
#[must_use]
pub fn calculate_gas(mut self, value: bool) -> Self {
self.context_builder.calculate_gas(value);
self
}
/// Set the expected exit code of the program.
///
/// # Arguments
/// * `code` - The expected exit code of the program.
#[must_use]
pub fn expected_exit_code(mut self, code: StatusCode) -> Self {
self.context_builder.expected_exit_code(code);
self
}
// todo!(n): workaround this
// /// Override the default stdout of the guest program.
// ///
// /// # Example
// /// ```rust,no_run
// /// use sp1_sdk::{include_elf, Prover, ProverClient, SP1Stdin};
// ///
// /// let mut stdout = Vec::new();
// ///
// /// let elf = &[1, 2, 3];
// /// let stdin = SP1Stdin::new();
// ///
// /// let client = ProverClient::builder().cpu().build();
// /// client.execute(elf, &stdin).stdout(&mut stdout).run();
// /// ```
// #[must_use]
// pub fn stdout<W: IoWriter>(mut self, writer: &'a mut W) -> Self {
// self.context_builder.stdout(writer);
// self
// }
// /// Override the default stdout of the guest program.
// ///
// /// # Example
// /// ```rust,no_run
// /// use sp1_sdk::{include_elf, Prover, ProverClient, SP1Stdin};
// ///
// /// let mut stderr = Vec::new();
// ///
// /// let elf = &[1, 2, 3];
// /// let stdin = SP1Stdin::new();
// ///
// /// let client = ProverClient::builder().cpu().build();
// /// client.execute(elf, &stdin).stderr(&mut stderr).run();
// /// ```
// #[must_use]
// pub fn stderr<W: IoWriter>(mut self, writer: &'a mut W) -> Self {
// self.context_builder.stderr(writer);
// self
// }
pub fn run(self) -> Result<(SP1PublicValues, ExecutionReport), ExecutionError> {
let Self { prover, elf, stdin, mut context_builder } = self;
let inner = prover.inner();
let context = context_builder.build();
let (pv, _, report) = crate::blocking::block_on(inner.execute(&elf, stdin, context))
.map_err(|e| ExecutionError::Other(e.to_string()))?;
Ok((pv, report))
}
}