Struct pbc_contract_common::zk::ZkInputDef

#[repr(C)]
pub struct ZkInputDef<MetadataT, SecretT: SecretBinary> { /* private fields */ }

Contains initialization information about Zk variables. Exclusively needed for the zk_on_secret_input hook.

<MetadataT> is the type of the piece of public information associated with the variable.

Implementations

impl<MetadataT, SecretT: SecretBinary + SecretBinaryFixedSize> ZkInputDef<MetadataT, SecretT>

pub fn with_metadata( shortname: Option<ShortnameZkVariableInputted>, metadata: MetadataT ) -> Self

Create new ZkInputDef with the given metadata, and a fixed size from the secret type ´SecretT`.

This method requires ‘SecretT’ to possess a fixed size. For types that do not posses a fixed size, for example Vecors, use ZkInputDef::with_metadata_and_size

impl<MetadataT, SecretT: SecretBinary> ZkInputDef<MetadataT, SecretT>

pub fn with_metadata_and_size( shortname: Option<ShortnameZkVariableInputted>, metadata: MetadataT, secret_size: u32 ) -> Self

Create new ZkInputDef with the given metadata and size.

secret_size specifies the size of the secret variable in bits.

Prefer ZkInputDef::with_metadata when your type has a fixed size, as it is much easier to use. Only use this method when using dynamically sized data, like Vectors. This method requires you to know precisely how much data to secret-share, and providing the wrong secret_sizecould prevent usage.

Trait Implementations

impl<MetadataT: Debug, SecretT: Debug + SecretBinary> Debug for ZkInputDef<MetadataT, SecretT>

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

Formats the value using the given formatter.

impl<MetadataT: ReadWriteState, SecretT: SecretBinary> WriteRPC for ZkInputDef<MetadataT, SecretT>

fn rpc_write_to<T: Write>(&self, writer: &mut T) -> Result<()>

Serialization method for RPC arguments.