openethereum/json/src/uint.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

177 lines
4.5 KiB
Rust
Raw Normal View History

2020-09-22 14:53:52 +02:00
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.
2016-03-15 18:17:48 +01:00
2020-09-22 14:53:52 +02:00
// OpenEthereum is free software: you can redistribute it and/or modify
2016-03-15 18:17:48 +01:00
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
2020-09-22 14:53:52 +02:00
// OpenEthereum is distributed in the hope that it will be useful,
2016-03-15 18:17:48 +01:00
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
2020-09-22 14:53:52 +02:00
// along with OpenEthereum. If not, see <http://www.gnu.org/licenses/>.
2016-03-15 18:17:48 +01:00
//! Lenient uint json deserialization for test json files.
use ethereum_types::U256;
use serde::{
de::{Error, Unexpected, Visitor},
Deserialize, Deserializer, Serialize, Serializer,
2020-08-05 06:08:03 +02:00
};
2016-03-15 18:17:48 +01:00
use std::{fmt, str::FromStr};
/// Lenient uint json deserialization for test json files.
#[derive(Default, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub struct Uint(pub U256);
2016-03-15 18:17:48 +01:00
impl Into<U256> for Uint {
fn into(self) -> U256 {
self.0
}
}
impl Into<u64> for Uint {
fn into(self) -> u64 {
u64::from(self.0)
}
}
impl Into<usize> for Uint {
fn into(self) -> usize {
// TODO: clean it after util conversions refactored.
u64::from(self.0) as usize
}
}
2016-03-29 13:01:26 +02:00
impl Into<u8> for Uint {
fn into(self) -> u8 {
u64::from(self.0) as u8
2016-03-29 13:01:26 +02:00
}
}
impl Serialize for Uint {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
self.0.to_string().serialize(serializer)
}
}
2017-07-06 11:36:15 +02:00
impl<'a> Deserialize<'a> for Uint {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
2017-07-06 11:36:15 +02:00
where
D: Deserializer<'a>,
{
deserializer.deserialize_any(UintVisitor)
2016-03-15 18:17:48 +01:00
}
}
struct UintVisitor;
2017-07-06 11:36:15 +02:00
impl<'a> Visitor<'a> for UintVisitor {
2016-03-15 18:17:48 +01:00
type Value = Uint;
2020-08-05 06:08:03 +02:00
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
write!(formatter, "a hex encoded or decimal uint")
}
2020-08-05 06:08:03 +02:00
fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
where
E: Error,
{
Ok(Uint(U256::from(value)))
}
2020-08-05 06:08:03 +02:00
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
where
E: Error,
{
2016-03-15 18:17:48 +01:00
let value = match value.len() {
0 => U256::from(0),
2 if value.starts_with("0x") => U256::from(0),
_ if value.starts_with("0x") => U256::from_str(&value[2..]).map_err(|e| {
Error::custom(format!("Invalid hex value {}: {}", value, e).as_str())
})?,
_ => U256::from_dec_str(value).map_err(|e| {
Error::custom(format!("Invalid decimal value {}: {:?}", value, e).as_str())
})?,
2016-03-15 18:17:48 +01:00
};
2020-08-05 06:08:03 +02:00
2016-03-15 18:17:48 +01:00
Ok(Uint(value))
}
2020-08-05 06:08:03 +02:00
fn visit_string<E>(self, value: String) -> Result<Self::Value, E>
where
E: Error,
{
2016-03-15 18:17:48 +01:00
self.visit_str(value.as_ref())
}
}
/// Deserialize and validate that the value is non-zero
pub fn validate_non_zero<'de, D>(d: D) -> Result<Uint, D::Error>
where
D: Deserializer<'de>,
{
let value = Uint::deserialize(d)?;
2020-08-05 06:08:03 +02:00
if value == Uint(U256::from(0)) {
return Err(Error::invalid_value(
Unexpected::Unsigned(value.into()),
&"a non-zero value",
));
}
2020-08-05 06:08:03 +02:00
Ok(value)
}
/// Deserialize and validate that the value is non-zero
pub fn validate_optional_non_zero<'de, D>(d: D) -> Result<Option<Uint>, D::Error>
where
D: Deserializer<'de>,
{
let value: Option<Uint> = Option::deserialize(d)?;
2020-08-05 06:08:03 +02:00
if let Some(value) = value {
if value == Uint(U256::from(0)) {
return Err(Error::invalid_value(
Unexpected::Unsigned(value.into()),
&"a non-zero value",
));
}
2020-08-05 06:08:03 +02:00
}
Ok(value)
}
2016-03-15 18:17:48 +01:00
#[cfg(test)]
mod test {
use ethereum_types::U256;
2016-03-15 18:17:48 +01:00
use serde_json;
use uint::Uint;
2020-08-05 06:08:03 +02:00
2016-03-15 18:17:48 +01:00
#[test]
fn uint_deserialization() {
let s = r#"["0xa", "10", "", "0x", 0]"#;
2016-03-15 18:17:48 +01:00
let deserialized: Vec<Uint> = serde_json::from_str(s).unwrap();
assert_eq!(
deserialized,
vec![
Uint(U256::from(10)),
Uint(U256::from(10)),
Uint(U256::from(0)),
Uint(U256::from(0)),
2016-03-15 18:17:48 +01:00
Uint(U256::from(0))
]
);
}
2020-08-05 06:08:03 +02:00
2016-03-15 18:17:48 +01:00
#[test]
fn uint_into() {
assert_eq!(U256::from(10), Uint(U256::from(10)).into());
}
}