Struct GenericSdkBuilder 

pub struct GenericSdkBuilder<E, VB>
where
    E: StarkEngine<SC = SC>,
    VB: VmBuilder<E>,
    VB::VmConfig: VmExecutionConfig<F>,
{ /* private fields */ }

Construction-only API for GenericSdk.

Each proving layer has one source of truth: either user-supplied config/params or a pre-generated proving key. build() normalizes those sources into an immutable GenericSdk.

Implementations

impl<E, VB> GenericSdkBuilder<E, VB>

where E: StarkEngine<SC = SC>, VB: VmBuilder<E>, VB::VmConfig: VmExecutionConfig<F>,

pub fn new() -> Self

Creates an empty builder with no configured proving layers.

pub fn app_config(self, app_config: AppConfig<VB::VmConfig>) -> Self

Uses the provided app configuration as the source of truth for app key generation.

pub fn app_pk(self, app_pk: AppProvingKey<VB::VmConfig>) -> Self

Seeds the SDK with a pre-generated app proving key and derives the app config from it.

pub fn agg_params(self, agg_params: AggregationSystemParams) -> Self

Uses the provided aggregation parameters to generate aggregation proving material lazily.

pub fn agg_pk(self, agg_pk: AggProvingKey) -> Self

Seeds the SDK with a pre-generated aggregation proving key.

pub fn root_params(self, root_params: SystemParams) -> Self

Uses the provided root prover parameters to generate the root proving key lazily.

pub fn root_pk(self, root_pk: RootProvingKey) -> Self

Seeds the SDK with a pre-generated root proving key.

pub fn agg_tree_config(self, agg_tree_config: AggregationTreeConfig) -> Self

Overrides the aggregation tree fanout used when constructing aggregation provers.

pub fn transpiler(self, transpiler: Transpiler<F>) -> Self

Sets the transpiler used to convert guest ELFs into VmExes.

pub fn build_without_transpiler(self) -> Result<GenericSdk<E, VB>, SdkError>

where VB: Default,

Builds the SDK without inferring a transpiler from the app source.

This is useful when callers only operate on pre-transpiled VmExe values and want ELF conversion to remain unavailable unless a transpiler was explicitly supplied via Self::transpiler.

pub fn build(self) -> Result<GenericSdk<E, VB>, SdkError>

where VB: Default, VB::VmConfig: TranspilerConfig<F>,

Builds the SDK, deriving a default transpiler from the app source when one was not explicitly supplied via Self::transpiler.

pub fn deferral_hook_commits(self, commits: DeferralHookCommits) -> Self

Enables deferral-aware aggregation without configuring a prover for non-empty deferral inputs.

This is mutually exclusive with Self::multi_deferral_circuit_prover and Self::deferral_agg_prover.

pub fn multi_deferral_circuit_prover( self, multi_deferral_circuit_prover: MultiDeferralCircuitProver, ) -> Self

Enables deferrals in this SDK build. The MultiDeferralCircuitProver must be created ahead of time because the openvm_sdk_config::deferral::DeferralConfig should be created using MultiDeferralCircuitProver::make_config, which generates the def_circuit_commits needed by the VM config.

This is mutually exclusive with Self::deferral_hook_commits and Self::deferral_agg_prover.

pub fn deferral_agg_prover(self, deferral_agg_prover: DeferralAggProver) -> Self

Enables deferrals in this SDK build using a pre-built DeferralAggProver.

This is mutually exclusive with Self::deferral_hook_commits and Self::multi_deferral_circuit_prover. Use this when the deferral aggregation path has already been constructed, for example by DeferralAggProver::verify_stark.

pub fn halo2_config( self, shape: StaticVerifierShape, config: Halo2Config, ) -> Self

Uses the provided Halo2 verifier shape and config to generate Halo2 proving material lazily.

pub fn halo2_pk(self, halo2_pk: Halo2ProvingKey) -> Self

Seeds the SDK with a pre-generated Halo2 proving key.

pub fn halo2_params_dir(self, params_dir: impl AsRef<Path>) -> Self

Overrides the directory used to read or cache Halo2 parameters.

Trait Implementations

impl<E, VB> Default for GenericSdkBuilder<E, VB>

where E: StarkEngine<SC = SC>, VB: VmBuilder<E>, VB::VmConfig: VmExecutionConfig<F>,

fn default() -> Self

Returns the “default value” for a type.