starknet-devnet-types 0.8.0-rc.1

use serde::{Deserialize, Deserializer, Serialize};
use starknet_api::core::PATRICIA_KEY_UPPER_BOUND;
use starknet_rs_core::types::Felt;

use crate::error::{DevnetResult, Error};
use crate::serde_helpers::hex_string::{
    deserialize_to_prefixed_patricia_key, serialize_patricia_key_to_prefixed_hex,
};

#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub struct PatriciaKey(pub(crate) Felt);

pub(crate) const PATRICIA_KEY_ZERO: PatriciaKey = PatriciaKey(Felt::ZERO);

impl PatriciaKey {
    pub fn new(felt: Felt) -> DevnetResult<Self> {
        if Felt::from_hex_unchecked(PATRICIA_KEY_UPPER_BOUND) < felt {
            return Err(Error::StarknetApiError(starknet_api::StarknetApiError::OutOfRange {
                string: format!("[0x0, {PATRICIA_KEY_UPPER_BOUND})"),
            }));
        }
        Ok(Self(felt))
    }

    /// Constructs without range checks.
    /// Safety: `felt` must be in [0x0, PATRICIA_KEY_UPPER_BOUND).
    pub(crate) fn new_unchecked(felt: Felt) -> Self {
        debug_assert!(
            Felt::from_hex_unchecked(PATRICIA_KEY_UPPER_BOUND) >= felt,
            "PatriciaKey out of range"
        );
        Self(felt)
    }

    pub fn to_felt(&self) -> Felt {
        self.0
    }
}

impl Serialize for PatriciaKey {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serialize_patricia_key_to_prefixed_hex(self, serializer)
    }
}

impl<'de> Deserialize<'de> for PatriciaKey {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserialize_to_prefixed_patricia_key(deserializer)
    }
}

impl From<starknet_api::core::PatriciaKey> for PatriciaKey {
    fn from(value: starknet_api::core::PatriciaKey) -> Self {
        Self(*value.key())
    }
}

impl From<PatriciaKey> for starknet_api::core::PatriciaKey {
    fn from(value: PatriciaKey) -> Self {
        Self::from_hex_unchecked(&value.0.to_hex_string())
    }
}

impl TryFrom<Felt> for PatriciaKey {
    type Error = Error;

    fn try_from(value: Felt) -> Result<Self, Self::Error> {
        Self::new(value)
    }
}

impl From<PatriciaKey> for starknet_api::state::StorageKey {
    fn from(value: PatriciaKey) -> Self {
        Self(value.into())
    }
}

pub type StorageKey = PatriciaKey;

#[cfg(test)]
mod tests {
    use super::PatriciaKey;
    use crate::felt::felt_from_prefixed_hex;

    #[test]
    fn creation_of_patricia_key_should_be_successful() {
        assert!(
            PatriciaKey::new(
                felt_from_prefixed_hex(
                    "0x7ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
                )
                .unwrap()
            )
            .is_ok()
        );
    }

    #[test]
    fn patricia_key_with_too_large_felt_should_return_error() {
        let result = PatriciaKey::new(
            felt_from_prefixed_hex(
                "0x800000000000000000000000000000000000000000000000000000000000001",
            )
            .unwrap(),
        );
        assert!(result.is_err());
    }
}