git.delta.rocks / unique-network / refs/commits / 1a56db748b0a

difftreelog

doc: architectural changes

Farhad Hakimov2022-07-11parent: #12c8c8f.patch.diff
in: master

10 files changed

modifiedclient/rpc/src/lib.rsdiffbeforeafterboth
--- a/client/rpc/src/lib.rs
+++ b/client/rpc/src/lib.rs
@@ -42,6 +42,7 @@
 #[rpc(server)]
 #[async_trait]
 pub trait UniqueApi<BlockHash, CrossAccountId, AccountId> {
+	/// Get tokens owned by account
 	#[method(name = "unique_accountTokens")]
 	fn account_tokens(
 		&self,
@@ -49,12 +50,14 @@
 		account: CrossAccountId,
 		at: Option<BlockHash>,
 	) -> Result<Vec<TokenId>>;
+	/// Get tokens contained in collection
 	#[method(name = "unique_collectionTokens")]
 	fn collection_tokens(
 		&self,
 		collection: CollectionId,
 		at: Option<BlockHash>,
 	) -> Result<Vec<TokenId>>;
+	/// Check if token exists
 	#[method(name = "unique_tokenExists")]
 	fn token_exists(
 		&self,
@@ -62,7 +65,7 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<bool>;
-
+	/// Get token owner
 	#[method(name = "unique_tokenOwner")]
 	fn token_owner(
 		&self,
@@ -70,6 +73,7 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<Option<CrossAccountId>>;
+	/// Get token owner, in case of nested token - find the parent recursively
 	#[method(name = "unique_topmostTokenOwner")]
 	fn topmost_token_owner(
 		&self,
@@ -77,6 +81,7 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<Option<CrossAccountId>>;
+	/// Get tokens nested directly into the token
 	#[method(name = "unique_tokenChildren")]
 	fn token_children(
 		&self,
@@ -84,7 +89,7 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<Vec<TokenChild>>;
-
+	/// Get collection properties
 	#[method(name = "unique_collectionProperties")]
 	fn collection_properties(
 		&self,
@@ -92,7 +97,7 @@
 		keys: Option<Vec<String>>,
 		at: Option<BlockHash>,
 	) -> Result<Vec<Property>>;
-
+	/// Get token properties
 	#[method(name = "unique_tokenProperties")]
 	fn token_properties(
 		&self,
@@ -101,7 +106,7 @@
 		keys: Option<Vec<String>>,
 		at: Option<BlockHash>,
 	) -> Result<Vec<Property>>;
-
+	/// Get property permissions
 	#[method(name = "unique_propertyPermissions")]
 	fn property_permissions(
 		&self,
@@ -109,7 +114,7 @@
 		keys: Option<Vec<String>>,
 		at: Option<BlockHash>,
 	) -> Result<Vec<PropertyKeyPermission>>;
-
+	/// Get token data
 	#[method(name = "unique_tokenData")]
 	fn token_data(
 		&self,
@@ -118,9 +123,10 @@
 		keys: Option<Vec<String>>,
 		at: Option<BlockHash>,
 	) -> Result<TokenData<CrossAccountId>>;
-
+	/// Get amount of unique collection tokens
 	#[method(name = "unique_totalSupply")]
 	fn total_supply(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<u32>;
+	/// Get owned amount of any user tokens
 	#[method(name = "unique_accountBalance")]
 	fn account_balance(
 		&self,
@@ -128,6 +134,7 @@
 		account: CrossAccountId,
 		at: Option<BlockHash>,
 	) -> Result<u32>;
+	/// Get owned amount of specific account token
 	#[method(name = "unique_balance")]
 	fn balance(
 		&self,
@@ -136,6 +143,7 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<String>;
+	/// Get allowed amount
 	#[method(name = "unique_allowance")]
 	fn allowance(
 		&self,
@@ -145,19 +153,21 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<String>;
-
+	/// Get admin list
 	#[method(name = "unique_adminlist")]
 	fn adminlist(
 		&self,
 		collection: CollectionId,
 		at: Option<BlockHash>,
 	) -> Result<Vec<CrossAccountId>>;
+	/// Get allowlist
 	#[method(name = "unique_allowlist")]
 	fn allowlist(
 		&self,
 		collection: CollectionId,
 		at: Option<BlockHash>,
 	) -> Result<Vec<CrossAccountId>>;
+	/// Check if user is allowed to use collection
 	#[method(name = "unique_allowed")]
 	fn allowed(
 		&self,
@@ -165,17 +175,20 @@
 		user: CrossAccountId,
 		at: Option<BlockHash>,
 	) -> Result<bool>;
+	/// Get last token ID created in a collection
 	#[method(name = "unique_lastTokenId")]
 	fn last_token_id(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<TokenId>;
+	/// Get collection by specified ID
 	#[method(name = "unique_collectionById")]
 	fn collection_by_id(
 		&self,
 		collection: CollectionId,
 		at: Option<BlockHash>,
 	) -> Result<Option<RpcCollection<AccountId>>>;
+	/// Get collection stats
 	#[method(name = "unique_collectionStats")]
 	fn collection_stats(&self, at: Option<BlockHash>) -> Result<CollectionStats>;
-
+	/// Get number of blocks when sponsored transaction is available
 	#[method(name = "unique_nextSponsored")]
 	fn next_sponsored(
 		&self,
@@ -184,14 +197,14 @@
 		token: TokenId,
 		at: Option<BlockHash>,
 	) -> Result<Option<u64>>;
-
+	/// Get effective collection limits
 	#[method(name = "unique_effectiveCollectionLimits")]
 	fn effective_collection_limits(
 		&self,
 		collection_id: CollectionId,
 		at: Option<BlockHash>,
 	) -> Result<Option<CollectionLimits>>;
-
+	/// Get total pieces of token
 	#[method(name = "unique_totalPieces")]
 	fn total_pieces(
 		&self,
@@ -304,6 +317,7 @@
 		fn base_parts(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Vec<PartType>>;
 
 		#[method(name = "rmrk_themeNames")]
+		/// Get Base's theme names
 		fn theme_names(
 			&self,
 			base_id: RmrkBaseId,
@@ -311,6 +325,7 @@
 		) -> Result<Vec<RmrkThemeName>>;
 
 		#[method(name = "rmrk_themes")]
+		/// Get Theme info -- name, properties, and inherit flag
 		fn theme(
 			&self,
 			base_id: RmrkBaseId,
modifiedpallets/common/src/lib.rsdiffbeforeafterboth
--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -299,46 +299,48 @@
 		///
 		/// # Arguments
 		///
-		/// * collection_id: Globally unique identifier of collection.
+		/// * collection_id: Globally unique identifier of collection that has been destroyed.
 		CollectionDestroyed(CollectionId),
 
 		/// New item was created.
 		///
 		/// # Arguments
 		///
-		/// * collection_id: Id of the collection where item was created.
+		/// * collection_id: ID of the collection where the item was created.
 		///
-		/// * item_id: Id of an item. Unique within the collection.
+		/// * item_id: ID of the item. Unique within the collection.
 		///
-		/// * recipient: Owner of newly created item
+		/// * recipient: Owner of the newly created item.
 		///
-		/// * amount: Always 1 for NFT
+		/// * amount: The amount of tokens that were created (always 1 for NFT).
 		ItemCreated(CollectionId, TokenId, T::CrossAccountId, u128),
 
 		/// Collection item was burned.
 		///
 		/// # Arguments
 		///
-		/// * collection_id.
+		/// * collection_id: Identifier of the collection to which the burned NFT belonged.
 		///
 		/// * item_id: Identifier of burned NFT.
 		///
-		/// * owner: which user has destroyed its tokens
+		/// * owner: Which user has destroyed their tokens.
 		///
-		/// * amount: Always 1 for NFT
+		/// * amount: The amount of tokens that were destroyed (always 1 for NFT).
 		ItemDestroyed(CollectionId, TokenId, T::CrossAccountId, u128),
 
-		/// Item was transferred
+		/// Item was transferred.
+		/// 
+		/// # Arguments
 		///
-		/// * collection_id: Id of collection to which item is belong
+		/// * collection_id: ID of the collection to which the item belongs.
 		///
-		/// * item_id: Id of an item
+		/// * item_id: ID of the item trasnferred.
 		///
-		/// * sender: Original owner of item
+		/// * sender: Original owner of the item.
 		///
-		/// * recipient: New owner of item
+		/// * recipient: New owner of the item.
 		///
-		/// * amount: Always 1 for NFT
+		/// * amount: The amount of tokens that were transferred (always 1 for NFT).
 		Transfer(
 			CollectionId,
 			TokenId,
@@ -347,6 +349,10 @@
 			u128,
 		),
 
+		/// Sponsoring allowance was approved.
+		/// 
+		/// # Arguments
+		/// 
 		/// * collection_id
 		///
 		/// * item_id
@@ -364,14 +370,53 @@
 			u128,
 		),
 
+		/// Collection property was added or edited.
+		/// 
+		/// # Arguments
+		/// 
+		/// * collection_id: ID of the collection, whose property was just set.
+		/// 
+		/// * property_key: Key of the property that was just set.
 		CollectionPropertySet(CollectionId, PropertyKey),
 
+		/// Collection property was deleted.
+		/// 
+		/// # Arguments
+		/// 
+		/// * collection_id: ID of the collection, whose property was just deleted.
+		/// 
+		/// * property_key: Key of the property that was just deleted.
 		CollectionPropertyDeleted(CollectionId, PropertyKey),
 
+		/// Item property was added or edited.
+		/// 
+		/// # Arguments
+		/// 
+		/// * collection_id: ID of the collection, whose token's property was just set.
+		/// 
+		/// * item_id: ID of the item, whose property was just set.
+		/// 
+		/// * property_key: Key of the property that was just set.
 		TokenPropertySet(CollectionId, TokenId, PropertyKey),
 
+		/// Item property was deleted.
+		/// 
+		/// # Arguments
+		/// 
+		/// * collection_id: ID of the collection, whose token's property was just deleted.
+		/// 
+		/// * item_id: ID of the item, whose property was just deleted.
+		/// 
+		/// * property_key: Key of the property that was just deleted.
 		TokenPropertyDeleted(CollectionId, TokenId, PropertyKey),
 
+		/// Token property permission was added or updated for a collection.
+		/// 
+		/// # Arguments
+		/// 
+		/// * collection_id: ID of the collection, whose permissions were just set/updated.
+		/// 
+		/// * property_key: Key of the property of the set/updated permission.
 		PropertyPermissionSet(CollectionId, PropertyKey),
 	}
 
@@ -413,26 +458,26 @@
 		/// Metadata flag frozen
 		MetadataFlagFrozen,
 
-		/// Item not exists.
+		/// Item does not exist
 		TokenNotFound,
-		/// Item balance not enough.
+		/// Item is balance not enough
 		TokenValueTooLow,
-		/// Requested value more than approved.
+		/// Requested value is more than the approved
 		ApprovedValueTooLow,
 		/// Tried to approve more than owned
 		CantApproveMoreThanOwned,
 
 		/// Can't transfer tokens to ethereum zero address
 		AddressIsZero,
-		/// Target collection doesn't supports this operation
+		/// Target collection doesn't support this operation
 		UnsupportedOperation,
 
-		/// Not sufficient funds to perform action
+		/// Insufficient funds to perform an action
 		NotSufficientFounds,
 
-		/// User not passed nesting rule
+		/// User does not satisfy the nesting rule
 		UserIsNotAllowedToNest,
-		/// Only tokens from specific collections may nest tokens under this
+		/// Only tokens from specific collections may nest tokens under this one
 		SourceCollectionIsNotAllowedToNest,
 
 		/// Tried to store more data than allowed in collection field
@@ -447,7 +492,7 @@
 		/// Property key is too long
 		PropertyKeyIsTooLong,
 
-		/// Only ASCII letters, digits, and '_', '-' are allowed
+		/// Only ASCII letters, digits, and symbols '_', '-', and '.' are allowed
 		InvalidCharacterInPropertyKey,
 
 		/// Empty property keys are forbidden
@@ -460,8 +505,11 @@
 		CollectionIsInternal,
 	}
 
+	/// The number of created collections. Essentially contains the last collection ID.
 	#[pallet::storage]
 	pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;
+
+	/// The number of destroyed collections
 	#[pallet::storage]
 	pub type DestroyedCollectionCount<T> =
 		StorageValue<Value = CollectionId, QueryKind = ValueQuery>;
@@ -486,6 +534,7 @@
 		OnEmpty = up_data_structs::CollectionProperties,
 	>;
 
+	/// Token permissions of a collection
 	#[pallet::storage]
 	#[pallet::getter(fn property_permissions)]
 	pub type CollectionPropertyPermissions<T> = StorageMap<
@@ -495,6 +544,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// Amount of collection admins
 	#[pallet::storage]
 	pub type AdminAmount<T> = StorageMap<
 		Hasher = Blake2_128Concat,
modifiedpallets/fungible/src/lib.rsdiffbeforeafterboth
--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -44,6 +44,7 @@
 pub mod erc;
 pub mod weights;
 
+/// todo:doc?
 pub type CreateItemData<T> = (<T as pallet_evm::account::Config>::CrossAccountId, u128);
 pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
 
@@ -78,10 +79,12 @@
 	#[pallet::generate_store(pub(super) trait Store)]
 	pub struct Pallet<T>(_);
 
+	/// Total amount of fungible tokens inside a collection.
 	#[pallet::storage]
 	pub type TotalSupply<T: Config> =
 		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u128, QueryKind = ValueQuery>;
 
+	/// Amount of tokens owned by an account inside a collection.
 	#[pallet::storage]
 	pub type Balance<T: Config> = StorageNMap<
 		Key = (
@@ -92,6 +95,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// todo:doc
 	#[pallet::storage]
 	pub type Allowance<T: Config> = StorageNMap<
 		Key = (
modifiedpallets/nonfungible/src/lib.rsdiffbeforeafterboth
--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -56,6 +56,8 @@
 pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;
 pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
 
+/// Token data, stored independently from other data used to describe it.
+/// Notably contains the owner account address.
 #[struct_versioning::versioned(version = 2, upper)]
 #[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]
 pub struct ItemData<CrossAccountId> {
@@ -102,13 +104,17 @@
 	#[pallet::generate_store(pub(super) trait Store)]
 	pub struct Pallet<T>(_);
 
+	/// Total amount of minted tokens in a collection.
 	#[pallet::storage]
 	pub type TokensMinted<T: Config> =
 		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;
+
+	/// Amount of burnt tokens in a collection.
 	#[pallet::storage]
 	pub type TokensBurnt<T: Config> =
 		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;
 
+	/// Token data, used to partially describe a token.
 	#[pallet::storage]
 	pub type TokenData<T: Config> = StorageNMap<
 		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),
@@ -116,6 +122,7 @@
 		QueryKind = OptionQuery,
 	>;
 
+	/// Key-value pairs, describing the metadata of a token.
 	#[pallet::storage]
 	#[pallet::getter(fn token_properties)]
 	pub type TokenProperties<T: Config> = StorageNMap<
@@ -125,6 +132,7 @@
 		OnEmpty = up_data_structs::TokenProperties,
 	>;
 
+	/// Scoped, auxiliary properties of a token, primarily used for on-chain operations.
 	#[pallet::storage]
 	#[pallet::getter(fn token_aux_property)]
 	pub type TokenAuxProperties<T: Config> = StorageNMap<
@@ -138,7 +146,7 @@
 		QueryKind = OptionQuery,
 	>;
 
-	/// Used to enumerate tokens owned by account
+	/// Used to enumerate tokens owned by account.
 	#[pallet::storage]
 	pub type Owned<T: Config> = StorageNMap<
 		Key = (
@@ -150,7 +158,7 @@
 		QueryKind = ValueQuery,
 	>;
 
-	/// Used to enumerate token's children
+	/// Used to enumerate token's children.
 	#[pallet::storage]
 	#[pallet::getter(fn token_children)]
 	pub type TokenChildren<T: Config> = StorageNMap<
@@ -163,6 +171,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// Amount of tokens owned in a collection.s
 	#[pallet::storage]
 	pub type AccountBalance<T: Config> = StorageNMap<
 		Key = (
@@ -173,6 +182,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// todo doc
 	#[pallet::storage]
 	pub type Allowance<T: Config> = StorageNMap<
 		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),
@@ -180,6 +190,7 @@
 		QueryKind = OptionQuery,
 	>;
 
+	/// Upgrade from the old schema to properties.
 	#[pallet::hooks]
 	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
 		fn on_runtime_upgrade() -> Weight {
modifiedpallets/refungible/src/lib.rsdiffbeforeafterboth
--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -38,6 +38,8 @@
 pub mod weights;
 pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
 
+/// Token data, stored independently from other data used to describe it.
+/// Notably contains the token metadata.
 #[struct_versioning::versioned(version = 2, upper)]
 #[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]
 pub struct ItemData {
@@ -86,13 +88,17 @@
 	#[pallet::generate_store(pub(super) trait Store)]
 	pub struct Pallet<T>(_);
 
+	/// Total amount of minted tokens in a collection.
 	#[pallet::storage]
 	pub type TokensMinted<T: Config> =
 		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;
+	
+	/// Amount of tokens burnt in a collection.
 	#[pallet::storage]
 	pub type TokensBurnt<T: Config> =
 		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;
 
+	/// Token data, used to partially describe a token.
 	#[pallet::storage]
 	pub type TokenData<T: Config> = StorageNMap<
 		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),
@@ -100,6 +106,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// Amount of pieces a refungible token is split into.
 	#[pallet::storage]
 	pub type TotalSupply<T: Config> = StorageNMap<
 		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),
@@ -107,7 +114,7 @@
 		QueryKind = ValueQuery,
 	>;
 
-	/// Used to enumerate tokens owned by account
+	/// Used to enumerate tokens owned by account.
 	#[pallet::storage]
 	pub type Owned<T: Config> = StorageNMap<
 		Key = (
@@ -119,6 +126,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// Amount of tokens (not pieces) partially owned by an account within a collection.
 	#[pallet::storage]
 	pub type AccountBalance<T: Config> = StorageNMap<
 		Key = (
@@ -130,6 +138,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// Amount of pieces of a token owned by an account.
 	#[pallet::storage]
 	pub type Balance<T: Config> = StorageNMap<
 		Key = (
@@ -142,6 +151,7 @@
 		QueryKind = ValueQuery,
 	>;
 
+	/// todo:doc
 	#[pallet::storage]
 	pub type Allowance<T: Config> = StorageNMap<
 		Key = (
@@ -248,7 +258,7 @@
 		// TODO: ERC721 transfer event
 		Ok(())
 	}
-
+	
 	pub fn burn(
 		collection: &RefungibleHandle<T>,
 		owner: &T::CrossAccountId,
@@ -595,6 +605,7 @@
 		Ok(())
 	}
 
+	/// todo:doc oh look, a precedent. not pub, too. but it has an unclear use-case.
 	/// Returns allowance, which should be set after transaction
 	fn check_allowed(
 		collection: &RefungibleHandle<T>,
modifiedpallets/scheduler/src/lib.rsdiffbeforeafterboth
--- a/pallets/scheduler/src/lib.rs
+++ b/pallets/scheduler/src/lib.rs
@@ -258,6 +258,7 @@
 
 	/// A Scheduler-Runtime interface for finer payment handling.
 	pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {
+		/// Reserve the maximum spendings on a call.
 		fn reserve_balance(
 			id: ScheduledId,
 			sponsor: <T as frame_system::Config>::AccountId,
@@ -265,6 +266,7 @@
 			count: u32,
 		) -> Result<(), DispatchError>;
 
+		/// Pay for call dispatch (un-reserve) from the reserved funds, returning the change.
 		fn pay_for_call(
 			id: ScheduledId,
 			sponsor: <T as frame_system::Config>::AccountId,
@@ -280,6 +282,7 @@
 			TransactionValidityError,
 		>;
 
+		/// Release reserved funds.
 		fn cancel_reserve(
 			id: ScheduledId,
 			sponsor: <T as frame_system::Config>::AccountId,
modifiedpallets/structure/src/lib.rsdiffbeforeafterboth
--- a/pallets/structure/src/lib.rs
+++ b/pallets/structure/src/lib.rs
@@ -25,19 +25,19 @@
 
 	#[pallet::error]
 	pub enum Error<T> {
-		/// While searched for owner, got already checked account
+		/// While searching for the owner, encountered an already checked account, detecting a loop.
 		OuroborosDetected,
-		/// While searched for owner, encountered depth limit
+		/// While searching for the owner, reached the depth limit.
 		DepthLimit,
-		/// While iterating over children, encountered breadth limit
+		/// While iterating over children, reached the breadth limit.
 		BreadthLimit,
-		/// While searched for owner, found token owner by not-yet-existing token
+		/// Couldn't find the token owner that is a token. Perhaps, it does not yet exist. todo:doc? rephrase?
 		TokenNotFound,
 	}
 
 	#[pallet::event]
 	pub enum Event<T> {
-		/// Executed call on behalf of token
+		/// Executed call on behalf of the token.
 		Executed(DispatchResult),
 	}
 
@@ -73,11 +73,11 @@
 
 #[derive(PartialEq)]
 pub enum Parent<CrossAccountId> {
-	/// Token owned by normal account
+	/// Token owned by a normal account.
 	User(CrossAccountId),
-	/// Passed token not found
+	/// Could not find the token provided as the owner.
 	TokenNotFound,
-	/// Token owner is another token (target token still may not exist)
+	/// Token owner is another token (still, the target token may not exist).
 	Token(CollectionId, TokenId),
 }
 
modifiedpallets/unique/src/lib.rsdiffbeforeafterboth
101 /// * admin: Admin address.101 /// * admin: Admin address.
102 CollectionAdminAdded(CollectionId, CrossAccountId),102 CollectionAdminAdded(CollectionId, CrossAccountId),
103103
104 /// Collection owned was change104 /// Collection owned was changed
105 ///105 ///
106 /// # Arguments106 /// # Arguments
107 ///107 ///
137 /// * admin: Admin address.137 /// * admin: Admin address.
138 CollectionAdminRemoved(CollectionId, CrossAccountId),138 CollectionAdminRemoved(CollectionId, CrossAccountId),
139139
140 /// Address was remove from allow list140 /// Address was removed from the allow list
141 ///141 ///
142 /// # Arguments142 /// # Arguments
143 ///143 ///
146 /// * user: Address.146 /// * user: Address.
147 AllowListAddressRemoved(CollectionId, CrossAccountId),147 AllowListAddressRemoved(CollectionId, CrossAccountId),
148148
149 /// Address was add to allow list149 /// Address was added to the allow list
150 ///150 ///
151 /// # Arguments151 /// # Arguments
152 ///152 ///
155 /// * user: Address.155 /// * user: Address.
156 AllowListAddressAdded(CollectionId, CrossAccountId),156 AllowListAddressAdded(CollectionId, CrossAccountId),
157157
158 /// Collection limits was set158 /// Collection limits were set
159 ///159 ///
160 /// # Arguments160 /// # Arguments
161 ///161 ///
162 /// * collection_id: Globally unique collection identifier.162 /// * collection_id: Globally unique collection identifier.
163 CollectionLimitSet(CollectionId),163 CollectionLimitSet(CollectionId),
164164
165 /// Collection permissions were set
166 ///
167 /// # Arguments
168 ///
169 /// * collection_id: Globally unique collection identifier.
165 CollectionPermissionSet(CollectionId),170 CollectionPermissionSet(CollectionId),
166 }171 }
167}172}
198 ChainVersion: u64;203 ChainVersion: u64;
199 //#endregion204 //#endregion
200205
201 //#region Tokens transfer rate limit baskets206 //#region Tokens transfer sponosoring rate limit baskets
202 /// (Collection id (controlled?2), who created (real))207 /// (Collection id (controlled?2), who created (real))
203 /// TODO: Off chain worker should remove from this map when collection gets removed208 /// TODO: Off chain worker should remove from this map when collection gets removed
204 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;209 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;
214 /// Collection id (controlled?2), token id (controlled?2)219 /// Collection id (controlled?2), token id (controlled?2)
215 #[deprecated]220 #[deprecated]
216 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;221 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;
222 /// Last sponsoring of token property setting // todo:doc rephrase this and the following
217 pub TokenPropertyBasket get(fn token_property_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;223 pub TokenPropertyBasket get(fn token_property_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;
218224
219 /// Approval sponsoring225 /// Last sponsoring of NFT approval in a collection
220 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;226 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;
227 /// Last sponsoring of fungible tokens approval in a collection
221 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;228 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;
229 /// Last sponsoring of RFT approval in a collection
222 pub RefungibleApproveBasket get(fn refungible_approve_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;230 pub RefungibleApproveBasket get(fn refungible_approve_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;
223 }231 }
224}232}
278 Self::create_collection_ex(origin, data)286 Self::create_collection_ex(origin, data)
279 }287 }
280288
281 /// This method creates a collection289 /// Create a collection with explicit parameters.
290 /// Prefer it to the deprecated [`created_collection`] method.
282 ///291 ///
283 /// Prefer it to deprecated [`created_collection`] method292 /// # Permissions
293 ///
294 /// * Anyone.
295 ///
296 /// # Arguments
297 ///
298 /// * data: explicit create-collection data.
284 #[weight = <SelfWeightOf<T>>::create_collection()]299 #[weight = <SelfWeightOf<T>>::create_collection()]
285 #[transactional]300 #[transactional]
286 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {301 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {
293 Ok(())308 Ok(())
294 }309 }
295310
296 /// Destroys collection if no tokens within this collection311 /// Destroy the collection if no tokens exist within.
297 ///312 ///
298 /// # Permissions313 /// # Permissions
299 ///314 ///
300 /// * Collection Owner.315 /// * Collection Owner
301 ///316 ///
302 /// # Arguments317 /// # Arguments
303 ///318 ///
398 ///413 ///
399 /// # Permissions414 /// # Permissions
400 ///415 ///
401 /// * Collection Owner.416 /// * Collection Owner
402 ///417 ///
403 /// # Arguments418 /// # Arguments
404 ///419 ///
424 target_collection.save()439 target_collection.save()
425 }440 }
426441
427 /// Adds an admin of the Collection.442 /// Adds an admin of the collection.
428 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.443 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.
429 ///444 ///
430 /// # Permissions445 /// # Permissions
431 ///446 ///
432 /// * Collection Owner.447 /// * Collection Owner
433 /// * Collection Admin.448 /// * Collection Admin
434 ///449 ///
435 /// # Arguments450 /// # Arguments
436 ///451 ///
437 /// * collection_id: ID of the Collection to add admin for.452 /// * collection_id: ID of the Collection to add admin for.
438 ///453 ///
439 /// * new_admin_id: Address of new admin to add.454 /// * new_admin: Address of new admin to add.
440 #[weight = <SelfWeightOf<T>>::add_collection_admin()]455 #[weight = <SelfWeightOf<T>>::add_collection_admin()]
441 #[transactional]456 #[transactional]
442 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {457 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin: T::CrossAccountId) -> DispatchResult {
443 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);458 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);
444 let collection = <CollectionHandle<T>>::try_get(collection_id)?;459 let collection = <CollectionHandle<T>>::try_get(collection_id)?;
445 collection.check_is_internal()?;460 collection.check_is_internal()?;
446461
447 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(462 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(
448 collection_id,463 collection_id,
449 new_admin_id.clone()464 new_admin.clone()
450 ));465 ));
451466
452 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)467 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin, true)
453 }468 }
454469
455 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.470 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.
456 ///471 ///
457 /// # Permissions472 /// # Permissions
458 ///473 ///
459 /// * Collection Owner.474 /// * Collection Owner
460 /// * Collection Admin.475 /// * Collection Admin
461 ///476 ///
462 /// # Arguments477 /// # Arguments
463 ///478 ///
479 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)494 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)
480 }495 }
481496
497 /// Set (invite) a new collection sponsor. If successful, confirmation from the sponsor-to-be will be pending.
498 ///
482 /// # Permissions499 /// # Permissions
483 ///500 ///
484 /// * Collection Owner501 /// * Collection Owner
502 /// * Collection Admin
485 ///503 ///
486 /// # Arguments504 /// # Arguments
487 ///505 ///
507 target_collection.save()525 target_collection.save()
508 }526 }
509527
528 /// Confirm own sponsorship of a collection.
529 ///
510 /// # Permissions530 /// # Permissions
511 ///531 ///
512 /// * Sponsor.532 /// * The sponsor to-be
513 ///533 ///
514 /// # Arguments534 /// # Arguments
515 ///535 ///
538 ///558 ///
539 /// # Permissions559 /// # Permissions
540 ///560 ///
541 /// * Collection owner.561 /// * Collection Owner
542 ///562 ///
543 /// # Arguments563 /// # Arguments
544 ///564 ///
560 target_collection.save()580 target_collection.save()
561 }581 }
562582
563 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.583 /// Create a concrete instance of NFT Collection created with CreateCollection method.
564 ///584 ///
565 /// # Permissions585 /// # Permissions
566 ///586 ///
567 /// * Collection Owner.587 /// * Collection Owner
568 /// * Collection Admin.588 /// * Collection Admin
569 /// * Anyone if589 /// * Anyone if
570 /// * Allow List is enabled, and590 /// * Allow List is enabled, and
571 /// * Address is added to allow list, and591 /// * Address is added to allow list, and
587 dispatch_tx::<T, _>(collection_id, |d| d.create_item(sender, owner, data, &budget))607 dispatch_tx::<T, _>(collection_id, |d| d.create_item(sender, owner, data, &budget))
588 }608 }
589609
590 /// This method creates multiple items in a collection created with CreateCollection method.610 /// Create multiple items in a collection created with CreateCollection method.
591 ///611 ///
592 /// # Permissions612 /// # Permissions
593 ///613 ///
594 /// * Collection Owner.614 /// * Collection Owner
595 /// * Collection Admin.615 /// * Collection Admin
596 /// * Anyone if616 /// * Anyone if
597 /// * Allow List is enabled, and617 /// * Allow List is enabled, and
598 /// * Address is added to allow list, and618 /// * Address is added to allow list, and
615 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data, &budget))635 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data, &budget))
616 }636 }
617637
638 /// Add or change collection properties.
639 ///
640 /// # Permissions
641 ///
642 /// * Collection Owner
643 /// * Collection Admin
644 ///
645 /// # Arguments
646 ///
647 /// * collection_id.
648 ///
649 /// * properties: a vector of key-value pairs stored as the collection's metadata. Keys support Latin letters, '-', '_', and '.' as symbols.
618 #[weight = T::CommonWeightInfo::set_collection_properties(properties.len() as u32)]650 #[weight = T::CommonWeightInfo::set_collection_properties(properties.len() as u32)]
619 #[transactional]651 #[transactional]
620 pub fn set_collection_properties(652 pub fn set_collection_properties(
629 dispatch_tx::<T, _>(collection_id, |d| d.set_collection_properties(sender, properties))661 dispatch_tx::<T, _>(collection_id, |d| d.set_collection_properties(sender, properties))
630 }662 }
631663
664 /// Delete specified collection properties.
665 ///
666 /// # Permissions
667 ///
668 /// * Collection Owner
669 /// * Collection Admin
670 ///
671 /// # Arguments
672 ///
673 /// * collection_id.
674 ///
675 /// * property_keys: a vector of keys of the properties to be deleted.
632 #[weight = T::CommonWeightInfo::delete_collection_properties(property_keys.len() as u32)]676 #[weight = T::CommonWeightInfo::delete_collection_properties(property_keys.len() as u32)]
633 #[transactional]677 #[transactional]
634 pub fn delete_collection_properties(678 pub fn delete_collection_properties(
643 dispatch_tx::<T, _>(collection_id, |d| d.delete_collection_properties(&sender, property_keys))687 dispatch_tx::<T, _>(collection_id, |d| d.delete_collection_properties(&sender, property_keys))
644 }688 }
645689
690 /// Add or change token properties according to collection's permissions.
691 ///
692 /// # Permissions
693 ///
694 /// * Depends on collection's token property permissions and specified property mutability:
695 /// * Collection Owner
696 /// * Collection Admin
697 /// * Token Owner
698 ///
699 /// # Arguments
700 ///
701 /// * collection_id.
702 ///
703 /// * token_id.
704 ///
705 /// * properties: a vector of key-value pairs stored as the token's metadata. Keys support Latin letters, '-', '_', and '.' as symbols.
646 #[weight = T::CommonWeightInfo::set_token_properties(properties.len() as u32)]706 #[weight = T::CommonWeightInfo::set_token_properties(properties.len() as u32)]
647 #[transactional]707 #[transactional]
648 pub fn set_token_properties(708 pub fn set_token_properties(
659 dispatch_tx::<T, _>(collection_id, |d| d.set_token_properties(sender, token_id, properties, &budget))719 dispatch_tx::<T, _>(collection_id, |d| d.set_token_properties(sender, token_id, properties, &budget))
660 }720 }
661721
722 /// Delete specified token properties.
723 ///
724 /// # Permissions
725 ///
726 /// * Depends on collection's token property permissions and specified property mutability:
727 /// * Collection Owner
728 /// * Collection Admin
729 /// * Token Owner
730 ///
731 /// # Arguments
732 ///
733 /// * collection_id.
734 ///
735 /// * token_id.
736 ///
737 /// * property_keys: a vector of keys of the properties to be deleted.
662 #[weight = T::CommonWeightInfo::delete_token_properties(property_keys.len() as u32)]738 #[weight = T::CommonWeightInfo::delete_token_properties(property_keys.len() as u32)]
663 #[transactional]739 #[transactional]
664 pub fn delete_token_properties(740 pub fn delete_token_properties(
675 dispatch_tx::<T, _>(collection_id, |d| d.delete_token_properties(sender, token_id, property_keys, &budget))751 dispatch_tx::<T, _>(collection_id, |d| d.delete_token_properties(sender, token_id, property_keys, &budget))
676 }752 }
677753
754 /// Add or change token property permissions of a collection.
755 ///
756 /// # Permissions
757 ///
758 /// * Collection Owner
759 /// * Collection Admin
760 ///
761 /// # Arguments
762 ///
763 /// * collection_id.
764 ///
765 /// * property_permissions: a vector of permissions for property keys. Keys support Latin letters, '-', '_', and '.' as symbols.
678 #[weight = T::CommonWeightInfo::set_token_property_permissions(property_permissions.len() as u32)]766 #[weight = T::CommonWeightInfo::set_token_property_permissions(property_permissions.len() as u32)]
679 #[transactional]767 #[transactional]
680 pub fn set_token_property_permissions(768 pub fn set_token_property_permissions(
689 dispatch_tx::<T, _>(collection_id, |d| d.set_token_property_permissions(&sender, property_permissions))777 dispatch_tx::<T, _>(collection_id, |d| d.set_token_property_permissions(&sender, property_permissions))
690 }778 }
691779
780 /// Create multiple items inside a collection with explicitly specified initial parameters.
781 ///
782 /// # Permissions
783 ///
784 /// * Collection Owner
785 /// * Collection Admin
786 /// * Anyone if
787 /// * Allow List is enabled, and
788 /// * Address is added to allow list, and
789 /// * MintPermission is enabled (see SetMintPermission method)
790 ///
791 /// # Arguments
792 ///
793 /// * collection_id: ID of the collection.
794 ///
795 /// * data: explicit item creation data.
692 #[weight = T::CommonWeightInfo::create_multiple_items_ex(&data)]796 #[weight = T::CommonWeightInfo::create_multiple_items_ex(&data)]
693 #[transactional]797 #[transactional]
694 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {798 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {
698 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data, &budget))802 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data, &budget))
699 }803 }
700804
701 /// Set transfers_enabled value for particular collection805 /// Set transfers_enabled value for particular collection.
702 ///806 ///
703 /// # Permissions807 /// # Permissions
704 ///808 ///
705 /// * Collection Owner.809 /// * Collection Owner
706 ///810 ///
707 /// # Arguments811 /// # Arguments
708 ///812 ///
723 target_collection.save()827 target_collection.save()
724 }828 }
725829
726 /// Destroys a concrete instance of NFT.830 /// Destroy a concrete instance of NFT.
727 ///831 ///
728 /// # Permissions832 /// # Permissions
729 ///833 ///
730 /// * Collection Owner.834 /// * Collection Owner
731 /// * Collection Admin.835 /// * Collection Admin
732 /// * Current NFT Owner.836 /// * Current NFT Owner
733 ///837 ///
734 /// # Arguments838 /// # Arguments
735 ///839 ///
752 Ok(post_info)856 Ok(post_info)
753 }857 }
754858
755 /// Destroys a concrete instance of NFT on behalf of the owner859 /// Destroy a concrete instance of NFT on behalf of the owner.
756 /// See also: [`approve`]860 /// See also: [`approve`]
757 ///861 ///
758 /// # Permissions862 /// # Permissions
835 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.939 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.
836 ///940 ///
837 /// # Permissions941 /// # Permissions
942 ///
838 /// * Collection Owner943 /// * Collection Owner
839 /// * Collection Admin944 /// * Collection Admin
840 /// * Current NFT owner945 /// * Current NFT owner
860 dispatch_tx::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value, &budget))965 dispatch_tx::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value, &budget))
861 }966 }
862967
968 /// Set specific limits of a collection. Empty, or None fields mean chain default.
969 ///.
970 /// # Permissions
971 ///
972 /// * Collection Owner
973 /// * Collection Admin
974 ///
975 /// # Arguments
976 ///
977 /// * collection_id.
978 ///
979 /// * new_limit: The new limits of the collection. They will overwrite the current ones.
863 #[weight = <SelfWeightOf<T>>::set_collection_limits()]980 #[weight = <SelfWeightOf<T>>::set_collection_limits()]
864 #[transactional]981 #[transactional]
865 pub fn set_collection_limits(982 pub fn set_collection_limits(
882 target_collection.save()999 target_collection.save()
883 }1000 }
8841001
1002 /// Set specific permissions of a collection. Empty, or None fields mean chain default.
1003 ///
1004 /// # Permissions
1005 ///
1006 /// * Collection Owner
1007 /// * Collection Admin
1008 ///
1009 /// # Arguments
1010 ///
1011 /// * collection_id.
1012 ///
1013 /// * new_permission: The new permissions of the collection. They will overwrite the current ones.
885 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1014 #[weight = <SelfWeightOf<T>>::set_collection_limits()]
886 #[transactional]1015 #[transactional]
887 pub fn set_collection_permissions(1016 pub fn set_collection_permissions(
888 origin,1017 origin,
889 collection_id: CollectionId,1018 collection_id: CollectionId,
890 new_limit: CollectionPermissions,1019 new_permission: CollectionPermissions,
891 ) -> DispatchResult {1020 ) -> DispatchResult {
892 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1021 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);
893 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1022 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;
894 target_collection.check_is_internal()?;1023 target_collection.check_is_internal()?;
895 target_collection.check_is_owner_or_admin(&sender)?;1024 target_collection.check_is_owner_or_admin(&sender)?;
896 let old_limit = &target_collection.permissions;1025 let old_limit = &target_collection.permissions;
8971026
898 target_collection.permissions = <PalletCommon<T>>::clamp_permissions(target_collection.mode.clone(), &old_limit, new_limit)?;1027 target_collection.permissions = <PalletCommon<T>>::clamp_permissions(target_collection.mode.clone(), &old_limit, new_permission)?;
8991028
900 <Pallet<T>>::deposit_event(Event::<T>::CollectionPermissionSet(1029 <Pallet<T>>::deposit_event(Event::<T>::CollectionPermissionSet(
901 collection_id1030 collection_id
904 target_collection.save()1033 target_collection.save()
905 }1034 }
9061035
1036 /// Re-partition a refungible token, while owning all of its parts.
1037 ///
1038 /// # Permissions
1039 ///
1040 /// * Token Owner (must own every part)
1041 ///
1042 /// # Arguments
1043 ///
1044 /// * collection_id.
1045 ///
1046 /// * token: the ID of the RFT.
1047 ///
1048 /// * amount: The new number of parts into which the token shall be partitioned.
907 #[weight = T::RefungibleExtensionsWeightInfo::repartition()]1049 #[weight = T::RefungibleExtensionsWeightInfo::repartition()]
908 #[transactional]1050 #[transactional]
909 pub fn repartition(1051 pub fn repartition(
modifiedprimitives/data-structs/src/lib.rsdiffbeforeafterboth
--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -197,7 +197,6 @@
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 pub enum CollectionMode {
 	NFT,
-	// decimal points
 	Fungible(DecimalPoints),
 	ReFungible,
 }
@@ -252,12 +251,14 @@
 pub enum SponsorshipState<AccountId> {
 	/// The fees are applied to the transaction sender
 	Disabled,
+	/// Pending confirmation from a sponsor-to-be
 	Unconfirmed(AccountId),
 	/// Transactions are sponsored by specified account
 	Confirmed(AccountId),
 }
 
 impl<AccountId> SponsorshipState<AccountId> {
+	/// Get the acting sponsor account, if present
 	pub fn sponsor(&self) -> Option<&AccountId> {
 		match self {
 			Self::Confirmed(sponsor) => Some(sponsor),
@@ -265,6 +266,7 @@
 		}
 	}
 
+	/// Get the sponsor account currently pending confirmation, if present
 	pub fn pending_sponsor(&self) -> Option<&AccountId> {
 		match self {
 			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),
@@ -272,6 +274,7 @@
 		}
 	}
 
+	/// Is sponsorship set and acting
 	pub fn confirmed(&self) -> bool {
 		matches!(self, Self::Confirmed(_))
 	}
@@ -283,7 +286,7 @@
 	}
 }
 
-/// Used in storage
+/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version)
 #[struct_versioning::versioned(version = 2, upper)]
 #[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]
 pub struct Collection<AccountId> {
@@ -324,7 +327,7 @@
 	pub meta_update_permission: MetaUpdatePermission,
 }
 
-/// Used in RPC calls
+/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version)
 #[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 pub struct RpcCollection<AccountId> {
@@ -362,12 +365,15 @@
 
 pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;
 
-/// All fields are wrapped in `Option`s, where None means chain default
+/// Limits and restrictions of a collection.
+/// All fields are wrapped in `Option`s, where None means chain default.
 // When adding/removing fields from this struct - don't forget to also update clamp_limits
 #[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 pub struct CollectionLimits {
+	/// Maximum number of owned tokens per account
 	pub account_token_ownership_limit: Option<u32>,
+	/// Maximum size of data of a sponsored transaction
 	pub sponsored_data_size: Option<u32>,
 
 	/// FIXME should we delete this or repurpose it?
@@ -375,13 +381,18 @@
 	/// Some(v) - setVariableMetadata is sponsored
 	///           if there is v block between txs
 	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,
+	/// Maximum amount of tokens inside the collection
 	pub token_limit: Option<u32>,
 
-	// Timeouts for item types in passed blocks
+	/// Timeout for sponsoring a token transfer in passed blocks
 	pub sponsor_transfer_timeout: Option<u32>,
+	/// Timeout for sponsoring an approval in passed blocks
 	pub sponsor_approve_timeout: Option<u32>,
+	/// Can a token be transferred by the owner
 	pub owner_can_transfer: Option<bool>,
+	/// Can a token be burned by the owner
 	pub owner_can_destroy: Option<bool>,
+	/// Can a token be transferred at all
 	pub transfers_enabled: Option<bool>,
 }
 
