Struct fadroma::scrt::vk::ViewingKey

pub struct ViewingKey(pub String);

Represents a viewing key string which is provided as unverified input to a query.

PartialEq is intentionally not implemented on this type in order to prevent from using it to check viewing keys that way. You should convert to ViewingKeyHashed (using ViewingKey::to_hashed) and then call ViewingKeyHashed::check which performs a specialized constant time equality comparison. ViewingKey::check and ViewingKey::check_hashed are also provided for convenience.

Tuple Fields

0: String

Implementations

impl ViewingKey

pub fn new(env: &Env, info: &MessageInfo, seed: &[u8], entropy: &[u8]) -> Self

pub fn to_hashed(&self) -> ViewingKeyHashed

Converts the viewing key to SHA-256 hash representation.

pub fn as_bytes(&self) -> &[u8]

pub fn check(&self, other: &ViewingKey) -> bool

Converts both self and other to ViewingKeyHashed and compares them for equality using a constant time function.

pub fn check_hashed(&self, hashed: &ViewingKeyHashed) -> bool

Converts self to ViewingKeyHashed and compares it to other for equality using a constant time function.

Trait Implementations

impl AsRef<[u8]> for ViewingKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for ViewingKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Canonize for ViewingKey

type Output = ViewingKey

fn canonize(self, _api: &dyn Api) -> StdResult<Self::Output>

impl Clone for ViewingKey

fn clone(&self) -> ViewingKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewingKey

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

Formats the value using the given formatter.

impl Default for ViewingKey

fn default() -> ViewingKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewingKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ViewingKey

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

Formats the value using the given formatter.

impl FadromaDeserialize for ViewingKey

fn from_bytes<'a>(de: &mut Deserializer<'a>) -> Result<Self>

Deserialize into a new instance by reading bytes from the provided Deserializer.

impl FadromaSerialize for ViewingKey

fn size_hint(&self) -> usize

The size in bytes of the particular instance when converted to its byte respresentation. While it’s preferred that this method returns an exact size (or at least a bigger estimation) it’s not an error to return an incorrect number. The penalty for doing so is potentially incurring unnecessary re-allocations.

fn to_bytes(&self, ser: &mut Serializer) -> Result<()>

Serialize the instance into bytes by writing to the provided Serializer.

impl<T: Into<String>> From<T> for ViewingKey

fn from(vk: T) -> Self

Converts to this type from the input type.

impl Humanize for ViewingKey

type Output = ViewingKey

fn humanize(self, _api: &dyn Api) -> StdResult<Self::Output>

impl JsonSchema for ViewingKey

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ViewingKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.