difftreelog
style cargo fmt
in: master
5 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
@@ -15,83 +15,83 @@
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
//! # RMRK Core Proxy Pallet
-//!
+//!
//! A pallet used as proxy for RMRK Core (<https://rmrk-team.github.io/rmrk-substrate/#/pallets/rmrk-core>).
-//!
+//!
//! - [`Config`]
//! - [`Call`]
//! - [`Pallet`]
-//!
+//!
//! ## Overview
-//!
-//! The RMRK Core Proxy pallet mirrors the functionality of RMRK Core,
+//!
+//! The RMRK Core Proxy pallet mirrors the functionality of RMRK Core,
//! binding its externalities to Unique's own underlying structure.
//! It is purposed to mimic RMRK Core exactly, allowing seamless integrations
//! of solutions based on RMRK.
-//!
+//!
//! RMRK Core itself contains essential functionality for RMRK's nested and
//! multi-resourced NFTs.
-//!
+//!
//! *Note*, that while RMRK itself is subject to active development and restructuring,
//! the proxy may be caught temporarily out of date.
-//!
+//!
//! ### What is RMRK?
-//!
-//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.
+//!
+//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.
//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.
-//!
+//!
//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,
-//! make use of specific changeable and partially shared metadata in the form of resources,
+//! make use of specific changeable and partially shared metadata in the form of resources,
//! and more.
-//!
+//!
//! Visit RMRK documentation and repositories to learn more:
//! - Docs: <https://docs.rmrk.app/getting-started/>
//! - FAQ: <https://coda.io/@rmrk/faq>
//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>
//! - RMRK spec repository: <https://github.com/rmrk-team/rmrk-spec>
-//!
+//!
//! ## Proxy Implementation
-//!
+//!
//! An external user is supposed to be able to utilize this proxy as they would
//! utilize RMRK, and get exactly the same results. Normally, Unique transactions
//! are off-limits to RMRK collections and tokens, and vice versa. However,
//! the information stored on chain can be freely interpreted by storage reads and RPCs.
-//!
+//!
//! ### ID Mapping
-//!
+//!
//! RMRK's collections' IDs are counted independently of Unique's and start at 0.
//! Note that tokens' IDs still start at 1.
//! The collections themselves, as well as tokens, are stored as Unique collections,
//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).
-//!
+//!
//! ### External/Internal Collection Insulation
-//!
+//!
//! A Unique transaction cannot target collections purposed for RMRK,
-//! and they are flagged as `external` to specify that. On the other hand,
+//! and they are flagged as `external` to specify that. On the other hand,
//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.
-//!
+//!
//! ### Native Properties
-//!
-//! Many of RMRK's native parameters are stored as scoped properties of a collection
+//!
+//! Many of RMRK's native parameters are stored as scoped properties of a collection
//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`
//! is an unacceptable symbol in user-defined proeprties, which, along with other safeguards,
//! makes them impossible to tamper with.
-//!
+//!
//! ### Collection and NFT Types
-//!
-//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,
+//!
+//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,
//! possible components of an NFT. Due to its similarity with the functionality
//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes
-//! are the collection's NFTs. See [`CollectionType`](pallet_rmrk_core::misc::CollectionType) and
+//! are the collection's NFTs. See [`CollectionType`](pallet_rmrk_core::misc::CollectionType) and
//! [`NftType`](pallet_rmrk_core::misc::NftType).
-//!
+//!
//! ## Interface
-//!
+//!
//! ### Dispatchables
-//!
+//!
//! - `create_collection` - Create a new collection of NFTs.
//! - `destroy_collection` - Destroy a collection.
-//! - `change_collection_issuer` - Change the issuer of a collection.
+//! - `change_collection_issuer` - Change the issuer of a collection.
//! Analogous to Unique's collection's [`owner`](up_data_structs::Collection).
//! - `lock_collection` - "Lock" the collection and prevent new token creation. **Cannot be undone.**
//! - `mint_nft` - Mint an NFT in a specified collection.
@@ -163,7 +163,7 @@
{
/// Overarching event type.
type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
-
+
/// The weight information of this pallet.
type WeightInfo: WeightInfo;
}
@@ -269,7 +269,7 @@
RmrkPropertyValueIsTooLong,
/// Could not find a property by the supplied key.
RmrkPropertyIsNotFound,
- /// Something went wrong when decoding encoded data from the storage.
+ /// Something went wrong when decoding encoded data from the storage.
/// Perhaps, there was a wrong key supplied for the type, or the data was improperly stored.
UnableToDecodeRmrkData,
@@ -290,7 +290,7 @@
CollectionFullOrLocked,
/// No such resource found.
ResourceDoesntExist,
- /// If an NFT is sent to a descendant, that would form a nesting loop, an ouroboros.
+ /// If an NFT is sent to a descendant, that would form a nesting loop, an ouroboros.
/// Sending to self is redundant.
CannotSendToDescendentOrSelf,
/// Not the target owner of the sent NFT.
@@ -317,7 +317,7 @@
/// # Arguments:
/// - `metadata`: Metadata describing the collection, e.g. IPFS hash. Cannot be changed.
/// - `max`: Optional maximum number of tokens.
- /// - `symbol`: UTF-8 string with token prefix, by which to represent the token in wallets and UIs.
+ /// - `symbol`: UTF-8 string with token prefix, by which to represent the token in wallets and UIs.
/// Analogous to Unique's [`token_prefix`](up_data_structs::Collection). Cannot be changed.
#[transactional]
#[pallet::weight(<SelfWeightOf<T>>::create_collection())]
@@ -383,8 +383,8 @@
Ok(())
}
- /// Destroy a collection.
- ///
+ /// Destroy a collection.
+ ///
/// Only empty collections can be destroyed. If it has any tokens, they must be burned first.
///
/// # Permissions:
@@ -419,7 +419,7 @@
}
/// Change the issuer of a collection. Analogous to Unique's collection's [`owner`](up_data_structs::Collection).
- ///
+ ///
/// # Permissions:
/// * Collection issuer
///
@@ -457,7 +457,7 @@
}
/// "Lock" the collection and prevent new token creation. Cannot be undone.
- ///
+ ///
/// # Permissions:
/// * Collection issuer
///
@@ -498,7 +498,7 @@
///
/// # Permissions:
/// * Collection issuer
- ///
+ ///
/// # Arguments:
/// - `owner`: Owner account of the NFT. If set to None, defaults to the sender (collection issuer).
/// - `collection_id`: RMRK collection ID for the NFT to be minted within. Cannot be changed.
@@ -574,20 +574,20 @@
Ok(())
}
- /// Burn an NFT, destroying it and its nested tokens up to the specified limit.
+ /// Burn an NFT, destroying it and its nested tokens up to the specified limit.
/// If the burning budget is exceeded, the transaction is reverted.
- ///
+ ///
/// This is the way to burn a nested token as well.
- ///
+ ///
/// For more information, see [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively).
- ///
+ ///
/// # Permissions:
/// * Token owner
- ///
+ ///
/// # Arguments:
/// - `collection_id`: RMRK ID of the collection in which the NFT to burn belongs to.
/// - `nft_id`: ID of the NFT to be destroyed.
- /// - `max_burns`: Maximum number of tokens to burn, used for nesting. The transaction
+ /// - `max_burns`: Maximum number of tokens to burn, used for nesting. The transaction
/// is reverted if there are more tokens to burn in the nesting tree than this number.
#[transactional]
#[pallet::weight(<SelfWeightOf<T>>::burn_nft(*max_burns))]
@@ -625,13 +625,13 @@
/// Transfer an NFT from an account/NFT A to another account/NFT B.
/// The token must be transferable. Nesting cannot occur deeper than the [`NESTING_BUDGET`].
- ///
+ ///
/// If the target owner is an NFT owned by another account, then the NFT will enter
/// the pending state and will have to be accepted by the other account.
///
/// # Permissions:
/// - Token owner
- ///
+ ///
/// # Arguments:
/// - `collection_id`: RMRK ID of the collection of the NFT to be transferred.
/// - `nft_id`: ID of the NFT to be transferred.
@@ -750,16 +750,16 @@
}
/// Accept an NFT sent from another account to self or an owned NFT.
- ///
+ ///
/// The NFT in question must be pending, and, thus, be [sent](`crate::pallet::Call::send`) first.
- ///
+ ///
/// # Permissions:
/// - Token-owner-to-be
///
/// # Arguments:
/// - `rmrk_collection_id`: RMRK collection ID of the NFT to be accepted.
/// - `rmrk_nft_id`: ID of the NFT to be accepted.
- /// - `new_owner`: Either the sender's account ID or a sender-owned NFT,
+ /// - `new_owner`: Either the sender's account ID or a sender-owned NFT,
/// whichever the accepted NFT was sent to.
#[transactional]
#[pallet::weight(<SelfWeightOf<T>>::accept_nft())]
@@ -842,12 +842,12 @@
/// Reject an NFT sent from another account to self or owned NFT.
/// The NFT in question will not be sent back and burnt instead.
- ///
+ ///
/// The NFT in question must be pending, and, thus, be [sent](`crate::pallet::Call::send`) first.
- ///
+ ///
/// # Permissions:
/// - Token-owner-to-be-not
- ///
+ ///
/// # Arguments:
/// - `rmrk_collection_id`: RMRK ID of the NFT to be rejected.
/// - `rmrk_nft_id`: ID of the NFT to be rejected.
@@ -905,11 +905,11 @@
}
/// Accept the addition of a newly created pending resource to an existing NFT.
- ///
+ ///
/// This transaction is needed when a resource is created and assigned to an NFT
- /// by a non-owner, i.e. the collection issuer, with one of the
+ /// by a non-owner, i.e. the collection issuer, with one of the
/// [`add_...` transactions](crate::pallet::Call::add_basic_resource).
- ///
+ ///
/// # Permissions:
/// - Token owner
///
@@ -960,10 +960,10 @@
}
/// Accept the removal of a removal-pending resource from an NFT.
- ///
- /// This transaction is needed when a non-owner, i.e. the collection issuer,
+ ///
+ /// This transaction is needed when a non-owner, i.e. the collection issuer,
/// requests a [removal](`crate::pallet::Call::remove_resource`) of a resource from an NFT.
- ///
+ ///
/// # Permissions:
/// - Token owner
///
@@ -1036,13 +1036,13 @@
Ok(())
}
- /// Add or edit a custom user property, a key-value pair, describing the metadata
+ /// Add or edit a custom user property, a key-value pair, describing the metadata
/// of a token or a collection, on either one of these.
- ///
- /// Note that in this proxy implementation many details regarding RMRK are stored
- /// as scoped properties prefixed with "rmrk:", normally inaccessible
+ ///
+ /// Note that in this proxy implementation many details regarding RMRK are stored
+ /// as scoped properties prefixed with "rmrk:", normally inaccessible
/// to external transactions and RPCs.
- ///
+ ///
/// # Permissions:
/// - Collection issuer - in case of collection property
/// - Token owner - in case of NFT property
@@ -1113,11 +1113,11 @@
/// Set a different order of resource priorities for an NFT. Priorities can be used,
/// for example, for order of rendering.
- ///
+ ///
/// Note that the priorities are not updated automatically, and are an empty vector
/// by default. There is no pre-set definition for the order to be particular,
/// it can be interpreted arbitrarily use-case by use-case.
- ///
+ ///
/// # Permissions:
/// - Token owner
///
@@ -1164,16 +1164,16 @@
}
/// Create and set/propose a basic resource for an NFT.
- ///
+ ///
/// A resource is considered a part of an NFT, an additional piece of metadata
/// usually serving to add a piece of media on top of the root metadata, be it
/// a different wing on the root template bird or something entirely unrelated.
/// A basic resource is the simplest, lacking a base or composables.
- ///
+ ///
/// See RMRK docs for more information and examples.
- ///
+ ///
/// # Permissions:
- /// - Collection issuer - if not the token owner, adding the resource will warrant
+ /// - Collection issuer - if not the token owner, adding the resource will warrant
/// the owner's [acceptance](crate::pallet::Call::accept_resource).
///
/// # Arguments:
@@ -1210,16 +1210,16 @@
}
/// Create and set/propose a composable resource for an NFT.
- ///
+ ///
/// A resource is considered a part of an NFT, an additional piece of metadata
/// usually serving to add a piece of media on top of the root metadata, be it
/// a different wing on the root template bird or something entirely unrelated.
/// A composable resource links to a base and has a subset of its parts it is composed of.
- ///
+ ///
/// See RMRK docs for more information and examples.
- ///
+ ///
/// # Permissions:
- /// - Collection issuer - if not the token owner, adding the resource will warrant
+ /// - Collection issuer - if not the token owner, adding the resource will warrant
/// the owner's [acceptance](crate::pallet::Call::accept_resource).
///
/// # Arguments:
@@ -1276,16 +1276,16 @@
}
/// Create and set/propose a slot resource for an NFT.
- ///
+ ///
/// A resource is considered a part of an NFT, an additional piece of metadata
/// usually serving to add a piece of media on top of the root metadata, be it
/// a different wing on the root template bird or something entirely unrelated.
/// A slot resource links to a base and a slot in it which it now occupies.
- ///
+ ///
/// See RMRK docs for more information and examples.
- ///
+ ///
/// # Permissions:
- /// - Collection issuer - if not the token owner, adding the resource will warrant
+ /// - Collection issuer - if not the token owner, adding the resource will warrant
/// the owner's [acceptance](crate::pallet::Call::accept_resource).
///
/// # Arguments:
@@ -1322,13 +1322,13 @@
}
/// Remove and erase a resource from an NFT.
- ///
+ ///
/// If the sender does not own the NFT, then it will be pending confirmation,
/// and will have to be [accepted](crate::pallet::Call::accept_resource_removal) by the token owner.
- ///
+ ///
/// # Permissions
/// - Collection issuer
- ///
+ ///
/// # Arguments
/// - `collection_id`: RMRK ID of a collection to which the NFT making use of the resource belongs to.
/// - `nft_id`: ID of the NFT with a resource to be removed.
@@ -1371,7 +1371,7 @@
Ok(scoped_key)
}
- /// Form a Unique property, transforming a RMRK key into bytes (without assigning the scope yet)
+ /// Form a Unique property, transforming a RMRK key into bytes (without assigning the scope yet)
/// and encoding the value from an arbitrary type into bytes.
pub fn encode_rmrk_property<E: Encode>(
rmrk_key: RmrkProperty,
@@ -1416,7 +1416,7 @@
}
/// Initialize a new NFT collection with certain RMRK-scoped properties.
- ///
+ ///
/// See [`init_collection`](pallet_nonfungible::pallet::Pallet::init_collection) for more details.
fn init_collection(
sender: T::CrossAccountId,
@@ -1439,7 +1439,7 @@
}
/// Mint a new NFT with certain RMRK-scoped properties. Sender must be the collection owner.
- ///
+ ///
/// See [`create_item`](pallet_nonfungible::pallet::Pallet::create_item) for more details.
pub fn create_nft(
sender: &T::CrossAccountId,
@@ -1458,18 +1458,13 @@
let nft_id = <PalletNft<T>>::current_token_id(collection.id);
- <PalletNft<T>>::set_scoped_token_properties(
- collection.id,
- nft_id,
- RMRK_SCOPE,
- properties,
- )?;
+ <PalletNft<T>>::set_scoped_token_properties(collection.id, nft_id, RMRK_SCOPE, properties)?;
Ok(nft_id)
}
/// Burn an NFT, along with its nested children, limited by `max_burns`. The sender must be the token owner.
- ///
+ ///
/// See [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively) for more details.
fn destroy_nft(
sender: T::CrossAccountId,
@@ -1531,7 +1526,7 @@
})
}
- /// Apply a mutation to the property of a token containing sent tokens
+ /// Apply a mutation to the property of a token containing sent tokens
/// that are currently pending acceptance.
fn mutate_pending_children(
(target_collection_id, target_nft_id): (CollectionId, TokenId),
@@ -1557,7 +1552,7 @@
)
}
- /// Get an iterator from a token's property containing tokens sent to it
+ /// Get an iterator from a token's property containing tokens sent to it
/// that are currently pending acceptance.
fn iterate_pending_children(
collection_id: CollectionId,
@@ -1601,7 +1596,7 @@
Ok(resource_id)
}
- /// Create and add a resource for a regular NFT, mark it as pending if the sender
+ /// Create and add a resource for a regular NFT, mark it as pending if the sender
/// is not the token owner. The sender must be the collection owner.
fn resource_add(
sender: T::AccountId,
@@ -1698,7 +1693,7 @@
Ok(())
}
- /// Remove one usage of a base from an NFT's property of associated bases. The base will stay, however,
+ /// Remove one usage of a base from an NFT's property of associated bases. The base will stay, however,
/// if the count of resources using the base is still non-zero.
fn remove_associated_base_id(
collection_id: CollectionId,
@@ -1843,7 +1838,7 @@
}
/// Get the type of a collection stored in it as a scoped property.
- ///
+ ///
/// RMRK Core proxy differentiates between regular collections as well as RMRK bases as collections.
pub fn get_collection_type(
collection_id: CollectionId,
@@ -1882,7 +1877,7 @@
Self::get_nft_collection(collection_id)
}
- /// Same as [`get_typed_nft_collection`](crate::pallet::Pallet::get_typed_nft_collection),
+ /// Same as [`get_typed_nft_collection`](crate::pallet::Pallet::get_typed_nft_collection),
/// but also return the Unique collection ID.
pub fn get_typed_nft_collection_mapped(
rmrk_collection_id: RmrkCollectionId,
@@ -1927,7 +1922,7 @@
}
/// Get the type of an NFT stored in it as a scoped property.
- ///
+ ///
/// RMRK Core proxy differentiates between regular NFTs, and RMRK parts and themes.
pub fn get_nft_type(
collection_id: CollectionId,
@@ -1949,7 +1944,7 @@
Ok(())
}
- /// Ensure that an account is the owner of the token, either directly
+ /// Ensure that an account is the owner of the token, either directly
/// or at the top of the nesting hierarchy; return an error if it is not.
pub fn ensure_nft_owner(
collection_id: CollectionId,
@@ -1971,7 +1966,7 @@
Ok(())
}
- /// Fetch non-scoped properties of a collection or a token that match the filter keys supplied,
+ /// Fetch non-scoped properties of a collection or a token that match the filter keys supplied,
/// or, if None are provided, return all non-scoped properties.
pub fn filter_user_properties<Key, Value, R, Mapper>(
collection_id: CollectionId,
@@ -2018,7 +2013,7 @@
})
}
- /// Get all non-scoped properties from a collection or a token, and apply some transformation
+ /// Get all non-scoped properties from a collection or a token, and apply some transformation
/// to each key-value pair.
pub fn iterate_user_properties<Key, Value, R, Mapper>(
collection_id: CollectionId,
pallets/proxy-rmrk-core/src/misc.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/misc.rs
+++ b/pallets/proxy-rmrk-core/src/misc.rs
@@ -19,7 +19,7 @@
use super::*;
use codec::{Encode, Decode, Error};
-/// Match errors from one type to another and return an error
+/// Match errors from one type to another and return an error
/// if a match is successful.
#[macro_export]
macro_rules! map_unique_err_to_proxy {
pallets/proxy-rmrk-core/src/property.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/property.rs
+++ b/pallets/proxy-rmrk-core/src/property.rs
@@ -24,7 +24,7 @@
pub const RESOURCE_ID_PREFIX: &str = "rsid-";
/// Property prefix for storing custom user-defined properties.
pub const USER_PROPERTY_PREFIX: &str = "userprop-";
-/// Property scope for RMRK, used to signify that this property
+/// Property scope for RMRK, used to signify that this property
/// was created and is used by RMRK.
pub const RMRK_SCOPE: PropertyScope = PropertyScope::Rmrk;
pallets/proxy-rmrk-core/src/rpc.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/rpc.rs
+++ b/pallets/proxy-rmrk-core/src/rpc.rs
@@ -104,7 +104,6 @@
}))
}
-
/// Get tokens owned by an account in a collection.
pub fn account_tokens<T: Config>(
account_id: T::AccountId,
pallets/proxy-rmrk-equip/src/lib.rsdiffbeforeafterboth15// 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/>.161617//! # RMRK Core Proxy Pallet17//! # RMRK Core Proxy Pallet18//! 18//!19//! A pallet used as proxy for RMRK Core (<https://rmrk-team.github.io/rmrk-substrate/#/pallets/rmrk-core>).19//! A pallet used as proxy for RMRK Core (<https://rmrk-team.github.io/rmrk-substrate/#/pallets/rmrk-core>).20//! 20//!21//! - [`Config`]21//! - [`Config`]22//! - [`Call`]22//! - [`Call`]23//! - [`Pallet`]23//! - [`Pallet`]24//! 24//!25//! ## Overview25//! ## Overview26//! 26//!27//! The RMRK Equip Proxy pallet mirrors the functionality of RMRK Equip, 27//! The RMRK Equip Proxy pallet mirrors the functionality of RMRK Equip,28//! binding its externalities to Unique's own underlying structure.28//! binding its externalities to Unique's own underlying structure.29//! It is purposed to mimic RMRK Equip exactly, allowing seamless integrations29//! It is purposed to mimic RMRK Equip exactly, allowing seamless integrations30//! of solutions based on RMRK.30//! of solutions based on RMRK.31//! 31//!32//! RMRK Equip itself contains functionality to equip NFTs, and work with Bases,32//! RMRK Equip itself contains functionality to equip NFTs, and work with Bases,33//! Parts, and Themes.33//! Parts, and Themes.34//! 34//!35//! Equip Proxy is responsible for a more specific area of RMRK, and heavily relies on the Core. 35//! Equip Proxy is responsible for a more specific area of RMRK, and heavily relies on the Core.36//! For a more foundational description of proxy implementation, please refer to [`pallet_rmrk_core`].36//! For a more foundational description of proxy implementation, please refer to [`pallet_rmrk_core`].37//! 37//!38//! *Note*, that while RMRK itself is subject to active development and restructuring,38//! *Note*, that while RMRK itself is subject to active development and restructuring,39//! the proxy may be caught temporarily out of date.39//! the proxy may be caught temporarily out of date.40//! 40//!41//! ### What is RMRK?41//! ### What is RMRK?42//! 42//!43//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives. 43//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.44//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.44//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.45//! 45//!46//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,46//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,47//! make use of specific changeable and partially shared metadata in the form of resources, 47//! make use of specific changeable and partially shared metadata in the form of resources,48//! and more.48//! and more.49//! 49//!50//! Visit RMRK documentation and repositories to learn more:50//! Visit RMRK documentation and repositories to learn more:51//! - Docs: <https://docs.rmrk.app/getting-started/>51//! - Docs: <https://docs.rmrk.app/getting-started/>52//! - FAQ: <https://coda.io/@rmrk/faq>52//! - FAQ: <https://coda.io/@rmrk/faq>53//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>53//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>54//! - RMRK spec repository: <https://github.com/rmrk-team/rmrk-spec>54//! - RMRK spec repository: <https://github.com/rmrk-team/rmrk-spec>55//! 55//!56//! ## Proxy Implementation56//! ## Proxy Implementation57//! 57//!58//! An external user is supposed to be able to utilize this proxy as they would58//! An external user is supposed to be able to utilize this proxy as they would59//! utilize RMRK, and get exactly the same results. Normally, Unique transactions59//! utilize RMRK, and get exactly the same results. Normally, Unique transactions60//! are off-limits to RMRK collections and tokens, and vice versa. However,60//! are off-limits to RMRK collections and tokens, and vice versa. However,61//! the information stored on chain can be freely interpreted by storage reads and RPCs.61//! the information stored on chain can be freely interpreted by storage reads and RPCs.62//! 62//!63//! ### ID Mapping63//! ### ID Mapping64//! 64//!65//! RMRK's collections' IDs are counted independently of Unique's and start at 0.65//! RMRK's collections' IDs are counted independently of Unique's and start at 0.66//! Note that tokens' IDs still start at 1.66//! Note that tokens' IDs still start at 1.67//! The collections themselves, as well as tokens, are stored as Unique collections,67//! The collections themselves, as well as tokens, are stored as Unique collections,68//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).68//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).69//! 69//!70//! ### External/Internal Collection Insulation70//! ### External/Internal Collection Insulation71//! 71//!72//! A Unique transaction cannot target collections purposed for RMRK,72//! A Unique transaction cannot target collections purposed for RMRK,73//! and they are flagged as `external` to specify that. On the other hand, 73//! and they are flagged as `external` to specify that. On the other hand,74//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.74//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.75//! 75//!76//! ### Native Properties76//! ### Native Properties77//! 77//!78//! Many of RMRK's native parameters are stored as scoped properties of a collection 78//! Many of RMRK's native parameters are stored as scoped properties of a collection79//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`79//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`80//! is an unacceptable symbol in user-defined proeprties, which, along with other safeguards,80//! is an unacceptable symbol in user-defined proeprties, which, along with other safeguards,81//! makes them impossible to tamper with.81//! makes them impossible to tamper with.82//! 82//!83//! ### Collection and NFT Types83//! ### Collection and NFT Types84//! 84//!85//! RMRK introduces the concept of a Base, which is a catalgoue of Parts, 85//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,86//! possible components of an NFT. Due to its similarity with the functionality86//! possible components of an NFT. Due to its similarity with the functionality87//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes87//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes88//! are the collection's NFTs. See [`CollectionType`](pallet_rmrk_core::misc::CollectionType) and 88//! are the collection's NFTs. See [`CollectionType`](pallet_rmrk_core::misc::CollectionType) and89//! [`NftType`](pallet_rmrk_core::misc::NftType).89//! [`NftType`](pallet_rmrk_core::misc::NftType).90//! 90//!91//! ## Interface91//! ## Interface92//! 92//!93//! ### Dispatchables93//! ### Dispatchables94//! 94//!95//! - `create_base` - Create a new Base.95//! - `create_base` - Create a new Base.96//! - `theme_add` - Add a Theme to a Base.96//! - `theme_add` - Add a Theme to a Base.97//! - `equippable` - Update the array of Collections allowed to be equipped to a Base's specified Slot Part.97//! - `equippable` - Update the array of Collections allowed to be equipped to a Base's specified Slot Part.184 #[pallet::call]184 #[pallet::call]185 impl<T: Config> Pallet<T> {185 impl<T: Config> Pallet<T> {186 /// Create a new Base.186 /// Create a new Base.187 /// 187 ///188 /// Modeled after the [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)188 /// Modeled after the [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)189 /// 189 ///190 /// # Permissions190 /// # Permissions191 /// - Anyone - will be assigned as the issuer of the base.191 /// - Anyone - will be assigned as the issuer of the base.192 ///192 ///193 /// # Arguments:193 /// # Arguments:194 /// - `base_type`: Arbitrary media type, e.g. "svg".194 /// - `base_type`: Arbitrary media type, e.g. "svg".195 /// - `symbol`: Arbitrary client-chosen symbol.195 /// - `symbol`: Arbitrary client-chosen symbol.196 /// - `parts`: Array of Fixed and Slot parts composing the base, 196 /// - `parts`: Array of Fixed and Slot parts composing the base,197 /// confined in length by [`RmrkPartsLimit`](up_data_structs::RmrkPartsLimit).197 /// confined in length by [`RmrkPartsLimit`](up_data_structs::RmrkPartsLimit).198 #[transactional]198 #[transactional]199 #[pallet::weight(<SelfWeightOf<T>>::create_base(parts.len() as u32))]199 #[pallet::weight(<SelfWeightOf<T>>::create_base(parts.len() as u32))]250253251 /// Add a Theme to a Base.254 /// Add a Theme to a Base.252 /// A Theme named "default" is required prior to adding other Themes.255 /// A Theme named "default" is required prior to adding other Themes.253 /// 256 ///254 /// Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md).257 /// Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md).255 ///258 ///256 /// # Permissions:259 /// # Permissions:257 /// - Base issuer260 /// - Base issuer258 /// 261 ///259 /// # Arguments:262 /// # Arguments:260 /// - `base_id`: Base ID containing the Theme to be updated.263 /// - `base_id`: Base ID containing the Theme to be updated.261 /// - `theme`: Theme to add to the Base. A Theme has a name and properties, which are an264 /// - `theme`: Theme to add to the Base. A Theme has a name and properties, which are an314 }317 }315318316 /// Update the array of Collections allowed to be equipped to a Base's specified Slot Part.319 /// Update the array of Collections allowed to be equipped to a Base's specified Slot Part.317 /// 320 ///318 /// Modeled after [equippable interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md).321 /// Modeled after [equippable interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md).319 ///322 ///320 /// # Permissions:323 /// # Permissions:321 /// - Base issuer324 /// - Base issuer322 /// 325 ///323 /// # Arguments:326 /// # Arguments:324 /// - `base_id`: Base containing the Slot Part to be updated.327 /// - `base_id`: Base containing the Slot Part to be updated.325 /// - `part_id`: Slot Part whose Equippable List is being updated.328 /// - `part_id`: Slot Part whose Equippable List is being updated.