Struct NetworkProverBuilder

pub struct NetworkProverBuilder { /* private fields */ }

A builder for the NetworkProver.

The builder is used to configure the NetworkProver before it is built.

Implementations

impl NetworkProverBuilder

pub fn private_key(self, private_key: &str) -> Self

Sets the Secp256k1 private key (same format as the one used by Ethereum).

Details

Sets the private key that will be used sign requests sent to the network. By default, the private key is read from the NETWORK_PRIVATE_KEY environment variable.

Example

use sp1_sdk::ProverClient;

let prover = ProverClient::builder().network().private_key("...").build();

pub fn rpc_url(self, rpc_url: &str) -> Self

Sets the remote procedure call URL.

Details

The URL determines the network that the client will connect to. By default, the URL is read from the NETWORK_RPC_URL environment variable.

Example

use sp1_sdk::ProverClient;

let prover = ProverClient::builder().network().rpc_url("...").build();

pub fn tee_signers(self, tee_signers: &[Address]) -> Self

Sets the list of TEE signers, used for verifying TEE proofs.

pub fn signer(self, signer: NetworkSigner) -> Self

Sets the network signer to use for signing requests.

Details

This method allows you to provide a custom signer implementation, such as AWS KMS or a local private key signer. If both signer and private_key are provided, the signer takes precedence.

Examples

Using a local private key:

use sp1_sdk::{NetworkSigner, ProverClient};

let private_key = "...";
let signer = NetworkSigner::local(private_key).unwrap();
let prover = ProverClient::builder().network().signer(signer).build();

Using AWS KMS:

use sp1_sdk::{NetworkSigner, ProverClient};

let kms_key_arn = "arn:aws:kms:us-east-1:123456789:key/key-id";
let signer = NetworkSigner::aws_kms(kms_key_arn).await.unwrap();
let prover = ProverClient::builder().network().signer(signer).build();

pub fn build(self) -> NetworkProver

Builds a NetworkProver.

Details

This method will build a NetworkProver with the given parameters. If signer is provided, it will be used directly. Otherwise, if private_key is provided, a local signer will be created from it. If neither is provided, the method will look for the NETWORK_PRIVATE_KEY environment variable.

Examples

Using a private key:

use sp1_sdk::ProverClient;

let prover = ProverClient::builder().network().private_key("...").rpc_url("...").build();

Using a local signer:

use sp1_sdk::{NetworkSigner, ProverClient};

let private_key = "...";
let signer = NetworkSigner::local(private_key).unwrap();
let prover = ProverClient::builder().network().signer(signer).build();

Using AWS KMS:

use sp1_sdk::{NetworkSigner, ProverClient};

let kms_key_arn = "arn:aws:kms:us-east-1:123456789:key/key-id";
let signer = NetworkSigner::aws_kms(kms_key_arn).await.unwrap();
let prover = ProverClient::builder().network().signer(signer).build();

Trait Implementations

impl Default for NetworkProverBuilder

fn default() -> NetworkProverBuilder

Returns the “default value” for a type.