@@ -509,6 +520,7 @@
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 pub enum SponsoringRateLimit {
 	SponsoringDisabled,
+	/// Once per how many blocks can sponsorship of a transaction type occur
 	Blocks(u32),
 }
 
@@ -516,6 +528,7 @@
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 #[derivative(Debug)]
 pub struct CreateNftData {
+	/// Key-value pairs used to describe the token as metadata
 	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]
 	#[derivative(Debug(format_with = "bounded::vec_debug"))]
 	pub properties: CollectionPropertiesVec,
@@ -524,6 +537,7 @@
 #[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 pub struct CreateFungibleData {
+	/// Number of fungible tokens minted
 	pub value: u128,
 }
 
@@ -534,6 +548,7 @@
 	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]
 	#[derivative(Debug(format_with = "bounded::vec_debug"))]
 	pub const_data: BoundedVec<u8, CustomDataLimit>,
+	/// Number of pieces the RFT is split into
 	pub pieces: u128,
 }
 
@@ -553,6 +568,7 @@
 	ReFungible(CreateReFungibleData),
 }
 
+/// Explicit NFT creation data with meta parameters
 #[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
 #[derivative(Debug)]
 pub struct CreateNftExData<CrossAccountId> {
@@ -561,6 +577,7 @@
 	pub owner: CrossAccountId,
 }
 
