Struct VerifySignatureRequest

#[non_exhaustive]
pub struct VerifySignatureRequest {
    pub message: Option<Bcs>,
    pub signature: Option<UserSignature>,
    pub address: Option<String>,
    pub jwks: Vec<ActiveJwk>,
}

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.

message: Option<Bcs>

The message to verify against.

Today the only supported message types are PersonalMessage and TransactionData and the Bcs.name must be set to indicate which type of message is being verified.

signature: Option<UserSignature>

The signature to verify.

address: Option<String>

Optional. Address to validate against the provided signature.

If provided, this address will be compared against the the address derived from the provide signature and a successful response will only be returned if they match.

jwks: Vec<ActiveJwk>

The set of JWKs to use when verifying Zklogin signatures. If this is empty the current set of valid JWKs stored onchain will be used

Implementations

impl VerifySignatureRequest

pub const MESSAGE_FIELD: &'static MessageField

pub const SIGNATURE_FIELD: &'static MessageField

pub const ADDRESS_FIELD: &'static MessageField

pub const JWKS_FIELD: &'static MessageField

impl VerifySignatureRequest

pub fn path_builder() -> VerifySignatureRequestFieldPathBuilder

impl VerifySignatureRequest

pub const fn const_default() -> Self

pub fn message(&self) -> &Bcs

Returns the value of message, or the default value if message is unset.

pub fn message_opt_mut(&mut self) -> Option<&mut Bcs>

If message is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn message_mut(&mut self) -> &mut Bcs

Returns a mutable reference to message. If the field is unset, it is first initialized with the default value.

pub fn message_opt(&self) -> Option<&Bcs>

If message is set, returns Some with the value; otherwise returns None.

pub fn set_message<T: Into<Bcs>>(&mut self, field: T)

Sets message with the provided value.

pub fn with_message<T: Into<Bcs>>(self, field: T) -> Self

Sets message with the provided value.

pub fn signature(&self) -> &UserSignature

Returns the value of signature, or the default value if signature is unset.

pub fn signature_opt_mut(&mut self) -> Option<&mut UserSignature>

If signature is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn signature_mut(&mut self) -> &mut UserSignature

Returns a mutable reference to signature. If the field is unset, it is first initialized with the default value.

pub fn signature_opt(&self) -> Option<&UserSignature>

If signature is set, returns Some with the value; otherwise returns None.

pub fn set_signature<T: Into<UserSignature>>(&mut self, field: T)

Sets signature with the provided value.

pub fn with_signature<T: Into<UserSignature>>(self, field: T) -> Self

Sets signature with the provided value.

pub fn address_opt_mut(&mut self) -> Option<&mut String>

If address is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn address_mut(&mut self) -> &mut String

Returns a mutable reference to address. If the field is unset, it is first initialized with the default value.

pub fn address_opt(&self) -> Option<&str>

If address is set, returns Some with the value; otherwise returns None.

pub fn set_address<T: Into<String>>(&mut self, field: T)

Sets address with the provided value.

pub fn with_address<T: Into<String>>(self, field: T) -> Self

Sets address with the provided value.

pub fn jwks(&self) -> &[ActiveJwk]

Returns the value of jwks, or the default value if jwks is unset.

pub fn jwks_mut(&mut self) -> &mut Vec<ActiveJwk>

Returns a mutable reference to jwks. If the field is unset, it is first initialized with the default value.

pub fn set_jwks(&mut self, field: Vec<ActiveJwk>)

Sets jwks with the provided value.

pub fn with_jwks(self, field: Vec<ActiveJwk>) -> Self

Sets jwks with the provided value.

impl VerifySignatureRequest

pub fn address(&self) -> &str

Returns the value of address, or the default value if address is unset.

Trait Implementations

impl Clone for VerifySignatureRequest

fn clone(&self) -> VerifySignatureRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VerifySignatureRequest

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

Formats the value using the given formatter.

impl Default for VerifySignatureRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VerifySignatureRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for VerifySignatureRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for VerifySignatureRequest

const FIELDS: &'static [&'static MessageField]

impl PartialEq for VerifySignatureRequest

fn eq(&self, other: &VerifySignatureRequest) -> 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 Serialize for VerifySignatureRequest

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VerifySignatureRequest