evm-interpreter 1.1.0

//! Re-export of uint type that is currently use.
//!
//! Depending on the feature flag, different underlying crate may be used.
//! * Default (no feature flag): use `primitive-types` crate.
//! * `ruint` feature flag: use `ruint` crate.

// H256 and H160 are pretty standardized, and there's no performance difference
// in different implementations, so we always only use the one from
// `primitive-types`.
pub use ::primitive_types::{H160, H256};

/// Extension for specialized U256 operations.
// Note on name resolution: when trait and struct itself defines functions of
// identical name, then Rust would by default calls the implementation on the
// struct directly. We take advantage of this for the extension trait.
#[doc(hidden)]
pub trait U256Ext: Sealed + Sized + Eq + PartialEq + Ord + PartialOrd + Clone + Copy {
	/// Zero value.
	const ZERO: Self;
	/// One value.
	const ONE: Self;
	/// Value 32.
	const VALUE_32: Self;
	/// Value 64.
	const VALUE_64: Self;
	/// Value 256.
	const VALUE_256: Self;
	/// Usize max.
	const USIZE_MAX: Self;
	/// U64 max.
	const U64_MAX: Self;
	/// U32 max.
	const U32_MAX: Self;
	/// Sign bit mask.
	const SIGN_BIT_MASK: Self;

	/// An ADDMOD operation for U256.
	fn add_mod(self, op2: Self, op3: Self) -> Self;
	/// An MULMOD operation for U256.
	fn mul_mod(self, op2: Self, op3: Self) -> Self;

	/// Conversion to usize with overflow checking.
	/// Should panic if the number is larger than usize::MAX.
	fn to_usize(&self) -> usize {
		assert!(*self <= Self::USIZE_MAX);
		self.low_usize()
	}
	/// Conversion to u64 with overflow checking.
	/// Should panic if the number is larger than u64::MAX.
	fn to_u64(&self) -> u64 {
		assert!(*self <= Self::U64_MAX);
		self.low_u64()
	}
	/// Conversion to u32 with overflow checking.
	/// Should panic if the number is larger than u32::MAX.
	fn to_u32(&self) -> u32 {
		assert!(*self <= Self::U32_MAX);
		self.low_u32()
	}

	/// Lower word of u64.
	fn low_u64(&self) -> u64;
	/// Lower word of u32.
	fn low_u32(&self) -> u32;
	/// Lower word of usize.
	fn low_usize(&self) -> usize;

	/// Conversion from u32.
	fn from_u32(v: u32) -> Self;
	/// Conversion from u64.
	fn from_u64(v: u64) -> Self;
	/// Conversion from usize.
	fn from_usize(v: usize) -> Self;

	/// Conversion to H256 big-endian.
	fn to_h256(self) -> H256;
	/// Conversion from H256 big-endian.
	fn from_h256(v: H256) -> Self;
	/// Conversion to H160 big-endian, discard leading bits.
	fn to_h160(self) -> H160 {
		self.to_h256().into()
	}
	/// Conversion from H160 big-endian, with leading bits as zero.
	fn from_h160(v: H160) -> Self {
		Self::from_h256(v.into())
	}

	/// Whether the value is zero.
	fn is_zero(&self) -> bool {
		*self == Self::ZERO
	}
	/// Whether a specific bit is set.
	fn bit(&self, index: usize) -> bool;
	/// Least number of bits needed to represent the number.
	fn bits(&self) -> usize;
	/// Log2 of the value, rounded down.
	fn log2floor(&self) -> u64;
	/// Append the value to RLP stream.
	fn append_to_rlp_stream(&self, rlp: &mut rlp::RlpStream);
}

// Use default primitive-types U256 implementation.
#[cfg(not(feature = "ruint"))]
mod primitive_types;
#[cfg(not(feature = "ruint"))]
use self::primitive_types::Sealed;
#[cfg(not(feature = "ruint"))]
pub use self::primitive_types::U256;

// Use ruint U256 implementation.
#[cfg(feature = "ruint")]
mod ruint;
#[cfg(feature = "ruint")]
use self::ruint::Sealed;
#[cfg(feature = "ruint")]
pub use self::ruint::U256;

#[cfg(test)]
mod tests {
	#[allow(unused_imports)]
	use super::{U256, U256Ext};

	#[test]
	fn shl_overflowing() {
		assert_eq!(U256::ONE << 257, U256::ZERO);
	}
}