Struct pbc_contract_common::zk::ZkState

#[non_exhaustive]
#[repr(C)]
pub struct ZkState<SecretVarMetadataT> {
    pub calculation_state: CalculationStatus,
    pub pending_inputs: AvlTreeMap<SecretVarId, ZkClosed<SecretVarMetadataT>>,
    pub secret_variables: AvlTreeMap<SecretVarId, ZkClosed<SecretVarMetadataT>>,
    pub data_attestations: AvlTreeMap<AttestationId, DataAttestation>,
    pub event_subscriptions: AvlTreeMap<EventSubscriptionId, EventSubscription>,
    pub external_events: AvlTreeMap<ExternalEventId, ExternalEvent>,
}

Stores and tracks state changes

• <SecretMetadataT>: Public state stored along with each variable.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

calculation_state: CalculationStatus

The MPC’s current state.

pending_inputs: AvlTreeMap<SecretVarId, ZkClosed<SecretVarMetadataT>>

Variables that are in the process of being input.

secret_variables: AvlTreeMap<SecretVarId, ZkClosed<SecretVarMetadataT>>

Secret variables that have been commited to.

data_attestations: AvlTreeMap<AttestationId, DataAttestation>

Attested data

event_subscriptions: AvlTreeMap<EventSubscriptionId, EventSubscription>

Event subscriptions

external_events: AvlTreeMap<ExternalEventId, ExternalEvent>

External events

Implementations

impl<SecretVarMetadataT: ReadWriteState> ZkState<SecretVarMetadataT>

pub fn get_pending_input( &self, id: SecretVarId ) -> Option<ZkClosed<SecretVarMetadataT>>

Utility method for finding pending input with given id

pub fn get_variable( &self, id: SecretVarId ) -> Option<ZkClosed<SecretVarMetadataT>>

Utility method for finding variable with given id

pub fn get_attestation( &self, attestation_id: AttestationId ) -> Option<DataAttestation>

Utility method for finding attestation by attestation id

Trait Implementations

impl<SecretVarMetadataT: Debug> Debug for ZkState<SecretVarMetadataT>

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

Formats the value using the given formatter.

impl<MetadataT: ReadWriteState> ReadRPC for ZkState<MetadataT>

fn rpc_read_from<T: Read>(reader: &mut T) -> Self

Deserialization method for RPC arguments.