difftreelog
Merge pull request #442 from UniqueNetwork/doc/nonfungible-pallet
in: master
6 files changed
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -133,6 +133,8 @@
}
}
+/// Implementation of `CommonCollectionOperations` for `NonfungibleHandle`. It wraps Nonfungible Pallete
+/// methods and adds weight info.
impl<T: Config> CommonCollectionOperations<T> for NonfungibleHandle<T> {
fn create_item(
&self,
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -14,6 +14,11 @@
// You should have received a copy of the GNU General Public License
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
+//! # Nonfungible Pallet EVM API
+//!
+//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Nonfungible Pallet.
+//! Method implementations are mostly doing parameter conversion and calling Nonfungible Pallet methods.
+
extern crate alloc;
use core::{
char::{REPLACEMENT_CHARACTER, decode_utf16},
@@ -40,8 +45,15 @@
SelfWeightOf, weights::WeightInfo, TokenProperties,
};
+/// @title A contract that allows to set and delete token properties and change token property permissions.
#[solidity_interface(name = "TokenProperties")]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice Set permissions for token property.
+ /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ /// @param key Property key.
+ /// @param is_mutable Permission to mutate property.
+ /// @param collection_admin Permission to mutate property by collection admin if property is mutable.
+ /// @param token_owner Permission to mutate property by token owner if property is mutable.
fn set_token_property_permission(
&mut self,
caller: caller,
@@ -68,6 +80,11 @@
.map_err(dispatch_to_evm::<T>)
}
+ /// @notice Set token property value.
+ /// @dev Throws error if `msg.sender` has no permission to edit the property.
+ /// @param tokenId ID of the token.
+ /// @param key Property key.
+ /// @param value Property value.
fn set_property(
&mut self,
caller: caller,
@@ -96,6 +113,10 @@
.map_err(dispatch_to_evm::<T>)
}
+ /// @notice Delete token property value.
+ /// @dev Throws error if `msg.sender` has no permission to edit the property.
+ /// @param tokenId ID of the token.
+ /// @param key Property key.
fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
@@ -111,7 +132,11 @@
.map_err(dispatch_to_evm::<T>)
}
- /// Throws error if key not found
+ /// @notice Get token property value.
+ /// @dev Throws error if key not found
+ /// @param tokenId ID of the token.
+ /// @param key Property key.
+ /// @return Property value bytes
fn property(&self, token_id: uint256, key: string) -> Result<bytes> {
let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
let key = <Vec<u8>>::from(key)
@@ -127,6 +152,11 @@
#[derive(ToLog)]
pub enum ERC721Events {
+ /// @dev This emits when ownership of any NFT changes by any mechanism.
+ /// This event emits when NFTs are created (`from` == 0) and destroyed
+ /// (`to` == 0). Exception: during contract creation, any number of NFTs
+ /// may be created and assigned without emitting Transfer. At the time of
+ /// any transfer, the approved address for that NFT (if any) is reset to none.
Transfer {
#[indexed]
from: address,
@@ -135,6 +165,10 @@
#[indexed]
token_id: uint256,
},
+ /// @dev This emits when the approved address for an NFT is changed or
+ /// reaffirmed. The zero address indicates there is no approved address.
+ /// When a Transfer event emits, this also indicates that the approved
+ /// address for that NFT (if any) is reset to none.
Approval {
#[indexed]
owner: address,
@@ -143,6 +177,8 @@
#[indexed]
token_id: uint256,
},
+ /// @dev This emits when an operator is enabled or disabled for an owner.
+ /// The operator can manage all NFTs of the owner.
#[allow(dead_code)]
ApprovalForAll {
#[indexed]
@@ -159,19 +195,27 @@
MintingFinished {},
}
+/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension
+/// @dev See https://eips.ethereum.org/EIPS/eip-721
#[solidity_interface(name = "ERC721Metadata")]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice A descriptive name for a collection of NFTs in this contract
fn name(&self) -> Result<string> {
Ok(decode_utf16(self.name.iter().copied())
.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))
.collect::<string>())
}
+ /// @notice An abbreviated name for NFTs in this contract
fn symbol(&self) -> Result<string> {
Ok(string::from_utf8_lossy(&self.token_prefix).into())
}
- /// Returns token's const_metadata
+ /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.
+ /// @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC
+ /// 3986. The URI may point to a JSON file that conforms to the "ERC721
+ /// Metadata JSON Schema".
+ /// @return token's const_metadata
#[solidity(rename_selector = "tokenURI")]
fn token_uri(&self, token_id: uint256) -> Result<string> {
let key = token_uri_key();
@@ -192,32 +236,53 @@
}
}
+/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
+/// @dev See https://eips.ethereum.org/EIPS/eip-721
#[solidity_interface(name = "ERC721Enumerable")]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice Enumerate valid NFTs
+ /// @param index A counter less than `totalSupply()`
+ /// @return The token identifier for the `index`th NFT,
+ /// (sort order not specified)
fn token_by_index(&self, index: uint256) -> Result<uint256> {
Ok(index)
}
- /// Not implemented
+ /// @dev Not implemented
fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {
// TODO: Not implemetable
Err("not implemented".into())
}
+ /// @notice Count NFTs tracked by this contract
+ /// @return A count of valid NFTs tracked by this contract, where each one of
+ /// them has an assigned and queryable owner not equal to the zero address
fn total_supply(&self) -> Result<uint256> {
self.consume_store_reads(1)?;
Ok(<Pallet<T>>::total_supply(self).into())
}
}
+/// @title ERC-721 Non-Fungible Token Standard
+/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md
#[solidity_interface(name = "ERC721", events(ERC721Events))]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice Count all NFTs assigned to an owner
+ /// @dev NFTs assigned to the zero address are considered invalid, and this
+ /// function throws for queries about the zero address.
+ /// @param owner An address for whom to query the balance
+ /// @return The number of NFTs owned by `owner`, possibly zero
fn balance_of(&self, owner: address) -> Result<uint256> {
self.consume_store_reads(1)?;
let owner = T::CrossAccountId::from_eth(owner);
let balance = <AccountBalance<T>>::get((self.id, owner));
Ok(balance.into())
}
+ /// @notice Find the owner of an NFT
+ /// @dev NFTs assigned to zero address are considered invalid, and queries
+ /// about them do throw.
+ /// @param tokenId The identifier for an NFT
+ /// @return The address of the owner of the NFT
fn owner_of(&self, token_id: uint256) -> Result<address> {
self.consume_store_reads(1)?;
let token: TokenId = token_id.try_into()?;
@@ -226,7 +291,7 @@
.owner
.as_eth())
}
- /// Not implemented
+ /// @dev Not implemented
fn safe_transfer_from_with_data(
&mut self,
_from: address,
@@ -238,7 +303,7 @@
// TODO: Not implemetable
Err("not implemented".into())
}
- /// Not implemented
+ /// @dev Not implemented
fn safe_transfer_from(
&mut self,
_from: address,
@@ -250,6 +315,16 @@
Err("not implemented".into())
}
+ /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
+ /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ /// THEY MAY BE PERMANENTLY LOST
+ /// @dev Throws unless `msg.sender` is the current owner or an authorized
+ /// operator for this NFT. Throws if `from` is not the current owner. Throws
+ /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ /// @param from The current owner of the NFT
+ /// @param to The new owner
+ /// @param tokenId The NFT to transfer
+ /// @param _value Not used for an NFT
#[weight(<SelfWeightOf<T>>::transfer_from())]
fn transfer_from(
&mut self,
@@ -272,6 +347,12 @@
Ok(())
}
+ /// @notice Set or reaffirm the approved address for an NFT
+ /// @dev The zero address indicates there is no approved address.
+ /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ /// operator of the current owner.
+ /// @param approved The new approved NFT controller
+ /// @param tokenId The NFT to approve
#[weight(<SelfWeightOf<T>>::approve())]
fn approve(
&mut self,
@@ -289,7 +370,7 @@
Ok(())
}
- /// Not implemented
+ /// @dev Not implemented
fn set_approval_for_all(
&mut self,
_caller: caller,
@@ -300,21 +381,26 @@
Err("not implemented".into())
}
- /// Not implemented
+ /// @dev Not implemented
fn get_approved(&self, _token_id: uint256) -> Result<address> {
// TODO: Not implemetable
Err("not implemented".into())
}
- /// Not implemented
+ /// @dev Not implemented
fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {
// TODO: Not implemetable
Err("not implemented".into())
}
}
+/// @title ERC721 Token that can be irreversibly burned (destroyed).
#[solidity_interface(name = "ERC721Burnable")]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice Burns a specific ERC721 token.
+ /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ /// operator of the current owner.
+ /// @param tokenId The NFT to approve
#[weight(<SelfWeightOf<T>>::burn_item())]
fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -325,14 +411,18 @@
}
}
+/// @title ERC721 minting logic.
#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]
impl<T: Config> NonfungibleHandle<T> {
fn minting_finished(&self) -> Result<bool> {
Ok(false)
}
- /// `token_id` should be obtained with `next_token_id` method,
- /// unlike standard, you can't specify it manually
+ /// @notice Function to mint token.
+ /// @dev `tokenId` should be obtained with `nextTokenId` method,
+ /// unlike standard, you can't specify it manually
+ /// @param to The new owner
+ /// @param tokenId ID of the minted NFT
#[weight(<SelfWeightOf<T>>::create_item())]
fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -364,8 +454,12 @@
Ok(true)
}
- /// `token_id` should be obtained with `next_token_id` method,
- /// unlike standard, you can't specify it manually
+ /// @notice Function to mint token with the given tokenUri.
+ /// @dev `tokenId` should be obtained with `nextTokenId` method,
+ /// unlike standard, you can't specify it manually
+ /// @param to The new owner
+ /// @param tokenId ID of the minted NFT
+ /// @param tokenUri Token URI that would be stored in the NFT properties
#[solidity(rename_selector = "mintWithTokenURI")]
#[weight(<SelfWeightOf<T>>::create_item())]
fn mint_with_token_uri(
@@ -420,7 +514,7 @@
Ok(true)
}
- /// Not implemented
+ /// @dev Not implemented
fn finish_minting(&mut self, _caller: caller) -> Result<bool> {
Err("not implementable".into())
}
@@ -449,8 +543,15 @@
false
}
+/// @title Unique extensions for ERC721.
#[solidity_interface(name = "ERC721UniqueExtensions")]
impl<T: Config> NonfungibleHandle<T> {
+ /// @notice Transfer ownership of an NFT
+ /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
+ /// is the zero address. Throws if `tokenId` is not a valid NFT.
+ /// @param to The new owner
+ /// @param tokenId The NFT to transfer
+ /// @param _value Not used for an NFT
#[weight(<SelfWeightOf<T>>::transfer())]
fn transfer(
&mut self,
@@ -470,6 +571,13 @@
Ok(())
}
+ /// @notice Burns a specific ERC721 token.
+ /// @dev Throws unless `msg.sender` is the current owner or an authorized
+ /// operator for this NFT. Throws if `from` is not the current owner. Throws
+ /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ /// @param from The current owner of the NFT
+ /// @param tokenId The NFT to transfer
+ /// @param _value Not used for an NFT
#[weight(<SelfWeightOf<T>>::burn_from())]
fn burn_from(
&mut self,
@@ -490,6 +598,7 @@
Ok(())
}
+ /// @notice Returns next free NFT ID.
fn next_token_id(&self) -> Result<uint256> {
self.consume_store_reads(1)?;
Ok(<TokensMinted<T>>::get(self.id)
@@ -498,6 +607,11 @@
.into())
}
+ /// @notice Function to mint multiple tokens.
+ /// @dev `tokenIds` should be an array of consecutive numbers and first number
+ /// should be obtained with `nextTokenId` method
+ /// @param to The new owner
+ /// @param tokenIds IDs of the minted NFTs
#[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]
fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -529,6 +643,11 @@
Ok(true)
}
+ /// @notice Function to mint multiple tokens with the given tokenUris.
+ /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive
+ /// numbers and first number should be obtained with `nextTokenId` method
+ /// @param to The new owner
+ /// @param tokens array of pairs of token ID and token URI for minted tokens
#[solidity(rename_selector = "mintBulkWithTokenURI")]
#[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]
fn mint_bulk_with_token_uri(
pallets/nonfungible/src/lib.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#![cfg_attr(not(feature = "std"), no_std)]1819use erc::ERC721Events;20use evm_coder::ToLog;21use frame_support::{22 BoundedVec, ensure, fail, transactional,23 storage::with_transaction,24 pallet_prelude::DispatchResultWithPostInfo,25 pallet_prelude::Weight,26 weights::{PostDispatchInfo, Pays},27};28use up_data_structs::{29 AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,30 mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,31 PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,32 AuxPropertyValue,33};34use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};35use pallet_common::{36 Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,37 eth::collection_id_to_address,38};39use pallet_structure::{Pallet as PalletStructure, Error as StructureError};40use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};41use sp_core::H160;42use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};43use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap, collections::btree_set::BTreeSet};44use core::ops::Deref;45use codec::{Encode, Decode, MaxEncodedLen};46use scale_info::TypeInfo;4748pub use pallet::*;49use weights::WeightInfo;50#[cfg(feature = "runtime-benchmarks")]51pub mod benchmarking;52pub mod common;53pub mod erc;54pub mod weights;5556pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;57pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;5859#[struct_versioning::versioned(version = 2, upper)]60#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]61pub struct ItemData<CrossAccountId> {62 #[version(..2)]63 pub const_data: BoundedVec<u8, CustomDataLimit>,6465 #[version(..2)]66 pub variable_data: BoundedVec<u8, CustomDataLimit>,6768 pub owner: CrossAccountId,69}7071#[frame_support::pallet]72pub mod pallet {73 use super::*;74 use frame_support::{75 Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,76 };77 use frame_system::pallet_prelude::*;78 use up_data_structs::{CollectionId, TokenId};79 use super::weights::WeightInfo;8081 #[pallet::error]82 pub enum Error<T> {83 /// Not Nonfungible item data used to mint in Nonfungible collection.84 NotNonfungibleDataUsedToMintFungibleCollectionToken,85 /// Used amount > 1 with NFT86 NonfungibleItemsHaveNoAmount,87 /// Unable to burn NFT with children88 CantBurnNftWithChildren,89 }9091 #[pallet::config]92 pub trait Config:93 frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config94 {95 type WeightInfo: WeightInfo;96 }9798 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);99100 #[pallet::pallet]101 #[pallet::storage_version(STORAGE_VERSION)]102 #[pallet::generate_store(pub(super) trait Store)]103 pub struct Pallet<T>(_);104105 #[pallet::storage]106 pub type TokensMinted<T: Config> =107 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;108 #[pallet::storage]109 pub type TokensBurnt<T: Config> =110 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;111112 #[pallet::storage]113 pub type TokenData<T: Config> = StorageNMap<114 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),115 Value = ItemData<T::CrossAccountId>,116 QueryKind = OptionQuery,117 >;118119 #[pallet::storage]120 #[pallet::getter(fn token_properties)]121 pub type TokenProperties<T: Config> = StorageNMap<122 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),123 Value = Properties,124 QueryKind = ValueQuery,125 OnEmpty = up_data_structs::TokenProperties,126 >;127128 #[pallet::storage]129 #[pallet::getter(fn token_aux_property)]130 pub type TokenAuxProperties<T: Config> = StorageNMap<131 Key = (132 Key<Twox64Concat, CollectionId>,133 Key<Twox64Concat, TokenId>,134 Key<Twox64Concat, PropertyScope>,135 Key<Twox64Concat, PropertyKey>,136 ),137 Value = AuxPropertyValue,138 QueryKind = OptionQuery,139 >;140141 /// Used to enumerate tokens owned by account142 #[pallet::storage]143 pub type Owned<T: Config> = StorageNMap<144 Key = (145 Key<Twox64Concat, CollectionId>,146 Key<Blake2_128Concat, T::CrossAccountId>,147 Key<Twox64Concat, TokenId>,148 ),149 Value = bool,150 QueryKind = ValueQuery,151 >;152153 /// Used to enumerate token's children154 #[pallet::storage]155 #[pallet::getter(fn token_children)]156 pub type TokenChildren<T: Config> = StorageNMap<157 Key = (158 Key<Twox64Concat, CollectionId>,159 Key<Twox64Concat, TokenId>,160 Key<Twox64Concat, (CollectionId, TokenId)>,161 ),162 Value = bool,163 QueryKind = ValueQuery,164 >;165166 #[pallet::storage]167 pub type AccountBalance<T: Config> = StorageNMap<168 Key = (169 Key<Twox64Concat, CollectionId>,170 Key<Blake2_128Concat, T::CrossAccountId>,171 ),172 Value = u32,173 QueryKind = ValueQuery,174 >;175176 #[pallet::storage]177 pub type Allowance<T: Config> = StorageNMap<178 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),179 Value = T::CrossAccountId,180 QueryKind = OptionQuery,181 >;182183 #[pallet::hooks]184 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {185 fn on_runtime_upgrade() -> Weight {186 if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {187 let mut had_consts = BTreeSet::new();188 <TokenData<T>>::translate::<ItemDataVersion1<T::CrossAccountId>, _>(189 |(collection, token), v| {190 let mut props = vec![];191 if !v.const_data.is_empty() {192 props.push(Property {193 key: b"_old_constData".to_vec().try_into().unwrap(),194 value: v195 .const_data196 .clone()197 .into_inner()198 .try_into()199 .expect("const too long"),200 });201 had_consts.insert(collection);202 }203 if !v.variable_data.is_empty() {204 props.push(Property {205 key: b"_old_variableData".to_vec().try_into().unwrap(),206 value: v207 .variable_data208 .clone()209 .into_inner()210 .try_into()211 .expect("variable too long"),212 })213 }214 if !props.is_empty() {215 Self::set_scoped_token_properties(216 collection,217 token,218 PropertyScope::None,219 props.into_iter(),220 )221 .expect("existing token data exceeds property storage");222 }223 Some(<ItemDataVersion2<T::CrossAccountId>>::from(v))224 },225 );226 for collection in had_consts {227 <PalletCommon<T>>::set_property_permission_unchecked(228 collection,229 PropertyKeyPermission {230 key: b"_old_constData".to_vec().try_into().unwrap(),231 permission: PropertyPermission {232 mutable: false,233 collection_admin: true,234 token_owner: false,235 },236 },237 )238 .expect("failed to configure permission");239 }240 }241242 0243 }244 }245}246247pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);248impl<T: Config> NonfungibleHandle<T> {249 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {250 Self(inner)251 }252 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {253 self.0254 }255 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {256 &mut self.0257 }258}259impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {260 fn recorder(&self) -> &SubstrateRecorder<T> {261 self.0.recorder()262 }263 fn into_recorder(self) -> SubstrateRecorder<T> {264 self.0.into_recorder()265 }266}267impl<T: Config> Deref for NonfungibleHandle<T> {268 type Target = pallet_common::CollectionHandle<T>;269270 fn deref(&self) -> &Self::Target {271 &self.0272 }273}274275impl<T: Config> Pallet<T> {276 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {277 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)278 }279 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {280 <TokenData<T>>::contains_key((collection.id, token))281 }282283 pub fn set_scoped_token_property(284 collection_id: CollectionId,285 token_id: TokenId,286 scope: PropertyScope,287 property: Property,288 ) -> DispatchResult {289 TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {290 properties.try_scoped_set(scope, property.key, property.value)291 })292 .map_err(<CommonError<T>>::from)?;293294 Ok(())295 }296297 pub fn set_scoped_token_properties(298 collection_id: CollectionId,299 token_id: TokenId,300 scope: PropertyScope,301 properties: impl Iterator<Item = Property>,302 ) -> DispatchResult {303 TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {304 stored_properties.try_scoped_set_from_iter(scope, properties)305 })306 .map_err(<CommonError<T>>::from)?;307308 Ok(())309 }310311 pub fn try_mutate_token_aux_property<R, E>(312 collection_id: CollectionId,313 token_id: TokenId,314 scope: PropertyScope,315 key: PropertyKey,316 f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,317 ) -> Result<R, E> {318 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)319 }320321 pub fn remove_token_aux_property(322 collection_id: CollectionId,323 token_id: TokenId,324 scope: PropertyScope,325 key: PropertyKey,326 ) {327 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));328 }329330 pub fn iterate_token_aux_properties(331 collection_id: CollectionId,332 token_id: TokenId,333 scope: PropertyScope,334 ) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {335 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))336 }337338 pub fn current_token_id(collection_id: CollectionId) -> TokenId {339 TokenId(<TokensMinted<T>>::get(collection_id))340 }341}342343// unchecked calls skips any permission checks344impl<T: Config> Pallet<T> {345 pub fn init_collection(346 owner: T::CrossAccountId,347 data: CreateCollectionData<T::AccountId>,348 is_external: bool,349 ) -> Result<CollectionId, DispatchError> {350 <PalletCommon<T>>::init_collection(owner, data, is_external)351 }352 pub fn destroy_collection(353 collection: NonfungibleHandle<T>,354 sender: &T::CrossAccountId,355 ) -> DispatchResult {356 let id = collection.id;357358 if Self::collection_has_tokens(id) {359 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());360 }361362 // =========363364 PalletCommon::destroy_collection(collection.0, sender)?;365366 <TokenData<T>>::remove_prefix((id,), None);367 <TokenChildren<T>>::remove_prefix((id,), None);368 <Owned<T>>::remove_prefix((id,), None);369 <TokensMinted<T>>::remove(id);370 <TokensBurnt<T>>::remove(id);371 <Allowance<T>>::remove_prefix((id,), None);372 <AccountBalance<T>>::remove_prefix((id,), None);373 Ok(())374 }375376 pub fn burn(377 collection: &NonfungibleHandle<T>,378 sender: &T::CrossAccountId,379 token: TokenId,380 ) -> DispatchResult {381 let token_data =382 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;383 ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);384385 if collection.permissions.access() == AccessMode::AllowList {386 collection.check_allowlist(sender)?;387 }388389 if Self::token_has_children(collection.id, token) {390 return Err(<Error<T>>::CantBurnNftWithChildren.into());391 }392393 let burnt = <TokensBurnt<T>>::get(collection.id)394 .checked_add(1)395 .ok_or(ArithmeticError::Overflow)?;396397 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))398 .checked_sub(1)399 .ok_or(ArithmeticError::Overflow)?;400401 // =========402403 if balance == 0 {404 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));405 } else {406 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);407 }408409 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);410411 <Owned<T>>::remove((collection.id, &token_data.owner, token));412 <TokensBurnt<T>>::insert(collection.id, burnt);413 <TokenData<T>>::remove((collection.id, token));414 <TokenProperties<T>>::remove((collection.id, token));415 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);416 let old_spender = <Allowance<T>>::take((collection.id, token));417418 if let Some(old_spender) = old_spender {419 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(420 collection.id,421 token,422 token_data.owner.clone(),423 old_spender,424 0,425 ));426 }427428 <PalletEvm<T>>::deposit_log(429 ERC721Events::Transfer {430 from: *token_data.owner.as_eth(),431 to: H160::default(),432 token_id: token.into(),433 }434 .to_log(collection_id_to_address(collection.id)),435 );436 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(437 collection.id,438 token,439 token_data.owner,440 1,441 ));442 Ok(())443 }444445 #[transactional]446 pub fn burn_recursively(447 collection: &NonfungibleHandle<T>,448 sender: &T::CrossAccountId,449 token: TokenId,450 self_budget: &dyn Budget,451 breadth_budget: &dyn Budget,452 ) -> DispatchResultWithPostInfo {453 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);454455 let current_token_account =456 T::CrossTokenAddressMapping::token_to_address(collection.id, token);457458 let mut weight = 0 as Weight;459460 // This method is transactional, if user in fact doesn't have permissions to remove token -461 // tokens removed here will be restored after rejected transaction462 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {463 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);464 let PostDispatchInfo { actual_weight, .. } =465 <PalletStructure<T>>::burn_item_recursively(466 current_token_account.clone(),467 collection,468 token,469 self_budget,470 breadth_budget,471 )?;472 if let Some(actual_weight) = actual_weight {473 weight = weight.saturating_add(actual_weight);474 }475 }476477 Self::burn(collection, sender, token)?;478 DispatchResultWithPostInfo::Ok(PostDispatchInfo {479 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),480 pays_fee: Pays::Yes,481 })482 }483484 #[transactional]485 fn modify_token_properties(486 collection: &NonfungibleHandle<T>,487 sender: &T::CrossAccountId,488 token_id: TokenId,489 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,490 is_token_create: bool,491 nesting_budget: &dyn Budget,492 ) -> DispatchResult {493 let mut collection_admin_status = None;494 let mut token_owner_result = None;495496 let mut is_collection_admin =497 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));498499 let mut is_token_owner = || {500 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {501 let is_owned = <PalletStructure<T>>::check_indirectly_owned(502 sender.clone(),503 collection.id,504 token_id,505 None,506 nesting_budget,507 )?;508509 Ok(is_owned)510 })511 };512513 for (key, value) in properties {514 let permission = <PalletCommon<T>>::property_permissions(collection.id)515 .get(&key)516 .cloned()517 .unwrap_or_else(PropertyPermission::none);518519 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))520 .get(&key)521 .is_some();522523 match permission {524 PropertyPermission { mutable: false, .. } if is_property_exists => {525 return Err(<CommonError<T>>::NoPermission.into());526 }527528 PropertyPermission {529 collection_admin,530 token_owner,531 ..532 } => {533 //TODO: investigate threats during public minting.534 if is_token_create && (collection_admin || token_owner) && value.is_some() {535 // Pass536 } else if collection_admin && is_collection_admin() {537 // Pass538 } else if token_owner && is_token_owner()? {539 // Pass540 } else {541 fail!(<CommonError<T>>::NoPermission);542 }543 }544 }545546 match value {547 Some(value) => {548 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {549 properties.try_set(key.clone(), value)550 })551 .map_err(<CommonError<T>>::from)?;552553 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(554 collection.id,555 token_id,556 key,557 ));558 }559 None => {560 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {561 properties.remove(&key)562 })563 .map_err(<CommonError<T>>::from)?;564565 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(566 collection.id,567 token_id,568 key,569 ));570 }571 }572 }573574 Ok(())575 }576577 pub fn set_token_properties(578 collection: &NonfungibleHandle<T>,579 sender: &T::CrossAccountId,580 token_id: TokenId,581 properties: impl Iterator<Item = Property>,582 is_token_create: bool,583 nesting_budget: &dyn Budget,584 ) -> DispatchResult {585 Self::modify_token_properties(586 collection,587 sender,588 token_id,589 properties.map(|p| (p.key, Some(p.value))),590 is_token_create,591 nesting_budget,592 )593 }594595 pub fn set_token_property(596 collection: &NonfungibleHandle<T>,597 sender: &T::CrossAccountId,598 token_id: TokenId,599 property: Property,600 nesting_budget: &dyn Budget,601 ) -> DispatchResult {602 let is_token_create = false;603604 Self::set_token_properties(605 collection,606 sender,607 token_id,608 [property].into_iter(),609 is_token_create,610 nesting_budget,611 )612 }613614 pub fn delete_token_properties(615 collection: &NonfungibleHandle<T>,616 sender: &T::CrossAccountId,617 token_id: TokenId,618 property_keys: impl Iterator<Item = PropertyKey>,619 nesting_budget: &dyn Budget,620 ) -> DispatchResult {621 let is_token_create = false;622623 Self::modify_token_properties(624 collection,625 sender,626 token_id,627 property_keys.into_iter().map(|key| (key, None)),628 is_token_create,629 nesting_budget,630 )631 }632633 pub fn delete_token_property(634 collection: &NonfungibleHandle<T>,635 sender: &T::CrossAccountId,636 token_id: TokenId,637 property_key: PropertyKey,638 nesting_budget: &dyn Budget,639 ) -> DispatchResult {640 Self::delete_token_properties(641 collection,642 sender,643 token_id,644 [property_key].into_iter(),645 nesting_budget,646 )647 }648649 pub fn set_collection_properties(650 collection: &NonfungibleHandle<T>,651 sender: &T::CrossAccountId,652 properties: Vec<Property>,653 ) -> DispatchResult {654 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)655 }656657 pub fn delete_collection_properties(658 collection: &CollectionHandle<T>,659 sender: &T::CrossAccountId,660 property_keys: Vec<PropertyKey>,661 ) -> DispatchResult {662 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)663 }664665 pub fn set_token_property_permissions(666 collection: &CollectionHandle<T>,667 sender: &T::CrossAccountId,668 property_permissions: Vec<PropertyKeyPermission>,669 ) -> DispatchResult {670 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)671 }672673 pub fn set_property_permission(674 collection: &CollectionHandle<T>,675 sender: &T::CrossAccountId,676 permission: PropertyKeyPermission,677 ) -> DispatchResult {678 <PalletCommon<T>>::set_property_permission(collection, sender, permission)679 }680681 pub fn transfer(682 collection: &NonfungibleHandle<T>,683 from: &T::CrossAccountId,684 to: &T::CrossAccountId,685 token: TokenId,686 nesting_budget: &dyn Budget,687 ) -> DispatchResult {688 ensure!(689 collection.limits.transfers_enabled(),690 <CommonError<T>>::TransferNotAllowed691 );692693 let token_data =694 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;695 ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);696697 if collection.permissions.access() == AccessMode::AllowList {698 collection.check_allowlist(from)?;699 collection.check_allowlist(to)?;700 }701 <PalletCommon<T>>::ensure_correct_receiver(to)?;702703 let balance_from = <AccountBalance<T>>::get((collection.id, from))704 .checked_sub(1)705 .ok_or(<CommonError<T>>::TokenValueTooLow)?;706 let balance_to = if from != to {707 let balance_to = <AccountBalance<T>>::get((collection.id, to))708 .checked_add(1)709 .ok_or(ArithmeticError::Overflow)?;710711 ensure!(712 balance_to < collection.limits.account_token_ownership_limit(),713 <CommonError<T>>::AccountTokenLimitExceeded,714 );715716 Some(balance_to)717 } else {718 None719 };720721 <PalletStructure<T>>::nest_if_sent_to_token(722 from.clone(),723 to,724 collection.id,725 token,726 nesting_budget,727 )?;728729 // =========730731 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);732733 <TokenData<T>>::insert(734 (collection.id, token),735 ItemData {736 owner: to.clone(),737 ..token_data738 },739 );740741 if let Some(balance_to) = balance_to {742 // from != to743 if balance_from == 0 {744 <AccountBalance<T>>::remove((collection.id, from));745 } else {746 <AccountBalance<T>>::insert((collection.id, from), balance_from);747 }748 <AccountBalance<T>>::insert((collection.id, to), balance_to);749 <Owned<T>>::remove((collection.id, from, token));750 <Owned<T>>::insert((collection.id, to, token), true);751 }752 Self::set_allowance_unchecked(collection, from, token, None, true);753754 <PalletEvm<T>>::deposit_log(755 ERC721Events::Transfer {756 from: *from.as_eth(),757 to: *to.as_eth(),758 token_id: token.into(),759 }760 .to_log(collection_id_to_address(collection.id)),761 );762 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(763 collection.id,764 token,765 from.clone(),766 to.clone(),767 1,768 ));769 Ok(())770 }771772 pub fn create_multiple_items(773 collection: &NonfungibleHandle<T>,774 sender: &T::CrossAccountId,775 data: Vec<CreateItemData<T>>,776 nesting_budget: &dyn Budget,777 ) -> DispatchResult {778 if !collection.is_owner_or_admin(sender) {779 ensure!(780 collection.permissions.mint_mode(),781 <CommonError<T>>::PublicMintingNotAllowed782 );783 collection.check_allowlist(sender)?;784785 for item in data.iter() {786 collection.check_allowlist(&item.owner)?;787 }788 }789790 for data in data.iter() {791 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;792 }793794 let first_token = <TokensMinted<T>>::get(collection.id);795 let tokens_minted = first_token796 .checked_add(data.len() as u32)797 .ok_or(ArithmeticError::Overflow)?;798 ensure!(799 tokens_minted <= collection.limits.token_limit(),800 <CommonError<T>>::CollectionTokenLimitExceeded801 );802803 let mut balances = BTreeMap::new();804 for data in &data {805 let balance = balances806 .entry(&data.owner)807 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));808 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;809810 ensure!(811 *balance <= collection.limits.account_token_ownership_limit(),812 <CommonError<T>>::AccountTokenLimitExceeded,813 );814 }815816 for (i, data) in data.iter().enumerate() {817 let token = TokenId(first_token + i as u32 + 1);818819 <PalletStructure<T>>::check_nesting(820 sender.clone(),821 &data.owner,822 collection.id,823 token,824 nesting_budget,825 )?;826 }827828 // =========829830 with_transaction(|| {831 for (i, data) in data.iter().enumerate() {832 let token = first_token + i as u32 + 1;833834 <TokenData<T>>::insert(835 (collection.id, token),836 ItemData {837 // const_data: data.const_data.clone(),838 owner: data.owner.clone(),839 },840 );841842 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(843 &data.owner,844 collection.id,845 TokenId(token),846 );847848 if let Err(e) = Self::set_token_properties(849 collection,850 sender,851 TokenId(token),852 data.properties.clone().into_iter(),853 true,854 nesting_budget,855 ) {856 return TransactionOutcome::Rollback(Err(e));857 }858 }859 TransactionOutcome::Commit(Ok(()))860 })?;861862 <TokensMinted<T>>::insert(collection.id, tokens_minted);863 for (account, balance) in balances {864 <AccountBalance<T>>::insert((collection.id, account), balance);865 }866 for (i, data) in data.into_iter().enumerate() {867 let token = first_token + i as u32 + 1;868 <Owned<T>>::insert((collection.id, &data.owner, token), true);869870 <PalletEvm<T>>::deposit_log(871 ERC721Events::Transfer {872 from: H160::default(),873 to: *data.owner.as_eth(),874 token_id: token.into(),875 }876 .to_log(collection_id_to_address(collection.id)),877 );878 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(879 collection.id,880 TokenId(token),881 data.owner.clone(),882 1,883 ));884 }885 Ok(())886 }887888 pub fn set_allowance_unchecked(889 collection: &NonfungibleHandle<T>,890 sender: &T::CrossAccountId,891 token: TokenId,892 spender: Option<&T::CrossAccountId>,893 assume_implicit_eth: bool,894 ) {895 if let Some(spender) = spender {896 let old_spender = <Allowance<T>>::get((collection.id, token));897 <Allowance<T>>::insert((collection.id, token), spender);898 // In ERC721 there is only one possible approved user of token, so we set899 // approved user to spender900 <PalletEvm<T>>::deposit_log(901 ERC721Events::Approval {902 owner: *sender.as_eth(),903 approved: *spender.as_eth(),904 token_id: token.into(),905 }906 .to_log(collection_id_to_address(collection.id)),907 );908 // In Unique chain, any token can have any amount of approved users, so we need to909 // set allowance of old owner to 0, and allowance of new owner to 1910 if old_spender.as_ref() != Some(spender) {911 if let Some(old_owner) = old_spender {912 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(913 collection.id,914 token,915 sender.clone(),916 old_owner,917 0,918 ));919 }920 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(921 collection.id,922 token,923 sender.clone(),924 spender.clone(),925 1,926 ));927 }928 } else {929 let old_spender = <Allowance<T>>::take((collection.id, token));930 if !assume_implicit_eth {931 // In ERC721 there is only one possible approved user of token, so we set932 // approved user to zero address933 <PalletEvm<T>>::deposit_log(934 ERC721Events::Approval {935 owner: *sender.as_eth(),936 approved: H160::default(),937 token_id: token.into(),938 }939 .to_log(collection_id_to_address(collection.id)),940 );941 }942 // In Unique chain, any token can have any amount of approved users, so we need to943 // set allowance of old owner to 0944 if let Some(old_spender) = old_spender {945 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(946 collection.id,947 token,948 sender.clone(),949 old_spender,950 0,951 ));952 }953 }954 }955956 pub fn set_allowance(957 collection: &NonfungibleHandle<T>,958 sender: &T::CrossAccountId,959 token: TokenId,960 spender: Option<&T::CrossAccountId>,961 ) -> DispatchResult {962 if collection.permissions.access() == AccessMode::AllowList {963 collection.check_allowlist(sender)?;964 if let Some(spender) = spender {965 collection.check_allowlist(spender)?;966 }967 }968969 if let Some(spender) = spender {970 <PalletCommon<T>>::ensure_correct_receiver(spender)?;971 }972973 let token_data =974 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;975 if &token_data.owner != sender {976 ensure!(977 collection.ignores_owned_amount(sender),978 <CommonError<T>>::CantApproveMoreThanOwned979 );980 }981982 // =========983984 Self::set_allowance_unchecked(collection, sender, token, spender, false);985 Ok(())986 }987988 fn check_allowed(989 collection: &NonfungibleHandle<T>,990 spender: &T::CrossAccountId,991 from: &T::CrossAccountId,992 token: TokenId,993 nesting_budget: &dyn Budget,994 ) -> DispatchResult {995 if spender.conv_eq(from) {996 return Ok(());997 }998 if collection.permissions.access() == AccessMode::AllowList {999 // `from`, `to` checked in [`transfer`]1000 collection.check_allowlist(spender)?;1001 }10021003 if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1004 return Ok(());1005 }10061007 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1008 ensure!(1009 <PalletStructure<T>>::check_indirectly_owned(1010 spender.clone(),1011 source.0,1012 source.1,1013 None,1014 nesting_budget1015 )?,1016 <CommonError<T>>::ApprovedValueTooLow,1017 );1018 return Ok(());1019 }1020 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1021 return Ok(());1022 }1023 ensure!(1024 collection.ignores_allowance(spender),1025 <CommonError<T>>::ApprovedValueTooLow1026 );1027 Ok(())1028 }10291030 pub fn transfer_from(1031 collection: &NonfungibleHandle<T>,1032 spender: &T::CrossAccountId,1033 from: &T::CrossAccountId,1034 to: &T::CrossAccountId,1035 token: TokenId,1036 nesting_budget: &dyn Budget,1037 ) -> DispatchResult {1038 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10391040 // =========10411042 // Allowance is reset in [`transfer`]1043 Self::transfer(collection, from, to, token, nesting_budget)1044 }10451046 pub fn burn_from(1047 collection: &NonfungibleHandle<T>,1048 spender: &T::CrossAccountId,1049 from: &T::CrossAccountId,1050 token: TokenId,1051 nesting_budget: &dyn Budget,1052 ) -> DispatchResult {1053 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10541055 // =========10561057 Self::burn(collection, from, token)1058 }10591060 pub fn check_nesting(1061 handle: &NonfungibleHandle<T>,1062 sender: T::CrossAccountId,1063 from: (CollectionId, TokenId),1064 under: TokenId,1065 nesting_budget: &dyn Budget,1066 ) -> DispatchResult {1067 let nesting = handle.permissions.nesting();10681069 #[cfg(not(feature = "runtime-benchmarks"))]1070 let permissive = false;1071 #[cfg(feature = "runtime-benchmarks")]1072 let permissive = nesting.permissive;10731074 if permissive {1075 // Pass1076 } else if nesting.token_owner1077 && <PalletStructure<T>>::check_indirectly_owned(1078 sender.clone(),1079 handle.id,1080 under,1081 Some(from),1082 nesting_budget,1083 )? {1084 // Pass1085 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1086 // Pass1087 } else {1088 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1089 }10901091 if let Some(whitelist) = &nesting.restricted {1092 ensure!(1093 whitelist.contains(&from.0),1094 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1095 );1096 }1097 Ok(())1098 }10991100 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1101 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1102 }11031104 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1105 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1106 }11071108 fn collection_has_tokens(collection_id: CollectionId) -> bool {1109 <TokenData<T>>::iter_prefix((collection_id,))1110 .next()1111 .is_some()1112 }11131114 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1115 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1116 .next()1117 .is_some()1118 }11191120 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1121 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1122 .map(|((child_collection_id, child_id), _)| TokenChild {1123 collection: child_collection_id,1124 token: child_id,1125 })1126 .collect()1127 }11281129 /// Delegated to `create_multiple_items`1130 pub fn create_item(1131 collection: &NonfungibleHandle<T>,1132 sender: &T::CrossAccountId,1133 data: CreateItemData<T>,1134 nesting_budget: &dyn Budget,1135 ) -> DispatchResult {1136 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1137 }1138}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//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`]25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//! Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//! an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//! owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//! it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//! attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//! with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//! some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//! Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96 BoundedVec, ensure, fail, transactional,97 storage::with_transaction,98 pallet_prelude::DispatchResultWithPostInfo,99 pallet_prelude::Weight,100 weights::{PostDispatchInfo, Pays},101};102use up_data_structs::{103 AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,104 mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,105 PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,106 AuxPropertyValue,107};108use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};109use pallet_common::{110 Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,111 eth::collection_id_to_address,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::H160;116use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};117use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap, collections::btree_set::BTreeSet};118use core::ops::Deref;119use codec::{Encode, Decode, MaxEncodedLen};120use scale_info::TypeInfo;121122pub use pallet::*;123use weights::WeightInfo;124#[cfg(feature = "runtime-benchmarks")]125pub mod benchmarking;126pub mod common;127pub mod erc;128pub mod weights;129130pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;131pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;132133#[struct_versioning::versioned(version = 2, upper)]134#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]135pub struct ItemData<CrossAccountId> {136 #[version(..2)]137 pub const_data: BoundedVec<u8, CustomDataLimit>,138139 #[version(..2)]140 pub variable_data: BoundedVec<u8, CustomDataLimit>,141142 pub owner: CrossAccountId,143}144145#[frame_support::pallet]146pub mod pallet {147 use super::*;148 use frame_support::{149 Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,150 };151 use frame_system::pallet_prelude::*;152 use up_data_structs::{CollectionId, TokenId};153 use super::weights::WeightInfo;154155 #[pallet::error]156 pub enum Error<T> {157 /// Not Nonfungible item data used to mint in Nonfungible collection.158 NotNonfungibleDataUsedToMintFungibleCollectionToken,159 /// Used amount > 1 with NFT160 NonfungibleItemsHaveNoAmount,161 /// Unable to burn NFT with children162 CantBurnNftWithChildren,163 }164165 #[pallet::config]166 pub trait Config:167 frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config168 {169 type WeightInfo: WeightInfo;170 }171172 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);173174 #[pallet::pallet]175 #[pallet::storage_version(STORAGE_VERSION)]176 #[pallet::generate_store(pub(super) trait Store)]177 pub struct Pallet<T>(_);178179 /// Amount of tokens minted for collection.180 #[pallet::storage]181 pub type TokensMinted<T: Config> =182 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;183184 /// Amount of burnt tokens for collection.185 #[pallet::storage]186 pub type TokensBurnt<T: Config> =187 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;188189 /// Custom data serialized to bytes for token.190 #[pallet::storage]191 pub type TokenData<T: Config> = StorageNMap<192 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),193 Value = ItemData<T::CrossAccountId>,194 QueryKind = OptionQuery,195 >;196197 /// Key-Value map stored for token.198 #[pallet::storage]199 #[pallet::getter(fn token_properties)]200 pub type TokenProperties<T: Config> = StorageNMap<201 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),202 Value = Properties,203 QueryKind = ValueQuery,204 OnEmpty = up_data_structs::TokenProperties,205 >;206207 /// Custom data that is serialized to bytes and attached to a token property.208 /// Currently used to store RMRK data.209 #[pallet::storage]210 #[pallet::getter(fn token_aux_property)]211 pub type TokenAuxProperties<T: Config> = StorageNMap<212 Key = (213 Key<Twox64Concat, CollectionId>,214 Key<Twox64Concat, TokenId>,215 Key<Twox64Concat, PropertyScope>,216 Key<Twox64Concat, PropertyKey>,217 ),218 Value = AuxPropertyValue,219 QueryKind = OptionQuery,220 >;221222 /// Used to enumerate tokens owned by account.223 #[pallet::storage]224 pub type Owned<T: Config> = StorageNMap<225 Key = (226 Key<Twox64Concat, CollectionId>,227 Key<Blake2_128Concat, T::CrossAccountId>,228 Key<Twox64Concat, TokenId>,229 ),230 Value = bool,231 QueryKind = ValueQuery,232 >;233234 /// Used to enumerate token's children.235 #[pallet::storage]236 #[pallet::getter(fn token_children)]237 pub type TokenChildren<T: Config> = StorageNMap<238 Key = (239 Key<Twox64Concat, CollectionId>,240 Key<Twox64Concat, TokenId>,241 Key<Twox64Concat, (CollectionId, TokenId)>,242 ),243 Value = bool,244 QueryKind = ValueQuery,245 >;246247 /// Amount of tokens owned by account.248 #[pallet::storage]249 pub type AccountBalance<T: Config> = StorageNMap<250 Key = (251 Key<Twox64Concat, CollectionId>,252 Key<Blake2_128Concat, T::CrossAccountId>,253 ),254 Value = u32,255 QueryKind = ValueQuery,256 >;257258 /// Allowance set by an owner for a spender for a token.259 #[pallet::storage]260 pub type Allowance<T: Config> = StorageNMap<261 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),262 Value = T::CrossAccountId,263 QueryKind = OptionQuery,264 >;265266 #[pallet::hooks]267 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {268 fn on_runtime_upgrade() -> Weight {269 if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {270 let mut had_consts = BTreeSet::new();271 <TokenData<T>>::translate::<ItemDataVersion1<T::CrossAccountId>, _>(272 |(collection, token), v| {273 let mut props = vec![];274 if !v.const_data.is_empty() {275 props.push(Property {276 key: b"_old_constData".to_vec().try_into().unwrap(),277 value: v278 .const_data279 .clone()280 .into_inner()281 .try_into()282 .expect("const too long"),283 });284 had_consts.insert(collection);285 }286 if !v.variable_data.is_empty() {287 props.push(Property {288 key: b"_old_variableData".to_vec().try_into().unwrap(),289 value: v290 .variable_data291 .clone()292 .into_inner()293 .try_into()294 .expect("variable too long"),295 })296 }297 if !props.is_empty() {298 Self::set_scoped_token_properties(299 collection,300 token,301 PropertyScope::None,302 props.into_iter(),303 )304 .expect("existing token data exceeds property storage");305 }306 Some(<ItemDataVersion2<T::CrossAccountId>>::from(v))307 },308 );309 for collection in had_consts {310 <PalletCommon<T>>::set_property_permission_unchecked(311 collection,312 PropertyKeyPermission {313 key: b"_old_constData".to_vec().try_into().unwrap(),314 permission: PropertyPermission {315 mutable: false,316 collection_admin: true,317 token_owner: false,318 },319 },320 )321 .expect("failed to configure permission");322 }323 }324325 0326 }327 }328}329330pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);331impl<T: Config> NonfungibleHandle<T> {332 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {333 Self(inner)334 }335 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {336 self.0337 }338 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {339 &mut self.0340 }341}342impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {343 fn recorder(&self) -> &SubstrateRecorder<T> {344 self.0.recorder()345 }346 fn into_recorder(self) -> SubstrateRecorder<T> {347 self.0.into_recorder()348 }349}350impl<T: Config> Deref for NonfungibleHandle<T> {351 type Target = pallet_common::CollectionHandle<T>;352353 fn deref(&self) -> &Self::Target {354 &self.0355 }356}357358impl<T: Config> Pallet<T> {359 /// Get number of NFT tokens in collection.360 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {361 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)362 }363364 /// Check that NFT token exists.365 ///366 /// - `token`: Token ID.367 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {368 <TokenData<T>>::contains_key((collection.id, token))369 }370371 /// Set the token property with the scope.372 ///373 /// - `property`: Contains key-value pair.374 pub fn set_scoped_token_property(375 collection_id: CollectionId,376 token_id: TokenId,377 scope: PropertyScope,378 property: Property,379 ) -> DispatchResult {380 TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {381 properties.try_scoped_set(scope, property.key, property.value)382 })383 .map_err(<CommonError<T>>::from)?;384385 Ok(())386 }387388 /// Batch operation to set multiple properties with the same scope.389 pub fn set_scoped_token_properties(390 collection_id: CollectionId,391 token_id: TokenId,392 scope: PropertyScope,393 properties: impl Iterator<Item = Property>,394 ) -> DispatchResult {395 TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {396 stored_properties.try_scoped_set_from_iter(scope, properties)397 })398 .map_err(<CommonError<T>>::from)?;399400 Ok(())401 }402403 /// Add or edit auxiliary data for the property.404 ///405 /// - `f`: function that adds or edits auxiliary data.406 pub fn try_mutate_token_aux_property<R, E>(407 collection_id: CollectionId,408 token_id: TokenId,409 scope: PropertyScope,410 key: PropertyKey,411 f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,412 ) -> Result<R, E> {413 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)414 }415416 /// Remove auxiliary data for the property.417 pub fn remove_token_aux_property(418 collection_id: CollectionId,419 token_id: TokenId,420 scope: PropertyScope,421 key: PropertyKey,422 ) {423 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));424 }425426 /// Get all auxiliary data in a given scope.427 ///428 /// Returns iterator over Property Key - Data pairs.429 pub fn iterate_token_aux_properties(430 collection_id: CollectionId,431 token_id: TokenId,432 scope: PropertyScope,433 ) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {434 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))435 }436437 /// Get ID of the last minted token438 pub fn current_token_id(collection_id: CollectionId) -> TokenId {439 TokenId(<TokensMinted<T>>::get(collection_id))440 }441}442443// unchecked calls skips any permission checks444impl<T: Config> Pallet<T> {445 /// Create NFT collection446 ///447 /// `init_collection` will take non-refundable deposit for collection creation.448 ///449 /// - `data`: Contains settings for collection limits and permissions.450 pub fn init_collection(451 owner: T::CrossAccountId,452 data: CreateCollectionData<T::AccountId>,453 is_external: bool,454 ) -> Result<CollectionId, DispatchError> {455 <PalletCommon<T>>::init_collection(owner, data, is_external)456 }457458 /// Destroy NFT collection459 ///460 /// `destroy_collection` will throw error if collection contains any tokens.461 /// Only owner can destroy collection.462 pub fn destroy_collection(463 collection: NonfungibleHandle<T>,464 sender: &T::CrossAccountId,465 ) -> DispatchResult {466 let id = collection.id;467468 if Self::collection_has_tokens(id) {469 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());470 }471472 // =========473474 PalletCommon::destroy_collection(collection.0, sender)?;475476 <TokenData<T>>::remove_prefix((id,), None);477 <TokenChildren<T>>::remove_prefix((id,), None);478 <Owned<T>>::remove_prefix((id,), None);479 <TokensMinted<T>>::remove(id);480 <TokensBurnt<T>>::remove(id);481 <Allowance<T>>::remove_prefix((id,), None);482 <AccountBalance<T>>::remove_prefix((id,), None);483 Ok(())484 }485486 /// Burn NFT token487 ///488 /// `burn` removes `token` from the `collection`, from it's owner and from the parent token489 /// if the token is nested.490 /// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.491 /// Also removes all corresponding properties and auxiliary properties.492 ///493 /// - `token`: Token that should be burned494 /// - `collection`: Collection that contains the token495 pub fn burn(496 collection: &NonfungibleHandle<T>,497 sender: &T::CrossAccountId,498 token: TokenId,499 ) -> DispatchResult {500 let token_data =501 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;502 ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);503504 if collection.permissions.access() == AccessMode::AllowList {505 collection.check_allowlist(sender)?;506 }507508 if Self::token_has_children(collection.id, token) {509 return Err(<Error<T>>::CantBurnNftWithChildren.into());510 }511512 let burnt = <TokensBurnt<T>>::get(collection.id)513 .checked_add(1)514 .ok_or(ArithmeticError::Overflow)?;515516 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))517 .checked_sub(1)518 .ok_or(ArithmeticError::Overflow)?;519520 // =========521522 if balance == 0 {523 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));524 } else {525 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);526 }527528 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);529530 <Owned<T>>::remove((collection.id, &token_data.owner, token));531 <TokensBurnt<T>>::insert(collection.id, burnt);532 <TokenData<T>>::remove((collection.id, token));533 <TokenProperties<T>>::remove((collection.id, token));534 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);535 let old_spender = <Allowance<T>>::take((collection.id, token));536537 if let Some(old_spender) = old_spender {538 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(539 collection.id,540 token,541 token_data.owner.clone(),542 old_spender,543 0,544 ));545 }546547 <PalletEvm<T>>::deposit_log(548 ERC721Events::Transfer {549 from: *token_data.owner.as_eth(),550 to: H160::default(),551 token_id: token.into(),552 }553 .to_log(collection_id_to_address(collection.id)),554 );555 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(556 collection.id,557 token,558 token_data.owner,559 1,560 ));561 Ok(())562 }563564 /// Same as [`burn`] but burns all the tokens that are nested in the token first565 ///566 /// - `self_budget`: Limit for searching children in depth.567 /// - `breadth_budget`: Limit of breadth of searching children.568 ///569 /// [`burn`]: struct.Pallet.html#method.burn570 #[transactional]571 pub fn burn_recursively(572 collection: &NonfungibleHandle<T>,573 sender: &T::CrossAccountId,574 token: TokenId,575 self_budget: &dyn Budget,576 breadth_budget: &dyn Budget,577 ) -> DispatchResultWithPostInfo {578 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);579580 let current_token_account =581 T::CrossTokenAddressMapping::token_to_address(collection.id, token);582583 let mut weight = 0 as Weight;584585 // This method is transactional, if user in fact doesn't have permissions to remove token -586 // tokens removed here will be restored after rejected transaction587 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {588 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);589 let PostDispatchInfo { actual_weight, .. } =590 <PalletStructure<T>>::burn_item_recursively(591 current_token_account.clone(),592 collection,593 token,594 self_budget,595 breadth_budget,596 )?;597 if let Some(actual_weight) = actual_weight {598 weight = weight.saturating_add(actual_weight);599 }600 }601602 Self::burn(collection, sender, token)?;603 DispatchResultWithPostInfo::Ok(PostDispatchInfo {604 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),605 pays_fee: Pays::Yes,606 })607 }608609 /// Batch operation to add, edit or remove properties for the token610 ///611 /// All affected properties should have mutable permission and sender should have612 /// permission to edit those properties.613 ///614 /// - `nesting_budget`: Limit for searching parents in depth to check ownership.615 /// - `is_token_create`: Indicates that method is called during token initialization.616 /// Allows to bypass ownership check.617 #[transactional]618 fn modify_token_properties(619 collection: &NonfungibleHandle<T>,620 sender: &T::CrossAccountId,621 token_id: TokenId,622 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,623 is_token_create: bool,624 nesting_budget: &dyn Budget,625 ) -> DispatchResult {626 let mut collection_admin_status = None;627 let mut token_owner_result = None;628629 let mut is_collection_admin =630 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));631632 let mut is_token_owner = || {633 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {634 let is_owned = <PalletStructure<T>>::check_indirectly_owned(635 sender.clone(),636 collection.id,637 token_id,638 None,639 nesting_budget,640 )?;641642 Ok(is_owned)643 })644 };645646 for (key, value) in properties {647 let permission = <PalletCommon<T>>::property_permissions(collection.id)648 .get(&key)649 .cloned()650 .unwrap_or_else(PropertyPermission::none);651652 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))653 .get(&key)654 .is_some();655656 match permission {657 PropertyPermission { mutable: false, .. } if is_property_exists => {658 return Err(<CommonError<T>>::NoPermission.into());659 }660661 PropertyPermission {662 collection_admin,663 token_owner,664 ..665 } => {666 //TODO: investigate threats during public minting.667 if is_token_create && (collection_admin || token_owner) && value.is_some() {668 // Pass669 } else if collection_admin && is_collection_admin() {670 // Pass671 } else if token_owner && is_token_owner()? {672 // Pass673 } else {674 fail!(<CommonError<T>>::NoPermission);675 }676 }677 }678679 match value {680 Some(value) => {681 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {682 properties.try_set(key.clone(), value)683 })684 .map_err(<CommonError<T>>::from)?;685686 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(687 collection.id,688 token_id,689 key,690 ));691 }692 None => {693 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {694 properties.remove(&key)695 })696 .map_err(<CommonError<T>>::from)?;697698 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(699 collection.id,700 token_id,701 key,702 ));703 }704 }705 }706707 Ok(())708 }709710 /// Batch operation to add or edit properties for the token711 ///712 /// Same as [`modify_token_properties`] but doesn't allow to remove properties713 ///714 /// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties715 pub fn set_token_properties(716 collection: &NonfungibleHandle<T>,717 sender: &T::CrossAccountId,718 token_id: TokenId,719 properties: impl Iterator<Item = Property>,720 is_token_create: bool,721 nesting_budget: &dyn Budget,722 ) -> DispatchResult {723 Self::modify_token_properties(724 collection,725 sender,726 token_id,727 properties.map(|p| (p.key, Some(p.value))),728 is_token_create,729 nesting_budget,730 )731 }732733 /// Add or edit single property for the token734 ///735 /// Calls [`set_token_properties`] internally736 ///737 /// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties738 pub fn set_token_property(739 collection: &NonfungibleHandle<T>,740 sender: &T::CrossAccountId,741 token_id: TokenId,742 property: Property,743 nesting_budget: &dyn Budget,744 ) -> DispatchResult {745 let is_token_create = false;746747 Self::set_token_properties(748 collection,749 sender,750 token_id,751 [property].into_iter(),752 is_token_create,753 nesting_budget,754 )755 }756757 /// Batch operation to remove properties from the token758 ///759 /// Same as [`modify_token_properties`] but doesn't allow to add or edit properties760 ///761 /// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties762 pub fn delete_token_properties(763 collection: &NonfungibleHandle<T>,764 sender: &T::CrossAccountId,765 token_id: TokenId,766 property_keys: impl Iterator<Item = PropertyKey>,767 nesting_budget: &dyn Budget,768 ) -> DispatchResult {769 let is_token_create = false;770771 Self::modify_token_properties(772 collection,773 sender,774 token_id,775 property_keys.into_iter().map(|key| (key, None)),776 is_token_create,777 nesting_budget,778 )779 }780781 /// Remove single property from the token782 ///783 /// Calls [`delete_token_properties`] internally784 ///785 /// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties786 pub fn delete_token_property(787 collection: &NonfungibleHandle<T>,788 sender: &T::CrossAccountId,789 token_id: TokenId,790 property_key: PropertyKey,791 nesting_budget: &dyn Budget,792 ) -> DispatchResult {793 Self::delete_token_properties(794 collection,795 sender,796 token_id,797 [property_key].into_iter(),798 nesting_budget,799 )800 }801802 /// Add or edit properties for the collection803 pub fn set_collection_properties(804 collection: &NonfungibleHandle<T>,805 sender: &T::CrossAccountId,806 properties: Vec<Property>,807 ) -> DispatchResult {808 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)809 }810811 /// Remove properties from the collection812 pub fn delete_collection_properties(813 collection: &CollectionHandle<T>,814 sender: &T::CrossAccountId,815 property_keys: Vec<PropertyKey>,816 ) -> DispatchResult {817 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)818 }819820 /// Set property permissions for the token.821 ///822 /// Sender should be the owner or admin of token's collection.823 pub fn set_token_property_permissions(824 collection: &CollectionHandle<T>,825 sender: &T::CrossAccountId,826 property_permissions: Vec<PropertyKeyPermission>,827 ) -> DispatchResult {828 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)829 }830831 /// Set property permissions for the collection.832 ///833 /// Sender should be the owner or admin of the collection.834 pub fn set_property_permission(835 collection: &CollectionHandle<T>,836 sender: &T::CrossAccountId,837 permission: PropertyKeyPermission,838 ) -> DispatchResult {839 <PalletCommon<T>>::set_property_permission(collection, sender, permission)840 }841842 /// Transfer NFT token from one account to another.843 ///844 /// `from` account stops being the owner and `to` account becomes the owner of the token.845 /// If `to` is token than `to` becomes owner of the token and the token become nested.846 /// Unnests token from previous parent if it was nested before.847 /// Removes allowance for the token if there was any.848 /// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.849 ///850 /// - `nesting_budget`: Limit for token nesting depth851 pub fn transfer(852 collection: &NonfungibleHandle<T>,853 from: &T::CrossAccountId,854 to: &T::CrossAccountId,855 token: TokenId,856 nesting_budget: &dyn Budget,857 ) -> DispatchResult {858 ensure!(859 collection.limits.transfers_enabled(),860 <CommonError<T>>::TransferNotAllowed861 );862863 let token_data =864 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;865 ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);866867 if collection.permissions.access() == AccessMode::AllowList {868 collection.check_allowlist(from)?;869 collection.check_allowlist(to)?;870 }871 <PalletCommon<T>>::ensure_correct_receiver(to)?;872873 let balance_from = <AccountBalance<T>>::get((collection.id, from))874 .checked_sub(1)875 .ok_or(<CommonError<T>>::TokenValueTooLow)?;876 let balance_to = if from != to {877 let balance_to = <AccountBalance<T>>::get((collection.id, to))878 .checked_add(1)879 .ok_or(ArithmeticError::Overflow)?;880881 ensure!(882 balance_to < collection.limits.account_token_ownership_limit(),883 <CommonError<T>>::AccountTokenLimitExceeded,884 );885886 Some(balance_to)887 } else {888 None889 };890891 <PalletStructure<T>>::nest_if_sent_to_token(892 from.clone(),893 to,894 collection.id,895 token,896 nesting_budget,897 )?;898899 // =========900901 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);902903 <TokenData<T>>::insert(904 (collection.id, token),905 ItemData {906 owner: to.clone(),907 ..token_data908 },909 );910911 if let Some(balance_to) = balance_to {912 // from != to913 if balance_from == 0 {914 <AccountBalance<T>>::remove((collection.id, from));915 } else {916 <AccountBalance<T>>::insert((collection.id, from), balance_from);917 }918 <AccountBalance<T>>::insert((collection.id, to), balance_to);919 <Owned<T>>::remove((collection.id, from, token));920 <Owned<T>>::insert((collection.id, to, token), true);921 }922 Self::set_allowance_unchecked(collection, from, token, None, true);923924 <PalletEvm<T>>::deposit_log(925 ERC721Events::Transfer {926 from: *from.as_eth(),927 to: *to.as_eth(),928 token_id: token.into(),929 }930 .to_log(collection_id_to_address(collection.id)),931 );932 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(933 collection.id,934 token,935 from.clone(),936 to.clone(),937 1,938 ));939 Ok(())940 }941942 /// Batch operation to mint multiple NFT tokens.943 ///944 /// The sender should be the owner/admin of the collection or collection should be configured945 /// to allow public minting.946 /// Throws if amount of tokens reached it's limit for the collection or if caller reached947 /// token ownership limit.948 ///949 /// - `data`: Contains list of token properties and users who will become the owners of the950 /// corresponging tokens.951 /// - `nesting_budget`: Limit for token nesting depth952 pub fn create_multiple_items(953 collection: &NonfungibleHandle<T>,954 sender: &T::CrossAccountId,955 data: Vec<CreateItemData<T>>,956 nesting_budget: &dyn Budget,957 ) -> DispatchResult {958 if !collection.is_owner_or_admin(sender) {959 ensure!(960 collection.permissions.mint_mode(),961 <CommonError<T>>::PublicMintingNotAllowed962 );963 collection.check_allowlist(sender)?;964965 for item in data.iter() {966 collection.check_allowlist(&item.owner)?;967 }968 }969970 for data in data.iter() {971 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;972 }973974 let first_token = <TokensMinted<T>>::get(collection.id);975 let tokens_minted = first_token976 .checked_add(data.len() as u32)977 .ok_or(ArithmeticError::Overflow)?;978 ensure!(979 tokens_minted <= collection.limits.token_limit(),980 <CommonError<T>>::CollectionTokenLimitExceeded981 );982983 let mut balances = BTreeMap::new();984 for data in &data {985 let balance = balances986 .entry(&data.owner)987 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));988 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;989990 ensure!(991 *balance <= collection.limits.account_token_ownership_limit(),992 <CommonError<T>>::AccountTokenLimitExceeded,993 );994 }995996 for (i, data) in data.iter().enumerate() {997 let token = TokenId(first_token + i as u32 + 1);998999 <PalletStructure<T>>::check_nesting(1000 sender.clone(),1001 &data.owner,1002 collection.id,1003 token,1004 nesting_budget,1005 )?;1006 }10071008 // =========10091010 with_transaction(|| {1011 for (i, data) in data.iter().enumerate() {1012 let token = first_token + i as u32 + 1;10131014 <TokenData<T>>::insert(1015 (collection.id, token),1016 ItemData {1017 // const_data: data.const_data.clone(),1018 owner: data.owner.clone(),1019 },1020 );10211022 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(1023 &data.owner,1024 collection.id,1025 TokenId(token),1026 );10271028 if let Err(e) = Self::set_token_properties(1029 collection,1030 sender,1031 TokenId(token),1032 data.properties.clone().into_iter(),1033 true,1034 nesting_budget,1035 ) {1036 return TransactionOutcome::Rollback(Err(e));1037 }1038 }1039 TransactionOutcome::Commit(Ok(()))1040 })?;10411042 <TokensMinted<T>>::insert(collection.id, tokens_minted);1043 for (account, balance) in balances {1044 <AccountBalance<T>>::insert((collection.id, account), balance);1045 }1046 for (i, data) in data.into_iter().enumerate() {1047 let token = first_token + i as u32 + 1;1048 <Owned<T>>::insert((collection.id, &data.owner, token), true);10491050 <PalletEvm<T>>::deposit_log(1051 ERC721Events::Transfer {1052 from: H160::default(),1053 to: *data.owner.as_eth(),1054 token_id: token.into(),1055 }1056 .to_log(collection_id_to_address(collection.id)),1057 );1058 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1059 collection.id,1060 TokenId(token),1061 data.owner.clone(),1062 1,1063 ));1064 }1065 Ok(())1066 }10671068 pub fn set_allowance_unchecked(1069 collection: &NonfungibleHandle<T>,1070 sender: &T::CrossAccountId,1071 token: TokenId,1072 spender: Option<&T::CrossAccountId>,1073 assume_implicit_eth: bool,1074 ) {1075 if let Some(spender) = spender {1076 let old_spender = <Allowance<T>>::get((collection.id, token));1077 <Allowance<T>>::insert((collection.id, token), spender);1078 // In ERC721 there is only one possible approved user of token, so we set1079 // approved user to spender1080 <PalletEvm<T>>::deposit_log(1081 ERC721Events::Approval {1082 owner: *sender.as_eth(),1083 approved: *spender.as_eth(),1084 token_id: token.into(),1085 }1086 .to_log(collection_id_to_address(collection.id)),1087 );1088 // In Unique chain, any token can have any amount of approved users, so we need to1089 // set allowance of old owner to 0, and allowance of new owner to 11090 if old_spender.as_ref() != Some(spender) {1091 if let Some(old_owner) = old_spender {1092 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(1093 collection.id,1094 token,1095 sender.clone(),1096 old_owner,1097 0,1098 ));1099 }1100 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(1101 collection.id,1102 token,1103 sender.clone(),1104 spender.clone(),1105 1,1106 ));1107 }1108 } else {1109 let old_spender = <Allowance<T>>::take((collection.id, token));1110 if !assume_implicit_eth {1111 // In ERC721 there is only one possible approved user of token, so we set1112 // approved user to zero address1113 <PalletEvm<T>>::deposit_log(1114 ERC721Events::Approval {1115 owner: *sender.as_eth(),1116 approved: H160::default(),1117 token_id: token.into(),1118 }1119 .to_log(collection_id_to_address(collection.id)),1120 );1121 }1122 // In Unique chain, any token can have any amount of approved users, so we need to1123 // set allowance of old owner to 01124 if let Some(old_spender) = old_spender {1125 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(1126 collection.id,1127 token,1128 sender.clone(),1129 old_spender,1130 0,1131 ));1132 }1133 }1134 }11351136 /// Set allowance for the spender to `transfer` or `burn` sender's token.1137 ///1138 /// - `token`: Token the spender is allowed to `transfer` or `burn`.1139 pub fn set_allowance(1140 collection: &NonfungibleHandle<T>,1141 sender: &T::CrossAccountId,1142 token: TokenId,1143 spender: Option<&T::CrossAccountId>,1144 ) -> DispatchResult {1145 if collection.permissions.access() == AccessMode::AllowList {1146 collection.check_allowlist(sender)?;1147 if let Some(spender) = spender {1148 collection.check_allowlist(spender)?;1149 }1150 }11511152 if let Some(spender) = spender {1153 <PalletCommon<T>>::ensure_correct_receiver(spender)?;1154 }11551156 let token_data =1157 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1158 if &token_data.owner != sender {1159 ensure!(1160 collection.ignores_owned_amount(sender),1161 <CommonError<T>>::CantApproveMoreThanOwned1162 );1163 }11641165 // =========11661167 Self::set_allowance_unchecked(collection, sender, token, spender, false);1168 Ok(())1169 }11701171 /// Checks allowance for the spender to use the token.1172 fn check_allowed(1173 collection: &NonfungibleHandle<T>,1174 spender: &T::CrossAccountId,1175 from: &T::CrossAccountId,1176 token: TokenId,1177 nesting_budget: &dyn Budget,1178 ) -> DispatchResult {1179 if spender.conv_eq(from) {1180 return Ok(());1181 }1182 if collection.permissions.access() == AccessMode::AllowList {1183 // `from`, `to` checked in [`transfer`]1184 collection.check_allowlist(spender)?;1185 }11861187 if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1188 return Ok(());1189 }11901191 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1192 ensure!(1193 <PalletStructure<T>>::check_indirectly_owned(1194 spender.clone(),1195 source.0,1196 source.1,1197 None,1198 nesting_budget1199 )?,1200 <CommonError<T>>::ApprovedValueTooLow,1201 );1202 return Ok(());1203 }1204 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1205 return Ok(());1206 }1207 ensure!(1208 collection.ignores_allowance(spender),1209 <CommonError<T>>::ApprovedValueTooLow1210 );1211 Ok(())1212 }12131214 /// Transfer NFT token from one account to another.1215 ///1216 /// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1217 /// The owner should set allowance for the spender to transfer token.1218 ///1219 /// [`transfer`]: struct.Pallet.html#method.transfer1220 pub fn transfer_from(1221 collection: &NonfungibleHandle<T>,1222 spender: &T::CrossAccountId,1223 from: &T::CrossAccountId,1224 to: &T::CrossAccountId,1225 token: TokenId,1226 nesting_budget: &dyn Budget,1227 ) -> DispatchResult {1228 Self::check_allowed(collection, spender, from, token, nesting_budget)?;12291230 // =========12311232 // Allowance is reset in [`transfer`]1233 Self::transfer(collection, from, to, token, nesting_budget)1234 }12351236 /// Burn NFT token for `from` account.1237 ///1238 /// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1239 /// set allowance for the spender to burn token.1240 ///1241 /// [`burn`]: struct.Pallet.html#method.burn1242 pub fn burn_from(1243 collection: &NonfungibleHandle<T>,1244 spender: &T::CrossAccountId,1245 from: &T::CrossAccountId,1246 token: TokenId,1247 nesting_budget: &dyn Budget,1248 ) -> DispatchResult {1249 Self::check_allowed(collection, spender, from, token, nesting_budget)?;12501251 // =========12521253 Self::burn(collection, from, token)1254 }12551256 /// Check that `from` token could be nested in `under` token.1257 ///1258 pub fn check_nesting(1259 handle: &NonfungibleHandle<T>,1260 sender: T::CrossAccountId,1261 from: (CollectionId, TokenId),1262 under: TokenId,1263 nesting_budget: &dyn Budget,1264 ) -> DispatchResult {1265 let nesting = handle.permissions.nesting();12661267 #[cfg(not(feature = "runtime-benchmarks"))]1268 let permissive = false;1269 #[cfg(feature = "runtime-benchmarks")]1270 let permissive = nesting.permissive;12711272 if permissive {1273 // Pass1274 } else if nesting.token_owner1275 && <PalletStructure<T>>::check_indirectly_owned(1276 sender.clone(),1277 handle.id,1278 under,1279 Some(from),1280 nesting_budget,1281 )? {1282 // Pass1283 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1284 // Pass1285 } else {1286 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1287 }12881289 if let Some(whitelist) = &nesting.restricted {1290 ensure!(1291 whitelist.contains(&from.0),1292 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1293 );1294 }1295 Ok(())1296 }12971298 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1299 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1300 }13011302 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1303 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1304 }13051306 fn collection_has_tokens(collection_id: CollectionId) -> bool {1307 <TokenData<T>>::iter_prefix((collection_id,))1308 .next()1309 .is_some()1310 }13111312 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1313 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1314 .next()1315 .is_some()1316 }13171318 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1319 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1320 .map(|((child_collection_id, child_id), _)| TokenChild {1321 collection: child_collection_id,1322 token: child_id,1323 })1324 .collect()1325 }13261327 /// Mint single NFT token.1328 ///1329 /// Delegated to [`create_multiple_items`]1330 ///1331 /// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1332 pub fn create_item(1333 collection: &NonfungibleHandle<T>,1334 sender: &T::CrossAccountId,1335 data: CreateItemData<T>,1336 nesting_budget: &dyn Budget,1337 ) -> DispatchResult {1338 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1339 }1340}pallets/nonfungible/src/stubs/UniqueNFT.rawdiffbeforeafterbothbinary blob — no preview
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -53,6 +53,13 @@
// Selector: 41369377
contract TokenProperties is Dummy, ERC165 {
+ // @notice Set permissions for token property.
+ // @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ // @param key Property key.
+ // @param is_mutable Permission to mutate property.
+ // @param collection_admin Permission to mutate property by collection admin if property is mutable.
+ // @param token_owner Permission to mutate property by token owner if property is mutable.
+ //
// Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa
function setTokenPropertyPermission(
string memory key,
@@ -68,6 +75,12 @@
dummy = 0;
}
+ // @notice Set token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param token_id ID of the token.
+ // @param key Property key.
+ // @param value Property value.
+ //
// Selector: setProperty(uint256,string,bytes) 1752d67b
function setProperty(
uint256 tokenId,
@@ -81,6 +94,11 @@
dummy = 0;
}
+ // @notice Delete token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param token_id ID of the token.
+ // @param key Property key.
+ //
// Selector: deleteProperty(uint256,string) 066111d1
function deleteProperty(uint256 tokenId, string memory key) public {
require(false, stub_error);
@@ -89,7 +107,10 @@
dummy = 0;
}
- // Throws error if key not found
+ // @notice Get token property value.
+ // @dev Throws error if key not found
+ // @param token_id ID of the token.
+ // @param key Property key.
//
// Selector: property(uint256,string) 7228c327
function property(uint256 tokenId, string memory key)
@@ -107,6 +128,11 @@
// Selector: 42966c68
contract ERC721Burnable is Dummy, ERC165 {
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ // operator of the current owner.
+ // @param tokenId The NFT to approve
+ //
// Selector: burn(uint256) 42966c68
function burn(uint256 tokenId) public {
require(false, stub_error);
@@ -117,6 +143,12 @@
// Selector: 58800161
contract ERC721 is Dummy, ERC165, ERC721Events {
+ // @notice Count all NFTs assigned to an owner
+ // @dev NFTs assigned to the zero address are considered invalid, and this
+ // function throws for queries about the zero address.
+ // @param _owner An address for whom to query the balance
+ // @return The number of NFTs owned by `_owner`, possibly zero
+ //
// Selector: balanceOf(address) 70a08231
function balanceOf(address owner) public view returns (uint256) {
require(false, stub_error);
@@ -125,6 +157,12 @@
return 0;
}
+ // @notice Find the owner of an NFT
+ // @dev NFTs assigned to zero address are considered invalid, and queries
+ // about them do throw.
+ // @param _tokenId The identifier for an NFT
+ // @return The address of the owner of the NFT
+ //
// Selector: ownerOf(uint256) 6352211e
function ownerOf(uint256 tokenId) public view returns (address) {
require(false, stub_error);
@@ -133,7 +171,7 @@
return 0x0000000000000000000000000000000000000000;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672
function safeTransferFromWithData(
@@ -150,7 +188,7 @@
dummy = 0;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: safeTransferFrom(address,address,uint256) 42842e0e
function safeTransferFrom(
@@ -165,6 +203,17 @@
dummy = 0;
}
+ // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
+ // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ // THEY MAY BE PERMANENTLY LOST
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this NFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param from The current owner of the NFT
+ // @param to The new owner
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: transferFrom(address,address,uint256) 23b872dd
function transferFrom(
address from,
@@ -178,6 +227,13 @@
dummy = 0;
}
+ // @notice Set or reaffirm the approved address for an NFT
+ // @dev The zero address indicates there is no approved address.
+ // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ // operator of the current owner.
+ // @param approved The new approved NFT controller
+ // @param tokenId The NFT to approve
+ //
// Selector: approve(address,uint256) 095ea7b3
function approve(address approved, uint256 tokenId) public {
require(false, stub_error);
@@ -186,7 +242,7 @@
dummy = 0;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: setApprovalForAll(address,bool) a22cb465
function setApprovalForAll(address operator, bool approved) public {
@@ -196,7 +252,7 @@
dummy = 0;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: getApproved(uint256) 081812fc
function getApproved(uint256 tokenId) public view returns (address) {
@@ -206,7 +262,7 @@
return 0x0000000000000000000000000000000000000000;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: isApprovedForAll(address,address) e985e9c5
function isApprovedForAll(address owner, address operator)
@@ -224,6 +280,8 @@
// Selector: 5b5e139f
contract ERC721Metadata is Dummy, ERC165 {
+ // @notice A descriptive name for a collection of NFTs in this contract
+ //
// Selector: name() 06fdde03
function name() public view returns (string memory) {
require(false, stub_error);
@@ -231,6 +289,8 @@
return "";
}
+ // @notice An abbreviated name for NFTs in this contract
+ //
// Selector: symbol() 95d89b41
function symbol() public view returns (string memory) {
require(false, stub_error);
@@ -238,7 +298,11 @@
return "";
}
- // Returns token's const_metadata
+ // @notice A distinct Uniform Resource Identifier (URI) for a given asset.
+ // @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC
+ // 3986. The URI may point to a JSON file that conforms to the "ERC721
+ // Metadata JSON Schema".
+ // @return token's const_metadata
//
// Selector: tokenURI(uint256) c87b56dd
function tokenURI(uint256 tokenId) public view returns (string memory) {
@@ -258,8 +322,11 @@
return false;
}
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted NFT
//
// Selector: mint(address,uint256) 40c10f19
function mint(address to, uint256 tokenId) public returns (bool) {
@@ -270,8 +337,12 @@
return false;
}
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token with the given tokenUri.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted NFT
+ // @param tokenUri Token URI that would be stored in the NFT properties
//
// Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f
function mintWithTokenURI(
@@ -287,7 +358,7 @@
return false;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: finishMinting() 7d64bcb4
function finishMinting() public returns (bool) {
@@ -299,6 +370,12 @@
// Selector: 780e9d63
contract ERC721Enumerable is Dummy, ERC165 {
+ // @notice Enumerate valid NFTs
+ // @dev Throws if `index` >= `totalSupply()`.
+ // @param index A counter less than `totalSupply()`
+ // @return The token identifier for the `index`th NFT,
+ // (sort order not specified)
+ //
// Selector: tokenByIndex(uint256) 4f6ccce7
function tokenByIndex(uint256 index) public view returns (uint256) {
require(false, stub_error);
@@ -307,7 +384,7 @@
return 0;
}
- // Not implemented
+ // @dev Not implemented
//
// Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59
function tokenOfOwnerByIndex(address owner, uint256 index)
@@ -322,6 +399,10 @@
return 0;
}
+ // @notice Count NFTs tracked by this contract
+ // @return A count of valid NFTs tracked by this contract, where each one of
+ // them has an assigned and queryable owner not equal to the zero address
+ //
// Selector: totalSupply() 18160ddd
function totalSupply() public view returns (uint256) {
require(false, stub_error);
@@ -475,6 +556,15 @@
// Selector: d74d154f
contract ERC721UniqueExtensions is Dummy, ERC165 {
+ // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
+ // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ // THEY MAY BE PERMANENTLY LOST
+ // @dev Throws unless `msg.sender` is the current owner. Throws if `to`
+ // is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param to The new owner
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: transfer(address,uint256) a9059cbb
function transfer(address to, uint256 tokenId) public {
require(false, stub_error);
@@ -483,6 +573,14 @@
dummy = 0;
}
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this NFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param from The current owner of the NFT
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: burnFrom(address,uint256) 79cc6790
function burnFrom(address from, uint256 tokenId) public {
require(false, stub_error);
@@ -491,6 +589,8 @@
dummy = 0;
}
+ // @notice Returns next free NFT ID.
+ //
// Selector: nextTokenId() 75794a3c
function nextTokenId() public view returns (uint256) {
require(false, stub_error);
@@ -498,6 +598,12 @@
return 0;
}
+ // @notice Function to mint multiple tokens.
+ // @dev `tokenIds` should be an array of consecutive numbers and first number
+ // should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokenIds IDs of the minted NFTs
+ //
// Selector: mintBulk(address,uint256[]) 44a9945e
function mintBulk(address to, uint256[] memory tokenIds)
public
@@ -510,6 +616,12 @@
return false;
}
+ // @notice Function to mint multiple tokens with the given tokenUris.
+ // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive
+ // numbers and first number should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokens array of pairs of token ID and token URI for minted tokens
+ //
// Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
public
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -44,6 +44,13 @@
// Selector: 41369377
interface TokenProperties is Dummy, ERC165 {
+ // @notice Set permissions for token property.
+ // @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ // @param key Property key.
+ // @param is_mutable Permission to mutate property.
+ // @param collection_admin Permission to mutate property by collection admin if property is mutable.
+ // @param token_owner Permission to mutate property by token owner if property is mutable.
+ //
// Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa
function setTokenPropertyPermission(
string memory key,
@@ -52,6 +59,12 @@
bool tokenOwner
) external;
+ // @notice Set token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param token_id ID of the token.
+ // @param key Property key.
+ // @param value Property value.
+ //
// Selector: setProperty(uint256,string,bytes) 1752d67b
function setProperty(
uint256 tokenId,
@@ -59,10 +72,18 @@
bytes memory value
) external;
+ // @notice Delete token property value.
+ // @dev Throws error if `msg.sender` has no permission to edit the property.
+ // @param token_id ID of the token.
+ // @param key Property key.
+ //
// Selector: deleteProperty(uint256,string) 066111d1
function deleteProperty(uint256 tokenId, string memory key) external;
- // Throws error if key not found
+ // @notice Get token property value.
+ // @dev Throws error if key not found
+ // @param token_id ID of the token.
+ // @param key Property key.
//
// Selector: property(uint256,string) 7228c327
function property(uint256 tokenId, string memory key)
@@ -73,19 +94,36 @@
// Selector: 42966c68
interface ERC721Burnable is Dummy, ERC165 {
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ // operator of the current owner.
+ // @param tokenId The NFT to approve
+ //
// Selector: burn(uint256) 42966c68
function burn(uint256 tokenId) external;
}
// Selector: 58800161
interface ERC721 is Dummy, ERC165, ERC721Events {
+ // @notice Count all NFTs assigned to an owner
+ // @dev NFTs assigned to the zero address are considered invalid, and this
+ // function throws for queries about the zero address.
+ // @param _owner An address for whom to query the balance
+ // @return The number of NFTs owned by `_owner`, possibly zero
+ //
// Selector: balanceOf(address) 70a08231
function balanceOf(address owner) external view returns (uint256);
+ // @notice Find the owner of an NFT
+ // @dev NFTs assigned to zero address are considered invalid, and queries
+ // about them do throw.
+ // @param _tokenId The identifier for an NFT
+ // @return The address of the owner of the NFT
+ //
// Selector: ownerOf(uint256) 6352211e
function ownerOf(uint256 tokenId) external view returns (address);
- // Not implemented
+ // @dev Not implemented
//
// Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672
function safeTransferFromWithData(
@@ -95,7 +133,7 @@
bytes memory data
) external;
- // Not implemented
+ // @dev Not implemented
//
// Selector: safeTransferFrom(address,address,uint256) 42842e0e
function safeTransferFrom(
@@ -104,6 +142,17 @@
uint256 tokenId
) external;
+ // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
+ // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ // THEY MAY BE PERMANENTLY LOST
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this NFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param from The current owner of the NFT
+ // @param to The new owner
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: transferFrom(address,address,uint256) 23b872dd
function transferFrom(
address from,
@@ -111,20 +160,27 @@
uint256 tokenId
) external;
+ // @notice Set or reaffirm the approved address for an NFT
+ // @dev The zero address indicates there is no approved address.
+ // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized
+ // operator of the current owner.
+ // @param approved The new approved NFT controller
+ // @param tokenId The NFT to approve
+ //
// Selector: approve(address,uint256) 095ea7b3
function approve(address approved, uint256 tokenId) external;
- // Not implemented
+ // @dev Not implemented
//
// Selector: setApprovalForAll(address,bool) a22cb465
function setApprovalForAll(address operator, bool approved) external;
- // Not implemented
+ // @dev Not implemented
//
// Selector: getApproved(uint256) 081812fc
function getApproved(uint256 tokenId) external view returns (address);
- // Not implemented
+ // @dev Not implemented
//
// Selector: isApprovedForAll(address,address) e985e9c5
function isApprovedForAll(address owner, address operator)
@@ -135,13 +191,21 @@
// Selector: 5b5e139f
interface ERC721Metadata is Dummy, ERC165 {
+ // @notice A descriptive name for a collection of NFTs in this contract
+ //
// Selector: name() 06fdde03
function name() external view returns (string memory);
+ // @notice An abbreviated name for NFTs in this contract
+ //
// Selector: symbol() 95d89b41
function symbol() external view returns (string memory);
- // Returns token's const_metadata
+ // @notice A distinct Uniform Resource Identifier (URI) for a given asset.
+ // @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC
+ // 3986. The URI may point to a JSON file that conforms to the "ERC721
+ // Metadata JSON Schema".
+ // @return token's const_metadata
//
// Selector: tokenURI(uint256) c87b56dd
function tokenURI(uint256 tokenId) external view returns (string memory);
@@ -152,14 +216,21 @@
// Selector: mintingFinished() 05d2035b
function mintingFinished() external view returns (bool);
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted NFT
//
// Selector: mint(address,uint256) 40c10f19
function mint(address to, uint256 tokenId) external returns (bool);
- // `token_id` should be obtained with `next_token_id` method,
- // unlike standard, you can't specify it manually
+ // @notice Function to mint token with the given tokenUri.
+ // @dev `tokenId` should be obtained with `nextTokenId` method,
+ // unlike standard, you can't specify it manually
+ // @param to The new owner
+ // @param tokenId ID of the minted NFT
+ // @param tokenUri Token URI that would be stored in the NFT properties
//
// Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f
function mintWithTokenURI(
@@ -168,7 +239,7 @@
string memory tokenUri
) external returns (bool);
- // Not implemented
+ // @dev Not implemented
//
// Selector: finishMinting() 7d64bcb4
function finishMinting() external returns (bool);
@@ -176,10 +247,16 @@
// Selector: 780e9d63
interface ERC721Enumerable is Dummy, ERC165 {
+ // @notice Enumerate valid NFTs
+ // @dev Throws if `index` >= `totalSupply()`.
+ // @param index A counter less than `totalSupply()`
+ // @return The token identifier for the `index`th NFT,
+ // (sort order not specified)
+ //
// Selector: tokenByIndex(uint256) 4f6ccce7
function tokenByIndex(uint256 index) external view returns (uint256);
- // Not implemented
+ // @dev Not implemented
//
// Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59
function tokenOfOwnerByIndex(address owner, uint256 index)
@@ -187,6 +264,10 @@
view
returns (uint256);
+ // @notice Count NFTs tracked by this contract
+ // @return A count of valid NFTs tracked by this contract, where each one of
+ // them has an assigned and queryable owner not equal to the zero address
+ //
// Selector: totalSupply() 18160ddd
function totalSupply() external view returns (uint256);
}
@@ -257,20 +338,51 @@
// Selector: d74d154f
interface ERC721UniqueExtensions is Dummy, ERC165 {
+ // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
+ // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE
+ // THEY MAY BE PERMANENTLY LOST
+ // @dev Throws unless `msg.sender` is the current owner. Throws if `to`
+ // is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param to The new owner
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: transfer(address,uint256) a9059cbb
function transfer(address to, uint256 tokenId) external;
+ // @notice Burns a specific ERC721 token.
+ // @dev Throws unless `msg.sender` is the current owner or an authorized
+ // operator for this NFT. Throws if `from` is not the current owner. Throws
+ // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.
+ // @param from The current owner of the NFT
+ // @param tokenId The NFT to transfer
+ // @param _value Not used for an NFT
+ //
// Selector: burnFrom(address,uint256) 79cc6790
function burnFrom(address from, uint256 tokenId) external;
+ // @notice Returns next free NFT ID.
+ //
// Selector: nextTokenId() 75794a3c
function nextTokenId() external view returns (uint256);
+ // @notice Function to mint multiple tokens.
+ // @dev `tokenIds` should be an array of consecutive numbers and first number
+ // should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokenIds IDs of the minted NFTs
+ //
// Selector: mintBulk(address,uint256[]) 44a9945e
function mintBulk(address to, uint256[] memory tokenIds)
external
returns (bool);
+ // @notice Function to mint multiple tokens with the given tokenUris.
+ // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive
+ // numbers and first number should be obtained with `nextTokenId` method
+ // @param to The new owner
+ // @param tokens array of pairs of token ID and token URI for minted tokens
+ //
// Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
external