Skip to content

Commit

Permalink
comment stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattstam
mattstam committed Dec 12, 2024
1 parent 3ff6af7 commit c5636bf
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 76 deletions.
56 changes: 51 additions & 5 deletions crates/sdk/src/local/prover.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ use std::future::{Future, IntoFuture};
use std::pin::Pin;
use std::sync::Arc;
use tokio::task;

/// An implementation of [crate::ProverClient] that can generate proofs locally.
pub struct LocalProver {
prover: Arc<SP1Prover<DefaultProverComponents>>,
Expand Down Expand Up @@ -65,6 +64,49 @@ impl LocalProver {
}
}

pub struct LocalProverBuilder {
timeout: Option<u64>,
cycle_limit: Option<u64>,
}

impl Default for LocalProverBuilder {
fn default() -> Self {
Self::new()
}
}

impl LocalProverBuilder {
/// Creates a new [`LocalProverBuilder`].
pub fn new() -> Self {
Self { timeout: None, cycle_limit: None }
}

/// Sets the timeout for proof requests.
///
/// This is the maximum amount of time to wait for the request to be generated.
pub fn with_timeout(mut self, timeout: u64) -> Self {
self.timeout = Some(timeout);
self
}

/// Sets the cycle limit for proof requests.
///
/// This is the maximum number of cycles to allow for the execution of the request.
pub fn with_cycle_limit(mut self, cycle_limit: u64) -> Self {
self.cycle_limit = Some(cycle_limit);
self
}

/// Builds the [`LocalProver`] with the given configuration.
pub fn build(self) -> LocalProver {
LocalProver {
prover: Arc::new(SP1Prover::new()),
timeout: self.timeout.unwrap_or(DEFAULT_TIMEOUT),
cycle_limit: self.cycle_limit.unwrap_or(DEFAULT_CYCLE_LIMIT),
}
}
}

pub struct LocalProofRequest<'a> {
prover: &'a LocalProver,
pk: &'a Arc<SP1ProvingKey>,
Expand All @@ -77,16 +119,16 @@ pub struct LocalProofRequest<'a> {
}

