difftreelog
Merge pull request #442 from UniqueNetwork/doc/nonfungible-pallet
in: master
6 files changed
pallets/nonfungible/src/common.rsdiffbeforeafterboth133 }133 }134}134}135135136/// Implementation of `CommonCollectionOperations` for `NonfungibleHandle`. It wraps Nonfungible Pallete137/// methods and adds weight info.136impl<T: Config> CommonCollectionOperations<T> for NonfungibleHandle<T> {138impl<T: Config> CommonCollectionOperations<T> for NonfungibleHandle<T> {137 fn create_item(139 fn create_item(138 &self,140 &self,pallets/nonfungible/src/erc.rsdiffbeforeafterboth14// You should have received a copy of the GNU General Public License14// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet EVM API18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Nonfungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Nonfungible Pallet methods.162117extern crate alloc;22extern crate alloc;18use core::{23use core::{40 SelfWeightOf, weights::WeightInfo, TokenProperties,45 SelfWeightOf, weights::WeightInfo, TokenProperties,41};46};424748/// @title A contract that allows to set and delete token properties and change token property permissions.43#[solidity_interface(name = "TokenProperties")]49#[solidity_interface(name = "TokenProperties")]44impl<T: Config> NonfungibleHandle<T> {50impl<T: Config> NonfungibleHandle<T> {51 /// @notice Set permissions for token property.52 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.53 /// @param key Property key.54 /// @param is_mutable Permission to mutate property.55 /// @param collection_admin Permission to mutate property by collection admin if property is mutable.56 /// @param token_owner Permission to mutate property by token owner if property is mutable.45 fn set_token_property_permission(57 fn set_token_property_permission(46 &mut self,58 &mut self,47 caller: caller,59 caller: caller,68 .map_err(dispatch_to_evm::<T>)80 .map_err(dispatch_to_evm::<T>)69 }81 }708283 /// @notice Set token property value.84 /// @dev Throws error if `msg.sender` has no permission to edit the property.85 /// @param tokenId ID of the token.86 /// @param key Property key.87 /// @param value Property value.71 fn set_property(88 fn set_property(72 &mut self,89 &mut self,73 caller: caller,90 caller: caller,96 .map_err(dispatch_to_evm::<T>)113 .map_err(dispatch_to_evm::<T>)97 }114 }98115116 /// @notice Delete token property value.117 /// @dev Throws error if `msg.sender` has no permission to edit the property.118 /// @param tokenId ID of the token.119 /// @param key Property key.99 fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {120 fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {100 let caller = T::CrossAccountId::from_eth(caller);121 let caller = T::CrossAccountId::from_eth(caller);101 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;122 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;111 .map_err(dispatch_to_evm::<T>)132 .map_err(dispatch_to_evm::<T>)112 }133 }113134135 /// @notice Get token property value.114 /// Throws error if key not found136 /// @dev Throws error if key not found137 /// @param tokenId ID of the token.138 /// @param key Property key.139 /// @return Property value bytes115 fn property(&self, token_id: uint256, key: string) -> Result<bytes> {140 fn property(&self, token_id: uint256, key: string) -> Result<bytes> {116 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;141 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;117 let key = <Vec<u8>>::from(key)142 let key = <Vec<u8>>::from(key)127152128#[derive(ToLog)]153#[derive(ToLog)]129pub enum ERC721Events {154pub enum ERC721Events {155 /// @dev This emits when ownership of any NFT changes by any mechanism.156 /// This event emits when NFTs are created (`from` == 0) and destroyed157 /// (`to` == 0). Exception: during contract creation, any number of NFTs158 /// may be created and assigned without emitting Transfer. At the time of159 /// any transfer, the approved address for that NFT (if any) is reset to none.130 Transfer {160 Transfer {131 #[indexed]161 #[indexed]132 from: address,162 from: address,135 #[indexed]165 #[indexed]136 token_id: uint256,166 token_id: uint256,137 },167 },168 /// @dev This emits when the approved address for an NFT is changed or169 /// reaffirmed. The zero address indicates there is no approved address.170 /// When a Transfer event emits, this also indicates that the approved171 /// address for that NFT (if any) is reset to none.138 Approval {172 Approval {139 #[indexed]173 #[indexed]140 owner: address,174 owner: address,143 #[indexed]177 #[indexed]144 token_id: uint256,178 token_id: uint256,145 },179 },180 /// @dev This emits when an operator is enabled or disabled for an owner.181 /// The operator can manage all NFTs of the owner.146 #[allow(dead_code)]182 #[allow(dead_code)]147 ApprovalForAll {183 ApprovalForAll {148 #[indexed]184 #[indexed]159 MintingFinished {},195 MintingFinished {},160}196}161197198/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension199/// @dev See https://eips.ethereum.org/EIPS/eip-721162#[solidity_interface(name = "ERC721Metadata")]200#[solidity_interface(name = "ERC721Metadata")]163impl<T: Config> NonfungibleHandle<T> {201impl<T: Config> NonfungibleHandle<T> {202 /// @notice A descriptive name for a collection of NFTs in this contract164 fn name(&self) -> Result<string> {203 fn name(&self) -> Result<string> {165 Ok(decode_utf16(self.name.iter().copied())204 Ok(decode_utf16(self.name.iter().copied())166 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))205 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))167 .collect::<string>())206 .collect::<string>())168 }207 }169208209 /// @notice An abbreviated name for NFTs in this contract170 fn symbol(&self) -> Result<string> {210 fn symbol(&self) -> Result<string> {171 Ok(string::from_utf8_lossy(&self.token_prefix).into())211 Ok(string::from_utf8_lossy(&self.token_prefix).into())172 }212 }173213214 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.215 /// @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC216 /// 3986. The URI may point to a JSON file that conforms to the "ERC721217 /// Metadata JSON Schema".174 /// Returns token's const_metadata218 /// @return token's const_metadata175 #[solidity(rename_selector = "tokenURI")]219 #[solidity(rename_selector = "tokenURI")]176 fn token_uri(&self, token_id: uint256) -> Result<string> {220 fn token_uri(&self, token_id: uint256) -> Result<string> {177 let key = token_uri_key();221 let key = token_uri_key();192 }236 }193}237}194238239/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension240/// @dev See https://eips.ethereum.org/EIPS/eip-721195#[solidity_interface(name = "ERC721Enumerable")]241#[solidity_interface(name = "ERC721Enumerable")]196impl<T: Config> NonfungibleHandle<T> {242impl<T: Config> NonfungibleHandle<T> {243 /// @notice Enumerate valid NFTs244 /// @param index A counter less than `totalSupply()`245 /// @return The token identifier for the `index`th NFT,246 /// (sort order not specified)197 fn token_by_index(&self, index: uint256) -> Result<uint256> {247 fn token_by_index(&self, index: uint256) -> Result<uint256> {198 Ok(index)248 Ok(index)199 }249 }200250201 /// Not implemented251 /// @dev Not implemented202 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {252 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {203 // TODO: Not implemetable253 // TODO: Not implemetable204 Err("not implemented".into())254 Err("not implemented".into())205 }255 }206256257 /// @notice Count NFTs tracked by this contract258 /// @return A count of valid NFTs tracked by this contract, where each one of259 /// them has an assigned and queryable owner not equal to the zero address207 fn total_supply(&self) -> Result<uint256> {260 fn total_supply(&self) -> Result<uint256> {208 self.consume_store_reads(1)?;261 self.consume_store_reads(1)?;209 Ok(<Pallet<T>>::total_supply(self).into())262 Ok(<Pallet<T>>::total_supply(self).into())210 }263 }211}264}212265266/// @title ERC-721 Non-Fungible Token Standard267/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md213#[solidity_interface(name = "ERC721", events(ERC721Events))]268#[solidity_interface(name = "ERC721", events(ERC721Events))]214impl<T: Config> NonfungibleHandle<T> {269impl<T: Config> NonfungibleHandle<T> {270 /// @notice Count all NFTs assigned to an owner271 /// @dev NFTs assigned to the zero address are considered invalid, and this272 /// function throws for queries about the zero address.273 /// @param owner An address for whom to query the balance274 /// @return The number of NFTs owned by `owner`, possibly zero215 fn balance_of(&self, owner: address) -> Result<uint256> {275 fn balance_of(&self, owner: address) -> Result<uint256> {216 self.consume_store_reads(1)?;276 self.consume_store_reads(1)?;217 let owner = T::CrossAccountId::from_eth(owner);277 let owner = T::CrossAccountId::from_eth(owner);218 let balance = <AccountBalance<T>>::get((self.id, owner));278 let balance = <AccountBalance<T>>::get((self.id, owner));219 Ok(balance.into())279 Ok(balance.into())220 }280 }281 /// @notice Find the owner of an NFT282 /// @dev NFTs assigned to zero address are considered invalid, and queries283 /// about them do throw.284 /// @param tokenId The identifier for an NFT285 /// @return The address of the owner of the NFT221 fn owner_of(&self, token_id: uint256) -> Result<address> {286 fn owner_of(&self, token_id: uint256) -> Result<address> {222 self.consume_store_reads(1)?;287 self.consume_store_reads(1)?;223 let token: TokenId = token_id.try_into()?;288 let token: TokenId = token_id.try_into()?;226 .owner291 .owner227 .as_eth())292 .as_eth())228 }293 }229 /// Not implemented294 /// @dev Not implemented230 fn safe_transfer_from_with_data(295 fn safe_transfer_from_with_data(231 &mut self,296 &mut self,232 _from: address,297 _from: address,238 // TODO: Not implemetable303 // TODO: Not implemetable239 Err("not implemented".into())304 Err("not implemented".into())240 }305 }241 /// Not implemented306 /// @dev Not implemented242 fn safe_transfer_from(307 fn safe_transfer_from(243 &mut self,308 &mut self,244 _from: address,309 _from: address,250 Err("not implemented".into())315 Err("not implemented".into())251 }316 }252317318 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE319 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE320 /// THEY MAY BE PERMANENTLY LOST321 /// @dev Throws unless `msg.sender` is the current owner or an authorized322 /// operator for this NFT. Throws if `from` is not the current owner. Throws323 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.324 /// @param from The current owner of the NFT325 /// @param to The new owner326 /// @param tokenId The NFT to transfer327 /// @param _value Not used for an NFT253 #[weight(<SelfWeightOf<T>>::transfer_from())]328 #[weight(<SelfWeightOf<T>>::transfer_from())]254 fn transfer_from(329 fn transfer_from(255 &mut self,330 &mut self,272 Ok(())347 Ok(())273 }348 }274349350 /// @notice Set or reaffirm the approved address for an NFT351 /// @dev The zero address indicates there is no approved address.352 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized353 /// operator of the current owner.354 /// @param approved The new approved NFT controller355 /// @param tokenId The NFT to approve275 #[weight(<SelfWeightOf<T>>::approve())]356 #[weight(<SelfWeightOf<T>>::approve())]276 fn approve(357 fn approve(277 &mut self,358 &mut self,289 Ok(())370 Ok(())290 }371 }291372292 /// Not implemented373 /// @dev Not implemented293 fn set_approval_for_all(374 fn set_approval_for_all(294 &mut self,375 &mut self,295 _caller: caller,376 _caller: caller,300 Err("not implemented".into())381 Err("not implemented".into())301 }382 }302383303 /// Not implemented384 /// @dev Not implemented304 fn get_approved(&self, _token_id: uint256) -> Result<address> {385 fn get_approved(&self, _token_id: uint256) -> Result<address> {305 // TODO: Not implemetable386 // TODO: Not implemetable306 Err("not implemented".into())387 Err("not implemented".into())307 }388 }308389309 /// Not implemented390 /// @dev Not implemented310 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {391 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {311 // TODO: Not implemetable392 // TODO: Not implemetable312 Err("not implemented".into())393 Err("not implemented".into())313 }394 }314}395}315396397/// @title ERC721 Token that can be irreversibly burned (destroyed).316#[solidity_interface(name = "ERC721Burnable")]398#[solidity_interface(name = "ERC721Burnable")]317impl<T: Config> NonfungibleHandle<T> {399impl<T: Config> NonfungibleHandle<T> {400 /// @notice Burns a specific ERC721 token.401 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized402 /// operator of the current owner.403 /// @param tokenId The NFT to approve318 #[weight(<SelfWeightOf<T>>::burn_item())]404 #[weight(<SelfWeightOf<T>>::burn_item())]319 fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {405 fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {320 let caller = T::CrossAccountId::from_eth(caller);406 let caller = T::CrossAccountId::from_eth(caller);325 }411 }326}412}327413414/// @title ERC721 minting logic.328#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]415#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]329impl<T: Config> NonfungibleHandle<T> {416impl<T: Config> NonfungibleHandle<T> {330 fn minting_finished(&self) -> Result<bool> {417 fn minting_finished(&self) -> Result<bool> {331 Ok(false)418 Ok(false)332 }419 }333420421 /// @notice Function to mint token.334 /// `token_id` should be obtained with `next_token_id` method,422 /// @dev `tokenId` should be obtained with `nextTokenId` method,335 /// unlike standard, you can't specify it manually423 /// unlike standard, you can't specify it manually424 /// @param to The new owner425 /// @param tokenId ID of the minted NFT336 #[weight(<SelfWeightOf<T>>::create_item())]426 #[weight(<SelfWeightOf<T>>::create_item())]337 fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {427 fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {338 let caller = T::CrossAccountId::from_eth(caller);428 let caller = T::CrossAccountId::from_eth(caller);364 Ok(true)454 Ok(true)365 }455 }366456457 /// @notice Function to mint token with the given tokenUri.367 /// `token_id` should be obtained with `next_token_id` method,458 /// @dev `tokenId` should be obtained with `nextTokenId` method,368 /// unlike standard, you can't specify it manually459 /// unlike standard, you can't specify it manually460 /// @param to The new owner461 /// @param tokenId ID of the minted NFT462 /// @param tokenUri Token URI that would be stored in the NFT properties369 #[solidity(rename_selector = "mintWithTokenURI")]463 #[solidity(rename_selector = "mintWithTokenURI")]370 #[weight(<SelfWeightOf<T>>::create_item())]464 #[weight(<SelfWeightOf<T>>::create_item())]371 fn mint_with_token_uri(465 fn mint_with_token_uri(420 Ok(true)514 Ok(true)421 }515 }422516423 /// Not implemented517 /// @dev Not implemented424 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {518 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {425 Err("not implementable".into())519 Err("not implementable".into())426 }520 }449 false543 false450}544}451545546/// @title Unique extensions for ERC721.452#[solidity_interface(name = "ERC721UniqueExtensions")]547#[solidity_interface(name = "ERC721UniqueExtensions")]453impl<T: Config> NonfungibleHandle<T> {548impl<T: Config> NonfungibleHandle<T> {549 /// @notice Transfer ownership of an NFT550 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`551 /// is the zero address. Throws if `tokenId` is not a valid NFT.552 /// @param to The new owner553 /// @param tokenId The NFT to transfer554 /// @param _value Not used for an NFT454 #[weight(<SelfWeightOf<T>>::transfer())]555 #[weight(<SelfWeightOf<T>>::transfer())]455 fn transfer(556 fn transfer(456 &mut self,557 &mut self,470 Ok(())571 Ok(())471 }572 }472573574 /// @notice Burns a specific ERC721 token.575 /// @dev Throws unless `msg.sender` is the current owner or an authorized576 /// operator for this NFT. Throws if `from` is not the current owner. Throws577 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.578 /// @param from The current owner of the NFT579 /// @param tokenId The NFT to transfer580 /// @param _value Not used for an NFT473 #[weight(<SelfWeightOf<T>>::burn_from())]581 #[weight(<SelfWeightOf<T>>::burn_from())]474 fn burn_from(582 fn burn_from(475 &mut self,583 &mut self,490 Ok(())598 Ok(())491 }599 }492600601 /// @notice Returns next free NFT ID.493 fn next_token_id(&self) -> Result<uint256> {602 fn next_token_id(&self) -> Result<uint256> {494 self.consume_store_reads(1)?;603 self.consume_store_reads(1)?;495 Ok(<TokensMinted<T>>::get(self.id)604 Ok(<TokensMinted<T>>::get(self.id)498 .into())607 .into())499 }608 }500609610 /// @notice Function to mint multiple tokens.611 /// @dev `tokenIds` should be an array of consecutive numbers and first number612 /// should be obtained with `nextTokenId` method613 /// @param to The new owner614 /// @param tokenIds IDs of the minted NFTs501 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]615 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]502 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {616 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {503 let caller = T::CrossAccountId::from_eth(caller);617 let caller = T::CrossAccountId::from_eth(caller);529 Ok(true)643 Ok(true)530 }644 }531645646 /// @notice Function to mint multiple tokens with the given tokenUris.647 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive648 /// numbers and first number should be obtained with `nextTokenId` method649 /// @param to The new owner650 /// @param tokens array of pairs of token ID and token URI for minted tokens532 #[solidity(rename_selector = "mintBulkWithTokenURI")]651 #[solidity(rename_selector = "mintBulkWithTokenURI")]533 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]652 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]534 fn mint_bulk_with_token_uri(653 fn mint_bulk_with_token_uri(pallets/nonfungible/src/lib.rsdiffbeforeafterboth14// You should have received a copy of the GNU General Public License14// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.15// 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`.169017#![cfg_attr(not(feature = "std"), no_std)]91#![cfg_attr(not(feature = "std"), no_std)]1892102 #[pallet::generate_store(pub(super) trait Store)]176 #[pallet::generate_store(pub(super) trait Store)]103 pub struct Pallet<T>(_);177 pub struct Pallet<T>(_);104178179 /// Amount of tokens minted for collection.105 #[pallet::storage]180 #[pallet::storage]106 pub type TokensMinted<T: Config> =181 pub type TokensMinted<T: Config> =107 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;182 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;183184 /// Amount of burnt tokens for collection.108 #[pallet::storage]185 #[pallet::storage]109 pub type TokensBurnt<T: Config> =186 pub type TokensBurnt<T: Config> =110 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;187 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;111188189 /// Custom data serialized to bytes for token.112 #[pallet::storage]190 #[pallet::storage]113 pub type TokenData<T: Config> = StorageNMap<191 pub type TokenData<T: Config> = StorageNMap<114 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),192 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),115 Value = ItemData<T::CrossAccountId>,193 Value = ItemData<T::CrossAccountId>,116 QueryKind = OptionQuery,194 QueryKind = OptionQuery,117 >;195 >;118196197 /// Key-Value map stored for token.119 #[pallet::storage]198 #[pallet::storage]120 #[pallet::getter(fn token_properties)]199 #[pallet::getter(fn token_properties)]121 pub type TokenProperties<T: Config> = StorageNMap<200 pub type TokenProperties<T: Config> = StorageNMap<125 OnEmpty = up_data_structs::TokenProperties,204 OnEmpty = up_data_structs::TokenProperties,126 >;205 >;127206207 /// Custom data that is serialized to bytes and attached to a token property.208 /// Currently used to store RMRK data.128 #[pallet::storage]209 #[pallet::storage]129 #[pallet::getter(fn token_aux_property)]210 #[pallet::getter(fn token_aux_property)]130 pub type TokenAuxProperties<T: Config> = StorageNMap<211 pub type TokenAuxProperties<T: Config> = StorageNMap<138 QueryKind = OptionQuery,219 QueryKind = OptionQuery,139 >;220 >;140221141 /// Used to enumerate tokens owned by account222 /// Used to enumerate tokens owned by account.142 #[pallet::storage]223 #[pallet::storage]143 pub type Owned<T: Config> = StorageNMap<224 pub type Owned<T: Config> = StorageNMap<144 Key = (225 Key = (150 QueryKind = ValueQuery,231 QueryKind = ValueQuery,151 >;232 >;152233153 /// Used to enumerate token's children234 /// Used to enumerate token's children.154 #[pallet::storage]235 #[pallet::storage]155 #[pallet::getter(fn token_children)]236 #[pallet::getter(fn token_children)]156 pub type TokenChildren<T: Config> = StorageNMap<237 pub type TokenChildren<T: Config> = StorageNMap<163 QueryKind = ValueQuery,244 QueryKind = ValueQuery,164 >;245 >;165246247 /// Amount of tokens owned by account.166 #[pallet::storage]248 #[pallet::storage]167 pub type AccountBalance<T: Config> = StorageNMap<249 pub type AccountBalance<T: Config> = StorageNMap<168 Key = (250 Key = (173 QueryKind = ValueQuery,255 QueryKind = ValueQuery,174 >;256 >;175257258 /// Allowance set by an owner for a spender for a token.176 #[pallet::storage]259 #[pallet::storage]177 pub type Allowance<T: Config> = StorageNMap<260 pub type Allowance<T: Config> = StorageNMap<178 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),261 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),273}356}274357275impl<T: Config> Pallet<T> {358impl<T: Config> Pallet<T> {359 /// Get number of NFT tokens in collection.276 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {360 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {277 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)361 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)278 }362 }363364 /// Check that NFT token exists.365 ///366 /// - `token`: Token ID.279 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {367 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {280 <TokenData<T>>::contains_key((collection.id, token))368 <TokenData<T>>::contains_key((collection.id, token))281 }369 }282370371 /// Set the token property with the scope.372 ///373 /// - `property`: Contains key-value pair.283 pub fn set_scoped_token_property(374 pub fn set_scoped_token_property(284 collection_id: CollectionId,375 collection_id: CollectionId,285 token_id: TokenId,376 token_id: TokenId,294 Ok(())385 Ok(())295 }386 }296387388 /// Batch operation to set multiple properties with the same scope.297 pub fn set_scoped_token_properties(389 pub fn set_scoped_token_properties(298 collection_id: CollectionId,390 collection_id: CollectionId,299 token_id: TokenId,391 token_id: TokenId,308 Ok(())400 Ok(())309 }401 }310402403 /// Add or edit auxiliary data for the property.404 ///405 /// - `f`: function that adds or edits auxiliary data.311 pub fn try_mutate_token_aux_property<R, E>(406 pub fn try_mutate_token_aux_property<R, E>(312 collection_id: CollectionId,407 collection_id: CollectionId,313 token_id: TokenId,408 token_id: TokenId,318 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)413 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)319 }414 }320415416 /// Remove auxiliary data for the property.321 pub fn remove_token_aux_property(417 pub fn remove_token_aux_property(322 collection_id: CollectionId,418 collection_id: CollectionId,323 token_id: TokenId,419 token_id: TokenId,327 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));423 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));328 }424 }329425426 /// Get all auxiliary data in a given scope.427 ///428 /// Returns iterator over Property Key - Data pairs.330 pub fn iterate_token_aux_properties(429 pub fn iterate_token_aux_properties(331 collection_id: CollectionId,430 collection_id: CollectionId,332 token_id: TokenId,431 token_id: TokenId,335 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))434 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))336 }435 }337436437 /// Get ID of the last minted token338 pub fn current_token_id(collection_id: CollectionId) -> TokenId {438 pub fn current_token_id(collection_id: CollectionId) -> TokenId {339 TokenId(<TokensMinted<T>>::get(collection_id))439 TokenId(<TokensMinted<T>>::get(collection_id))340 }440 }341}441}342442343// unchecked calls skips any permission checks443// unchecked calls skips any permission checks344impl<T: Config> Pallet<T> {444impl<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.345 pub fn init_collection(450 pub fn init_collection(346 owner: T::CrossAccountId,451 owner: T::CrossAccountId,347 data: CreateCollectionData<T::AccountId>,452 data: CreateCollectionData<T::AccountId>,350 <PalletCommon<T>>::init_collection(owner, data, is_external)455 <PalletCommon<T>>::init_collection(owner, data, is_external)351 }456 }457458 /// Destroy NFT collection459 ///460 /// `destroy_collection` will throw error if collection contains any tokens.461 /// Only owner can destroy collection.352 pub fn destroy_collection(462 pub fn destroy_collection(353 collection: NonfungibleHandle<T>,463 collection: NonfungibleHandle<T>,354 sender: &T::CrossAccountId,464 sender: &T::CrossAccountId,373 Ok(())483 Ok(())374 }484 }375485486 /// 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 token376 pub fn burn(495 pub fn burn(377 collection: &NonfungibleHandle<T>,496 collection: &NonfungibleHandle<T>,378 sender: &T::CrossAccountId,497 sender: &T::CrossAccountId,442 Ok(())561 Ok(())443 }562 }444563564 /// 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.burn445 #[transactional]570 #[transactional]446 pub fn burn_recursively(571 pub fn burn_recursively(447 collection: &NonfungibleHandle<T>,572 collection: &NonfungibleHandle<T>,481 })606 })482 }607 }483608609 /// 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.484 #[transactional]617 #[transactional]485 fn modify_token_properties(618 fn modify_token_properties(486 collection: &NonfungibleHandle<T>,619 collection: &NonfungibleHandle<T>,574 Ok(())707 Ok(())575 }708 }576709710 /// 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_properties577 pub fn set_token_properties(715 pub fn set_token_properties(578 collection: &NonfungibleHandle<T>,716 collection: &NonfungibleHandle<T>,579 sender: &T::CrossAccountId,717 sender: &T::CrossAccountId,592 )730 )593 }731 }594732733 /// Add or edit single property for the token734 ///735 /// Calls [`set_token_properties`] internally736 ///737 /// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties595 pub fn set_token_property(738 pub fn set_token_property(596 collection: &NonfungibleHandle<T>,739 collection: &NonfungibleHandle<T>,597 sender: &T::CrossAccountId,740 sender: &T::CrossAccountId,611 )754 )612 }755 }613756757 /// 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_properties614 pub fn delete_token_properties(762 pub fn delete_token_properties(615 collection: &NonfungibleHandle<T>,763 collection: &NonfungibleHandle<T>,616 sender: &T::CrossAccountId,764 sender: &T::CrossAccountId,630 )778 )631 }779 }632780781 /// Remove single property from the token782 ///783 /// Calls [`delete_token_properties`] internally784 ///785 /// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties633 pub fn delete_token_property(786 pub fn delete_token_property(634 collection: &NonfungibleHandle<T>,787 collection: &NonfungibleHandle<T>,635 sender: &T::CrossAccountId,788 sender: &T::CrossAccountId,646 )799 )647 }800 }648801802 /// Add or edit properties for the collection649 pub fn set_collection_properties(803 pub fn set_collection_properties(650 collection: &NonfungibleHandle<T>,804 collection: &NonfungibleHandle<T>,651 sender: &T::CrossAccountId,805 sender: &T::CrossAccountId,654 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)808 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)655 }809 }656810811 /// Remove properties from the collection657 pub fn delete_collection_properties(812 pub fn delete_collection_properties(658 collection: &CollectionHandle<T>,813 collection: &CollectionHandle<T>,659 sender: &T::CrossAccountId,814 sender: &T::CrossAccountId,662 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)817 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)663 }818 }664819820 /// Set property permissions for the token.821 ///822 /// Sender should be the owner or admin of token's collection.665 pub fn set_token_property_permissions(823 pub fn set_token_property_permissions(666 collection: &CollectionHandle<T>,824 collection: &CollectionHandle<T>,667 sender: &T::CrossAccountId,825 sender: &T::CrossAccountId,670 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)828 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)671 }829 }672830831 /// Set property permissions for the collection.832 ///833 /// Sender should be the owner or admin of the collection.673 pub fn set_property_permission(834 pub fn set_property_permission(674 collection: &CollectionHandle<T>,835 collection: &CollectionHandle<T>,675 sender: &T::CrossAccountId,836 sender: &T::CrossAccountId,678 <PalletCommon<T>>::set_property_permission(collection, sender, permission)839 <PalletCommon<T>>::set_property_permission(collection, sender, permission)679 }840 }680841842 /// 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 depth681 pub fn transfer(851 pub fn transfer(682 collection: &NonfungibleHandle<T>,852 collection: &NonfungibleHandle<T>,683 from: &T::CrossAccountId,853 from: &T::CrossAccountId,769 Ok(())939 Ok(())770 }940 }771941942 /// 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 depth772 pub fn create_multiple_items(952 pub fn create_multiple_items(773 collection: &NonfungibleHandle<T>,953 collection: &NonfungibleHandle<T>,774 sender: &T::CrossAccountId,954 sender: &T::CrossAccountId,953 }1133 }954 }1134 }95511351136 /// Set allowance for the spender to `transfer` or `burn` sender's token.1137 ///1138 /// - `token`: Token the spender is allowed to `transfer` or `burn`.956 pub fn set_allowance(1139 pub fn set_allowance(957 collection: &NonfungibleHandle<T>,1140 collection: &NonfungibleHandle<T>,958 sender: &T::CrossAccountId,1141 sender: &T::CrossAccountId,985 Ok(())1168 Ok(())986 }1169 }98711701171 /// Checks allowance for the spender to use the token.988 fn check_allowed(1172 fn check_allowed(989 collection: &NonfungibleHandle<T>,1173 collection: &NonfungibleHandle<T>,990 spender: &T::CrossAccountId,1174 spender: &T::CrossAccountId,1027 Ok(())1211 Ok(())1028 }1212 }102912131214 /// 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.transfer1030 pub fn transfer_from(1220 pub fn transfer_from(1031 collection: &NonfungibleHandle<T>,1221 collection: &NonfungibleHandle<T>,1032 spender: &T::CrossAccountId,1222 spender: &T::CrossAccountId,1043 Self::transfer(collection, from, to, token, nesting_budget)1233 Self::transfer(collection, from, to, token, nesting_budget)1044 }1234 }104512351236 /// 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.burn1046 pub fn burn_from(1242 pub fn burn_from(1047 collection: &NonfungibleHandle<T>,1243 collection: &NonfungibleHandle<T>,1048 spender: &T::CrossAccountId,1244 spender: &T::CrossAccountId,1057 Self::burn(collection, from, token)1253 Self::burn(collection, from, token)1058 }1254 }105912551256 /// Check that `from` token could be nested in `under` token.1257 ///1060 pub fn check_nesting(1258 pub fn check_nesting(1061 handle: &NonfungibleHandle<T>,1259 handle: &NonfungibleHandle<T>,1062 sender: T::CrossAccountId,1260 sender: T::CrossAccountId,1126 .collect()1324 .collect()1127 }1325 }112813261327 /// Mint single NFT token.1328 ///1129 /// Delegated to `create_multiple_items`1329 /// Delegated to [`create_multiple_items`]1330 ///1331 /// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1130 pub fn create_item(1332 pub fn create_item(1131 collection: &NonfungibleHandle<T>,1333 collection: &NonfungibleHandle<T>,1132 sender: &T::CrossAccountId,1334 sender: &T::CrossAccountId,pallets/nonfungible/src/stubs/UniqueNFT.rawdiffbeforeafterbothbinary blob — no preview
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth535354// Selector: 4136937754// Selector: 4136937755contract TokenProperties is Dummy, ERC165 {55contract TokenProperties is Dummy, ERC165 {56 // @notice Set permissions for token property.57 // @dev Throws error if `msg.sender` is not admin or owner of the collection.58 // @param key Property key.59 // @param is_mutable Permission to mutate property.60 // @param collection_admin Permission to mutate property by collection admin if property is mutable.61 // @param token_owner Permission to mutate property by token owner if property is mutable.62 //56 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa63 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa57 function setTokenPropertyPermission(64 function setTokenPropertyPermission(58 string memory key,65 string memory key,68 dummy = 0;75 dummy = 0;69 }76 }707778 // @notice Set token property value.79 // @dev Throws error if `msg.sender` has no permission to edit the property.80 // @param token_id ID of the token.81 // @param key Property key.82 // @param value Property value.83 //71 // Selector: setProperty(uint256,string,bytes) 1752d67b84 // Selector: setProperty(uint256,string,bytes) 1752d67b72 function setProperty(85 function setProperty(73 uint256 tokenId,86 uint256 tokenId,81 dummy = 0;94 dummy = 0;82 }95 }839697 // @notice Delete token property value.98 // @dev Throws error if `msg.sender` has no permission to edit the property.99 // @param token_id ID of the token.100 // @param key Property key.101 //84 // Selector: deleteProperty(uint256,string) 066111d1102 // Selector: deleteProperty(uint256,string) 066111d185 function deleteProperty(uint256 tokenId, string memory key) public {103 function deleteProperty(uint256 tokenId, string memory key) public {86 require(false, stub_error);104 require(false, stub_error);89 dummy = 0;107 dummy = 0;90 }108 }91109110 // @notice Get token property value.92 // Throws error if key not found111 // @dev Throws error if key not found112 // @param token_id ID of the token.113 // @param key Property key.93 //114 //94 // Selector: property(uint256,string) 7228c327115 // Selector: property(uint256,string) 7228c32795 function property(uint256 tokenId, string memory key)116 function property(uint256 tokenId, string memory key)107128108// Selector: 42966c68129// Selector: 42966c68109contract ERC721Burnable is Dummy, ERC165 {130contract ERC721Burnable is Dummy, ERC165 {131 // @notice Burns a specific ERC721 token.132 // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized133 // operator of the current owner.134 // @param tokenId The NFT to approve135 //110 // Selector: burn(uint256) 42966c68136 // Selector: burn(uint256) 42966c68111 function burn(uint256 tokenId) public {137 function burn(uint256 tokenId) public {112 require(false, stub_error);138 require(false, stub_error);117143118// Selector: 58800161144// Selector: 58800161119contract ERC721 is Dummy, ERC165, ERC721Events {145contract ERC721 is Dummy, ERC165, ERC721Events {146 // @notice Count all NFTs assigned to an owner147 // @dev NFTs assigned to the zero address are considered invalid, and this148 // function throws for queries about the zero address.149 // @param _owner An address for whom to query the balance150 // @return The number of NFTs owned by `_owner`, possibly zero151 //120 // Selector: balanceOf(address) 70a08231152 // Selector: balanceOf(address) 70a08231121 function balanceOf(address owner) public view returns (uint256) {153 function balanceOf(address owner) public view returns (uint256) {122 require(false, stub_error);154 require(false, stub_error);125 return 0;157 return 0;126 }158 }127159160 // @notice Find the owner of an NFT161 // @dev NFTs assigned to zero address are considered invalid, and queries162 // about them do throw.163 // @param _tokenId The identifier for an NFT164 // @return The address of the owner of the NFT165 //128 // Selector: ownerOf(uint256) 6352211e166 // Selector: ownerOf(uint256) 6352211e129 function ownerOf(uint256 tokenId) public view returns (address) {167 function ownerOf(uint256 tokenId) public view returns (address) {130 require(false, stub_error);168 require(false, stub_error);133 return 0x0000000000000000000000000000000000000000;171 return 0x0000000000000000000000000000000000000000;134 }172 }135173136 // Not implemented174 // @dev Not implemented137 //175 //138 // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672176 // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672139 function safeTransferFromWithData(177 function safeTransferFromWithData(150 dummy = 0;188 dummy = 0;151 }189 }152190153 // Not implemented191 // @dev Not implemented154 //192 //155 // Selector: safeTransferFrom(address,address,uint256) 42842e0e193 // Selector: safeTransferFrom(address,address,uint256) 42842e0e156 function safeTransferFrom(194 function safeTransferFrom(165 dummy = 0;203 dummy = 0;166 }204 }167205206 // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE207 // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE208 // THEY MAY BE PERMANENTLY LOST209 // @dev Throws unless `msg.sender` is the current owner or an authorized210 // operator for this NFT. Throws if `from` is not the current owner. Throws211 // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.212 // @param from The current owner of the NFT213 // @param to The new owner214 // @param tokenId The NFT to transfer215 // @param _value Not used for an NFT216 //168 // Selector: transferFrom(address,address,uint256) 23b872dd217 // Selector: transferFrom(address,address,uint256) 23b872dd169 function transferFrom(218 function transferFrom(170 address from,219 address from,178 dummy = 0;227 dummy = 0;179 }228 }180229230 // @notice Set or reaffirm the approved address for an NFT231 // @dev The zero address indicates there is no approved address.232 // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized233 // operator of the current owner.234 // @param approved The new approved NFT controller235 // @param tokenId The NFT to approve236 //181 // Selector: approve(address,uint256) 095ea7b3237 // Selector: approve(address,uint256) 095ea7b3182 function approve(address approved, uint256 tokenId) public {238 function approve(address approved, uint256 tokenId) public {183 require(false, stub_error);239 require(false, stub_error);186 dummy = 0;242 dummy = 0;187 }243 }188244189 // Not implemented245 // @dev Not implemented190 //246 //191 // Selector: setApprovalForAll(address,bool) a22cb465247 // Selector: setApprovalForAll(address,bool) a22cb465192 function setApprovalForAll(address operator, bool approved) public {248 function setApprovalForAll(address operator, bool approved) public {196 dummy = 0;252 dummy = 0;197 }253 }198254199 // Not implemented255 // @dev Not implemented200 //256 //201 // Selector: getApproved(uint256) 081812fc257 // Selector: getApproved(uint256) 081812fc202 function getApproved(uint256 tokenId) public view returns (address) {258 function getApproved(uint256 tokenId) public view returns (address) {206 return 0x0000000000000000000000000000000000000000;262 return 0x0000000000000000000000000000000000000000;207 }263 }208264209 // Not implemented265 // @dev Not implemented210 //266 //211 // Selector: isApprovedForAll(address,address) e985e9c5267 // Selector: isApprovedForAll(address,address) e985e9c5212 function isApprovedForAll(address owner, address operator)268 function isApprovedForAll(address owner, address operator)224280225// Selector: 5b5e139f281// Selector: 5b5e139f226contract ERC721Metadata is Dummy, ERC165 {282contract ERC721Metadata is Dummy, ERC165 {283 // @notice A descriptive name for a collection of NFTs in this contract284 //227 // Selector: name() 06fdde03285 // Selector: name() 06fdde03228 function name() public view returns (string memory) {286 function name() public view returns (string memory) {229 require(false, stub_error);287 require(false, stub_error);230 dummy;288 dummy;231 return "";289 return "";232 }290 }233291292 // @notice An abbreviated name for NFTs in this contract293 //234 // Selector: symbol() 95d89b41294 // Selector: symbol() 95d89b41235 function symbol() public view returns (string memory) {295 function symbol() public view returns (string memory) {236 require(false, stub_error);296 require(false, stub_error);237 dummy;297 dummy;238 return "";298 return "";239 }299 }240300301 // @notice A distinct Uniform Resource Identifier (URI) for a given asset.302 // @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC303 // 3986. The URI may point to a JSON file that conforms to the "ERC721304 // Metadata JSON Schema".241 // Returns token's const_metadata305 // @return token's const_metadata242 //306 //243 // Selector: tokenURI(uint256) c87b56dd307 // Selector: tokenURI(uint256) c87b56dd244 function tokenURI(uint256 tokenId) public view returns (string memory) {308 function tokenURI(uint256 tokenId) public view returns (string memory) {258 return false;322 return false;259 }323 }260324325 // @notice Function to mint token.261 // `token_id` should be obtained with `next_token_id` method,326 // @dev `tokenId` should be obtained with `nextTokenId` method,262 // unlike standard, you can't specify it manually327 // unlike standard, you can't specify it manually328 // @param to The new owner329 // @param tokenId ID of the minted NFT263 //330 //264 // Selector: mint(address,uint256) 40c10f19331 // Selector: mint(address,uint256) 40c10f19265 function mint(address to, uint256 tokenId) public returns (bool) {332 function mint(address to, uint256 tokenId) public returns (bool) {270 return false;337 return false;271 }338 }272339340 // @notice Function to mint token with the given tokenUri.273 // `token_id` should be obtained with `next_token_id` method,341 // @dev `tokenId` should be obtained with `nextTokenId` method,274 // unlike standard, you can't specify it manually342 // unlike standard, you can't specify it manually343 // @param to The new owner344 // @param tokenId ID of the minted NFT345 // @param tokenUri Token URI that would be stored in the NFT properties275 //346 //276 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f347 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f277 function mintWithTokenURI(348 function mintWithTokenURI(287 return false;358 return false;288 }359 }289360290 // Not implemented361 // @dev Not implemented291 //362 //292 // Selector: finishMinting() 7d64bcb4363 // Selector: finishMinting() 7d64bcb4293 function finishMinting() public returns (bool) {364 function finishMinting() public returns (bool) {299370300// Selector: 780e9d63371// Selector: 780e9d63301contract ERC721Enumerable is Dummy, ERC165 {372contract ERC721Enumerable is Dummy, ERC165 {373 // @notice Enumerate valid NFTs374 // @dev Throws if `index` >= `totalSupply()`.375 // @param index A counter less than `totalSupply()`376 // @return The token identifier for the `index`th NFT,377 // (sort order not specified)378 //302 // Selector: tokenByIndex(uint256) 4f6ccce7379 // Selector: tokenByIndex(uint256) 4f6ccce7303 function tokenByIndex(uint256 index) public view returns (uint256) {380 function tokenByIndex(uint256 index) public view returns (uint256) {304 require(false, stub_error);381 require(false, stub_error);307 return 0;384 return 0;308 }385 }309386310 // Not implemented387 // @dev Not implemented311 //388 //312 // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59389 // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59313 function tokenOfOwnerByIndex(address owner, uint256 index)390 function tokenOfOwnerByIndex(address owner, uint256 index)322 return 0;399 return 0;323 }400 }324401402 // @notice Count NFTs tracked by this contract403 // @return A count of valid NFTs tracked by this contract, where each one of404 // them has an assigned and queryable owner not equal to the zero address405 //325 // Selector: totalSupply() 18160ddd406 // Selector: totalSupply() 18160ddd326 function totalSupply() public view returns (uint256) {407 function totalSupply() public view returns (uint256) {327 require(false, stub_error);408 require(false, stub_error);475556476// Selector: d74d154f557// Selector: d74d154f477contract ERC721UniqueExtensions is Dummy, ERC165 {558contract ERC721UniqueExtensions is Dummy, ERC165 {559 // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE560 // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE561 // THEY MAY BE PERMANENTLY LOST562 // @dev Throws unless `msg.sender` is the current owner. Throws if `to`563 // is the zero address. Throws if `tokenId` is not a valid NFT.564 // @param to The new owner565 // @param tokenId The NFT to transfer566 // @param _value Not used for an NFT567 //478 // Selector: transfer(address,uint256) a9059cbb568 // Selector: transfer(address,uint256) a9059cbb479 function transfer(address to, uint256 tokenId) public {569 function transfer(address to, uint256 tokenId) public {480 require(false, stub_error);570 require(false, stub_error);483 dummy = 0;573 dummy = 0;484 }574 }485575576 // @notice Burns a specific ERC721 token.577 // @dev Throws unless `msg.sender` is the current owner or an authorized578 // operator for this NFT. Throws if `from` is not the current owner. Throws579 // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.580 // @param from The current owner of the NFT581 // @param tokenId The NFT to transfer582 // @param _value Not used for an NFT583 //486 // Selector: burnFrom(address,uint256) 79cc6790584 // Selector: burnFrom(address,uint256) 79cc6790487 function burnFrom(address from, uint256 tokenId) public {585 function burnFrom(address from, uint256 tokenId) public {488 require(false, stub_error);586 require(false, stub_error);491 dummy = 0;589 dummy = 0;492 }590 }493591592 // @notice Returns next free NFT ID.593 //494 // Selector: nextTokenId() 75794a3c594 // Selector: nextTokenId() 75794a3c495 function nextTokenId() public view returns (uint256) {595 function nextTokenId() public view returns (uint256) {496 require(false, stub_error);596 require(false, stub_error);497 dummy;597 dummy;498 return 0;598 return 0;499 }599 }500600601 // @notice Function to mint multiple tokens.602 // @dev `tokenIds` should be an array of consecutive numbers and first number603 // should be obtained with `nextTokenId` method604 // @param to The new owner605 // @param tokenIds IDs of the minted NFTs606 //501 // Selector: mintBulk(address,uint256[]) 44a9945e607 // Selector: mintBulk(address,uint256[]) 44a9945e502 function mintBulk(address to, uint256[] memory tokenIds)608 function mintBulk(address to, uint256[] memory tokenIds)503 public609 public510 return false;616 return false;511 }617 }512618619 // @notice Function to mint multiple tokens with the given tokenUris.620 // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive621 // numbers and first number should be obtained with `nextTokenId` method622 // @param to The new owner623 // @param tokens array of pairs of token ID and token URI for minted tokens624 //513 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006625 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006514 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)626 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)515 public627 publictests/src/eth/api/UniqueNFT.soldiffbeforeafterboth444445// Selector: 4136937745// Selector: 4136937746interface TokenProperties is Dummy, ERC165 {46interface TokenProperties is Dummy, ERC165 {47 // @notice Set permissions for token property.48 // @dev Throws error if `msg.sender` is not admin or owner of the collection.49 // @param key Property key.50 // @param is_mutable Permission to mutate property.51 // @param collection_admin Permission to mutate property by collection admin if property is mutable.52 // @param token_owner Permission to mutate property by token owner if property is mutable.53 //47 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa54 // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa48 function setTokenPropertyPermission(55 function setTokenPropertyPermission(49 string memory key,56 string memory key,52 bool tokenOwner59 bool tokenOwner53 ) external;60 ) external;546162 // @notice Set token property value.63 // @dev Throws error if `msg.sender` has no permission to edit the property.64 // @param token_id ID of the token.65 // @param key Property key.66 // @param value Property value.67 //55 // Selector: setProperty(uint256,string,bytes) 1752d67b68 // Selector: setProperty(uint256,string,bytes) 1752d67b56 function setProperty(69 function setProperty(57 uint256 tokenId,70 uint256 tokenId,58 string memory key,71 string memory key,59 bytes memory value72 bytes memory value60 ) external;73 ) external;617475 // @notice Delete token property value.76 // @dev Throws error if `msg.sender` has no permission to edit the property.77 // @param token_id ID of the token.78 // @param key Property key.79 //62 // Selector: deleteProperty(uint256,string) 066111d180 // Selector: deleteProperty(uint256,string) 066111d163 function deleteProperty(uint256 tokenId, string memory key) external;81 function deleteProperty(uint256 tokenId, string memory key) external;648283 // @notice Get token property value.65 // Throws error if key not found84 // @dev Throws error if key not found85 // @param token_id ID of the token.86 // @param key Property key.66 //87 //67 // Selector: property(uint256,string) 7228c32788 // Selector: property(uint256,string) 7228c32768 function property(uint256 tokenId, string memory key)89 function property(uint256 tokenId, string memory key)739474// Selector: 42966c6895// Selector: 42966c6875interface ERC721Burnable is Dummy, ERC165 {96interface ERC721Burnable is Dummy, ERC165 {97 // @notice Burns a specific ERC721 token.98 // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized99 // operator of the current owner.100 // @param tokenId The NFT to approve101 //76 // Selector: burn(uint256) 42966c68102 // Selector: burn(uint256) 42966c6877 function burn(uint256 tokenId) external;103 function burn(uint256 tokenId) external;78}104}7910580// Selector: 58800161106// Selector: 5880016181interface ERC721 is Dummy, ERC165, ERC721Events {107interface ERC721 is Dummy, ERC165, ERC721Events {108 // @notice Count all NFTs assigned to an owner109 // @dev NFTs assigned to the zero address are considered invalid, and this110 // function throws for queries about the zero address.111 // @param _owner An address for whom to query the balance112 // @return The number of NFTs owned by `_owner`, possibly zero113 //82 // Selector: balanceOf(address) 70a08231114 // Selector: balanceOf(address) 70a0823183 function balanceOf(address owner) external view returns (uint256);115 function balanceOf(address owner) external view returns (uint256);84116117 // @notice Find the owner of an NFT118 // @dev NFTs assigned to zero address are considered invalid, and queries119 // about them do throw.120 // @param _tokenId The identifier for an NFT121 // @return The address of the owner of the NFT122 //85 // Selector: ownerOf(uint256) 6352211e123 // Selector: ownerOf(uint256) 6352211e86 function ownerOf(uint256 tokenId) external view returns (address);124 function ownerOf(uint256 tokenId) external view returns (address);8712588 // Not implemented126 // @dev Not implemented89 //127 //90 // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672128 // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a1167291 function safeTransferFromWithData(129 function safeTransferFromWithData(95 bytes memory data133 bytes memory data96 ) external;134 ) external;9713598 // Not implemented136 // @dev Not implemented99 //137 //100 // Selector: safeTransferFrom(address,address,uint256) 42842e0e138 // Selector: safeTransferFrom(address,address,uint256) 42842e0e101 function safeTransferFrom(139 function safeTransferFrom(104 uint256 tokenId142 uint256 tokenId105 ) external;143 ) external;106144145 // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE146 // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE147 // THEY MAY BE PERMANENTLY LOST148 // @dev Throws unless `msg.sender` is the current owner or an authorized149 // operator for this NFT. Throws if `from` is not the current owner. Throws150 // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.151 // @param from The current owner of the NFT152 // @param to The new owner153 // @param tokenId The NFT to transfer154 // @param _value Not used for an NFT155 //107 // Selector: transferFrom(address,address,uint256) 23b872dd156 // Selector: transferFrom(address,address,uint256) 23b872dd108 function transferFrom(157 function transferFrom(109 address from,158 address from,110 address to,159 address to,111 uint256 tokenId160 uint256 tokenId112 ) external;161 ) external;113162163 // @notice Set or reaffirm the approved address for an NFT164 // @dev The zero address indicates there is no approved address.165 // @dev Throws unless `msg.sender` is the current NFT owner, or an authorized166 // operator of the current owner.167 // @param approved The new approved NFT controller168 // @param tokenId The NFT to approve169 //114 // Selector: approve(address,uint256) 095ea7b3170 // Selector: approve(address,uint256) 095ea7b3115 function approve(address approved, uint256 tokenId) external;171 function approve(address approved, uint256 tokenId) external;116172117 // Not implemented173 // @dev Not implemented118 //174 //119 // Selector: setApprovalForAll(address,bool) a22cb465175 // Selector: setApprovalForAll(address,bool) a22cb465120 function setApprovalForAll(address operator, bool approved) external;176 function setApprovalForAll(address operator, bool approved) external;121177122 // Not implemented178 // @dev Not implemented123 //179 //124 // Selector: getApproved(uint256) 081812fc180 // Selector: getApproved(uint256) 081812fc125 function getApproved(uint256 tokenId) external view returns (address);181 function getApproved(uint256 tokenId) external view returns (address);126182127 // Not implemented183 // @dev Not implemented128 //184 //129 // Selector: isApprovedForAll(address,address) e985e9c5185 // Selector: isApprovedForAll(address,address) e985e9c5130 function isApprovedForAll(address owner, address operator)186 function isApprovedForAll(address owner, address operator)135191136// Selector: 5b5e139f192// Selector: 5b5e139f137interface ERC721Metadata is Dummy, ERC165 {193interface ERC721Metadata is Dummy, ERC165 {194 // @notice A descriptive name for a collection of NFTs in this contract195 //138 // Selector: name() 06fdde03196 // Selector: name() 06fdde03139 function name() external view returns (string memory);197 function name() external view returns (string memory);140198199 // @notice An abbreviated name for NFTs in this contract200 //141 // Selector: symbol() 95d89b41201 // Selector: symbol() 95d89b41142 function symbol() external view returns (string memory);202 function symbol() external view returns (string memory);143203204 // @notice A distinct Uniform Resource Identifier (URI) for a given asset.205 // @dev Throws if `tokenId` is not a valid NFT. URIs are defined in RFC206 // 3986. The URI may point to a JSON file that conforms to the "ERC721207 // Metadata JSON Schema".144 // Returns token's const_metadata208 // @return token's const_metadata145 //209 //146 // Selector: tokenURI(uint256) c87b56dd210 // Selector: tokenURI(uint256) c87b56dd147 function tokenURI(uint256 tokenId) external view returns (string memory);211 function tokenURI(uint256 tokenId) external view returns (string memory);152 // Selector: mintingFinished() 05d2035b216 // Selector: mintingFinished() 05d2035b153 function mintingFinished() external view returns (bool);217 function mintingFinished() external view returns (bool);154218219 // @notice Function to mint token.155 // `token_id` should be obtained with `next_token_id` method,220 // @dev `tokenId` should be obtained with `nextTokenId` method,156 // unlike standard, you can't specify it manually221 // unlike standard, you can't specify it manually222 // @param to The new owner223 // @param tokenId ID of the minted NFT157 //224 //158 // Selector: mint(address,uint256) 40c10f19225 // Selector: mint(address,uint256) 40c10f19159 function mint(address to, uint256 tokenId) external returns (bool);226 function mint(address to, uint256 tokenId) external returns (bool);160227228 // @notice Function to mint token with the given tokenUri.161 // `token_id` should be obtained with `next_token_id` method,229 // @dev `tokenId` should be obtained with `nextTokenId` method,162 // unlike standard, you can't specify it manually230 // unlike standard, you can't specify it manually231 // @param to The new owner232 // @param tokenId ID of the minted NFT233 // @param tokenUri Token URI that would be stored in the NFT properties163 //234 //164 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f235 // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f165 function mintWithTokenURI(236 function mintWithTokenURI(168 string memory tokenUri239 string memory tokenUri169 ) external returns (bool);240 ) external returns (bool);170241171 // Not implemented242 // @dev Not implemented172 //243 //173 // Selector: finishMinting() 7d64bcb4244 // Selector: finishMinting() 7d64bcb4174 function finishMinting() external returns (bool);245 function finishMinting() external returns (bool);175}246}176247177// Selector: 780e9d63248// Selector: 780e9d63178interface ERC721Enumerable is Dummy, ERC165 {249interface ERC721Enumerable is Dummy, ERC165 {250 // @notice Enumerate valid NFTs251 // @dev Throws if `index` >= `totalSupply()`.252 // @param index A counter less than `totalSupply()`253 // @return The token identifier for the `index`th NFT,254 // (sort order not specified)255 //179 // Selector: tokenByIndex(uint256) 4f6ccce7256 // Selector: tokenByIndex(uint256) 4f6ccce7180 function tokenByIndex(uint256 index) external view returns (uint256);257 function tokenByIndex(uint256 index) external view returns (uint256);181258182 // Not implemented259 // @dev Not implemented183 //260 //184 // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59261 // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59185 function tokenOfOwnerByIndex(address owner, uint256 index)262 function tokenOfOwnerByIndex(address owner, uint256 index)186 external263 external187 view264 view188 returns (uint256);265 returns (uint256);189266267 // @notice Count NFTs tracked by this contract268 // @return A count of valid NFTs tracked by this contract, where each one of269 // them has an assigned and queryable owner not equal to the zero address270 //190 // Selector: totalSupply() 18160ddd271 // Selector: totalSupply() 18160ddd191 function totalSupply() external view returns (uint256);272 function totalSupply() external view returns (uint256);192}273}257338258// Selector: d74d154f339// Selector: d74d154f259interface ERC721UniqueExtensions is Dummy, ERC165 {340interface ERC721UniqueExtensions is Dummy, ERC165 {341 // @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE342 // TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE343 // THEY MAY BE PERMANENTLY LOST344 // @dev Throws unless `msg.sender` is the current owner. Throws if `to`345 // is the zero address. Throws if `tokenId` is not a valid NFT.346 // @param to The new owner347 // @param tokenId The NFT to transfer348 // @param _value Not used for an NFT349 //260 // Selector: transfer(address,uint256) a9059cbb350 // Selector: transfer(address,uint256) a9059cbb261 function transfer(address to, uint256 tokenId) external;351 function transfer(address to, uint256 tokenId) external;262352353 // @notice Burns a specific ERC721 token.354 // @dev Throws unless `msg.sender` is the current owner or an authorized355 // operator for this NFT. Throws if `from` is not the current owner. Throws356 // if `to` is the zero address. Throws if `tokenId` is not a valid NFT.357 // @param from The current owner of the NFT358 // @param tokenId The NFT to transfer359 // @param _value Not used for an NFT360 //263 // Selector: burnFrom(address,uint256) 79cc6790361 // Selector: burnFrom(address,uint256) 79cc6790264 function burnFrom(address from, uint256 tokenId) external;362 function burnFrom(address from, uint256 tokenId) external;265363364 // @notice Returns next free NFT ID.365 //266 // Selector: nextTokenId() 75794a3c366 // Selector: nextTokenId() 75794a3c267 function nextTokenId() external view returns (uint256);367 function nextTokenId() external view returns (uint256);268368369 // @notice Function to mint multiple tokens.370 // @dev `tokenIds` should be an array of consecutive numbers and first number371 // should be obtained with `nextTokenId` method372 // @param to The new owner373 // @param tokenIds IDs of the minted NFTs374 //269 // Selector: mintBulk(address,uint256[]) 44a9945e375 // Selector: mintBulk(address,uint256[]) 44a9945e270 function mintBulk(address to, uint256[] memory tokenIds)376 function mintBulk(address to, uint256[] memory tokenIds)271 external377 external272 returns (bool);378 returns (bool);273379380 // @notice Function to mint multiple tokens with the given tokenUris.381 // @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive382 // numbers and first number should be obtained with `nextTokenId` method383 // @param to The new owner384 // @param tokens array of pairs of token ID and token URI for minted tokens385 //274 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006386 // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006275 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)387 function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)276 external388 external