sp1-prover 6.0.1

The SP1 prover implementation
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
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
use std::sync::Arc;

use slop_futures::pipeline::TaskJoinError;
use sp1_hypercube::prover::ProverSemaphore;
use sp1_prover_types::{
    ArtifactClient, ArtifactType, InMemoryArtifactClient, TaskStatus, TaskType,
};
use tokio::{sync::mpsc, task::JoinSet};
use tracing::Instrument;

use crate::{
    worker::{
        node::SP1NodeCore, run_vk_generation, LocalWorkerClient, LocalWorkerClientChannels,
        ProofId, RawTaskRequest, SP1LocalNode, SP1NodeInner, SP1WorkerBuilder, TaskError, TaskId,
        TaskMetadata, WorkerClient,
    },
    SP1ProverComponents,
};

pub struct SP1LocalNodeBuilder<C: SP1ProverComponents> {
    pub worker_builder: SP1WorkerBuilder<C, InMemoryArtifactClient, LocalWorkerClient>,
    pub channels: LocalWorkerClientChannels,
}

impl<C: SP1ProverComponents> Default for SP1LocalNodeBuilder<C> {
    fn default() -> Self {
        Self::new()
    }
}

impl<C: SP1ProverComponents> SP1LocalNodeBuilder<C> {
    /// Creates a new local node builder with a default worker client builder.
    pub fn new() -> Self {
        Self::from_worker_client_builder(SP1WorkerBuilder::new())
    }

    /// Creates a new local node builder from a worker client builder.
    ///
    /// This method can be used to initialize a node from a worker client builder that has already
    /// been configured with the desired prover components.
    pub fn from_worker_client_builder(builder: SP1WorkerBuilder<C>) -> Self {
        let artifact_client = InMemoryArtifactClient::new();
        let (worker_client, channels) = LocalWorkerClient::init();
        let worker_builder =
            builder.with_artifact_client(artifact_client).with_worker_client(worker_client);
        Self { worker_builder, channels }
    }

    /// Sets the core air prover to the worker client builder.
    pub fn with_core_air_prover(
        mut self,
        core_air_prover: Arc<C::CoreProver>,
        permit: ProverSemaphore,
    ) -> Self {
        self.worker_builder = self.worker_builder.with_core_air_prover(core_air_prover, permit);
        self
    }

    /// Sets the compress air prover to the worker client builder.
    pub fn with_compress_air_prover(
        mut self,
        compress_air_prover: Arc<C::RecursionProver>,
        permit: ProverSemaphore,
    ) -> Self {
        self.worker_builder =
            self.worker_builder.with_compress_air_prover(compress_air_prover, permit);
        self
    }

    /// Sets the shrink air prover to the worker client builder.
    pub fn with_shrink_air_prover(
        mut self,
        shrink_air_prover: Arc<C::RecursionProver>,
        permit: ProverSemaphore,
    ) -> Self {
        self.worker_builder = self.worker_builder.with_shrink_air_prover(shrink_air_prover, permit);
        self
    }

    /// Sets the wrap air prover to the worker client builder.
    pub fn with_wrap_air_prover(
        mut self,
        wrap_air_prover: C::WrapProverBuilder,
        permit: ProverSemaphore,
    ) -> Self {
        self.worker_builder = self.worker_builder.with_wrap_air_prover(wrap_air_prover, permit);
        self
    }

