difftreelog
refactor(pallet-refungible) disallow invalid bulk mints
in: master
`create_multiple_items_ex` was allowing invalid (that will be always rejected at runtime level) refungible mint extrinsics, by passing multiple users into `RefungibleMultipleItems` call.
5 files changed
pallets/refungible/Cargo.tomldiffbeforeafterboth--- a/pallets/refungible/Cargo.toml
+++ b/pallets/refungible/Cargo.toml
@@ -28,6 +28,7 @@
sp-core = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24" }
sp-runtime = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24" }
sp-std = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.24" }
+derivative = { version = "2.2.0", features = ["use_core"] }
[features]
default = ["std"]
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -19,8 +19,9 @@
use sp_std::collections::btree_map::BTreeMap;
use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, traits::Get};
use up_data_structs::{
- CollectionId, TokenId, CreateItemExData, CreateRefungibleExData, budget::Budget, Property,
- PropertyKey, PropertyValue, PropertyKeyPermission, CreateItemData, CollectionPropertiesVec,
+ CollectionId, TokenId, CreateItemExData, budget::Budget, Property, PropertyKey, PropertyValue,
+ PropertyKeyPermission, CollectionPropertiesVec, CreateRefungibleExMultipleOwners,
+ CreateRefungibleExSingleOwner,
};
use pallet_common::{
CommonCollectionOperations, CommonWeightInfo, RefungibleExtensions, with_weight,
@@ -32,7 +33,7 @@
use crate::{
AccountBalance, Allowance, Balance, Config, Error, Owned, Pallet, RefungibleHandle,
- SelfWeightOf, TokenData, weights::WeightInfo, TokensMinted, TotalSupply,
+ SelfWeightOf, TokenData, weights::WeightInfo, TokensMinted, TotalSupply, CreateItemData,
};
macro_rules! max_weight_of {
@@ -58,11 +59,11 @@
<SelfWeightOf<T>>::create_item()
}
- fn create_multiple_items(data: &[CreateItemData]) -> Weight {
+ fn create_multiple_items(data: &[up_data_structs::CreateItemData]) -> Weight {
<SelfWeightOf<T>>::create_multiple_items(data.len() as u32).saturating_add(
data.iter()
.map(|data| match data {
- CreateItemData::ReFungible(rft_data) => {
+ up_data_structs::CreateItemData::ReFungible(rft_data) => {
properties_weight::<T>(&rft_data.properties)
}
_ => 0,
@@ -152,9 +153,9 @@
fn map_create_data<T: Config>(
data: up_data_structs::CreateItemData,
to: &T::CrossAccountId,
-) -> Result<CreateRefungibleExData<T::CrossAccountId>, DispatchError> {
+) -> Result<CreateItemData<T::CrossAccountId>, DispatchError> {
match data {
- up_data_structs::CreateItemData::ReFungible(data) => Ok(CreateRefungibleExData {
+ up_data_structs::CreateItemData::ReFungible(data) => Ok(CreateItemData {
users: {
let mut out = BTreeMap::new();
out.insert(to.clone(), data.pieces);
@@ -214,12 +215,26 @@
) -> DispatchResultWithPostInfo {
let weight = <CommonWeights<T>>::create_multiple_items_ex(&data);
let data = match data {
- CreateItemExData::RefungibleMultipleOwners(r) => vec![r],
- CreateItemExData::RefungibleMultipleItems(r)
- if r.iter().all(|i| i.users.len() == 1) =>
- {
- r.into_inner()
- }
+ CreateItemExData::RefungibleMultipleOwners(CreateRefungibleExMultipleOwners {
+ users,
+ properties,
+ }) => vec![CreateItemData { users, properties }],
+ CreateItemExData::RefungibleMultipleItems(r) => r
+ .into_inner()
+ .into_iter()
+ .map(
+ |CreateRefungibleExSingleOwner {
+ user,
+ pieces,
+ properties,
+ }| CreateItemData {
+ users: BTreeMap::from([(user, pieces)])
+ .try_into()
+ .expect("limit >= 1"),
+ properties,
+ },
+ )
+ .collect(),
_ => fail!(<Error<T>>::NotRefungibleDataUsedToMintFungibleCollectionToken),
};
pallets/refungible/src/erc.rsdiffbeforeafterboth1// 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//! # Refungible Pallet EVM API for tokens18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Refungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Refungible Pallet methods.2122extern 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);5455/// @title A contract that allows to set and delete token properties and change token property permissions.56#[solidity_interface(name = "TokenProperties")]57impl<T: Config> RefungibleHandle<T> {58 /// @notice Set permissions for token property.59 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.60 /// @param key Property key.61 /// @param is_mutable Permission to mutate property.62 /// @param collection_admin Permission to mutate property by collection admin if property is mutable.63 /// @param token_owner Permission to mutate property by token owner if property is mutable.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 /// @notice Set token property value.91 /// @dev Throws error if `msg.sender` has no permission to edit the property.92 /// @param tokenId ID of the token.93 /// @param key Property key.94 /// @param value Property value.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 /// @notice Delete token property value.124 /// @dev Throws error if `msg.sender` has no permission to edit the property.125 /// @param tokenId ID of the token.126 /// @param key Property key.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 /// @notice Get token property value.143 /// @dev Throws error if key not found144 /// @param tokenId ID of the token.145 /// @param key Property key.146 /// @return Property value bytes147 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 /// @dev This event emits when NFTs are created (`from` == 0) and destroyed163 /// (`to` == 0). Exception: during contract creation, any number of RFTs164 /// may be created and assigned without emitting Transfer.165 Transfer {166 #[indexed]167 from: address,168 #[indexed]169 to: address,170 #[indexed]171 token_id: uint256,172 },173 /// @dev Not supported174 Approval {175 #[indexed]176 owner: address,177 #[indexed]178 approved: address,179 #[indexed]180 token_id: uint256,181 },182 /// @dev Not supported183 #[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 /// @dev Not supported196 #[allow(dead_code)]197 MintingFinished {},198}199200#[solidity_interface(name = "ERC721Metadata")]201impl<T: Config> RefungibleHandle<T> {202 /// @notice A descriptive name for a collection of RFTs in this contract203 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 /// @notice An abbreviated name for RFTs in this contract210 fn symbol(&self) -> Result<string> {211 Ok(string::from_utf8_lossy(&self.token_prefix).into())212 }213214 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.215 ///216 /// @dev If the token has a `url` property and it is not empty, it is returned.217 /// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.218 /// If the collection property `baseURI` is empty or absent, return "" (empty string)219 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix220 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).221 ///222 /// @return token's const_metadata223 #[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}258259/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension260/// @dev See https://eips.ethereum.org/EIPS/eip-721261#[solidity_interface(name = "ERC721Enumerable")]262impl<T: Config> RefungibleHandle<T> {263 /// @notice Enumerate valid RFTs264 /// @param index A counter less than `totalSupply()`265 /// @return The token identifier for the `index`th NFT,266 /// (sort order not specified)267 fn token_by_index(&self, index: uint256) -> Result<uint256> {268 Ok(index)269 }270271 /// Not implemented272 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {273 // TODO: Not implemetable274 Err("not implemented".into())275 }276277 /// @notice Count RFTs tracked by this contract278 /// @return A count of valid RFTs tracked by this contract, where each one of279 /// them has an assigned and queryable owner not equal to the zero address280 fn total_supply(&self) -> Result<uint256> {281 self.consume_store_reads(1)?;282 Ok(<Pallet<T>>::total_supply(self).into())283 }284}285286/// @title ERC-721 Non-Fungible Token Standard287/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md288#[solidity_interface(name = "ERC721", events(ERC721Events))]289impl<T: Config> RefungibleHandle<T> {290 /// @notice Count all RFTs assigned to an owner291 /// @dev RFTs assigned to the zero address are considered invalid, and this292 /// function throws for queries about the zero address.293 /// @param owner An address for whom to query the balance294 /// @return The number of RFTs owned by `owner`, possibly zero295 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 /// @notice Find the owner of an RFT303 /// @dev RFTs assigned to zero address are considered invalid, and queries304 /// about them do throw.305 /// Returns special 0xffffffffffffffffffffffffffffffffffffffff address for306 /// the tokens that are partially owned.307 /// @param tokenId The identifier for an RFT308 /// @return The address of the owner of the RFT309 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 /// @dev Not implemented319 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 // TODO: Not implemetable328 Err("not implemented".into())329 }330331 /// @dev Not implemented332 fn safe_transfer_from(333 &mut self,334 _from: address,335 _to: address,336 _token_id: uint256,337 _value: value,338 ) -> Result<void> {339 // TODO: Not implemetable340 Err("not implemented".into())341 }342343 /// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE344 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE345 /// THEY MAY BE PERMANENTLY LOST346 /// @dev Throws unless `msg.sender` is the current owner or an authorized347 /// operator for this RFT. Throws if `from` is not the current owner. Throws348 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.349 /// Throws if RFT pieces have multiple owners.350 /// @param from The current owner of the NFT351 /// @param to The new owner352 /// @param tokenId The NFT to transfer353 /// @param _value Not used for an NFT354 #[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 /// @dev Not implemented381 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 /// @dev Not implemented392 fn set_approval_for_all(393 &mut self,394 _caller: caller,395 _operator: address,396 _approved: bool,397 ) -> Result<void> {398 // TODO: Not implemetable399 Err("not implemented".into())400 }401402 /// @dev Not implemented403 fn get_approved(&self, _token_id: uint256) -> Result<address> {404 // TODO: Not implemetable405 Err("not implemented".into())406 }407408 /// @dev Not implemented409 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {410 // TODO: Not implemetable411 Err("not implemented".into())412 }413}414415/// Returns amount of pieces of `token` that `owner` have416fn 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}425426/// Throws if `owner_balance` is lower than total amount of `token` pieces427fn 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}439440/// @title ERC721 Token that can be irreversibly burned (destroyed).441#[solidity_interface(name = "ERC721Burnable")]442impl<T: Config> RefungibleHandle<T> {443 /// @notice Burns a specific ERC721 token.444 /// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized445 /// operator of the current owner.446 /// @param tokenId The RFT to approve447 #[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}459460/// @title ERC721 minting logic.461#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]462impl<T: Config> RefungibleHandle<T> {463 fn minting_finished(&self) -> Result<bool> {464 Ok(false)465 }466467 /// @notice Function to mint token.468 /// @dev `tokenId` should be obtained with `nextTokenId` method,469 /// unlike standard, you can't specify it manually470 /// @param to The new owner471 /// @param tokenId ID of the minted RFT472 #[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 users = [(to.clone(), 1)]490 .into_iter()491 .collect::<BTreeMap<_, _>>()492 .try_into()493 .unwrap();494 <Pallet<T>>::create_item(495 self,496 &caller,497 CreateItemData::<T> {498 users,499 properties: CollectionPropertiesVec::default(),500 },501 &budget,502 )503 .map_err(dispatch_to_evm::<T>)?;504505 Ok(true)506 }507508 /// @notice Function to mint token with the given tokenUri.509 /// @dev `tokenId` should be obtained with `nextTokenId` method,510 /// unlike standard, you can't specify it manually511 /// @param to The new owner512 /// @param tokenId ID of the minted RFT513 /// @param tokenUri Token URI that would be stored in the RFT properties514 #[solidity(rename_selector = "mintWithTokenURI")]515 #[weight(<SelfWeightOf<T>>::create_item())]516 fn mint_with_token_uri(517 &mut self,518 caller: caller,519 to: address,520 token_id: uint256,521 token_uri: string,522 ) -> Result<bool> {523 let key = key::url();524 let permission = get_token_permission::<T>(self.id, &key)?;525 if !permission.collection_admin {526 return Err("Operation is not allowed".into());527 }528529 let caller = T::CrossAccountId::from_eth(caller);530 let to = T::CrossAccountId::from_eth(to);531 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;532 let budget = self533 .recorder534 .weight_calls_budget(<StructureWeight<T>>::find_parent());535536 if <TokensMinted<T>>::get(self.id)537 .checked_add(1)538 .ok_or("item id overflow")?539 != token_id540 {541 return Err("item id should be next".into());542 }543544 let mut properties = CollectionPropertiesVec::default();545 properties546 .try_push(Property {547 key,548 value: token_uri549 .into_bytes()550 .try_into()551 .map_err(|_| "token uri is too long")?,552 })553 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;554555 let users = [(to.clone(), 1)]556 .into_iter()557 .collect::<BTreeMap<_, _>>()558 .try_into()559 .unwrap();560 <Pallet<T>>::create_item(561 self,562 &caller,563 CreateItemData::<T> { users, properties },564 &budget,565 )566 .map_err(dispatch_to_evm::<T>)?;567 Ok(true)568 }569570 /// @dev Not implemented571 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {572 Err("not implementable".into())573 }574}575576fn get_token_property<T: Config>(577 collection: &CollectionHandle<T>,578 token_id: u32,579 key: &up_data_structs::PropertyKey,580) -> Result<string> {581 collection.consume_store_reads(1)?;582 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))583 .map_err(|_| Error::Revert("Token properties not found".into()))?;584 if let Some(property) = properties.get(key) {585 return Ok(string::from_utf8_lossy(property).into());586 }587588 Err("Property tokenURI not found".into())589}590591fn is_erc721_metadata_compatible<T: Config>(collection_id: CollectionId) -> bool {592 if let Some(shema_name) =593 pallet_common::Pallet::<T>::get_collection_property(collection_id, &key::schema_name())594 {595 let shema_name = shema_name.into_inner();596 shema_name == property_value::ERC721_METADATA597 } else {598 false599 }600}601602fn get_token_permission<T: Config>(603 collection_id: CollectionId,604 key: &PropertyKey,605) -> Result<PropertyPermission> {606 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)607 .map_err(|_| Error::Revert("No permissions for collection".into()))?;608 let a = token_property_permissions609 .get(key)610 .map(Clone::clone)611 .ok_or_else(|| {612 let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();613 Error::Revert(alloc::format!("No permission for key {}", key))614 })?;615 Ok(a)616}617618/// @title Unique extensions for ERC721.619#[solidity_interface(name = "ERC721UniqueExtensions")]620impl<T: Config> RefungibleHandle<T> {621 /// @notice Transfer ownership of an RFT622 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`623 /// is the zero address. Throws if `tokenId` is not a valid RFT.624 /// Throws if RFT pieces have multiple owners.625 /// @param to The new owner626 /// @param tokenId The RFT to transfer627 /// @param _value Not used for an RFT628 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]629 fn transfer(630 &mut self,631 caller: caller,632 to: address,633 token_id: uint256,634 _value: value,635 ) -> Result<void> {636 let caller = T::CrossAccountId::from_eth(caller);637 let to = T::CrossAccountId::from_eth(to);638 let token = token_id.try_into()?;639 let budget = self640 .recorder641 .weight_calls_budget(<StructureWeight<T>>::find_parent());642643 let balance = balance(&self, token, &caller)?;644 ensure_single_owner(&self, token, balance)?;645646 <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)647 .map_err(dispatch_to_evm::<T>)?;648 Ok(())649 }650651 /// @notice Burns a specific ERC721 token.652 /// @dev Throws unless `msg.sender` is the current owner or an authorized653 /// operator for this RFT. Throws if `from` is not the current owner. Throws654 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.655 /// Throws if RFT pieces have multiple owners.656 /// @param from The current owner of the RFT657 /// @param tokenId The RFT to transfer658 /// @param _value Not used for an RFT659 #[weight(<SelfWeightOf<T>>::burn_from())]660 fn burn_from(661 &mut self,662 caller: caller,663 from: address,664 token_id: uint256,665 _value: value,666 ) -> Result<void> {667 let caller = T::CrossAccountId::from_eth(caller);668 let from = T::CrossAccountId::from_eth(from);669 let token = token_id.try_into()?;670 let budget = self671 .recorder672 .weight_calls_budget(<StructureWeight<T>>::find_parent());673674 let balance = balance(&self, token, &caller)?;675 ensure_single_owner(&self, token, balance)?;676677 <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)678 .map_err(dispatch_to_evm::<T>)?;679 Ok(())680 }681682 /// @notice Returns next free RFT ID.683 fn next_token_id(&self) -> Result<uint256> {684 self.consume_store_reads(1)?;685 Ok(<TokensMinted<T>>::get(self.id)686 .checked_add(1)687 .ok_or("item id overflow")?688 .into())689 }690691 /// @notice Function to mint multiple tokens.692 /// @dev `tokenIds` should be an array of consecutive numbers and first number693 /// should be obtained with `nextTokenId` method694 /// @param to The new owner695 /// @param tokenIds IDs of the minted RFTs696 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]697 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {698 let caller = T::CrossAccountId::from_eth(caller);699 let to = T::CrossAccountId::from_eth(to);700 let mut expected_index = <TokensMinted<T>>::get(self.id)701 .checked_add(1)702 .ok_or("item id overflow")?;703 let budget = self704 .recorder705 .weight_calls_budget(<StructureWeight<T>>::find_parent());706707 let total_tokens = token_ids.len();708 for id in token_ids.into_iter() {709 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;710 if id != expected_index {711 return Err("item id should be next".into());712 }713 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;714 }715 let users = [(to.clone(), 1)]716 .into_iter()717 .collect::<BTreeMap<_, _>>()718 .try_into()719 .unwrap();720 let create_item_data = CreateItemData::<T> {721 users,722 properties: CollectionPropertiesVec::default(),723 };724 let data = (0..total_tokens)725 .map(|_| create_item_data.clone())726 .collect();727728 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)729 .map_err(dispatch_to_evm::<T>)?;730 Ok(true)731 }732733 /// @notice Function to mint multiple tokens with the given tokenUris.734 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive735 /// numbers and first number should be obtained with `nextTokenId` method736 /// @param to The new owner737 /// @param tokens array of pairs of token ID and token URI for minted tokens738 #[solidity(rename_selector = "mintBulkWithTokenURI")]739 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]740 fn mint_bulk_with_token_uri(741 &mut self,742 caller: caller,743 to: address,744 tokens: Vec<(uint256, string)>,745 ) -> Result<bool> {746 let key = key::url();747 let caller = T::CrossAccountId::from_eth(caller);748 let to = T::CrossAccountId::from_eth(to);749 let mut expected_index = <TokensMinted<T>>::get(self.id)750 .checked_add(1)751 .ok_or("item id overflow")?;752 let budget = self753 .recorder754 .weight_calls_budget(<StructureWeight<T>>::find_parent());755756 let mut data = Vec::with_capacity(tokens.len());757 let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]758 .into_iter()759 .collect::<BTreeMap<_, _>>()760 .try_into()761 .unwrap();762 for (id, token_uri) in tokens {763 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;764 if id != expected_index {765 return Err("item id should be next".into());766 }767 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;768769 let mut properties = CollectionPropertiesVec::default();770 properties771 .try_push(Property {772 key: key.clone(),773 value: token_uri774 .into_bytes()775 .try_into()776 .map_err(|_| "token uri is too long")?,777 })778 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;779780 let create_item_data = CreateItemData::<T> {781 users: users.clone(),782 properties,783 };784 data.push(create_item_data);785 }786787 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)788 .map_err(dispatch_to_evm::<T>)?;789 Ok(true)790 }791}792793#[solidity_interface(794 name = "UniqueRefungible",795 is(796 ERC721,797 ERC721Metadata,798 ERC721Enumerable,799 ERC721UniqueExtensions,800 ERC721Mintable,801 ERC721Burnable,802 via("CollectionHandle<T>", common_mut, Collection),803 TokenProperties,804 )805)]806impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> {}807808// Not a tests, but code generators809generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);810generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);811812impl<T: Config> CommonEvmHandler for RefungibleHandle<T>813where814 T::AccountId: From<[u8; 32]>,815{816 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");817 fn call(818 self,819 handle: &mut impl PrecompileHandle,820 ) -> Option<pallet_common::erc::PrecompileResult> {821 call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)822 }823}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//! # Refungible Pallet EVM API for tokens18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Refungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Refungible Pallet methods.2122extern 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);5455/// @title A contract that allows to set and delete token properties and change token property permissions.56#[solidity_interface(name = "TokenProperties")]57impl<T: Config> RefungibleHandle<T> {58 /// @notice Set permissions for token property.59 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.60 /// @param key Property key.61 /// @param is_mutable Permission to mutate property.62 /// @param collection_admin Permission to mutate property by collection admin if property is mutable.63 /// @param token_owner Permission to mutate property by token owner if property is mutable.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 /// @notice Set token property value.91 /// @dev Throws error if `msg.sender` has no permission to edit the property.92 /// @param tokenId ID of the token.93 /// @param key Property key.94 /// @param value Property value.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 /// @notice Delete token property value.124 /// @dev Throws error if `msg.sender` has no permission to edit the property.125 /// @param tokenId ID of the token.126 /// @param key Property key.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 /// @notice Get token property value.143 /// @dev Throws error if key not found144 /// @param tokenId ID of the token.145 /// @param key Property key.146 /// @return Property value bytes147 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 /// @dev This event emits when NFTs are created (`from` == 0) and destroyed163 /// (`to` == 0). Exception: during contract creation, any number of RFTs164 /// may be created and assigned without emitting Transfer.165 Transfer {166 #[indexed]167 from: address,168 #[indexed]169 to: address,170 #[indexed]171 token_id: uint256,172 },173 /// @dev Not supported174 Approval {175 #[indexed]176 owner: address,177 #[indexed]178 approved: address,179 #[indexed]180 token_id: uint256,181 },182 /// @dev Not supported183 #[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 /// @dev Not supported196 #[allow(dead_code)]197 MintingFinished {},198}199200#[solidity_interface(name = "ERC721Metadata")]201impl<T: Config> RefungibleHandle<T> {202 /// @notice A descriptive name for a collection of RFTs in this contract203 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 /// @notice An abbreviated name for RFTs in this contract210 fn symbol(&self) -> Result<string> {211 Ok(string::from_utf8_lossy(&self.token_prefix).into())212 }213214 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.215 ///216 /// @dev If the token has a `url` property and it is not empty, it is returned.217 /// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.218 /// If the collection property `baseURI` is empty or absent, return "" (empty string)219 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix220 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).221 ///222 /// @return token's const_metadata223 #[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}258259/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension260/// @dev See https://eips.ethereum.org/EIPS/eip-721261#[solidity_interface(name = "ERC721Enumerable")]262impl<T: Config> RefungibleHandle<T> {263 /// @notice Enumerate valid RFTs264 /// @param index A counter less than `totalSupply()`265 /// @return The token identifier for the `index`th NFT,266 /// (sort order not specified)267 fn token_by_index(&self, index: uint256) -> Result<uint256> {268 Ok(index)269 }270271 /// Not implemented272 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {273 // TODO: Not implemetable274 Err("not implemented".into())275 }276277 /// @notice Count RFTs tracked by this contract278 /// @return A count of valid RFTs tracked by this contract, where each one of279 /// them has an assigned and queryable owner not equal to the zero address280 fn total_supply(&self) -> Result<uint256> {281 self.consume_store_reads(1)?;282 Ok(<Pallet<T>>::total_supply(self).into())283 }284}285286/// @title ERC-721 Non-Fungible Token Standard287/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md288#[solidity_interface(name = "ERC721", events(ERC721Events))]289impl<T: Config> RefungibleHandle<T> {290 /// @notice Count all RFTs assigned to an owner291 /// @dev RFTs assigned to the zero address are considered invalid, and this292 /// function throws for queries about the zero address.293 /// @param owner An address for whom to query the balance294 /// @return The number of RFTs owned by `owner`, possibly zero295 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 /// @notice Find the owner of an RFT303 /// @dev RFTs assigned to zero address are considered invalid, and queries304 /// about them do throw.305 /// Returns special 0xffffffffffffffffffffffffffffffffffffffff address for306 /// the tokens that are partially owned.307 /// @param tokenId The identifier for an RFT308 /// @return The address of the owner of the RFT309 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 /// @dev Not implemented319 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 // TODO: Not implemetable328 Err("not implemented".into())329 }330331 /// @dev Not implemented332 fn safe_transfer_from(333 &mut self,334 _from: address,335 _to: address,336 _token_id: uint256,337 _value: value,338 ) -> Result<void> {339 // TODO: Not implemetable340 Err("not implemented".into())341 }342343 /// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE344 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE345 /// THEY MAY BE PERMANENTLY LOST346 /// @dev Throws unless `msg.sender` is the current owner or an authorized347 /// operator for this RFT. Throws if `from` is not the current owner. Throws348 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.349 /// Throws if RFT pieces have multiple owners.350 /// @param from The current owner of the NFT351 /// @param to The new owner352 /// @param tokenId The NFT to transfer353 /// @param _value Not used for an NFT354 #[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 /// @dev Not implemented381 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 /// @dev Not implemented392 fn set_approval_for_all(393 &mut self,394 _caller: caller,395 _operator: address,396 _approved: bool,397 ) -> Result<void> {398 // TODO: Not implemetable399 Err("not implemented".into())400 }401402 /// @dev Not implemented403 fn get_approved(&self, _token_id: uint256) -> Result<address> {404 // TODO: Not implemetable405 Err("not implemented".into())406 }407408 /// @dev Not implemented409 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {410 // TODO: Not implemetable411 Err("not implemented".into())412 }413}414415/// Returns amount of pieces of `token` that `owner` have416fn 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}425426/// Throws if `owner_balance` is lower than total amount of `token` pieces427fn 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}439440/// @title ERC721 Token that can be irreversibly burned (destroyed).441#[solidity_interface(name = "ERC721Burnable")]442impl<T: Config> RefungibleHandle<T> {443 /// @notice Burns a specific ERC721 token.444 /// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized445 /// operator of the current owner.446 /// @param tokenId The RFT to approve447 #[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}459460/// @title ERC721 minting logic.461#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]462impl<T: Config> RefungibleHandle<T> {463 fn minting_finished(&self) -> Result<bool> {464 Ok(false)465 }466467 /// @notice Function to mint token.468 /// @dev `tokenId` should be obtained with `nextTokenId` method,469 /// unlike standard, you can't specify it manually470 /// @param to The new owner471 /// @param tokenId ID of the minted RFT472 #[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 users = [(to.clone(), 1)]490 .into_iter()491 .collect::<BTreeMap<_, _>>()492 .try_into()493 .unwrap();494 <Pallet<T>>::create_item(495 self,496 &caller,497 CreateItemData::<T::CrossAccountId> {498 users,499 properties: CollectionPropertiesVec::default(),500 },501 &budget,502 )503 .map_err(dispatch_to_evm::<T>)?;504505 Ok(true)506 }507508 /// @notice Function to mint token with the given tokenUri.509 /// @dev `tokenId` should be obtained with `nextTokenId` method,510 /// unlike standard, you can't specify it manually511 /// @param to The new owner512 /// @param tokenId ID of the minted RFT513 /// @param tokenUri Token URI that would be stored in the RFT properties514 #[solidity(rename_selector = "mintWithTokenURI")]515 #[weight(<SelfWeightOf<T>>::create_item())]516 fn mint_with_token_uri(517 &mut self,518 caller: caller,519 to: address,520 token_id: uint256,521 token_uri: string,522 ) -> Result<bool> {523 let key = key::url();524 let permission = get_token_permission::<T>(self.id, &key)?;525 if !permission.collection_admin {526 return Err("Operation is not allowed".into());527 }528529 let caller = T::CrossAccountId::from_eth(caller);530 let to = T::CrossAccountId::from_eth(to);531 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;532 let budget = self533 .recorder534 .weight_calls_budget(<StructureWeight<T>>::find_parent());535536 if <TokensMinted<T>>::get(self.id)537 .checked_add(1)538 .ok_or("item id overflow")?539 != token_id540 {541 return Err("item id should be next".into());542 }543544 let mut properties = CollectionPropertiesVec::default();545 properties546 .try_push(Property {547 key,548 value: token_uri549 .into_bytes()550 .try_into()551 .map_err(|_| "token uri is too long")?,552 })553 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;554555 let users = [(to.clone(), 1)]556 .into_iter()557 .collect::<BTreeMap<_, _>>()558 .try_into()559 .unwrap();560 <Pallet<T>>::create_item(561 self,562 &caller,563 CreateItemData::<T::CrossAccountId> { users, properties },564 &budget,565 )566 .map_err(dispatch_to_evm::<T>)?;567 Ok(true)568 }569570 /// @dev Not implemented571 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {572 Err("not implementable".into())573 }574}575576fn get_token_property<T: Config>(577 collection: &CollectionHandle<T>,578 token_id: u32,579 key: &up_data_structs::PropertyKey,580) -> Result<string> {581 collection.consume_store_reads(1)?;582 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))583 .map_err(|_| Error::Revert("Token properties not found".into()))?;584 if let Some(property) = properties.get(key) {585 return Ok(string::from_utf8_lossy(property).into());586 }587588 Err("Property tokenURI not found".into())589}590591fn is_erc721_metadata_compatible<T: Config>(collection_id: CollectionId) -> bool {592 if let Some(shema_name) =593 pallet_common::Pallet::<T>::get_collection_property(collection_id, &key::schema_name())594 {595 let shema_name = shema_name.into_inner();596 shema_name == property_value::ERC721_METADATA597 } else {598 false599 }600}601602fn get_token_permission<T: Config>(603 collection_id: CollectionId,604 key: &PropertyKey,605) -> Result<PropertyPermission> {606 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)607 .map_err(|_| Error::Revert("No permissions for collection".into()))?;608 let a = token_property_permissions609 .get(key)610 .map(Clone::clone)611 .ok_or_else(|| {612 let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();613 Error::Revert(alloc::format!("No permission for key {}", key))614 })?;615 Ok(a)616}617618/// @title Unique extensions for ERC721.619#[solidity_interface(name = "ERC721UniqueExtensions")]620impl<T: Config> RefungibleHandle<T> {621 /// @notice Transfer ownership of an RFT622 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`623 /// is the zero address. Throws if `tokenId` is not a valid RFT.624 /// Throws if RFT pieces have multiple owners.625 /// @param to The new owner626 /// @param tokenId The RFT to transfer627 /// @param _value Not used for an RFT628 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]629 fn transfer(630 &mut self,631 caller: caller,632 to: address,633 token_id: uint256,634 _value: value,635 ) -> Result<void> {636 let caller = T::CrossAccountId::from_eth(caller);637 let to = T::CrossAccountId::from_eth(to);638 let token = token_id.try_into()?;639 let budget = self640 .recorder641 .weight_calls_budget(<StructureWeight<T>>::find_parent());642643 let balance = balance(&self, token, &caller)?;644 ensure_single_owner(&self, token, balance)?;645646 <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)647 .map_err(dispatch_to_evm::<T>)?;648 Ok(())649 }650651 /// @notice Burns a specific ERC721 token.652 /// @dev Throws unless `msg.sender` is the current owner or an authorized653 /// operator for this RFT. Throws if `from` is not the current owner. Throws654 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.655 /// Throws if RFT pieces have multiple owners.656 /// @param from The current owner of the RFT657 /// @param tokenId The RFT to transfer658 /// @param _value Not used for an RFT659 #[weight(<SelfWeightOf<T>>::burn_from())]660 fn burn_from(661 &mut self,662 caller: caller,663 from: address,664 token_id: uint256,665 _value: value,666 ) -> Result<void> {667 let caller = T::CrossAccountId::from_eth(caller);668 let from = T::CrossAccountId::from_eth(from);669 let token = token_id.try_into()?;670 let budget = self671 .recorder672 .weight_calls_budget(<StructureWeight<T>>::find_parent());673674 let balance = balance(&self, token, &caller)?;675 ensure_single_owner(&self, token, balance)?;676677 <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)678 .map_err(dispatch_to_evm::<T>)?;679 Ok(())680 }681682 /// @notice Returns next free RFT ID.683 fn next_token_id(&self) -> Result<uint256> {684 self.consume_store_reads(1)?;685 Ok(<TokensMinted<T>>::get(self.id)686 .checked_add(1)687 .ok_or("item id overflow")?688 .into())689 }690691 /// @notice Function to mint multiple tokens.692 /// @dev `tokenIds` should be an array of consecutive numbers and first number693 /// should be obtained with `nextTokenId` method694 /// @param to The new owner695 /// @param tokenIds IDs of the minted RFTs696 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]697 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {698 let caller = T::CrossAccountId::from_eth(caller);699 let to = T::CrossAccountId::from_eth(to);700 let mut expected_index = <TokensMinted<T>>::get(self.id)701 .checked_add(1)702 .ok_or("item id overflow")?;703 let budget = self704 .recorder705 .weight_calls_budget(<StructureWeight<T>>::find_parent());706707 let total_tokens = token_ids.len();708 for id in token_ids.into_iter() {709 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;710 if id != expected_index {711 return Err("item id should be next".into());712 }713 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;714 }715 let users = [(to.clone(), 1)]716 .into_iter()717 .collect::<BTreeMap<_, _>>()718 .try_into()719 .unwrap();720 let create_item_data = CreateItemData::<T::CrossAccountId> {721 users,722 properties: CollectionPropertiesVec::default(),723 };724 let data = (0..total_tokens)725 .map(|_| create_item_data.clone())726 .collect();727728 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)729 .map_err(dispatch_to_evm::<T>)?;730 Ok(true)731 }732733 /// @notice Function to mint multiple tokens with the given tokenUris.734 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive735 /// numbers and first number should be obtained with `nextTokenId` method736 /// @param to The new owner737 /// @param tokens array of pairs of token ID and token URI for minted tokens738 #[solidity(rename_selector = "mintBulkWithTokenURI")]739 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]740 fn mint_bulk_with_token_uri(741 &mut self,742 caller: caller,743 to: address,744 tokens: Vec<(uint256, string)>,745 ) -> Result<bool> {746 let key = key::url();747 let caller = T::CrossAccountId::from_eth(caller);748 let to = T::CrossAccountId::from_eth(to);749 let mut expected_index = <TokensMinted<T>>::get(self.id)750 .checked_add(1)751 .ok_or("item id overflow")?;752 let budget = self753 .recorder754 .weight_calls_budget(<StructureWeight<T>>::find_parent());755756 let mut data = Vec::with_capacity(tokens.len());757 let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]758 .into_iter()759 .collect::<BTreeMap<_, _>>()760 .try_into()761 .unwrap();762 for (id, token_uri) in tokens {763 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;764 if id != expected_index {765 return Err("item id should be next".into());766 }767 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;768769 let mut properties = CollectionPropertiesVec::default();770 properties771 .try_push(Property {772 key: key.clone(),773 value: token_uri774 .into_bytes()775 .try_into()776 .map_err(|_| "token uri is too long")?,777 })778 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;779780 let create_item_data = CreateItemData::<T::CrossAccountId> {781 users: users.clone(),782 properties,783 };784 data.push(create_item_data);785 }786787 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)788 .map_err(dispatch_to_evm::<T>)?;789 Ok(true)790 }791}792793#[solidity_interface(794 name = "UniqueRefungible",795 is(796 ERC721,797 ERC721Metadata,798 ERC721Enumerable,799 ERC721UniqueExtensions,800 ERC721Mintable,801 ERC721Burnable,802 via("CollectionHandle<T>", common_mut, Collection),803 TokenProperties,804 )805)]806impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> {}807808// Not a tests, but code generators809generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);810generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);811812impl<T: Config> CommonEvmHandler for RefungibleHandle<T>813where814 T::AccountId: From<[u8; 32]>,815{816 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");817 fn call(818 self,819 handle: &mut impl PrecompileHandle,820 ) -> Option<pallet_common::erc::PrecompileResult> {821 call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)822 }823}pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -93,7 +93,9 @@
use codec::{Encode, Decode, MaxEncodedLen};
use core::ops::Deref;
use evm_coder::ToLog;
-use frame_support::{BoundedVec, ensure, fail, storage::with_transaction, transactional};
+use frame_support::{
+ BoundedVec, ensure, fail, storage::with_transaction, transactional, pallet_prelude::ConstU32,
+};
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
@@ -106,11 +108,13 @@
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};
use up_data_structs::{
- AccessMode, budget::Budget, CollectionId, CreateCollectionData, CreateRefungibleExData,
- CustomDataLimit, mapping::TokenAddressMapping, MAX_REFUNGIBLE_PIECES, TokenId, Property,
+ AccessMode, budget::Budget, CollectionId, CreateCollectionData, CustomDataLimit,
+ mapping::TokenAddressMapping, MAX_REFUNGIBLE_PIECES, MAX_ITEMS_PER_BATCH, TokenId, Property,
PropertyKey, PropertyKeyPermission, PropertyPermission, PropertyScope, PropertyValue,
- TrySetProperty,
+ TrySetProperty, CollectionPropertiesVec,
};
+use frame_support::BoundedBTreeMap;
+use derivative::Derivative;
pub use pallet::*;
#[cfg(feature = "runtime-benchmarks")]
@@ -120,8 +124,13 @@
pub mod erc_token;
pub mod weights;
-pub type CreateItemData<T> =
- CreateRefungibleExData<<T as pallet_evm::account::Config>::CrossAccountId>;
+#[derive(Derivative, Clone)]
+pub struct CreateItemData<CrossAccountId> {
+ #[derivative(Debug(format_with = "bounded::map_debug"))]
+ pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,
+ #[derivative(Debug(format_with = "bounded::vec_debug"))]
+ pub properties: CollectionPropertiesVec,
+}
pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
/// Token data, stored independently from other data used to describe it
@@ -873,7 +882,7 @@
pub fn create_multiple_items(
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
- data: Vec<CreateItemData<T>>,
+ data: Vec<CreateItemData<T::CrossAccountId>>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
if !collection.is_owner_or_admin(sender) {
@@ -1213,7 +1222,7 @@
pub fn create_item(
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
- data: CreateItemData<T>,
+ data: CreateItemData<T::CrossAccountId>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::create_multiple_items(collection, sender, vec![data], nesting_budget)
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -826,13 +826,23 @@
/// Extended data for create ReFungible item.
#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]
-pub struct CreateRefungibleExData<CrossAccountId> {
+pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {
#[derivative(Debug(format_with = "bounded::map_debug"))]
pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,
#[derivative(Debug(format_with = "bounded::vec_debug"))]
pub properties: CollectionPropertiesVec,
}
+/// Extended data for create ReFungible item.
+#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
+#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]
+pub struct CreateRefungibleExSingleOwner<CrossAccountId> {
+ pub user: CrossAccountId,
+ pub pieces: u128,
+ #[derivative(Debug(format_with = "bounded::vec_debug"))]
+ pub properties: CollectionPropertiesVec,
+}
+
/// Unified extended data for creating item.
#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]
@@ -853,12 +863,12 @@
/// many tokens, each may have only one owner
RefungibleMultipleItems(
#[derivative(Debug(format_with = "bounded::vec_debug"))]
- BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,
+ BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,
),
/// Extended data for create ReFungible item in case of
/// single token, which may have many owners
- RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),
+ RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),
}
impl From<CreateNftData> for CreateItemData {