Struct Request

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

Implementations

impl<N: Network> Request<N>

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

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, signer, [tvk, tcm, function ID, input IDs]) response := r - challenge * sk_sig

impl<N: Network> Request<N>

pub fn verify(&self, input_types: &[ValueType<N>], is_root: bool) -> 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, signer, [tvk, tcm, function ID, input IDs])

impl<N: Network> Request<N>

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

Returns the request signer.

pub const fn network_id(&self) -> &U16<N>

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 tcm(&self) -> &Field<N>

Returns the transition commitment tcm.

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

Returns the signer commitment scm.

Trait Implementations

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

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: Network> Debug for Request<N>

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

Prints the request as a JSON-string.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the request from a string or bytes.

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

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

Displays the request as a JSON-string.

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

fn from( (signer, network_id, program_id, function_name, input_ids, inputs, signature, sk_tag, tvk, tcm, scm): (Address<N>, U16<N>, ProgramID<N>, Identifier<N>, Vec<InputID<N>>, Vec<Value<N>>, Signature<N>, Field<N>, Field<N>, Field<N>, Field<N>), ) -> Self

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

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

fn read_le<R: Read>(reader: R) -> IoResult<Self>

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: Network> FromStr for Request<N>

fn from_str(request: &str) -> Result<Self, Self::Err>

Initializes the request from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Serializes the request into string or bytes.

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

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the request to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

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

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

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