    pub async fn build(self) -> anyhow::Result<SP1LocalNode> {
        // Destructure the builder.
        let Self { worker_builder, mut channels } = self;
        // Get the core options from the worker builder.
        let opts = worker_builder.core_opts().clone();

        // Build the node.
        let worker = worker_builder.build().await?;

        // Create a join set for the task handlers.
        let mut join_set = JoinSet::new();

        // Spawn tasks to handle all the requests. We must spawn a handler for each task type to
        // avoid blocking the main thread by not having processed the input channel.

        // Spawn the controller handler
        join_set.spawn({
            let mut controller_rx = channels.task_receivers.remove(&TaskType::Controller).unwrap();
            let worker = worker.clone();
            async move {
                while let Some((task_id, request)) = controller_rx.recv().await {
                    let span = tracing::debug_span!("Controller", proof_id = %request.context.proof_id, task_id = %task_id);
                    // Run the controller task
                    if let Err(e) = worker.controller().run(request.clone()).instrument(span).await
                    {
                        tracing::error!("Controller: task failed: {e:?}");
                    }

                    // Complete the task
                    if let Err(e) = worker
                        .worker_client()
                        .complete_task(
                            request.context.proof_id,
                            task_id,
                            TaskMetadata { gpu_time: None },
                        )
                        .await
                    {
                        tracing::error!("Controller: marking task as complete failed: {e:?}");
                    }

                    // Remove all the inputs from the task
                    for input in request.inputs {
                        if let Err(e) = worker
                            .artifact_client()
                            .delete(&input, ArtifactType::UnspecifiedArtifactType)
                            .await
                        {
                            tracing::error!("Controller: deleting input artifact failed: {e:?}");
                        }
                    }
                }
            }
        });

        // Spawn the setup handler
        join_set.spawn({
            let mut setup_rx = channels.task_receivers.remove(&TaskType::SetupVkey).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let mut task_set = JoinSet::new();
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = setup_rx.recv() => {
                            let span = tracing::debug_span!("SetupVkey", proof_id = %request.context.proof_id, task_id = %id);
                            let RawTaskRequest { inputs, outputs, context } = request.clone();
                            let proof_id = context.proof_id.clone();
                            let elf = inputs[0].clone();
                            let output = outputs[0].clone();
                            let handle = worker
                                    .prover_engine()
                                    .submit_setup(id.clone(), elf, output)
                                    .instrument(span.clone())
                                    .await
                                    .unwrap();
                            let tx = task_tx.clone();
                            task_set.spawn(async move {
                                let result = handle.await.map(|res| res.map(|(_, metadata)| metadata));
                                TaskOutput::handle_worker_result(result, &tx, proof_id, id, request, TaskType::SetupVkey);
                            }
                          );
                        }

                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the recursion vk tree handler
        join_set.spawn({
            let mut controller_rx =
                channels.task_receivers.remove(&TaskType::UtilVkeyMapController).unwrap();
            let worker = worker.clone();
            async move {
                while let Some((task_id, request)) = controller_rx.recv().await {
                    // Run the controller task
                    if let Err(e) =
                        worker.controller().run_sp1_util_vkey_map_controller(request.clone()).await
                    {
                        tracing::error!("Controller: task failed: {e:?}");
                    }

                    // Complete the task
                    if let Err(e) = worker
                        .worker_client()
                        .complete_task(
                            request.context.proof_id,
                            task_id,
                            TaskMetadata { gpu_time: None },
                        )
                        .await
                    {
                        tracing::error!("Controller: marking task as complete failed: {e:?}");
                    }

                    // Remove all the inputs from the task
                    for input in request.inputs {
                        if let Err(e) = worker
                            .artifact_client()
                            .delete(&input, ArtifactType::UnspecifiedArtifactType)
                            .await
                        {
                            tracing::error!("Controller: deleting input artifact failed: {e:?}");
                        }
                    }
                }
            }
        });

        // Spawn the vk chunk worker handler.
        join_set.spawn({
            let mut core_prover_rx =
                channels.task_receivers.remove(&TaskType::UtilVkeyMapChunk).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            let vk_worker = Arc::new(worker.clone().prover_engine().vk_worker.clone());
            async move {
                let mut task_set = JoinSet::new();
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();

                loop {
                    let vk_worker = vk_worker.clone();
                    tokio::select! {
                        Some((id, request)) = core_prover_rx.recv() => {
                            let proof_id = request.context.proof_id.clone();
                        let handle = run_vk_generation::<_,_>(vk_worker, request, worker.artifact_client().clone());
                            let tx = task_tx.clone();
                            let task_id = id;
                            task_set.spawn(async move {
                                match handle.await {
                                    Ok(()) => {
                                        tx.send((proof_id, task_id, TaskStatus::Succeeded)).ok();
                                    }
                                    Err(e) => {
                                        tracing::error!("Failed to generate vk chunk: {:?}", e);
                                    }
                                }
                            });
                        }

                        Some((proof_id, task_id , status)) = task_rx.recv() => {
                            assert_eq!(status, TaskStatus::Succeeded);
                         if let Err(e) = worker_client.complete_task(proof_id, task_id, TaskMetadata { gpu_time: None }).await {
                             tracing::error!("Failed to complete vk chunk task: {:?}", e);
                         }
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the prove shard handler
        join_set.spawn({
            let mut core_prover_rx = channels.task_receivers.remove(&TaskType::ProveShard).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let mut task_set = JoinSet::new();
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();

                loop {
                    tokio::select! {
                        Some((id, request)) = core_prover_rx.recv() => {
                            let span = tracing::debug_span!("ProveShard", proof_id = %request.context.proof_id, task_id = %id);
                            let proof_id = request.context.proof_id.clone();
                            let handle = worker
                                .prover_engine()
                                .submit_prove_core_shard(
                                    request.clone(),
                                )
                                .instrument(span.clone())
                                .await
                                .unwrap();
                            let tx = task_tx.clone();
                            task_set.spawn(
                                async move {
                                    let result = handle.await;
                                    TaskOutput::handle_worker_result(result, &tx, proof_id, id, request, TaskType::ProveShard);
                                }.instrument(span)
                           );
                        }

                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the recursion reduce handler
        join_set.spawn({
            let mut recursion_reduce_rx =
                channels.task_receivers.remove(&TaskType::RecursionReduce).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let mut task_set = JoinSet::new();
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = recursion_reduce_rx.recv() => {
                            let span = tracing::debug_span!("RecursionReduce", proof_id = %request.context.proof_id, task_id = %id);
                            let proof_id = request.context.proof_id.clone();
                            let handle = worker
                                .prover_engine()
                                .submit_recursion_reduce(request.clone())
                                .instrument(span.clone())
                                .await
                                .unwrap();
                            let tx = task_tx.clone();
                            task_set.spawn(async move {
                                let result = handle.await;
                                TaskOutput::handle_worker_result(result, &tx, proof_id, id, request, TaskType::RecursionReduce);
                            }.instrument(span)
                          );
                        }

                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the deferred handler
        join_set.spawn({
            let mut recursion_deferred_rx =
                channels.task_receivers.remove(&TaskType::RecursionDeferred).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let mut task_set = JoinSet::new();
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = recursion_deferred_rx.recv() => {
                            let span = tracing::debug_span!("RecursionDeferred", proof_id = %request.context.proof_id, task_id = %id);
                            let proof_id = request.context.proof_id.clone();
                            let handle = worker
                                .prover_engine()
                                .submit_prove_deferred(request.clone())
                                .instrument(span.clone())
                                .await
                                .unwrap();
                            let tx = task_tx.clone();
                            task_set.spawn(async move {
                                let result = handle.await;
                                TaskOutput::handle_worker_result(result, &tx, proof_id, id, request, TaskType::RecursionDeferred);
                            }.instrument(span)
                          );
                        }
                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the deferred marker task handler.
        // Marker deferred tasks are completed by the [TaskType::ProveShard] task, but we still need to consume the receiver here.
        join_set.spawn({
            let mut marker_deferred_task_rx =
                channels.task_receivers.remove(&TaskType::MarkerDeferredRecord).unwrap();
            async move { while let Some((_task_id, _request)) = marker_deferred_task_rx.recv().await {} }
        });

        // Spawn the shrink wrap handler
        //
        // In the local node, we only allow one of these tasks to be run at a time.
        join_set.spawn({
            let mut shrink_wrap_rx = channels.task_receivers.remove(&TaskType::ShrinkWrap).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = shrink_wrap_rx.recv() => {
                            let span = tracing::debug_span!("ShrinkWrap", proof_id = %request.context.proof_id, task_id = %id);
                            let worker = worker.clone();
                            let proof_id = request.context.proof_id.clone();
                            let result = worker
                                .prover_engine()
                                .run_shrink_wrap(request.clone())
                                .instrument(span)
                                .await
                                .map(|_| TaskMetadata::default());
                            TaskOutput::handle_worker_result(Ok(result), &task_tx, proof_id, id, request, TaskType::ShrinkWrap);
                        }
                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the plonk wrap handler
        //
        // in the local node, we only allow one of these tasks to be run at a time.
        join_set.spawn({
            let mut plonk_wrap_rx = channels.task_receivers.remove(&TaskType::PlonkWrap).unwrap();
            let worker = worker.clone();
            let worker_client = worker.worker_client().clone();
            async move {
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = plonk_wrap_rx.recv() => {
                            let span = tracing::debug_span!("PlonkWrap", proof_id = %request.context.proof_id, task_id = %id);
                            let worker = worker.clone();
                            let proof_id = request.context.proof_id.clone();
                            let result = worker
                                .prover_engine()
                                .run_plonk(request.clone())
                                .instrument(span)
                                .await
                                .map(|_| TaskMetadata::default());
                            TaskOutput::handle_worker_result(Ok(result), &task_tx, proof_id, id, request, TaskType::PlonkWrap);
                        }
                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(&worker_client).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Spawn the groth16 wrap handler
        //
        // In the local node, we only allow one of these tasks to be run at a time.
        join_set.spawn({
            let mut groth16_wrap_rx =
                channels.task_receivers.remove(&TaskType::Groth16Wrap).unwrap();
            let worker = worker.clone();
            async move {
                let (task_tx, mut task_rx) = mpsc::unbounded_channel();
                loop {
                    tokio::select! {
                        Some((id, request)) = groth16_wrap_rx.recv() => {
                            let span = tracing::debug_span!("Groth16Wrap", proof_id = %request.context.proof_id, task_id = %id);
                            let worker = worker.clone();
                            let proof_id = request.context.proof_id.clone();
                            let result = worker
                                .prover_engine()
                                .run_groth16(request.clone())
                                .instrument(span)
                                .await
                                .map(|_| TaskMetadata::default());
                            TaskOutput::handle_worker_result(Ok(result), &task_tx, proof_id, id, request, TaskType::Groth16Wrap);
                        }
                        Some(output) = task_rx.recv() => {
                            output.handle_task_output(worker.worker_client()).await;
                        }
                        else => {
                            break;
                        }
                    }
                }
            }
        });

        // Get the verifier, artifact client, and worker client from the worker
        let verifier = worker.verifier().clone();
        let artifact_client = worker.artifact_client().clone();
        let worker_client = worker.worker_client().clone();
        let core = SP1NodeCore::new(verifier, opts);
        let inner =
            Arc::new(SP1NodeInner { artifact_client, worker_client, core, _tasks: join_set });
        Ok(SP1LocalNode { inner })
    }
}

struct TaskOutput {
    proof_id: ProofId,
    task_id: TaskId,
    status: TaskStatus,
    task_metadata: TaskMetadata,
    task_data: Option<RawTaskRequest>,
    task_type: TaskType,
}

impl TaskOutput {
    fn handle_worker_result(
        result: Result<Result<TaskMetadata, TaskError>, TaskJoinError>,
        tx: &mpsc::UnboundedSender<TaskOutput>,
        proof_id: ProofId,
        task_id: TaskId,
        request: RawTaskRequest,
        task_type: TaskType,
    ) {
        match result {
            Ok(Ok(task_metadata)) => {
                tracing::debug!("task succeeded");
                let task_output = TaskOutput {
                    proof_id,
                    task_id,
                    status: TaskStatus::Succeeded,
                    task_metadata,
                    task_data: None,
                    task_type,
                };
                tx.send(task_output).ok();
            }
            Ok(Err(TaskError::Retryable(e))) => {
                tracing::error!("task failed with retryable error: {:?}", e);
                let task_output = TaskOutput {
                    proof_id,
                    task_id,
                    status: TaskStatus::FailedRetryable,
                    task_metadata: TaskMetadata::default(),
                    task_data: Some(request),
                    task_type,
                };
                tx.send(task_output).ok();
            }
            Ok(Err(TaskError::Fatal(e))) => {
                tracing::error!("task failed with fatal error: {:?}", e);
                let task_output = TaskOutput {
                    proof_id,
                    task_id,
                    status: TaskStatus::FailedFatal,
                    task_metadata: TaskMetadata::default(),
                    task_data: None,
                    task_type,
                };
                tx.send(task_output).ok();
            }
            Ok(Err(TaskError::Execution(e))) => {
                tracing::error!("task failed with fatal error: {:?}", e);
                let task_output = TaskOutput {
                    proof_id,
                    task_id,
                    status: TaskStatus::FailedFatal,
                    task_metadata: TaskMetadata::default(),
                    task_data: None,
                    task_type,
                };
                tx.send(task_output).ok();
            }
            Err(e) => {
                tracing::error!("task panicked: {:?}", e);
            }
        }
    }

    async fn handle_task_output(self, worker_client: &LocalWorkerClient) {
        let TaskOutput { proof_id, task_id, status, task_metadata, task_data, task_type } = self;
        match status {
            TaskStatus::Succeeded => {
                let result = worker_client
                    .complete_task(proof_id.clone(), task_id.clone(), task_metadata)
                    .await;
                if let Err(e) = result {
                    tracing::error!(
                        "Failed to complete task, proof_id: {:?}, task_id: {:?}, error: {:?}",
                        proof_id,
                        task_id,
                        e
                    );
                }
            }
            TaskStatus::FailedRetryable => {
                let task = task_data.unwrap();
                let res = worker_client.submit_task(task_type, task).await;
                if let Err(e) = res {
                    tracing::error!("Failed to submit retry, task: {:?}, error: {:?}", task_id, e);
                }
            }
            TaskStatus::FailedFatal => {
                let res = worker_client
                    .update_task_status(task_id.clone(), TaskStatus::FailedFatal)
                    .await;
                if let Err(e) = res {
                    tracing::error!("Failed to fail task, task: {:?}, error: {:?}", task_id, e);
                }
            }
            _ => {}
        }
    }
}