Struct axiom_sdk::axiom::AxiomCompute

pub struct AxiomCompute<A: AxiomComputeFn> { /* private fields */ }

Helper struct that contains all the necessary metadata and inputs to run an Axiom Compute function

Implementations

impl<A: AxiomComputeFn> AxiomCompute<A>

where A::Input<Fr>: Default + Debug, A::Input<AssignedValue<Fr>>: Debug,

pub fn new() -> Self

Create a new AxiomCompute instance

pub fn set_provider(&mut self, provider: Provider<Http>)

Set the provider for the AxiomCompute instance

pub fn set_params(&mut self, params: AxiomCircuitParams)

Set the params for the AxiomCompute instance

pub fn set_inputs(&mut self, input: A::LogicInput)

Set the inputs for the AxiomCompute instance

pub fn set_pinning(&mut self, pinning: AxiomCircuitPinning)

Set the pinning for the AxiomCompute instance

pub fn use_provider(self, provider: Provider<Http>) -> Self

Use the given provider for the AxiomCompute instance

pub fn use_params(self, params: AxiomCircuitParams) -> Self

Use the given params for the AxiomCompute instance

pub fn use_inputs(self, input: A::LogicInput) -> Self

Use the given inputs for the AxiomCompute instance

pub fn use_pinning(self, pinning: AxiomCircuitPinning) -> Self

Use the given pinning for the AxiomCompute instance

pub fn mock(&self)

Run the mock prover

pub fn keygen( &self ) -> (VerifyingKey<G1Affine>, ProvingKey<G1Affine>, AxiomCircuitPinning)

Run key generation and return the proving and verifying keys, and the circuit pinning

pub fn prove(&self, pk: ProvingKey<G1Affine>) -> Snark

Run the prover and return the resulting snark

pub fn run(&self, pk: ProvingKey<G1Affine>) -> AxiomV2CircuitOutput

Run the prover and return the outputs needed to make an on-chain compute query

pub fn circuit(&self) -> AxiomCircuit<Fr, Http, Self>

Returns an AxiomCircuit instance, for functions that expect the halo2 circuit trait

Trait Implementations

impl<A: AxiomComputeFn> AxiomCircuitScaffold<Provider, Fr> for AxiomCompute<A>

where A::Input<Fr>: Default + Debug, A::Input<AssignedValue<Fr>>: Debug,

type InputValue = <A as AxiomComputeInput>::Input<Fr>

type InputWitness = <A as AxiomComputeInput>::Input<AssignedValue<Fr>>

type FirstPhasePayload = <A as AxiomComputeFn>::FirstPhasePayload

fn virtual_assign_phase0( builder: &mut RlcCircuitBuilder<Fr>, range: &RangeChip<Fr>, subquery_caller: Arc<Mutex<SubqueryCaller<Http, Fr>>>, callback: &mut Vec<HiLo<AssignedValue<Fr>>>, assigned_inputs: Self::InputWitness ) -> <A as AxiomComputeFn>::FirstPhasePayload

fn virtual_assign_phase1( builder: &mut RlcCircuitBuilder<Fr>, range: &RangeChip<Fr>, payload: Self::FirstPhasePayload )

Most people should not use this

impl<A: Clone + AxiomComputeFn> Clone for AxiomCompute<A>

where A::LogicInput: Clone,

fn clone(&self) -> AxiomCompute<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + AxiomComputeFn> Debug for AxiomCompute<A>

where A::LogicInput: Debug,

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

Formats the value using the given formatter.

impl<A: AxiomComputeFn> Default for AxiomCompute<A>

fn default() -> Self

Returns the “default value” for a type.