12345678910111213141516171819202122extern crate alloc;2324use alloc::string::ToString;25use core::{26 char::{REPLACEMENT_CHARACTER, decode_utf16},27 convert::TryInto,28};29use evm_coder::{ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};30use frame_support::{BoundedBTreeMap, BoundedVec};31use pallet_common::{32 CollectionHandle, CollectionPropertyPermissions,33 erc::{34 CommonEvmHandler, CollectionCall,35 static_property::{key, value as property_value},36 },37};38use pallet_evm::{account::CrossAccountId, PrecompileHandle};39use pallet_evm_coder_substrate::{call, dispatch_to_evm};40use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};41use sp_core::H160;42use sp_std::{collections::btree_map::BTreeMap, vec::Vec, vec};43use up_data_structs::{44 CollectionId, CollectionPropertiesVec, Property, PropertyKey, PropertyKeyPermission,45 PropertyPermission, TokenId,46};4748use crate::{49 AccountBalance, Balance, Config, CreateItemData, Pallet, RefungibleHandle, SelfWeightOf,50 TokenProperties, TokensMinted, TotalSupply, weights::WeightInfo,51};5253pub const ADDRESS_FOR_PARTIALLY_OWNED_TOKENS: H160 = H160::repeat_byte(0xff);545556#[solidity_interface(name = "TokenProperties")]57impl<T: Config> RefungibleHandle<T> {58 59 60 61 62 63 64 fn set_token_property_permission(65 &mut self,66 caller: caller,67 key: string,68 is_mutable: bool,69 collection_admin: bool,70 token_owner: bool,71 ) -> Result<()> {72 let caller = T::CrossAccountId::from_eth(caller);73 <Pallet<T>>::set_token_property_permissions(74 self,75 &caller,76 vec![PropertyKeyPermission {77 key: <Vec<u8>>::from(key)78 .try_into()79 .map_err(|_| "too long key")?,80 permission: PropertyPermission {81 mutable: is_mutable,82 collection_admin,83 token_owner,84 },85 }],86 )87 .map_err(dispatch_to_evm::<T>)88 }8990 91 92 93 94 95 fn set_property(96 &mut self,97 caller: caller,98 token_id: uint256,99 key: string,100 value: bytes,101 ) -> Result<()> {102 let caller = T::CrossAccountId::from_eth(caller);103 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;104 let key = <Vec<u8>>::from(key)105 .try_into()106 .map_err(|_| "key too long")?;107 let value = value.try_into().map_err(|_| "value too long")?;108109 let nesting_budget = self110 .recorder111 .weight_calls_budget(<StructureWeight<T>>::find_parent());112113 <Pallet<T>>::set_token_property(114 self,115 &caller,116 TokenId(token_id),117 Property { key, value },118 &nesting_budget,119 )120 .map_err(dispatch_to_evm::<T>)121 }122123 124 125 126 127 fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {128 let caller = T::CrossAccountId::from_eth(caller);129 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;130 let key = <Vec<u8>>::from(key)131 .try_into()132 .map_err(|_| "key too long")?;133134 let nesting_budget = self135 .recorder136 .weight_calls_budget(<StructureWeight<T>>::find_parent());137138 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)139 .map_err(dispatch_to_evm::<T>)140 }141142 143 144 145 146 147 fn property(&self, token_id: uint256, key: string) -> Result<bytes> {148 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;149 let key = <Vec<u8>>::from(key)150 .try_into()151 .map_err(|_| "key too long")?;152153 let props = <TokenProperties<T>>::get((self.id, token_id));154 let prop = props.get(&key).ok_or("key not found")?;155156 Ok(prop.to_vec())157 }158}159160#[derive(ToLog)]161pub enum ERC721Events {162 163 164 165 Transfer {166 #[indexed]167 from: address,168 #[indexed]169 to: address,170 #[indexed]171 token_id: uint256,172 },173 174 Approval {175 #[indexed]176 owner: address,177 #[indexed]178 approved: address,179 #[indexed]180 token_id: uint256,181 },182 183 #[allow(dead_code)]184 ApprovalForAll {185 #[indexed]186 owner: address,187 #[indexed]188 operator: address,189 approved: bool,190 },191}192193#[derive(ToLog)]194pub enum ERC721MintableEvents {195 196 #[allow(dead_code)]197 MintingFinished {},198}199200#[solidity_interface(name = "ERC721Metadata")]201impl<T: Config> RefungibleHandle<T> {202 203 fn name(&self) -> Result<string> {204 Ok(decode_utf16(self.name.iter().copied())205 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))206 .collect::<string>())207 }208209 210 fn symbol(&self) -> Result<string> {211 Ok(string::from_utf8_lossy(&self.token_prefix).into())212 }213214 215 216 217 218 219 220 221 222 223 #[solidity(rename_selector = "tokenURI")]224 fn token_uri(&self, token_id: uint256) -> Result<string> {225 let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;226227 if let Ok(url) = get_token_property(self, token_id_u32, &key::url()) {228 if !url.is_empty() {229 return Ok(url);230 }231 } else if !is_erc721_metadata_compatible::<T>(self.id) {232 return Err("tokenURI not set".into());233 }234235 if let Some(base_uri) =236 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())237 {238 if !base_uri.is_empty() {239 let base_uri = string::from_utf8(base_uri.into_inner()).map_err(|e| {240 Error::Revert(alloc::format!(241 "Can not convert value \"baseURI\" to string with error \"{}\"",242 e243 ))244 })?;245 if let Ok(suffix) = get_token_property(self, token_id_u32, &key::suffix()) {246 if !suffix.is_empty() {247 return Ok(base_uri + suffix.as_str());248 }249 }250251 return Ok(base_uri + token_id.to_string().as_str());252 }253 }254255 Ok("".into())256 }257}258259260261#[solidity_interface(name = "ERC721Enumerable")]262impl<T: Config> RefungibleHandle<T> {263 264 265 266 267 fn token_by_index(&self, index: uint256) -> Result<uint256> {268 Ok(index)269 }270271 272 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {273 274 Err("not implemented".into())275 }276277 278 279 280 fn total_supply(&self) -> Result<uint256> {281 self.consume_store_reads(1)?;282 Ok(<Pallet<T>>::total_supply(self).into())283 }284}285286287288#[solidity_interface(name = "ERC721", events(ERC721Events))]289impl<T: Config> RefungibleHandle<T> {290 291 292 293 294 295 fn balance_of(&self, owner: address) -> Result<uint256> {296 self.consume_store_reads(1)?;297 let owner = T::CrossAccountId::from_eth(owner);298 let balance = <AccountBalance<T>>::get((self.id, owner));299 Ok(balance.into())300 }301302 303 304 305 306 307 308 309 fn owner_of(&self, token_id: uint256) -> Result<address> {310 self.consume_store_reads(2)?;311 let token = token_id.try_into()?;312 let owner = <Pallet<T>>::token_owner(self.id, token);313 Ok(owner314 .map(|address| *address.as_eth())315 .unwrap_or_else(|| ADDRESS_FOR_PARTIALLY_OWNED_TOKENS))316 }317318 319 fn safe_transfer_from_with_data(320 &mut self,321 _from: address,322 _to: address,323 _token_id: uint256,324 _data: bytes,325 _value: value,326 ) -> Result<void> {327 328 Err("not implemented".into())329 }330331 332 fn safe_transfer_from(333 &mut self,334 _from: address,335 _to: address,336 _token_id: uint256,337 _value: value,338 ) -> Result<void> {339 340 Err("not implemented".into())341 }342343 344 345 346 347 348 349 350 351 352 353 354 #[weight(<SelfWeightOf<T>>::transfer_from_creating_removing())]355 fn transfer_from(356 &mut self,357 caller: caller,358 from: address,359 to: address,360 token_id: uint256,361 _value: value,362 ) -> Result<void> {363 let caller = T::CrossAccountId::from_eth(caller);364 let from = T::CrossAccountId::from_eth(from);365 let to = T::CrossAccountId::from_eth(to);366 let token = token_id.try_into()?;367 let budget = self368 .recorder369 .weight_calls_budget(<StructureWeight<T>>::find_parent());370371 let balance = balance(&self, token, &from)?;372 ensure_single_owner(&self, token, balance)?;373374 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, balance, &budget)375 .map_err(dispatch_to_evm::<T>)?;376377 Ok(())378 }379380 381 fn approve(382 &mut self,383 _caller: caller,384 _approved: address,385 _token_id: uint256,386 _value: value,387 ) -> Result<void> {388 Err("not implemented".into())389 }390391 392 fn set_approval_for_all(393 &mut self,394 _caller: caller,395 _operator: address,396 _approved: bool,397 ) -> Result<void> {398 399 Err("not implemented".into())400 }401402 403 fn get_approved(&self, _token_id: uint256) -> Result<address> {404 405 Err("not implemented".into())406 }407408 409 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {410 411 Err("not implemented".into())412 }413}414415416fn balance<T: Config>(417 collection: &RefungibleHandle<T>,418 token: TokenId,419 owner: &T::CrossAccountId,420) -> Result<u128> {421 collection.consume_store_reads(1)?;422 let balance = <Balance<T>>::get((collection.id, token, &owner));423 Ok(balance)424}425426427fn ensure_single_owner<T: Config>(428 collection: &RefungibleHandle<T>,429 token: TokenId,430 owner_balance: u128,431) -> Result<()> {432 collection.consume_store_reads(1)?;433 let total_supply = <TotalSupply<T>>::get((collection.id, token));434 if total_supply != owner_balance {435 return Err("token has multiple owners".into());436 }437 Ok(())438}439440441#[solidity_interface(name = "ERC721Burnable")]442impl<T: Config> RefungibleHandle<T> {443 444 445 446 447 #[weight(<SelfWeightOf<T>>::burn_item_fully())]448 fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {449 let caller = T::CrossAccountId::from_eth(caller);450 let token = token_id.try_into()?;451452 let balance = balance(&self, token, &caller)?;453 ensure_single_owner(&self, token, balance)?;454455 <Pallet<T>>::burn(self, &caller, token, balance).map_err(dispatch_to_evm::<T>)?;456 Ok(())457 }458}459460461#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]462impl<T: Config> RefungibleHandle<T> {463 fn minting_finished(&self) -> Result<bool> {464 Ok(false)465 }466467 468 469 470 471 472 #[weight(<SelfWeightOf<T>>::create_item())]473 fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {474 let caller = T::CrossAccountId::from_eth(caller);475 let to = T::CrossAccountId::from_eth(to);476 let token_id: u32 = token_id.try_into()?;477 let budget = self478 .recorder479 .weight_calls_budget(<StructureWeight<T>>::find_parent());480481 if <TokensMinted<T>>::get(self.id)482 .checked_add(1)483 .ok_or("item id overflow")?484 != token_id485 {486 return Err("item id should be next".into());487 }488489 let const_data = BoundedVec::default();490 let users = [(to.clone(), 1)]491 .into_iter()492 .collect::<BTreeMap<_, _>>()493 .try_into()494 .unwrap();495 <Pallet<T>>::create_item(496 self,497 &caller,498 CreateItemData::<T> {499 const_data,500 users,501 properties: CollectionPropertiesVec::default(),502 },503 &budget,504 )505 .map_err(dispatch_to_evm::<T>)?;506507 Ok(true)508 }509510 511 512 513 514 515 516 #[solidity(rename_selector = "mintWithTokenURI")]517 #[weight(<SelfWeightOf<T>>::create_item())]518 fn mint_with_token_uri(519 &mut self,520 caller: caller,521 to: address,522 token_id: uint256,523 token_uri: string,524 ) -> Result<bool> {525 let key = key::url();526 let permission = get_token_permission::<T>(self.id, &key)?;527 if !permission.collection_admin {528 return Err("Operation is not allowed".into());529 }530531 let caller = T::CrossAccountId::from_eth(caller);532 let to = T::CrossAccountId::from_eth(to);533 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;534 let budget = self535 .recorder536 .weight_calls_budget(<StructureWeight<T>>::find_parent());537538 if <TokensMinted<T>>::get(self.id)539 .checked_add(1)540 .ok_or("item id overflow")?541 != token_id542 {543 return Err("item id should be next".into());544 }545546 let mut properties = CollectionPropertiesVec::default();547 properties548 .try_push(Property {549 key,550 value: token_uri551 .into_bytes()552 .try_into()553 .map_err(|_| "token uri is too long")?,554 })555 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;556557 let const_data = BoundedVec::default();558 let users = [(to.clone(), 1)]559 .into_iter()560 .collect::<BTreeMap<_, _>>()561 .try_into()562 .unwrap();563 <Pallet<T>>::create_item(564 self,565 &caller,566 CreateItemData::<T> {567 const_data,568 users,569 properties,570 },571 &budget,572 )573 .map_err(dispatch_to_evm::<T>)?;574 Ok(true)575 }576577 578 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {579 Err("not implementable".into())580 }581}582583fn get_token_property<T: Config>(584 collection: &CollectionHandle<T>,585 token_id: u32,586 key: &up_data_structs::PropertyKey,587) -> Result<string> {588 collection.consume_store_reads(1)?;589 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))590 .map_err(|_| Error::Revert("Token properties not found".into()))?;591 if let Some(property) = properties.get(key) {592 return Ok(string::from_utf8_lossy(property).into());593 }594595 Err("Property tokenURI not found".into())596}597598fn is_erc721_metadata_compatible<T: Config>(collection_id: CollectionId) -> bool {599 if let Some(shema_name) =600 pallet_common::Pallet::<T>::get_collection_property(collection_id, &key::schema_name())601 {602 let shema_name = shema_name.into_inner();603 shema_name == property_value::ERC721_METADATA604 } else {605 false606 }607}608609fn get_token_permission<T: Config>(610 collection_id: CollectionId,611 key: &PropertyKey,612) -> Result<PropertyPermission> {613 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)614 .map_err(|_| Error::Revert("No permissions for collection".into()))?;615 let a = token_property_permissions616 .get(key)617 .map(Clone::clone)618 .ok_or_else(|| {619 let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();620 Error::Revert(alloc::format!("No permission for key {}", key))621 })?;622 Ok(a)623}624625626#[solidity_interface(name = "ERC721UniqueExtensions")]627impl<T: Config> RefungibleHandle<T> {628 629 630 631 632 633 634 635 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]636 fn transfer(637 &mut self,638 caller: caller,639 to: address,640 token_id: uint256,641 _value: value,642 ) -> Result<void> {643 let caller = T::CrossAccountId::from_eth(caller);644 let to = T::CrossAccountId::from_eth(to);645 let token = token_id.try_into()?;646 let budget = self647 .recorder648 .weight_calls_budget(<StructureWeight<T>>::find_parent());649650 let balance = balance(&self, token, &caller)?;651 ensure_single_owner(&self, token, balance)?;652653 <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)654 .map_err(dispatch_to_evm::<T>)?;655 Ok(())656 }657658 659 660 661 662 663 664 665 666 #[weight(<SelfWeightOf<T>>::burn_from())]667 fn burn_from(668 &mut self,669 caller: caller,670 from: address,671 token_id: uint256,672 _value: value,673 ) -> Result<void> {674 let caller = T::CrossAccountId::from_eth(caller);675 let from = T::CrossAccountId::from_eth(from);676 let token = token_id.try_into()?;677 let budget = self678 .recorder679 .weight_calls_budget(<StructureWeight<T>>::find_parent());680681 let balance = balance(&self, token, &caller)?;682 ensure_single_owner(&self, token, balance)?;683684 <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)685 .map_err(dispatch_to_evm::<T>)?;686 Ok(())687 }688689 690 fn next_token_id(&self) -> Result<uint256> {691 self.consume_store_reads(1)?;692 Ok(<TokensMinted<T>>::get(self.id)693 .checked_add(1)694 .ok_or("item id overflow")?695 .into())696 }697698 699 700 701 702 703 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]704 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {705 let caller = T::CrossAccountId::from_eth(caller);706 let to = T::CrossAccountId::from_eth(to);707 let mut expected_index = <TokensMinted<T>>::get(self.id)708 .checked_add(1)709 .ok_or("item id overflow")?;710 let budget = self711 .recorder712 .weight_calls_budget(<StructureWeight<T>>::find_parent());713714 let total_tokens = token_ids.len();715 for id in token_ids.into_iter() {716 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;717 if id != expected_index {718 return Err("item id should be next".into());719 }720 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;721 }722 let const_data = BoundedVec::default();723 let users = [(to.clone(), 1)]724 .into_iter()725 .collect::<BTreeMap<_, _>>()726 .try_into()727 .unwrap();728 let create_item_data = CreateItemData::<T> {729 const_data,730 users,731 properties: CollectionPropertiesVec::default(),732 };733 let data = (0..total_tokens)734 .map(|_| create_item_data.clone())735 .collect();736737 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)738 .map_err(dispatch_to_evm::<T>)?;739 Ok(true)740 }741742 743 744 745 746 747 #[solidity(rename_selector = "mintBulkWithTokenURI")]748 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]749 fn mint_bulk_with_token_uri(750 &mut self,751 caller: caller,752 to: address,753 tokens: Vec<(uint256, string)>,754 ) -> Result<bool> {755 let key = key::url();756 let caller = T::CrossAccountId::from_eth(caller);757 let to = T::CrossAccountId::from_eth(to);758 let mut expected_index = <TokensMinted<T>>::get(self.id)759 .checked_add(1)760 .ok_or("item id overflow")?;761 let budget = self762 .recorder763 .weight_calls_budget(<StructureWeight<T>>::find_parent());764765 let mut data = Vec::with_capacity(tokens.len());766 let const_data = BoundedVec::default();767 let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]768 .into_iter()769 .collect::<BTreeMap<_, _>>()770 .try_into()771 .unwrap();772 for (id, token_uri) in tokens {773 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;774 if id != expected_index {775 return Err("item id should be next".into());776 }777 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;778779 let mut properties = CollectionPropertiesVec::default();780 properties781 .try_push(Property {782 key: key.clone(),783 value: token_uri784 .into_bytes()785 .try_into()786 .map_err(|_| "token uri is too long")?,787 })788 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;789790 let create_item_data = CreateItemData::<T> {791 const_data: const_data.clone(),792 users: users.clone(),793 properties,794 };795 data.push(create_item_data);796 }797798 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)799 .map_err(dispatch_to_evm::<T>)?;800 Ok(true)801 }802}803804#[solidity_interface(805 name = "UniqueRefungible",806 is(807 ERC721,808 ERC721Metadata,809 ERC721Enumerable,810 ERC721UniqueExtensions,811 ERC721Mintable,812 ERC721Burnable,813 via("CollectionHandle<T>", common_mut, Collection),814 TokenProperties,815 )816)]817impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> {}818819820generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);821generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);822823impl<T: Config> CommonEvmHandler for RefungibleHandle<T>824where825 T::AccountId: From<[u8; 32]>,826{827 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");828 fn call(829 self,830 handle: &mut impl PrecompileHandle,831 ) -> Option<pallet_common::erc::PrecompileResult> {832 call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)833 }834}