Enum JsonStorageKey

pub enum JsonStorageKey {
    Hash(B256),
    Number(U256),
}

A storage key type that can be serialized to and from a hex string up to 32 bytes. Used for eth_getStorageAt and eth_getProof RPCs.

This is a wrapper type meant to mirror geth’s serialization and deserialization behavior for storage keys.

In eth_getStorageAt, this is used for deserialization of the index field. Internally, the index is a B256, but in eth_getStorageAt requests, its serialization can be up to 32 bytes. To support this, the storage key is deserialized first as a U256, and converted to a B256 for use internally.

eth_getProof also takes storage keys up to 32 bytes as input, so the keys field is similarly deserialized. However, geth populates the storage proof key fields in the response by mirroring the key field used in the input.

See how storageKeys (the input) are populated in the StorageResult (the output): https://github.com/ethereum/go-ethereum/blob/00a73fbcce3250b87fc4160f3deddc44390848f4/internal/ethapi/api.go#L658-L690

The contained B256 and From implementation for String are used to preserve the input and implement this behavior from geth.

Variants

Hash(B256)

A full 32-byte key (tried first during deserialization)

Number(U256)

A number (fallback if B256 deserialization fails)

Implementations

impl JsonStorageKey

pub fn as_b256(&self) -> B256

Returns the key as a B256 value.

Trait Implementations

impl Clone for JsonStorageKey

fn clone(&self) -> JsonStorageKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonStorageKey

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

Formats the value using the given formatter.

impl Default for JsonStorageKey

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonStorageKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JsonStorageKey

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

Formats the value using the given formatter.

impl From<[u8; 32]> for JsonStorageKey

fn from(value: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<FixedBytes<32>> for JsonStorageKey

fn from(value: B256) -> Self

Converts to this type from the input type.

impl From<Uint<256, 4>> for JsonStorageKey

fn from(value: U256) -> Self

Converts to this type from the input type.

impl FromStr for JsonStorageKey

type Err = ParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for JsonStorageKey

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for JsonStorageKey

impl Eq for JsonStorageKey

impl StructuralPartialEq for JsonStorageKey