+/// Explicit RFT creation data with meta parameters
 #[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
 #[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]
 pub struct CreateRefungibleExData<CrossAccountId> {
@@ -570,6 +587,7 @@
 	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,
 }
 
+/// Explicit item creation data with meta parameters, namely the owner
 #[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]
 #[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]
 pub enum CreateItemExData<CrossAccountId> {
@@ -617,6 +635,7 @@
 	}
 }
 
+/// Token's address, dictated by its collection and token IDs
 #[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]
 #[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
 // todo possibly rename to be used generally as an address pair
modifiedtests/src/interfaces/unique/definitions.tsdiffbeforeafterboth
--- a/tests/src/interfaces/unique/definitions.ts
+++ b/tests/src/interfaces/unique/definitions.ts
@@ -43,13 +43,13 @@
     accountTokens: fun('Get tokens owned by account', [collectionParam, crossAccountParam()], 'Vec<u32>'),
     collectionTokens: fun('Get tokens contained in collection', [collectionParam], 'Vec<u32>'),
 
-    lastTokenId: fun('Get last token id', [collectionParam], 'u32'),
+    lastTokenId: fun('Get last token ID created in a collection', [collectionParam], 'u32'),
     totalSupply: fun('Get amount of unique collection tokens', [collectionParam], 'u32'),
