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

difftreelog

source

pallets/nft/src/lib.rs18.1 KiBsourcehistory
1#![cfg_attr(not(feature = "std"), no_std)]23use codec::{Decode, Encode};4/// A FRAME pallet template with necessary imports56/// Feel free to remove or edit this file as needed.7/// If you change the name of this file, make sure to update its references in runtime/src/lib.rs8/// If you remove this file, you can remove those references910/// For more guidance on Substrate FRAME, see the example pallet11/// https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs12use frame_support::{decl_event, decl_module, decl_storage, dispatch::DispatchResult, ensure};13use frame_system::{self as system, ensure_signed};14use sp_runtime::sp_std::prelude::Vec;1516#[cfg(test)]17mod mock;1819#[cfg(test)]20mod tests;2122#[derive(Encode, Decode, Default, Clone, PartialEq)]23#[cfg_attr(feature = "std", derive(Debug))]24pub struct CollectionType<AccountId> {25    pub owner: AccountId,26    pub next_item_id: u64,27    pub name: Vec<u16>, // 64 include null escape char28    pub description: Vec<u16>, // 256 include null escape char29    pub token_trefix: Vec<u8>, // 16 include null escape char30    pub custom_data_size: u32,31}3233#[derive(Encode, Decode, Default, Clone, PartialEq)]34#[cfg_attr(feature = "std", derive(Debug))]35pub struct CollectionAdminsType<AccountId> {36    pub admin: AccountId,37    pub collection_id: u64,38}3940#[derive(Encode, Decode, Default, Clone, PartialEq)]41#[cfg_attr(feature = "std", derive(Debug))]42pub struct NftItemType<AccountId> {43    pub collection: u64,44    pub owner: AccountId,45    pub data: Vec<u8>,46}4748/// The pallet's configuration trait.49pub trait Trait: system::Trait {50    // Add other types and constants required to configure this pallet.5152    /// The overarching event type.53    type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;54}5556// This pallet's storage items.57decl_storage! {58    // It is important to update your storage name so that your pallet's59    // storage items are isolated from other pallets.60    trait Store for Module<T: Trait> as Nft {6162        /// Next available collection ID63        pub NextCollectionID get(fn next_collection_id): u64;64        pub Collection get(fn collection): map hasher(identity) u64 => CollectionType<T::AccountId>;65        pub AdminList get(fn admin_list_collection): map hasher(identity) u64 => Vec<T::AccountId>;6667        /// Balance owner per collection map68        pub Balance get(fn balance_count): map hasher(blake2_128_concat) (u64, T::AccountId) => u64;69        pub ApprovedList get(fn approved): map hasher(blake2_128_concat) (u64, u64) => Vec<T::AccountId>;7071        pub ItemList get(fn item_id): map hasher(blake2_128_concat) (u64, u64) => NftItemType<T::AccountId>;72        pub ItemListIndex get(fn item_index): map hasher(blake2_128_concat) u64 => u64;7374        pub AddressTokens get(fn address_tokens): map hasher(blake2_128_concat) (u64, T::AccountId) => Vec<u64>;7576    }77}7879// The pallet's events80decl_event!(81    pub enum Event<T>82    where83        AccountId = <T as system::Trait>::AccountId,84    {85        Created(u64, AccountId),86        ItemCreated(u64),87        ItemDestroyed(u64, u64),88    }89);9091// The pallet's dispatchable functions.92decl_module! {93    /// The module declaration.94    pub struct Module<T: Trait> for enum Call where origin: T::Origin {9596        // Initializing events97        // this is needed only if you are using events in your pallet98        fn deposit_event() = default;99100        // Create collection of NFT with given parameters101        //102        // @param customDataSz size of custom data in each collection item103        // returns collection ID104105        // Create collection of NFT with given parameters106        //107        // @param customDataSz size of custom data in each collection item108        // returns collection ID109        #[weight = 0]110        pub fn create_collection(   origin, 111                                    collection_name: Vec<u16>, 112                                    collection_description: Vec<u16>, 113                                    token_prefix: Vec<u8>, 114                                    custom_data_sz: u32) -> DispatchResult {115116            // Anyone can create a collection117            let who = ensure_signed(origin)?;118119            // check params 120            let mut name = collection_name.to_vec();121            name.push(0);122            ensure!(name.len() <= 64, "Collection name can not be longer than 63 char");123124            let mut description = collection_description.to_vec();125            description.push(0);126            ensure!(name.len() <= 256, "Collection description can not be longer than 255 char");127128            let mut token_trefix = token_prefix.to_vec();129            token_trefix.push(0);130            ensure!(token_trefix.len() <= 16, "Token prefix can not be longer than 15 char");131132            // Generate next collection ID133            let next_id = NextCollectionID::get();134135            NextCollectionID::put(next_id);136137            // Create new collection138            let new_collection = CollectionType {139                owner: who.clone(),140                name: name,141                description: description,142                token_trefix: token_trefix,143                next_item_id: next_id,144                custom_data_size: custom_data_sz,145            };146147            // Add new collection to map148            <Collection<T>>::insert(next_id, new_collection);149150            // call event151            Self::deposit_event(RawEvent::Created(next_id, who.clone()));152153            Ok(())154        }155156        #[weight = 0]157        pub fn destroy_collection(origin, collection_id: u64) -> DispatchResult {158159            let sender = ensure_signed(origin)?;160            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");161162            let owner = <Collection<T>>::get(collection_id).owner;163            ensure!(sender == owner, "You do not own this collection");164            <Collection<T>>::remove(collection_id);165166            Ok(())167        }168169        #[weight = 0]170        pub fn change_collection_owner(origin, collection_id: u64, new_owner: T::AccountId) -> DispatchResult {171172            let sender = ensure_signed(origin)?;173            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");174175            let mut target_collection = <Collection<T>>::get(collection_id);176            ensure!(sender == target_collection.owner, "You do not own this collection");177178            target_collection.owner = new_owner;179            <Collection<T>>::insert(collection_id, target_collection);180181            Ok(())182        }183184        #[weight = 0]185        pub fn add_collection_admin(origin, collection_id: u64, new_admin_id: T::AccountId) -> DispatchResult {186187            let sender = ensure_signed(origin)?;188            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");189190            let target_collection = <Collection<T>>::get(collection_id);191            let is_owner = sender == target_collection.owner;192193            let no_perm_mes = "You do not have permissions to modify this collection";194            let exists = <AdminList<T>>::contains_key(collection_id);195196            if !is_owner197            {198                 ensure!(exists, no_perm_mes);199                 ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);200            }201202            let mut admin_arr: Vec<T::AccountId> = Vec::new();203            if exists204            {205                admin_arr = <AdminList<T>>::get(collection_id);206                ensure!(!admin_arr.contains(&new_admin_id), "Account already has admin role");207            }208209            admin_arr.push(new_admin_id);210            <AdminList<T>>::insert(collection_id, admin_arr);211212            Ok(())213        }214215        #[weight = 0]216        pub fn remove_collection_admin(origin, collection_id: u64, account_id: T::AccountId) -> DispatchResult {217218            let sender = ensure_signed(origin)?;219            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");220221            let target_collection = <Collection<T>>::get(collection_id);222            let is_owner = sender == target_collection.owner;223224            let no_perm_mes = "You do not have permissions to modify this collection";225            let exists = <AdminList<T>>::contains_key(collection_id);226227            if !is_owner228            {229                ensure!(exists, no_perm_mes);230                ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);231            }232233            if exists234            {235                let mut admin_arr = <AdminList<T>>::get(collection_id);236                admin_arr.retain(|i| *i != account_id);237                <AdminList<T>>::insert(collection_id, admin_arr);238            }239240            Ok(())241        }242243        #[weight = 0]244        pub fn create_item(origin, collection_id: u64, properties: Vec<u8>) -> DispatchResult {245246            let sender = ensure_signed(origin)?;247            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");248249            let target_collection = <Collection<T>>::get(collection_id);250            ensure!(target_collection.custom_data_size >= properties.len() as u32, "Size of item is too large");251            let is_owner = sender == target_collection.owner;252253            let no_perm_mes = "You do not have permissions to modify this collection";254            let exists = <AdminList<T>>::contains_key(collection_id);255256            if !is_owner257            {258                ensure!(exists, no_perm_mes);259                ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);260            }261262            let new_balance = <Balance<T>>::get((collection_id, sender.clone())) + 1;263            <Balance<T>>::insert((collection_id, sender.clone()), new_balance);264265            // Create new item266            let new_item = NftItemType {267                collection: collection_id,268                owner: sender,269                data: properties,270            };271272273            let current_index = <ItemListIndex>::get(collection_id);274275            Self::add_token_index(collection_id, current_index, new_item.owner.clone())?;276277            <ItemListIndex>::insert(collection_id, current_index);278            <ItemList<T>>::insert((collection_id, current_index), new_item);279280            // call event281            Self::deposit_event(RawEvent::ItemCreated(collection_id));282283            Ok(())284        }285286        #[weight = 0]287        pub fn burn_item(origin, collection_id: u64, item_id: u64) -> DispatchResult {288289            let sender = ensure_signed(origin)?;290            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");291292            let target_collection = <Collection<T>>::get(collection_id);293            let is_owner = sender == target_collection.owner;294295            ensure!(<ItemList<T>>::contains_key((collection_id, item_id)), "Item does not exists");296            let item = <ItemList<T>>::get((collection_id, item_id));297298            if !is_owner299            {300                // check if item owner301                if item.owner != sender302                {303                    let no_perm_mes = "You do not have permissions to modify this collection";304305                    ensure!(<AdminList<T>>::contains_key(collection_id), no_perm_mes);306                    ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);307                }308            }309            <ItemList<T>>::remove((collection_id, item_id));310311            Self::remove_token_index(collection_id, item_id, item.owner.clone())?;312313            // update balance314            let new_balance = <Balance<T>>::get((collection_id, item.owner.clone())) - 1;315            <Balance<T>>::insert((collection_id, item.owner.clone()), new_balance);316317            // call event318            Self::deposit_event(RawEvent::ItemDestroyed(collection_id, item_id));319320            Ok(())321        }322323        #[weight = 0]324        pub fn transfer(origin, collection_id: u64, item_id: u64, new_owner: T::AccountId) -> DispatchResult {325326            let sender = ensure_signed(origin)?;327            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");328329            let target_collection = <Collection<T>>::get(collection_id);330            let is_owner = sender == target_collection.owner;331332            ensure!(<ItemList<T>>::contains_key((collection_id, item_id)), "Item does not exists");333            let mut item = <ItemList<T>>::get((collection_id, item_id));334335            if !is_owner336            {337                // check if item owner338                if item.owner != sender339                {340                    let no_perm_mes = "You do not have permissions to modify this collection";341342                    ensure!(<AdminList<T>>::contains_key(collection_id), no_perm_mes);343                    ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);344                }345            }346            <ItemList<T>>::remove((collection_id, item_id));347348            // update balance349            let balance_old_owner = <Balance<T>>::get((collection_id, item.owner.clone())) - 1;350            <Balance<T>>::insert((collection_id, item.owner.clone()), balance_old_owner);351352            let balance_new_owner = <Balance<T>>::get((collection_id, new_owner.clone())) + 1;353            <Balance<T>>::insert((collection_id, new_owner.clone()), balance_new_owner);354355            // change owner356            let old_owner = item.owner.clone();357            item.owner = new_owner.clone();358            <ItemList<T>>::insert((collection_id, item_id), item);359360            // update index collection361            Self::move_token_index(collection_id, item_id, old_owner, new_owner.clone())?;362363            // reset approved list364            let itm: Vec<T::AccountId> = Vec::new();365            <ApprovedList<T>>::insert((collection_id, item_id), itm);366367            Ok(())368        }369370        #[weight = 0]371        pub fn approve(origin, approved: T::AccountId, collection_id: u64, item_id: u64) -> DispatchResult {372373            let sender = ensure_signed(origin)?;374            ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");375376            let target_collection = <Collection<T>>::get(collection_id);377            let is_owner = sender == target_collection.owner;378379            ensure!(<ItemList<T>>::contains_key((collection_id, item_id)), "Item does not exists");380            let item = <ItemList<T>>::get((collection_id, item_id));381382            if !is_owner383            {384                // check if item owner385                if item.owner != sender386                {387                    let no_perm_mes = "You do not have permissions to modify this collection";388389                    ensure!(<AdminList<T>>::contains_key(collection_id), no_perm_mes);390                    ensure!(<AdminList<T>>::get(collection_id).contains(&sender), no_perm_mes);391                }392            }393394            let list_exists = <ApprovedList<T>>::contains_key((collection_id, item_id));395            if list_exists {396397                let mut list = <ApprovedList<T>>::get((collection_id, item_id));398                let item_contains = list.contains(&approved.clone());399400                if !item_contains {401                    list.push(approved.clone());402                }403            } else {404405                let mut itm = Vec::new();406                itm.push(approved.clone());407                <ApprovedList<T>>::insert((collection_id, item_id), itm);408            }409410            Ok(())411        }412413        #[weight = 0]414        pub fn transfer_from(origin, collection_id: u64, item_id: u64, new_owner: T::AccountId) -> DispatchResult {415416            let no_perm_mes = "You do not have permissions to modify this collection";417            ensure!(<ApprovedList<T>>::contains_key((collection_id, item_id)), no_perm_mes);418            let list_itm = <ApprovedList<T>>::get((collection_id, item_id));419            ensure!(list_itm.contains(&new_owner.clone()), no_perm_mes);420421            Self::transfer(origin, collection_id, item_id, new_owner)?;422423            Ok(())424        }425426        #[weight = 0]427        pub fn safe_transfer_from(origin, collection_id: u64, item_id: u64, new_owner: T::AccountId) -> DispatchResult {428429            let no_perm_mes = "You do not have permissions to modify this collection";430            ensure!(<ApprovedList<T>>::contains_key((collection_id, item_id)), no_perm_mes);431            let list_itm = <ApprovedList<T>>::get((collection_id, item_id));432            ensure!(list_itm.contains(&new_owner.clone()), no_perm_mes);433434            // on_nft_received  call435436            Self::transfer(origin, collection_id, item_id, new_owner)?;437438            Ok(())439        }440    }441}442443444impl<T: Trait> Module<T> {445    fn add_token_index(collection_id: u64, item_index: u64, owner: T::AccountId) -> DispatchResult {446        447        let list_exists = <AddressTokens<T>>::contains_key((collection_id, owner.clone()));448        if list_exists {449450            let mut list = <AddressTokens<T>>::get((collection_id, owner.clone()));451            let item_contains = list.contains(&item_index.clone());452453            if !item_contains {454                list.push(item_index.clone());455            }456457            <AddressTokens<T>>::insert((collection_id, owner.clone()), list);458459        } else {460461            let mut itm = Vec::new();462            itm.push(item_index.clone());463            <AddressTokens<T>>::insert((collection_id, owner), itm);464        }465466        Ok(())467    }468469    fn remove_token_index(collection_id: u64, item_index: u64, owner: T::AccountId) -> DispatchResult {470        471        let list_exists = <AddressTokens<T>>::contains_key((collection_id, owner.clone()));472        if list_exists {473474            let mut list = <AddressTokens<T>>::get((collection_id, owner.clone()));475            let item_contains = list.contains(&item_index.clone());476477            if item_contains {478                list.retain(|&item| item != item_index);479                <AddressTokens<T>>::insert((collection_id, owner), list);480            }481        }482483        Ok(())484    }485486    fn move_token_index(collection_id: u64, item_index: u64, old_owner: T::AccountId, new_owner: T::AccountId) -> DispatchResult {487        488        Self::remove_token_index(collection_id, item_index, old_owner)?;489        Self::add_token_index(collection_id, item_index, new_owner)?;490        491        Ok(())492    }493}