git.delta.rocks / unique-network / refs/commits / 4aadc003b1ed

difftreelog

source

crates/evm-coder/src/abi.rs9.5 KiBsourcehistory
1//! TODO: I misunterstood therminology, abi IS rlp encoded, so2//! this module should be replaced with rlp crate34#![allow(dead_code)]56#[cfg(not(feature = "std"))]7use alloc::{8	string::{String, ToString},9	vec::Vec,10};11use evm_core::ExitError;12use primitive_types::{H160, U256};1314use crate::{execution::Error, types::string};15use crate::execution::Result;1617const ABI_ALIGNMENT: usize = 32;1819#[derive(Clone)]20pub struct AbiReader<'i> {21	buf: &'i [u8],22	subresult_offset: usize,23	offset: usize,24}25impl<'i> AbiReader<'i> {26	pub fn new(buf: &'i [u8]) -> Self {27		Self {28			buf,29			subresult_offset: 0,30			offset: 0,31		}32	}33	pub fn new_call(buf: &'i [u8]) -> Result<(u32, Self)> {34		if buf.len() < 4 {35			return Err(Error::Error(ExitError::OutOfOffset));36		}37		let mut method_id = [0; 4];38		method_id.copy_from_slice(&buf[0..4]);3940		Ok((41			u32::from_be_bytes(method_id),42			Self {43				buf,44				subresult_offset: 4,45				offset: 4,46			},47		))48	}4950	fn read_padleft<const S: usize>(&mut self) -> Result<[u8; S]> {51		if self.buf.len() - self.offset < ABI_ALIGNMENT {52			return Err(Error::Error(ExitError::OutOfOffset));53		}54		let mut block = [0; S];55		// Verify padding is empty56		if !self.buf[self.offset..self.offset + ABI_ALIGNMENT - S]57			.iter()58			.all(|&v| v == 0)59		{60			return Err(Error::Error(ExitError::InvalidRange));61		}62		block.copy_from_slice(63			&self.buf[self.offset + ABI_ALIGNMENT - S..self.offset + ABI_ALIGNMENT],64		);65		self.offset += ABI_ALIGNMENT;66		Ok(block)67	}6869	pub fn address(&mut self) -> Result<H160> {70		Ok(H160(self.read_padleft()?))71	}7273	pub fn bool(&mut self) -> Result<bool> {74		let data: [u8; 1] = self.read_padleft()?;75		match data[0] {76			0 => Ok(false),77			1 => Ok(true),78			_ => Err(Error::Error(ExitError::InvalidRange)),79		}80	}8182	pub fn bytes4(&mut self) -> Result<[u8; 4]> {83		self.read_padleft()84	}8586	pub fn bytes(&mut self) -> Result<Vec<u8>> {87		let mut subresult = self.subresult()?;88		let length = subresult.read_usize()?;89		if subresult.buf.len() <= subresult.offset + length {90			return Err(Error::Error(ExitError::OutOfOffset));91		}92		Ok(subresult.buf[subresult.offset..subresult.offset + length].into())93	}94	pub fn string(&mut self) -> Result<string> {95		string::from_utf8(self.bytes()?).map_err(|_| Error::Error(ExitError::InvalidRange))96	}9798	pub fn uint32(&mut self) -> Result<u32> {99		Ok(u32::from_be_bytes(self.read_padleft()?))100	}101102	pub fn uint128(&mut self) -> Result<u128> {103		Ok(u128::from_be_bytes(self.read_padleft()?))104	}105106	pub fn uint256(&mut self) -> Result<U256> {107		let buf: [u8; 32] = self.read_padleft()?;108		Ok(U256::from_big_endian(&buf))109	}110111	pub fn uint64(&mut self) -> Result<u64> {112		Ok(u64::from_be_bytes(self.read_padleft()?))113	}114115	pub fn read_usize(&mut self) -> Result<usize> {116		Ok(usize::from_be_bytes(self.read_padleft()?))117	}118119	fn subresult(&mut self) -> Result<AbiReader<'i>> {120		let offset = self.read_usize()?;121		if offset + self.subresult_offset > self.buf.len() {122			return Err(Error::Error(ExitError::InvalidRange));123		}124		Ok(AbiReader {125			buf: self.buf,126			subresult_offset: offset + self.subresult_offset,127			offset: offset + self.subresult_offset,128		})129	}130131	pub fn is_finished(&self) -> bool {132		self.buf.len() == self.offset133	}134}135136#[derive(Default)]137pub struct AbiWriter {138	static_part: Vec<u8>,139	dynamic_part: Vec<(usize, AbiWriter)>,140}141impl AbiWriter {142	pub fn new() -> Self {143		Self::default()144	}145	pub fn new_call(method_id: u32) -> Self {146		let mut val = Self::new();147		val.static_part.extend(&method_id.to_be_bytes());148		val149	}150151	fn write_padleft(&mut self, block: &[u8]) {152		assert!(block.len() <= ABI_ALIGNMENT);153		self.static_part154			.extend(&[0; ABI_ALIGNMENT][0..ABI_ALIGNMENT - block.len()]);155		self.static_part.extend(block);156	}157158	fn write_padright(&mut self, bytes: &[u8]) {159		assert!(bytes.len() <= ABI_ALIGNMENT);160		self.static_part.extend(bytes);161		self.static_part162			.extend(&[0; ABI_ALIGNMENT][0..ABI_ALIGNMENT - bytes.len()]);163	}164165	pub fn address(&mut self, address: &H160) {166		self.write_padleft(&address.0)167	}168169	pub fn bool(&mut self, value: &bool) {170		self.write_padleft(&[if *value { 1 } else { 0 }])171	}172173	pub fn uint8(&mut self, value: &u8) {174		self.write_padleft(&[*value])175	}176177	pub fn uint32(&mut self, value: &u32) {178		self.write_padleft(&u32::to_be_bytes(*value))179	}180181	pub fn uint128(&mut self, value: &u128) {182		self.write_padleft(&u128::to_be_bytes(*value))183	}184185	pub fn uint256(&mut self, value: &U256) {186		let mut out = [0; 32];187		value.to_big_endian(&mut out);188		self.write_padleft(&out)189	}190191	pub fn write_usize(&mut self, value: &usize) {192		self.write_padleft(&usize::to_be_bytes(*value))193	}194195	pub fn write_subresult(&mut self, result: Self) {196		self.dynamic_part.push((self.static_part.len(), result));197		// Empty block, to be filled later198		self.write_padleft(&[]);199	}200201	pub fn memory(&mut self, value: &[u8]) {202		let mut sub = Self::new();203		sub.write_usize(&value.len());204		for chunk in value.chunks(ABI_ALIGNMENT) {205			sub.write_padright(chunk);206		}207		self.write_subresult(sub);208	}209210	pub fn string(&mut self, value: &str) {211		self.memory(value.as_bytes())212	}213214	pub fn finish(mut self) -> Vec<u8> {215		for (static_offset, part) in self.dynamic_part {216			let part_offset = self.static_part.len();217218			let encoded_dynamic_offset = usize::to_be_bytes(part_offset);219			self.static_part[static_offset + ABI_ALIGNMENT - encoded_dynamic_offset.len()220				..static_offset + ABI_ALIGNMENT]221				.copy_from_slice(&encoded_dynamic_offset);222			self.static_part.extend(part.finish())223		}224		self.static_part225	}226}227228pub trait AbiRead<T> {229	fn abi_read(&mut self) -> Result<T>;230}231232macro_rules! impl_abi_readable {233	($ty:ty, $method:ident) => {234		impl AbiRead<$ty> for AbiReader<'_> {235			fn abi_read(&mut self) -> Result<$ty> {236				self.$method()237			}238		}239	};240}241242impl_abi_readable!(u32, uint32);243impl_abi_readable!(u128, uint128);244impl_abi_readable!(U256, uint256);245impl_abi_readable!(H160, address);246impl_abi_readable!(Vec<u8>, bytes);247impl_abi_readable!(bool, bool);248impl_abi_readable!(string, string);249250mod sealed {251	/// Not all types can be placed in vec, i.e `Vec<u8>` is restricted, `bytes` should be used instead252	pub trait CanBePlacedInVec {}253}254255impl sealed::CanBePlacedInVec for U256 {}256impl sealed::CanBePlacedInVec for string {}257impl sealed::CanBePlacedInVec for H160 {}258259impl<R: sealed::CanBePlacedInVec> AbiRead<Vec<R>> for AbiReader<'_>260where261	Self: AbiRead<R>,262{263	fn abi_read(&mut self) -> Result<Vec<R>> {264		todo!()265	}266}267268macro_rules! impl_tuples {269	($($ident:ident)+) => {270		impl<$($ident),+> sealed::CanBePlacedInVec for ($($ident,)+) {}271		impl<$($ident),+> AbiRead<($($ident,)+)> for AbiReader<'_>272		where273			$(Self: AbiRead<$ident>),+274		{275			fn abi_read(&mut self) -> Result<($($ident,)+)> {276				Ok((277					$(<Self as AbiRead<$ident>>::abi_read(self)?,)+278				))279			}280		}281	};282}283284impl_tuples! {A}285impl_tuples! {A B}286impl_tuples! {A B C}287impl_tuples! {A B C D}288impl_tuples! {A B C D E}289impl_tuples! {A B C D E F}290impl_tuples! {A B C D E F G}291impl_tuples! {A B C D E F G H}292impl_tuples! {A B C D E F G H I}293impl_tuples! {A B C D E F G H I J}294295pub trait AbiWrite {296	fn abi_write(&self, writer: &mut AbiWriter);297}298299macro_rules! impl_abi_writeable {300	($ty:ty, $method:ident) => {301		impl AbiWrite for $ty {302			fn abi_write(&self, writer: &mut AbiWriter) {303				writer.$method(&self)304			}305		}306	};307}308309impl_abi_writeable!(u8, uint8);310impl_abi_writeable!(u32, uint32);311impl_abi_writeable!(u128, uint128);312impl_abi_writeable!(U256, uint256);313impl_abi_writeable!(H160, address);314impl_abi_writeable!(bool, bool);315impl_abi_writeable!(&str, string);316impl AbiWrite for &string {317	fn abi_write(&self, writer: &mut AbiWriter) {318		writer.string(self)319	}320}321322impl AbiWrite for () {323	fn abi_write(&self, _writer: &mut AbiWriter) {}324}325326#[macro_export]327macro_rules! abi_decode {328	($reader:expr, $($name:ident: $typ:ident),+ $(,)?) => {329		$(330			let $name = $reader.$typ()?;331		)+332	}333}334#[macro_export]335macro_rules! abi_encode {336	($($typ:ident($value:expr)),* $(,)?) => {{337		#[allow(unused_mut)]338		let mut writer = ::evm_coder::abi::AbiWriter::new();339		$(340			writer.$typ($value);341		)*342		writer343	}};344	(call $val:expr; $($typ:ident($value:expr)),* $(,)?) => {{345		#[allow(unused_mut)]346		let mut writer = ::evm_coder::abi::AbiWriter::new_call($val);347		$(348			writer.$typ($value);349		)*350		writer351	}}352}353354#[cfg(test)]355pub mod test {356	use super::{AbiReader, AbiWriter};357	use hex_literal::hex;358359	#[test]360	fn dynamic_after_static() {361		let mut encoder = AbiWriter::new();362		encoder.bool(&true);363		encoder.string("test");364		let encoded = encoder.finish();365366		let mut encoder = AbiWriter::new();367		encoder.bool(&true);368		// Offset to subresult369		encoder.uint32(&(32 * 2));370		// Len of "test"371		encoder.uint32(&4);372		encoder.write_padright(&[b't', b'e', b's', b't']);373		let alternative_encoded = encoder.finish();374375		assert_eq!(encoded, alternative_encoded);376377		let mut decoder = AbiReader::new(&encoded);378		assert_eq!(decoder.bool().unwrap(), true);379		assert_eq!(decoder.string().unwrap(), "test");380	}381382	#[test]383	fn mint_sample() {384		let (call, mut decoder) = AbiReader::new_call(&hex!(385			"386				50bb4e7f387				000000000000000000000000ad2c0954693c2b5404b7e50967d3481bea432374388				0000000000000000000000000000000000000000000000000000000000000001389				0000000000000000000000000000000000000000000000000000000000000060390				0000000000000000000000000000000000000000000000000000000000000008391				5465737420555249000000000000000000000000000000000000000000000000392			"393		))394		.unwrap();395		assert_eq!(call, 0x50bb4e7f);396		assert_eq!(397			format!("{:?}", decoder.address().unwrap()),398			"0xad2c0954693c2b5404b7e50967d3481bea432374"399		);400		assert_eq!(decoder.uint32().unwrap(), 1);401		assert_eq!(decoder.string().unwrap(), "Test URI");402	}403}