-    accountBalance: fun('Get amount of different user tokens', [collectionParam, crossAccountParam()], 'u32'),
-    balance: fun('Get amount of specific account token', [collectionParam, crossAccountParam(), tokenParam], 'u128'),
+    accountBalance: fun('Get owned amount of any user tokens', [collectionParam, crossAccountParam()], 'u32'),
+    balance: fun('Get owned amount of specific account token', [collectionParam, crossAccountParam(), tokenParam], 'u128'),
     allowance: fun('Get allowed amount', [collectionParam, crossAccountParam('sender'), crossAccountParam('spender'), tokenParam], 'u128'),
     tokenOwner: fun('Get token owner', [collectionParam, tokenParam], `Option<${CROSS_ACCOUNT_ID_TYPE}>`),
-    topmostTokenOwner: fun('Get token owner, in case of nested token - find parent recursive', [collectionParam, tokenParam], `Option<${CROSS_ACCOUNT_ID_TYPE}>`),
+    topmostTokenOwner: fun('Get token owner, in case of nested token - find the parent recursively', [collectionParam, tokenParam], `Option<${CROSS_ACCOUNT_ID_TYPE}>`),
     tokenChildren: fun('Get tokens nested directly into the token', [collectionParam, tokenParam], 'Vec<UpDataStructsTokenChild>'),
     constMetadata: fun('Get token constant metadata', [collectionParam, tokenParam], 'Vec<u8>'),
     variableMetadata: fun('Get token variable metadata', [collectionParam, tokenParam], 'Vec<u8>'),
@@ -74,7 +74,7 @@
       'UpDataStructsTokenData',
     ),
     tokenExists: fun('Check if token exists', [collectionParam, tokenParam], 'bool'),
-    collectionById: fun('Get collection by specified id', [collectionParam], 'Option<UpDataStructsRpcCollection>'),
+    collectionById: fun('Get collection by specified ID', [collectionParam], 'Option<UpDataStructsRpcCollection>'),
     collectionStats: fun('Get collection stats', [], 'UpDataStructsCollectionStats'),
     allowed: fun('Check if user is allowed to use collection', [collectionParam, crossAccountParam()], 'bool'),
     nextSponsored: fun('Get number of blocks when sponsored transaction is available', [collectionParam, crossAccountParam(), tokenParam], 'Option<u64>'),