Skip to main content

StoffelRuntime

Struct StoffelRuntime 

Source
pub struct StoffelRuntime { /* private fields */ }

Implementations§

Source§

impl StoffelRuntime

Source

pub fn program(&self) -> &Program

Source

pub fn to_bytecode(&self) -> Result<Vec<u8>>

Serialize the compiled program as CLI-compatible Stoffel bytecode.

Source

pub fn save_bytecode(&self, path: impl AsRef<Path>) -> Result<()>

Save the compiled program as CLI-compatible Stoffel bytecode.

Source

pub fn bytecode_summary(&self) -> Result<BytecodeSummary>

Summarize the CLI-compatible bytecode artifact without changing it.

Source

pub fn client(&self) -> ClientBuilder

Source

pub fn client_for_deployment( &self, deployment: &NetworkDeployment, ) -> ClientBuilder

Create a client builder with this runtime’s program and all deployment servers.

Source

pub fn offchain_client_config( &self, client_slot: u64, ) -> Result<OffChainClientConfigBuilder>

Create an off-chain client IO config builder from this runtime’s typed program metadata.

The runtime supplies the MPC backend, topology, and output count for client_slot. Callers still provide coordinator/node endpoints, timestamp, and client identity explicitly.

Source

pub fn server(&self, party_id: usize) -> ServerBuilder

Source

pub fn server_for_config(&self, config: &NetworkConfig) -> ServerBuilder

Create a server builder for one party config while carrying this program.

Source

pub fn servers_for_deployment( &self, deployment: &NetworkDeployment, ) -> Vec<ServerBuilder>

Create one server builder per party in a validated deployment plan.

Each builder carries this runtime’s compiled program metadata and uses the corresponding party’s network config.

Source

pub fn mpc_config(&self) -> Option<&MpcConfig>

Source

pub fn network_config(&self) -> Option<&NetworkConfig>

Source

pub fn mpc_summary(&self) -> Result<Option<MpcConfigSummary>>

Source

pub fn network_summary(&self) -> Result<Option<NetworkConfigSummary>>

Source

pub fn summary(&self) -> Result<RuntimeSummary>

Source

pub fn local_runner_binary_path(&self) -> Option<&Path>

Source

pub fn inputs(&self) -> &[(String, Value)]

Source

pub fn client_inputs(&self) -> &[(u64, Vec<Value>)]

Source

pub fn configured_expected_clients(&self) -> Option<usize>

Source

pub fn validate_client_inputs(&self) -> Result<()>

Source

pub fn with_inputs<V>(self, inputs: &[(&str, V)]) -> Self
where V: Clone + Into<Value>,

Replace named function inputs for clear execution.

Source

pub fn with_input<V>(self, name: impl Into<String>, value: V) -> Self
where V: Into<Value>,

Add one named function input for clear execution.

Source

pub fn with_input_file(self, path: impl AsRef<Path>) -> Result<Self>

Replace named function inputs with values loaded from a .json, .csv, or .txt file.

Source

pub fn with_client_input<V>(self, client_slot: u64, values: &[V]) -> Self
where V: Clone + Into<Value>,

Add one coordinator client input set for local networked execution.

Source

pub fn with_client_input_file(self, path: impl AsRef<Path>) -> Result<Self>

Replace local ClientStore inputs with values loaded from a .json, .csv, or .txt file.

Source

pub fn with_client_inputs<V>(self, inputs: &[(u64, &[V])]) -> Self
where V: Clone + Into<Value>,

Replace all coordinator client input sets for local networked execution.

Source

pub fn expected_output_clients(self, n: usize) -> Self

Declare output-capable client slots 0..n-1 for local execution.

Source

pub fn local_runner_path(self, path: impl AsRef<Path>) -> Self

Set the stoffel-run binary path used by local coordinator execution.

Source

pub fn local_network(&self) -> LocalNetworkBuilder<'_>

Configure a real localhost coordinator-backed MPC run.

This builder exposes local development controls without replacing the networking, coordinator, or protocol implementations owned by the lower crates.

Source

pub fn execute_clear(&self) -> Result<Vec<Value>>

Source

pub fn execute_clear_function(&self, name: &str) -> Result<Vec<Value>>

Source

pub fn execute<A>(&self, name: &str, args: A) -> Result<Vec<Value>>
where A: ProgramArgs,

Execute a named function with positional SDK values.

This is the direct, local cleartext execution path for a loaded or compiled program. Arguments are validated against the function metadata stored in the binary before the VM is invoked.

Source

pub fn execute_main<A>(&self, args: A) -> Result<Vec<Value>>
where A: ProgramArgs,

Execute main with positional SDK values.

Source

pub async fn execute_local(&self) -> Result<Vec<Value>>

Execute the runtime’s main entrypoint using the local coordinator runner.

This uses the same real localhost party mesh as crate::Stoffel::execute_local. It is intended for runtimes that were built from no-argument ClientStore entrypoints with client input supplied through the builder.

Source

pub async fn execute_local_function(&self, name: &str) -> Result<Vec<Value>>

Execute a named runtime entrypoint using the local coordinator runner.

Trait Implementations§

Source§

impl Clone for StoffelRuntime

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StoffelRuntime

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more