difftreelog
feat add rmrk proxt extrinsics comments
in: master
2 files changed
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/lib.rs
+++ b/pallets/proxy-rmrk-core/src/lib.rs
@@ -176,8 +176,9 @@
#[pallet::call]
impl<T: Config> Pallet<T> {
+ /// Create a collection
+ #[transactional]
#[pallet::weight(<SelfWeightOf<T>>::create_collection())]
- #[transactional]
pub fn create_collection(
origin: OriginFor<T>,
metadata: RmrkString,
@@ -229,6 +230,7 @@
Ok(())
}
+ /// destroy collection
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn destroy_collection(
@@ -255,6 +257,12 @@
Ok(())
}
+ /// Change the issuer of a collection
+ ///
+ /// Parameters:
+ /// - `origin`: sender of the transaction
+ /// - `collection_id`: collection id of the nft to change issuer of
+ /// - `new_issuer`: Collection's new issuer
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn change_collection_issuer(
@@ -285,6 +293,7 @@
Ok(())
}
+ /// lock collection
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn lock_collection(
@@ -316,6 +325,16 @@
Ok(())
}
+ /// Mints an NFT in the specified collection
+ /// Sets metadata and the royalty attribute
+ ///
+ /// Parameters:
+ /// - `collection_id`: The class of the asset to be minted.
+ /// - `nft_id`: The nft value of the asset to be minted.
+ /// - `recipient`: Receiver of the royalty
+ /// - `royalty`: Permillage reward from each trade for the Recipient
+ /// - `metadata`: Arbitrary data about an nft, e.g. IPFS hash
+ /// - `transferable`: Ability to transfer this NFT
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn mint_nft(
@@ -385,6 +404,7 @@
Ok(())
}
+ /// burn nft
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn burn_nft(
@@ -416,6 +436,13 @@
Ok(())
}
+ /// Transfers a NFT from an Account or NFT A to another Account or NFT B
+ ///
+ /// Parameters:
+ /// - `origin`: sender of the transaction
+ /// - `rmrk_collection_id`: collection id of the nft to be transferred
+ /// - `rmrk_nft_id`: nft id of the nft to be transferred
+ /// - `new_owner`: new owner of the nft which can be either an account or a NFT
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn send(
@@ -520,6 +547,14 @@
Ok(())
}
+ /// Accepts an NFT sent from another account to self or owned NFT
+ ///
+ /// Parameters:
+ /// - `origin`: sender of the transaction
+ /// - `rmrk_collection_id`: collection id of the nft to be accepted
+ /// - `rmrk_nft_id`: nft id of the nft to be accepted
+ /// - `new_owner`: either origin's account ID or origin-owned NFT, whichever the NFT was
+ /// sent to
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn accept_nft(
@@ -589,6 +624,12 @@
Ok(())
}
+ /// Rejects an NFT sent from another account to self or owned NFT
+ ///
+ /// Parameters:
+ /// - `origin`: sender of the transaction
+ /// - `rmrk_collection_id`: collection id of the nft to be accepted
+ /// - `rmrk_nft_id`: nft id of the nft to be accepted
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn reject_nft(
@@ -625,6 +666,7 @@
Ok(())
}
+ /// accept the addition of a new resource to an existing NFT
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn accept_resource(
@@ -681,6 +723,7 @@
Ok(())
}
+ /// accept the removal of a resource of an existing NFT
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn accept_resource_removal(
@@ -738,6 +781,7 @@
Ok(())
}
+ /// set a custom value on an NFT
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn set_property(
@@ -797,6 +841,7 @@
Ok(())
}
+ /// set a different order of resource priority
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn set_priority(
@@ -835,6 +880,7 @@
Ok(())
}
+ /// Create basic resource
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn add_basic_resource(
@@ -872,6 +918,7 @@
Ok(())
}
+ /// Create composable resource
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn add_composable_resource(
@@ -912,6 +959,7 @@
Ok(())
}
+ /// Create slot resource
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn add_slot_resource(
@@ -951,6 +999,7 @@
Ok(())
}
+ /// remove resource
#[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]
#[transactional]
pub fn remove_resource(
pallets/proxy-rmrk-equip/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 frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};20use frame_system::{pallet_prelude::*, ensure_signed};21use sp_runtime::DispatchError;22use up_data_structs::*;23use pallet_common::{Pallet as PalletCommon, Error as CommonError};24use pallet_rmrk_core::{25 Pallet as PalletCore,26 misc::{self, *},27 property::RmrkProperty::*,28};29use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle};30use pallet_evm::account::CrossAccountId;3132pub use pallet::*;3334#[frame_support::pallet]35pub mod pallet {36 use super::*;3738 #[pallet::config]39 pub trait Config: frame_system::Config + pallet_rmrk_core::Config {40 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;41 }4243 #[pallet::storage]44 #[pallet::getter(fn internal_part_id)]45 pub type InernalPartId<T: Config> =46 StorageDoubleMap<_, Twox64Concat, CollectionId, Twox64Concat, RmrkPartId, TokenId>;4748 #[pallet::storage]49 #[pallet::getter(fn base_has_default_theme)]50 pub type BaseHasDefaultTheme<T: Config> =51 StorageMap<_, Twox64Concat, CollectionId, bool, ValueQuery>;5253 #[pallet::pallet]54 #[pallet::generate_store(pub(super) trait Store)]55 pub struct Pallet<T>(_);5657 #[pallet::event]58 #[pallet::generate_deposit(pub(super) fn deposit_event)]59 pub enum Event<T: Config> {60 BaseCreated {61 issuer: T::AccountId,62 base_id: RmrkBaseId,63 },64 }6566 #[pallet::error]67 pub enum Error<T> {68 PermissionError,69 NoAvailableBaseId,70 NoAvailablePartId,71 BaseDoesntExist,72 NeedsDefaultThemeFirst,73 }7475 #[pallet::call]76 impl<T: Config> Pallet<T> {77 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]78 #[transactional]79 pub fn create_base(80 origin: OriginFor<T>,81 base_type: RmrkString,82 symbol: RmrkString,83 parts: BoundedVec<RmrkPartType, RmrkPartsLimit>,84 ) -> DispatchResult {85 let sender = ensure_signed(origin)?;86 let cross_sender = T::CrossAccountId::from_sub(sender.clone());8788 let data = CreateCollectionData {89 limits: None,90 token_prefix: symbol91 .into_inner()92 .try_into()93 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,94 ..Default::default()95 };9697 let collection_id_res =98 <PalletNft<T>>::init_collection(cross_sender.clone(), data, true);99100 if let Err(DispatchError::Arithmetic(_)) = &collection_id_res {101 return Err(<Error<T>>::NoAvailableBaseId.into());102 }103104 let collection_id = collection_id_res?;105106 <PalletCommon<T>>::set_scoped_collection_properties(107 collection_id,108 PropertyScope::Rmrk,109 [110 <PalletCore<T>>::rmrk_property(CollectionType, &misc::CollectionType::Base)?,111 <PalletCore<T>>::rmrk_property(BaseType, &base_type)?,112 ]113 .into_iter(),114 )?;115116 let collection = <PalletCore<T>>::get_nft_collection(collection_id)?;117118 for part in parts {119 let part_id = part.id();120 let part_token_id = Self::create_part(&cross_sender, &collection, part)?;121122 <InernalPartId<T>>::insert(collection_id, part_id, part_token_id);123124 <PalletNft<T>>::set_scoped_token_property(125 collection_id,126 part_token_id,127 PropertyScope::Rmrk,128 <PalletCore<T>>::rmrk_property(ExternalPartId, &part_id)?,129 )?;130 }131132 Self::deposit_event(Event::BaseCreated {133 issuer: sender,134 base_id: collection_id.0,135 });136137 Ok(())138 }139140 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]141 #[transactional]142 pub fn theme_add(143 origin: OriginFor<T>,144 base_id: RmrkBaseId,145 theme: RmrkTheme,146 ) -> DispatchResult {147 let sender = ensure_signed(origin)?;148149 let sender = T::CrossAccountId::from_sub(sender);150 let owner = &sender;151152 let collection_id: CollectionId = base_id.into();153154 let collection = <PalletCore<T>>::get_typed_nft_collection(155 collection_id,156 misc::CollectionType::Base,157 )158 .map_err(|_| <Error<T>>::BaseDoesntExist)?;159 collection.check_is_external()?;160161 if theme.name.as_slice() == b"default" {162 <BaseHasDefaultTheme<T>>::insert(collection_id, true);163 } else if !Self::base_has_default_theme(collection_id) {164 return Err(<Error<T>>::NeedsDefaultThemeFirst.into());165 }166167 let token_id = <PalletCore<T>>::create_nft(168 &sender,169 owner,170 &collection,171 [172 <PalletCore<T>>::rmrk_property(TokenType, &NftType::Theme)?,173 <PalletCore<T>>::rmrk_property(ThemeName, &theme.name)?,174 <PalletCore<T>>::rmrk_property(ThemeInherit, &theme.inherit)?,175 ]176 .into_iter(),177 )178 .map_err(|_| <Error<T>>::PermissionError)?;179180 for property in theme.properties {181 <PalletNft<T>>::set_scoped_token_property(182 collection_id,183 token_id,184 PropertyScope::Rmrk,185 <PalletCore<T>>::rmrk_property(186 UserProperty(property.key.as_slice()),187 &property.value,188 )?,189 )?;190 }191192 Ok(())193 }194 }195}196197impl<T: Config> Pallet<T> {198 fn create_part(199 sender: &T::CrossAccountId,200 collection: &NonfungibleHandle<T>,201 part: RmrkPartType,202 ) -> Result<TokenId, DispatchError> {203 let owner = sender;204205 let src = part.src();206 let z_index = part.z_index();207208 let nft_type = match part {209 RmrkPartType::FixedPart(_) => NftType::FixedPart,210 RmrkPartType::SlotPart(_) => NftType::SlotPart,211 };212213 let token_id = <PalletCore<T>>::create_nft(214 sender,215 owner,216 collection,217 [218 <PalletCore<T>>::rmrk_property(TokenType, &nft_type)?,219 <PalletCore<T>>::rmrk_property(Src, &src)?,220 <PalletCore<T>>::rmrk_property(ZIndex, &z_index)?,221 ]222 .into_iter(),223 )224 .map_err(|err| match err {225 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailablePartId.into(),226 err => err,227 })?;228229 if let RmrkPartType::SlotPart(part) = part {230 <PalletNft<T>>::set_scoped_token_property(231 collection.id,232 token_id,233 PropertyScope::Rmrk,234 <PalletCore<T>>::rmrk_property(EquippableList, &part.equippable)?,235 )?;236 }237238 Ok(token_id)239 }240}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#![cfg_attr(not(feature = "std"), no_std)]1819use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};20use frame_system::{pallet_prelude::*, ensure_signed};21use sp_runtime::DispatchError;22use up_data_structs::*;23use pallet_common::{Pallet as PalletCommon, Error as CommonError};24use pallet_rmrk_core::{25 Pallet as PalletCore,26 misc::{self, *},27 property::RmrkProperty::*,28};29use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle};30use pallet_evm::account::CrossAccountId;3132pub use pallet::*;3334#[frame_support::pallet]35pub mod pallet {36 use super::*;3738 #[pallet::config]39 pub trait Config: frame_system::Config + pallet_rmrk_core::Config {40 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;41 }4243 #[pallet::storage]44 #[pallet::getter(fn internal_part_id)]45 pub type InernalPartId<T: Config> =46 StorageDoubleMap<_, Twox64Concat, CollectionId, Twox64Concat, RmrkPartId, TokenId>;4748 #[pallet::storage]49 #[pallet::getter(fn base_has_default_theme)]50 pub type BaseHasDefaultTheme<T: Config> =51 StorageMap<_, Twox64Concat, CollectionId, bool, ValueQuery>;5253 #[pallet::pallet]54 #[pallet::generate_store(pub(super) trait Store)]55 pub struct Pallet<T>(_);5657 #[pallet::event]58 #[pallet::generate_deposit(pub(super) fn deposit_event)]59 pub enum Event<T: Config> {60 BaseCreated {61 issuer: T::AccountId,62 base_id: RmrkBaseId,63 },64 }6566 #[pallet::error]67 pub enum Error<T> {68 PermissionError,69 NoAvailableBaseId,70 NoAvailablePartId,71 BaseDoesntExist,72 NeedsDefaultThemeFirst,73 }7475 #[pallet::call]76 impl<T: Config> Pallet<T> {7778 /// Creates a new Base.79 /// Modeled after [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)80 ///81 /// Parameters:82 /// - origin: Caller, will be assigned as the issuer of the Base83 /// - base_type: media type, e.g. "svg"84 /// - symbol: arbitrary client-chosen symbol85 /// - parts: array of Fixed and Slot parts composing the base, confined in length by86 /// RmrkPartsLimit87 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]88 #[transactional]89 pub fn create_base(90 origin: OriginFor<T>,91 base_type: RmrkString,92 symbol: RmrkString,93 parts: BoundedVec<RmrkPartType, RmrkPartsLimit>,94 ) -> DispatchResult {95 let sender = ensure_signed(origin)?;96 let cross_sender = T::CrossAccountId::from_sub(sender.clone());9798 let data = CreateCollectionData {99 limits: None,100 token_prefix: symbol101 .into_inner()102 .try_into()103 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,104 ..Default::default()105 };106107 let collection_id_res =108 <PalletNft<T>>::init_collection(cross_sender.clone(), data, true);109110 if let Err(DispatchError::Arithmetic(_)) = &collection_id_res {111 return Err(<Error<T>>::NoAvailableBaseId.into());112 }113114 let collection_id = collection_id_res?;115116 <PalletCommon<T>>::set_scoped_collection_properties(117 collection_id,118 PropertyScope::Rmrk,119 [120 <PalletCore<T>>::rmrk_property(CollectionType, &misc::CollectionType::Base)?,121 <PalletCore<T>>::rmrk_property(BaseType, &base_type)?,122 ]123 .into_iter(),124 )?;125126 let collection = <PalletCore<T>>::get_nft_collection(collection_id)?;127128 for part in parts {129 let part_id = part.id();130 let part_token_id = Self::create_part(&cross_sender, &collection, part)?;131132 <InernalPartId<T>>::insert(collection_id, part_id, part_token_id);133134 <PalletNft<T>>::set_scoped_token_property(135 collection_id,136 part_token_id,137 PropertyScope::Rmrk,138 <PalletCore<T>>::rmrk_property(ExternalPartId, &part_id)?,139 )?;140 }141142 Self::deposit_event(Event::BaseCreated {143 issuer: sender,144 base_id: collection_id.0,145 });146147 Ok(())148 }149150 /// Adds a Theme to a Base.151 /// Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md)152 /// Themes are stored in the Themes storage153 /// A Theme named "default" is required prior to adding other Themes.154 ///155 /// Parameters:156 /// - origin: The caller of the function, must be issuer of the base157 /// - base_id: The Base containing the Theme to be updated158 /// - theme: The Theme to add to the Base. A Theme has a name and properties, which are an159 /// array of [key, value, inherit].160 /// - key: arbitrary BoundedString, defined by client161 /// - value: arbitrary BoundedString, defined by client162 /// - inherit: optional bool163 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]164 #[transactional]165 pub fn theme_add(166 origin: OriginFor<T>,167 base_id: RmrkBaseId,168 theme: RmrkTheme,169 ) -> DispatchResult {170 let sender = ensure_signed(origin)?;171172 let sender = T::CrossAccountId::from_sub(sender);173 let owner = &sender;174175 let collection_id: CollectionId = base_id.into();176177 let collection = <PalletCore<T>>::get_typed_nft_collection(178 collection_id,179 misc::CollectionType::Base,180 )181 .map_err(|_| <Error<T>>::BaseDoesntExist)?;182 collection.check_is_external()?;183184 if theme.name.as_slice() == b"default" {185 <BaseHasDefaultTheme<T>>::insert(collection_id, true);186 } else if !Self::base_has_default_theme(collection_id) {187 return Err(<Error<T>>::NeedsDefaultThemeFirst.into());188 }189190 let token_id = <PalletCore<T>>::create_nft(191 &sender,192 owner,193 &collection,194 [195 <PalletCore<T>>::rmrk_property(TokenType, &NftType::Theme)?,196 <PalletCore<T>>::rmrk_property(ThemeName, &theme.name)?,197 <PalletCore<T>>::rmrk_property(ThemeInherit, &theme.inherit)?,198 ]199 .into_iter(),200 )201 .map_err(|_| <Error<T>>::PermissionError)?;202203 for property in theme.properties {204 <PalletNft<T>>::set_scoped_token_property(205 collection_id,206 token_id,207 PropertyScope::Rmrk,208 <PalletCore<T>>::rmrk_property(209 UserProperty(property.key.as_slice()),210 &property.value,211 )?,212 )?;213 }214215 Ok(())216 }217 }218}219220impl<T: Config> Pallet<T> {221 fn create_part(222 sender: &T::CrossAccountId,223 collection: &NonfungibleHandle<T>,224 part: RmrkPartType,225 ) -> Result<TokenId, DispatchError> {226 let owner = sender;227228 let src = part.src();229 let z_index = part.z_index();230231 let nft_type = match part {232 RmrkPartType::FixedPart(_) => NftType::FixedPart,233 RmrkPartType::SlotPart(_) => NftType::SlotPart,234 };235236 let token_id = <PalletCore<T>>::create_nft(237 sender,238 owner,239 collection,240 [241 <PalletCore<T>>::rmrk_property(TokenType, &nft_type)?,242 <PalletCore<T>>::rmrk_property(Src, &src)?,243 <PalletCore<T>>::rmrk_property(ZIndex, &z_index)?,244 ]245 .into_iter(),246 )247 .map_err(|err| match err {248 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailablePartId.into(),249 err => err,250 })?;251252 if let RmrkPartType::SlotPart(part) = part {253 <PalletNft<T>>::set_scoped_token_property(254 collection.id,255 token_id,256 PropertyScope::Rmrk,257 <PalletCore<T>>::rmrk_property(EquippableList, &part.equippable)?,258 )?;259 }260261 Ok(token_id)262 }263}