Struct starknet_api::state::StorageKey

pub struct StorageKey(pub PatriciaKey);

A storage key in a contract.

Tuple Fields

0: PatriciaKey

Methods from Deref<Target = PatriciaKey>

pub fn key(&self) -> &StarkHash

Methods from Deref<Target = StarkHash>

pub const ZERO: Felt = _

pub const ONE: Felt = _

pub const TWO: Felt = _

pub const THREE: Felt = _

pub const MAX: Felt = _

pub const ELEMENT_UPPER_BOUND: Felt = _

pub fn to_bytes_be(&self) -> [u8; 32]

Converts to big-endian byte representation in a u8 array. This is as performant as to_bytes_le

pub fn to_bytes_le(&self) -> [u8; 32]

Converts to little-endian byte representation in a u8 array. This is as performant as to_bytes_be

pub fn to_hex_string(&self) -> String

Helper to produce a hexadecimal formatted string. Equivalent to calling format!("{self:#x}").

pub fn to_fixed_hex_string(&self) -> String

Helper to produce a hexadecimal formatted string of 66 chars.

pub fn to_bits_le(&self) -> [bool; 256]

Converts to little-endian bit representation.

pub fn to_bits_be(&self) -> [bool; 256]

Converts to big-endian bit representation.

pub fn field_div(&self, rhs: &NonZeroFelt) -> Felt

Finite field division.

pub fn floor_div(&self, rhs: &NonZeroFelt) -> Felt

Truncated quotient between self and rhs.

pub fn div_rem(&self, rhs: &NonZeroFelt) -> (Felt, Felt)

Quotient and remainder between self and rhs.

pub fn inverse(&self) -> Option<Felt>

Multiplicative inverse inside field.

pub fn sqrt(&self) -> Option<Felt>

Finds the square root. There may be 2 roots for each square, and the lower one is returned.

pub fn square(&self) -> Felt

Raises self to the power of 2.

pub fn double(&self) -> Felt

Doubles the point self

pub fn pow(&self, exponent: impl Into<u128>) -> Felt

Raises self to the power of exponent.

pub fn pow_felt(&self, exponent: &Felt) -> Felt

Raises self to the power of exponent.

pub fn mul_mod(&self, rhs: &Felt, p: &NonZeroFelt) -> Felt

Modular multiplication between self and rhs in modulo p.

pub fn mod_inverse(&self, p: &NonZeroFelt) -> Option<Felt>

Multiplicative inverse of self in modulo p.

pub fn mod_floor(&self, n: &NonZeroFelt) -> Felt

Remainder of dividing self by n as integers.

pub fn to_raw_reversed(&self) -> [u64; 4]

Returns the internal representation of a felt and reverses it to match starknet-rs mont representation

pub fn to_raw(&self) -> [u64; 4]

Returns the internal representation of a felt

pub fn to_le_digits(&self) -> [u64; 4]

Convert self’s representative into an array of u64 digits, least significant digits first.

pub fn to_be_digits(&self) -> [u64; 4]

Convert self’s representative into an array of u64 digits, most significant digits first.

pub fn bits(&self) -> usize

Count the minimum number of bits needed to express self’s representative.

pub fn to_biguint(&self) -> BigUint

pub fn to_bigint(&self) -> BigInt

Trait Implementations

impl Clone for StorageKey

fn clone(&self) -> StorageKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageKey

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

Formats the value using the given formatter.

impl Default for StorageKey

fn default() -> StorageKey

Returns the “default value” for a type.

impl Deref for StorageKey

type Target = PatriciaKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for StorageKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StorageKey> for Felt

fn from(storage_key: StorageKey) -> Felt

Converts to this type from the input type.

impl From<u128> for StorageKey

fn from(val: u128) -> Self

Converts to this type from the input type.

impl From<u16> for StorageKey

fn from(x: u16) -> Self

Converts to this type from the input type.

impl From<u32> for StorageKey

fn from(x: u32) -> Self

Converts to this type from the input type.

impl From<u64> for StorageKey

fn from(x: u64) -> Self

Converts to this type from the input type.

impl From<u8> for StorageKey

fn from(x: u8) -> Self

Converts to this type from the input type.

impl Hash for StorageKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StorageKey

fn cmp(&self, other: &StorageKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StorageKey

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

fn partial_cmp(&self, other: &StorageKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StorageKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Felt> for StorageKey

type Error = StarknetApiError

The type returned in the event of a conversion error.

fn try_from(val: StarkHash) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for StorageKey

impl Eq for StorageKey

impl StructuralPartialEq for StorageKey