impl<'a> LocalProofRequest<'a> {
/// Creates a new [`LocalProofRequest`].
/// Creates a new [`LocalProofRequest`] using the prover's configuration and default values.
pub fn new(prover: &'a LocalProver, pk: &'a Arc<SP1ProvingKey>, stdin: SP1Stdin) -> Self {
Self {
prover,
pk,
stdin,
mode: Mode::default(),
version: SP1_CIRCUIT_VERSION.to_string(),
timeout: prover.timeout,
cycle_limit: prover.cycle_limit,
version: SP1_CIRCUIT_VERSION.to_string(),
prover_ops: SP1ProverOpts::default(),
}
}
Expand Down Expand Up @@ -151,6 +193,7 @@ impl<'a> LocalProofRequest<'a> {
}

impl<'a> LocalProofRequest<'a> {
#[allow(clippy::too_many_arguments)
fn run_inner(
prover: &SP1Prover<DefaultProverComponents>,
pk: &SP1ProvingKey,
Expand All @@ -161,9 +204,10 @@ impl<'a> LocalProofRequest<'a> {
version: String,
prover_opts: SP1ProverOpts,
) -> Result<SP1ProofWithPublicValues> {
// Set the max cycles on the context.
let context = SP1Context::builder().max_cycles(cycle_limit).build();

// Generate the core proof
// Generate the core proof.
let proof: sp1_prover::SP1ProofWithMetadata<sp1_prover::SP1CoreProofData> =
prover.prove_core(pk, &stdin, prover_opts, context)?;

Expand All @@ -180,7 +224,7 @@ impl<'a> LocalProofRequest<'a> {
stdin.proofs.iter().map(|(reduce_proof, _)| reduce_proof.clone()).collect();
let public_values = proof.public_values.clone();

// Generate the compressed proof
// Generate the compressed proof.
let reduce_proof = prover.compress(&pk.vk, proof, deferred_proofs, prover_opts)?;

if mode == Mode::Compressed {
Expand All @@ -199,6 +243,7 @@ impl<'a> LocalProofRequest<'a> {
let outer_proof = prover.wrap_bn254(compress_proof, prover_opts)?;

if mode == Mode::Plonk {
// Generate the Plonk proof.
let plonk_bn254_artifacts = if sp1_prover::build::sp1_dev_mode() {
sp1_prover::build::try_build_plonk_bn254_artifacts_dev(
&outer_proof.vk,
Expand All @@ -216,6 +261,7 @@ impl<'a> LocalProofRequest<'a> {
sp1_version: version.to_string(),
});
} else if mode == Mode::Groth16 {
// Generate the Groth16 proof.
let groth16_bn254_artifacts = if sp1_prover::build::sp1_dev_mode() {
sp1_prover::build::try_build_groth16_bn254_artifacts_dev(
&outer_proof.vk,
Expand Down
154 changes: 83 additions & 71 deletions crates/sdk/src/network-v2/prover.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,24 @@ pub const MAX_TIMEOUT: u64 = 86400;
/// The number of seconds to wait between checking the status of a proof request.
pub const STATUS_CHECK_INTERVAL_SECS: u64 = 2;

/// An implementation of [crate::ProverClient] that can generate proofs on a remote RPC server.
/// An implementation of [crate::ProverClient] that can generate proofs on the prover network.
pub struct NetworkProver {
prover: Arc<SP1Prover<DefaultProverComponents>>,
network_client: NetworkClient,
timeout: u64,
cycles_limit: u64,
cycle_limit: u64,
}

impl NetworkProver {
/// Creates a new [`NetworkProver`] with the given private private_key.
/// This function uses default timeout and cycle limit.
/// Creates a new [`NetworkProver`] with the given private private_key and RPC URL.
///
/// Uses default timeout and cycle limit.
pub fn new(rpc_url: String, private_key: String) -> Self {
Self {
prover: Arc::new(SP1Prover::new()),
network_client: NetworkClient::new(&private_key).rpc_url(rpc_url),
timeout: DEFAULT_TIMEOUT,
cycles_limit: DEFAULT_CYCLE_LIMIT,
cycle_limit: DEFAULT_CYCLE_LIMIT,
}
}

Expand Down Expand Up @@ -210,6 +211,72 @@ impl NetworkProver {
}
}

pub struct NetworkProverBuilder {
rpc_url: Option<String>,
private_key: Option<String>,
timeout: Option<u64>,
cycle_limit: Option<u64>,
}

impl Default for NetworkProverBuilder {
fn default() -> Self {
Self::new()
}
}

impl NetworkProverBuilder {
/// Creates a new [`NetworkProverBuilder`].
pub fn new() -> Self {
Self { rpc_url: None, private_key: None, timeout: None, cycle_limit: None }
}

/// Sets the RPC URL for the prover network.
///
/// This configures the endpoint that will be used for all network operations.
/// If not set, the default RPC URL will be used.
pub fn rpc_url(mut self, url: String) -> Self {
self.rpc_url = Some(url);
self
}

/// Sets the private key to use for the prover network.
///
/// This is required and must be set before building the prover.
pub fn private_key(mut self, key: String) -> Self {
self.private_key = Some(key);
self
}

/// Sets the timeout for proof requests.
///
/// This is the maximum amount of time to wait for the request to be generated.
pub fn with_timeout(mut self, timeout: u64) -> Self {
self.timeout = Some(timeout);
self
}

/// Sets the cycle limit for proof requests.
///
/// This is the maximum number of cycles to allow for the execution of the request.
pub fn with_cycle_limit(mut self, cycle_limit: u64) -> Self {
self.cycle_limit = Some(cycle_limit);
self
}

/// Builds the [`NetworkProver`] with the given configuration.
pub fn build(self) -> NetworkProver {
NetworkProver {
prover: Arc::new(SP1Prover::new()),
network_client: NetworkClient::new(
&self.private_key.expect("A private key set on the builder"),
)
.rpc_url(self.rpc_url.unwrap_or(DEFAULT_PROVER_NETWORK_RPC.to_string())),
timeout: self.timeout.unwrap_or(DEFAULT_TIMEOUT),
cycle_limit: self.cycle_limit.unwrap_or(DEFAULT_CYCLE_LIMIT),
}
}
}

pub struct NetworkProofRequest<'a> {
prover: &'a NetworkProver,
pk: &'a SP1ProvingKey,
Expand All @@ -223,6 +290,7 @@ pub struct NetworkProofRequest<'a> {
}

impl<'a> NetworkProofRequest<'a> {
/// Creates a new [`NetworkProofRequest`] using the prover's configuration and default values.
pub fn new(prover: &'a NetworkProver, pk: &'a SP1ProvingKey, stdin: SP1Stdin) -> Self {
Self {
prover,
Expand All @@ -231,13 +299,13 @@ impl<'a> NetworkProofRequest<'a> {
mode: Mode::default().into(),
version: SP1_CIRCUIT_VERSION.to_string(),
timeout: prover.timeout,
cycle_limit: Some(prover.cycles_limit),
cycle_limit: Some(prover.cycle_limit),
skip_simulation: false,
strategy: DEFAULT_FULFILLMENT_STRATEGY,
}
}

fn with_mode(mut self, mode: Mode) -> Self {
fn mode(mut self, mode: Mode) -> Self {
self.mode = mode.into();
self
}
Expand All @@ -262,16 +330,19 @@ impl<'a> NetworkProofRequest<'a> {
self
}

pub fn version(mut self, version: String) -> Self {
pub fn version(mut self, version: String) -> Self {
self.version = version;
self
}

pub fn timeout(mut self, timeout: u64) -> Self {
pub fn timeout(mut self, timeout: u64) -> Self {
self.timeout = timeout;
self
}

pub fn cycle_limit(mut self, cycle_limit: u64) -> Self {
pub fn cycle_limit(mut self, cycle_limit: u64) -> Self {
self.cycle_limit = Some(cycle_limit);
self
Expand All @@ -282,6 +353,7 @@ impl<'a> NetworkProofRequest<'a> {
self
}

pub fn strategy(mut self, strategy: FulfillmentStrategy) -> Self {
pub fn strategy(mut self, strategy: FulfillmentStrategy) -> Self {
self.strategy = strategy;
self
Expand Down Expand Up @@ -331,6 +403,7 @@ impl<'a> NetworkProofRequest<'a> {
impl Prover for NetworkProver {
async fn setup(&self, elf: Arc<[u8]>) -> Arc<SP1ProvingKey> {
let prover = Arc::clone(&self.prover);

task::spawn_blocking(move || {
let (pk, _vk) = prover.setup(&elf);
Arc::new(pk)
Expand All @@ -351,6 +424,7 @@ impl Prover for NetworkProver {
stdin: SP1Stdin,
) -> Result<(SP1PublicValues, ExecutionReport), ExecutionError> {
let prover = Arc::clone(&self.prover);

task::spawn_blocking(move || prover.execute(&elf, &stdin, SP1Context::default()))
.await
.unwrap()
Expand All @@ -372,7 +446,7 @@ impl Prover for NetworkProver {
opts: ProofOpts,
) -> Result<SP1ProofWithPublicValues> {
self.prove(pk, stdin)
.with_mode(opts.mode)
.mode(opts.mode)
.timeout(opts.timeout)
.cycle_limit(opts.cycle_limit)
.await
Expand All @@ -386,7 +460,7 @@ impl Prover for NetworkProver {
opts: ProofOpts,
) -> Result<SP1ProofWithPublicValues> {
self.prove(pk, stdin)
.with_mode(opts.mode)
.mode(opts.mode)
.timeout(opts.timeout)
.cycle_limit(opts.cycle_limit)
.run()
Expand Down Expand Up @@ -422,68 +496,6 @@ impl<'a> IntoFuture for NetworkProofRequest<'a> {
}
}

pub struct NetworkProverBuilder {
rpc_url: Option<String>,
private_key: Option<String>,
timeout: Option<u64>,
cycle_limit: Option<u64>,
}


#[allow(clippy::new_without_default)]
impl NetworkProverBuilder {
/// Creates a new network prover builder.
pub fn new() -> Self {
Self { rpc_url: None, private_key: None, timeout: None, cycle_limit: None }
}

/// Sets the RPC URL for the prover network.
///
/// This configures the endpoint that will be used for all network operations.
/// If not set, the default RPC URL will be used.
pub fn rpc_url(mut self, url: String) -> Self {
self.rpc_url = Some(url);
self
}

/// Sets the private key to use for the prover network.
///
/// This is required and must be set before building the prover.
pub fn private_key(mut self, key: String) -> Self {
self.private_key = Some(key);
self
}

/// Sets the timeout for proof requests.
///
/// This is the maximum amount of time to wait for the request to be fulfilled.
pub fn with_timeout(mut self, timeout: u64) -> Self {
self.timeout = Some(timeout);
self
}

/// Sets the cycle limit for proof requests.
///
/// This is the maximum number of cycles to allow for the execution of the request.
pub fn with_cycle_limit(mut self, cycle_limit: u64) -> Self {
self.cycle_limit = Some(cycle_limit);
self
}

/// Builds the prover with the given configuration.
pub fn build(self) -> NetworkProver {
NetworkProver {
prover: Arc::new(SP1Prover::new()),
network_client: NetworkClient::new(
&self.private_key.expect("A private key set on the builder"),
)
.rpc_url(self.rpc_url.unwrap_or(DEFAULT_PROVER_NETWORK_RPC.to_string())),
timeout: self.timeout.unwrap_or(DEFAULT_TIMEOUT),
cycles_limit: self.cycle_limit.unwrap_or(DEFAULT_CYCLE_LIMIT),
}
}
}

// #[cfg(test)]
// mod tests {
// use super::*;
Expand Down

0 comments on commit c5636bf

Please sign in to comment.