Struct snarkvm_wasm::program::Request

pub struct Request<N>where
    N: Network,{ /* private fields */ }

Implementations

impl<N> Request<N>where
    N: Network,

pub fn sign<R>(
    private_key: &PrivateKey<N>,
    program_id: ProgramID<N>,
    function_name: Identifier<N>,
    inputs: impl ExactSizeIterator<Item = impl TryInto<Value<N>>>,
    input_types: &[ValueType<N>],
    rng: &mut R
) -> Result<Request<N>, Error>where
    R: Rng + CryptoRng,

Returns the request for a given private key, program ID, function name, inputs, input types, and RNG, where: challenge := HashToScalar(r * G, pk_sig, pr_sig, caller, [tvk, tcm, function ID, input IDs]) response := r - challenge * sk_sig

impl<N> Request<N>where
    N: Network,

pub fn verify(&self, input_types: &[ValueType<N>]) -> bool

Returns true if the request is valid, and false otherwise.

Verifies (challenge == challenge’) && (address == address’) && (serial_numbers == serial_numbers’) where: challenge’ := HashToScalar(r * G, pk_sig, pr_sig, caller, [tvk, tcm, function ID, input IDs])

impl<N> Request<N>where
    N: Network,

pub const fn caller(&self) -> &Address<N>

Returns the request caller.

pub const fn network_id(&self) -> &Integer<N, u16>

Returns the network ID.

pub const fn program_id(&self) -> &ProgramID<N>

Returns the program ID.

pub const fn function_name(&self) -> &Identifier<N>

Returns the function name.

pub fn input_ids(&self) -> &[InputID<N>]

Returns the input ID for the transition.

pub fn inputs(&self) -> &[Value<N>]

Returns the function inputs.

pub const fn signature(&self) -> &Signature<N>

Returns the signature for the transition.

pub const fn sk_tag(&self) -> &Field<N>

Returns the tag secret key sk_tag.

pub const fn tvk(&self) -> &Field<N>

Returns the transition view key tvk.

pub fn to_tpk(&self) -> Group<N>

Returns the transition public key tpk.

pub const fn tsk(&self) -> &Scalar<N>

Returns the transition secret key tsk.

pub const fn tcm(&self) -> &Field<N>

Returns the transition commitment tcm.

Trait Implementations

impl<N> Clone for Request<N>where
    N: Clone + Network,

fn clone(&self) -> Request<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Request<N>where
    N: Network,

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

Prints the request as a JSON-string.

impl<'de, N> Deserialize<'de> for Request<N>where
    N: Network,

fn deserialize<D>(
    deserializer: D
) -> Result<Request<N>, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserializes the request from a string or bytes.

impl<N> Display for Request<N>where
    N: Network,

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

Displays the request as a JSON-string.

impl<N> From<(Address<N>, Integer<N, u16>, ProgramID<N>, Identifier<N>, Vec<InputID<N>, Global>, Vec<Value<N>, Global>, Signature<N>, Field<N>, Field<N>, Scalar<N>, Field<N>)> for Request<N>where
    N: Network,

fn from(
    _: (Address<N>, Integer<N, u16>, ProgramID<N>, Identifier<N>, Vec<InputID<N>, Global>, Vec<Value<N>, Global>, Signature<N>, Field<N>, Field<N>, Scalar<N>, Field<N>)
) -> Request<N>

Note: See Request::sign to create the request. This method is used to eject from a circuit.

impl<N> FromBytes for Request<N>where
    N: Network,

fn read_le<R>(reader: R) -> Result<Request<N>, Error>where
    R: Read,

Reads the request from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>where
    Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromStr for Request<N>where
    N: Network,

fn from_str(request: &str) -> Result<Request<N>, <Request<N> as FromStr>::Err>

Initializes the request from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq<Request<N>> for Request<N>where
    N: PartialEq<N> + Network,

fn eq(&self, other: &Request<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Serialize for Request<N>where
    N: Network,

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
    S: Serializer,

Serializes the request into string or bytes.

impl<N> ToBytes for Request<N>where
    N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>where
    W: Write,

Writes the request to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>where
    Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Eq for Request<N>where
    N: Eq + Network,

impl<N> StructuralEq for Request<N>where
    N: Network,

impl<N> StructuralPartialEq for Request<N>where
    N: Network,