git.delta.rocks / unique-network / refs/commits / b25659aaac93

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! The module contains a number of functions for converting and checking ethereum identifiers.1819use alloc::format;20use sp_std::{vec, vec::Vec};21use evm_coder::{22	AbiCoder,23	types::{uint256, address},24};25pub use pallet_evm::{Config, account::CrossAccountId};26use sp_core::H160;27use up_data_structs::CollectionId;2829// 0x17c4e6453Cc49AAAaEACA894e6D9683e00000001 - collection 130// TODO: Unhardcode prefix31const ETH_COLLECTION_PREFIX: [u8; 16] = [32	0x17, 0xc4, 0xe6, 0x45, 0x3c, 0xc4, 0x9a, 0xaa, 0xae, 0xac, 0xa8, 0x94, 0xe6, 0xd9, 0x68, 0x3e,33];3435/// Maps the ethereum address of the collection in substrate.36pub fn map_eth_to_id(eth: &H160) -> Option<CollectionId> {37	if eth[0..16] != ETH_COLLECTION_PREFIX {38		return None;39	}40	let mut id_bytes = [0; 4];41	id_bytes.copy_from_slice(&eth[16..20]);42	Some(CollectionId(u32::from_be_bytes(id_bytes)))43}4445/// Maps the substrate collection id in ethereum.46pub fn collection_id_to_address(id: CollectionId) -> H160 {47	let mut out = [0; 20];48	out[0..16].copy_from_slice(&ETH_COLLECTION_PREFIX);49	out[16..20].copy_from_slice(&u32::to_be_bytes(id.0));50	H160(out)51}5253/// Check if the ethereum address is a collection.54pub fn is_collection(address: &H160) -> bool {55	address[0..16] == ETH_COLLECTION_PREFIX56}5758/// Convert `uint256` to `CrossAccountId`.59pub fn convert_uint256_to_cross_account<T: Config>(from: uint256) -> T::CrossAccountId60where61	T::AccountId: From<[u8; 32]>,62{63	let mut new_admin_arr = [0_u8; 32];64	from.to_big_endian(&mut new_admin_arr);65	let account_id = T::AccountId::from(new_admin_arr);66	T::CrossAccountId::from_sub(account_id)67}6869/// Ethereum representation of Optional value with uint256.70#[derive(Debug, Default, AbiCoder)]71pub struct OptionUint {72	status: bool,73	value: uint256,74}7576impl From<u32> for OptionUint {77	fn from(value: u32) -> Self {78		Self {79			status: true,80			value: uint256::from(value),81		}82	}83}8485impl From<Option<u32>> for OptionUint {86	fn from(value: Option<u32>) -> Self {87		match value {88			Some(value) => Self {89				status: true,90				value: value.into(),91			},92			None => Self {93				status: false,94				value: Default::default(),95			},96		}97	}98}99100impl From<Option<bool>> for OptionUint {101	fn from(value: Option<bool>) -> Self {102		match value {103			Some(value) => Self {104				status: true,105				value: if value {106					uint256::from(1)107				} else {108					Default::default()109				},110			},111			None => Self {112				status: false,113				value: Default::default(),114			},115		}116	}117}118119/// Cross account struct120#[derive(Debug, Default, AbiCoder)]121pub struct CrossAccount {122	pub(crate) eth: address,123	pub(crate) sub: uint256,124}125126impl CrossAccount {127	/// Converts `CrossAccountId` to [`CrossAccount`]128	pub fn from_sub_cross_account<T>(cross_account_id: &T::CrossAccountId) -> Self129	where130		T: pallet_evm::Config,131		T::AccountId: AsRef<[u8; 32]>,132	{133		if cross_account_id.is_canonical_substrate() {134			Self::from_sub::<T>(cross_account_id.as_sub())135		} else {136			Self {137				eth: *cross_account_id.as_eth(),138				sub: Default::default(),139			}140		}141	}142	/// Creates [`CrossAccount`] from substrate account143	pub fn from_sub<T>(account_id: &T::AccountId) -> Self144	where145		T: pallet_evm::Config,146		T::AccountId: AsRef<[u8; 32]>,147	{148		Self {149			eth: Default::default(),150			sub: uint256::from_big_endian(account_id.as_ref()),151		}152	}153	/// Converts [`CrossAccount`] to `CrossAccountId`154	pub fn into_sub_cross_account<T>(&self) -> evm_coder::execution::Result<T::CrossAccountId>155	where156		T: pallet_evm::Config,157		T::AccountId: From<[u8; 32]>,158	{159		if self.eth == Default::default() && self.sub == Default::default() {160			Err("All fields of cross account is zeroed".into())161		} else if self.eth == Default::default() {162			Ok(convert_uint256_to_cross_account::<T>(self.sub))163		} else if self.sub == Default::default() {164			Ok(T::CrossAccountId::from_eth(self.eth))165		} else {166			Err("All fields of cross account is non zeroed".into())167		}168	}169}170171/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).172#[derive(Debug, Default, AbiCoder)]173pub struct Property {174	/// Property key.175	pub key: evm_coder::types::string,176	/// Property value.177	pub value: evm_coder::types::bytes,178}179180/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.181#[derive(Debug, Default, Clone, Copy, AbiCoder)]182#[repr(u8)]183pub enum CollectionLimitField {184	/// How many tokens can a user have on one account.185	#[default]186	AccountTokenOwnership,187188	/// How many bytes of data are available for sponsorship.189	SponsoredDataSize,190191	/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]192	SponsoredDataRateLimit,193194	/// How many tokens can be mined into this collection.195	TokenLimit,196197	/// Timeouts for transfer sponsoring.198	SponsorTransferTimeout,199200	/// Timeout for sponsoring an approval in passed blocks.201	SponsorApproveTimeout,202203	/// Whether the collection owner of the collection can send tokens (which belong to other users).204	OwnerCanTransfer,205206	/// Can the collection owner burn other people's tokens.207	OwnerCanDestroy,208209	/// Is it possible to send tokens from this collection between users.210	TransferEnabled,211}212213/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.214#[derive(Debug, Default, AbiCoder)]215pub struct CollectionLimit {216	field: CollectionLimitField,217	value: OptionUint,218}219220impl CollectionLimit {221	/// Make [`CollectionLimit`] from [`CollectionLimitField`] and int value.222	pub fn from_int(field: CollectionLimitField, value: u32) -> Self {223		Self {224			field,225			value: value.into(),226		}227	}228229	/// Make [`CollectionLimit`] from [`CollectionLimitField`] and optional int value.230	pub fn from_opt_int(field: CollectionLimitField, value: Option<u32>) -> Self {231		Self {232			field,233			value: value.into(),234		}235	}236237	/// Make [`CollectionLimit`] from [`CollectionLimitField`] and bool value.238	pub fn from_opt_bool(field: CollectionLimitField, value: Option<bool>) -> Self {239		Self {240			field,241			value: value.into(),242		}243	}244}245246impl TryInto<up_data_structs::CollectionLimits> for CollectionLimit {247	type Error = evm_coder::execution::Error;248249	fn try_into(self) -> Result<up_data_structs::CollectionLimits, Self::Error> {250		if !self.value.status {251			return Err(Self::Error::Revert("user can't disable limits".into()));252		}253254		let value = self.value.value.try_into().map_err(|error| {255			Self::Error::Revert(format!(256				"can't convert value to u32 \"{}\" because: \"{error}\"",257				self.value.value258			))259		})?;260261		let convert_value_to_bool = || match value {262			0 => Ok(false),263			1 => Ok(true),264			_ => {265				return Err(Self::Error::Revert(format!(266					"can't convert value to boolean \"{value}\""267				)))268			}269		};270271		let mut limits = up_data_structs::CollectionLimits::default();272		match self.field {273			CollectionLimitField::AccountTokenOwnership => {274				limits.account_token_ownership_limit = Some(value);275			}276			CollectionLimitField::SponsoredDataSize => {277				limits.sponsored_data_size = Some(value);278			}279			CollectionLimitField::SponsoredDataRateLimit => {280				limits.sponsored_data_rate_limit =281					Some(up_data_structs::SponsoringRateLimit::Blocks(value));282			}283			CollectionLimitField::TokenLimit => {284				limits.token_limit = Some(value);285			}286			CollectionLimitField::SponsorTransferTimeout => {287				limits.sponsor_transfer_timeout = Some(value);288			}289			CollectionLimitField::SponsorApproveTimeout => {290				limits.sponsor_approve_timeout = Some(value);291			}292			CollectionLimitField::OwnerCanTransfer => {293				limits.owner_can_transfer = Some(convert_value_to_bool()?);294			}295			CollectionLimitField::OwnerCanDestroy => {296				limits.owner_can_destroy = Some(convert_value_to_bool()?);297			}298			CollectionLimitField::TransferEnabled => {299				limits.transfers_enabled = Some(convert_value_to_bool()?);300			}301		};302		Ok(limits)303	}304}305306/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.307#[derive(Default, Debug, Clone, Copy, AbiCoder)]308#[repr(u8)]309pub enum CollectionPermissionField {310	/// Owner of token can nest tokens under it.311	#[default]312	TokenOwner,313314	/// Admin of token collection can nest tokens under token.315	CollectionAdmin,316}317318/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.319#[derive(AbiCoder, Copy, Clone, Default, Debug)]320#[repr(u8)]321pub enum TokenPermissionField {322	/// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]323	#[default]324	Mutable,325326	/// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]327	TokenOwner,328329	/// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]330	CollectionAdmin,331}332333/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.334#[derive(Debug, Default, AbiCoder)]335pub struct PropertyPermission {336	/// TokenPermission field.337	code: TokenPermissionField,338	/// TokenPermission value.339	value: bool,340}341342impl PropertyPermission {343	/// Make vector of [`PropertyPermission`] from [`up_data_structs::PropertyPermission`].344	pub fn into_vec(pp: up_data_structs::PropertyPermission) -> Vec<Self> {345		vec![346			PropertyPermission {347				code: TokenPermissionField::Mutable,348				value: pp.mutable,349			},350			PropertyPermission {351				code: TokenPermissionField::TokenOwner,352				value: pp.token_owner,353			},354			PropertyPermission {355				code: TokenPermissionField::CollectionAdmin,356				value: pp.collection_admin,357			},358		]359	}360361	/// Make [`up_data_structs::PropertyPermission`] from vector of [`PropertyPermission`].362	pub fn from_vec(permission: Vec<Self>) -> up_data_structs::PropertyPermission {363		let mut token_permission = up_data_structs::PropertyPermission::default();364365		for PropertyPermission { code, value } in permission {366			match code {367				TokenPermissionField::Mutable => token_permission.mutable = value,368				TokenPermissionField::TokenOwner => token_permission.token_owner = value,369				TokenPermissionField::CollectionAdmin => token_permission.collection_admin = value,370			}371		}372		token_permission373	}374}375376/// Ethereum representation of Token Property Permissions.377#[derive(Debug, Default, AbiCoder)]378pub struct TokenPropertyPermission {379	/// Token property key.380	key: evm_coder::types::string,381	/// Token property permissions.382	permissions: Vec<PropertyPermission>,383}384385impl386	From<(387		up_data_structs::PropertyKey,388		up_data_structs::PropertyPermission,389	)> for TokenPropertyPermission390{391	fn from(392		value: (393			up_data_structs::PropertyKey,394			up_data_structs::PropertyPermission,395		),396	) -> Self {397		let (key, permission) = value;398		let key = evm_coder::types::string::from_utf8(key.into_inner())399			.expect("Stored key must be valid");400		let permissions = PropertyPermission::into_vec(permission);401		Self { key, permissions }402	}403}404405impl TokenPropertyPermission {406	/// Convert vector of [`TokenPropertyPermission`] into vector of [`up_data_structs::PropertyKeyPermission`].407	pub fn into_property_key_permissions(408		permissions: Vec<TokenPropertyPermission>,409	) -> evm_coder::execution::Result<Vec<up_data_structs::PropertyKeyPermission>> {410		let mut perms = Vec::new();411412		for TokenPropertyPermission { key, permissions } in permissions {413			if permissions.len() > <TokenPermissionField as evm_coder::abi::AbiType>::FIELDS_COUNT {414				return Err(alloc::format!(415					"Actual number of fields {} for {}, which exceeds the maximum value of {}",416					permissions.len(),417					stringify!(EthTokenPermissions),418					<TokenPermissionField as evm_coder::abi::AbiType>::FIELDS_COUNT419				)420				.as_str()421				.into());422			}423424			let token_permission = PropertyPermission::from_vec(permissions);425426			perms.push(up_data_structs::PropertyKeyPermission {427				key: key.into_bytes().try_into().map_err(|_| "too long key")?,428				permission: token_permission,429			});430		}431		Ok(perms)432	}433}434435/// Nested collections.436#[derive(Debug, Default, AbiCoder)]437pub struct CollectionNesting {438	token_owner: bool,439	ids: Vec<uint256>,440}441442impl CollectionNesting {443	/// Create [`CollectionNesting`].444	pub fn new(token_owner: bool, ids: Vec<uint256>) -> Self {445		Self { token_owner, ids }446	}447}448449/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.450#[derive(Debug, Default, AbiCoder)]451pub struct CollectionNestingPermission {452	field: CollectionPermissionField,453	value: bool,454}455456impl CollectionNestingPermission {457	/// Create [`CollectionNestingPermission`].458	pub fn new(field: CollectionPermissionField, value: bool) -> Self {459		Self { field, value }460	}461}