difftreelog
refactor use type-safe propertywriter to set/delete properties
in: master
12 files changed
pallets/balances-adapter/src/common.rsdiffbeforeafterboth--- a/pallets/balances-adapter/src/common.rs
+++ b/pallets/balances-adapter/src/common.rs
@@ -172,6 +172,20 @@
fail!(<pallet_common::Error<T>>::UnsupportedOperation);
}
+ fn get_token_properties_map(&self, _token_id: TokenId) -> up_data_structs::TokenProperties {
+ // No token properties are defined on fungibles
+ up_data_structs::TokenProperties::new()
+ }
+
+ fn set_token_properties_map(&self, _token_id: TokenId, _map: up_data_structs::TokenProperties) {
+ // No token properties are defined on fungibles
+ }
+
+ fn properties_exist(&self, _token: TokenId) -> bool {
+ // No token properties are defined on fungibles
+ false
+ }
+
fn set_token_property_permissions(
&self,
_sender: &<T>::CrossAccountId,
@@ -277,6 +291,15 @@
Err(up_data_structs::TokenOwnerError::MultipleOwners)
}
+ fn check_token_indirect_owner(
+ &self,
+ _token: TokenId,
+ _maybe_owner: &<T>::CrossAccountId,
+ _nesting_budget: &dyn up_data_structs::budget::Budget,
+ ) -> Result<bool, frame_support::sp_runtime::DispatchError> {
+ Ok(false)
+ }
+
fn token_owners(&self, _token: TokenId) -> Vec<<T>::CrossAccountId> {
vec![]
}
pallets/common/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/common/src/benchmarking.rs
+++ b/pallets/common/src/benchmarking.rs
@@ -22,8 +22,9 @@
use frame_benchmarking::{benchmarks, account};
use up_data_structs::{
CollectionMode, CreateCollectionData, CollectionId, Property, PropertyKey, PropertyValue,
- CollectionPermissions, NestingPermissions, AccessMode, MAX_COLLECTION_NAME_LENGTH,
- MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH, MAX_PROPERTIES_PER_ITEM,
+ CollectionPermissions, NestingPermissions, AccessMode, PropertiesPermissionMap,
+ MAX_COLLECTION_NAME_LENGTH, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,
+ MAX_PROPERTIES_PER_ITEM,
};
use frame_support::{
traits::{Get, fungible::Balanced, Imbalance, tokens::Precision},
@@ -123,6 +124,16 @@
)
}
+pub fn load_is_admin_and_property_permissions<T: Config>(
+ collection: &CollectionHandle<T>,
+ sender: &T::CrossAccountId,
+) -> (bool, PropertiesPermissionMap) {
+ (
+ collection.is_owner_or_admin(sender),
+ <Pallet<T>>::property_permissions(collection.id),
+ )
+}
+
/// Helper macros, which handles all benchmarking preparation in semi-declarative way
///
/// `name` is a substrate account
@@ -215,4 +226,12 @@
assert_eq!(collection_handle.permissions.access(), AccessMode::AllowList);
}: {collection_handle.check_allowlist(&sender)?;}
+
+ init_token_properties_common {
+ bench_init!{
+ owner: sub; collection: collection(owner);
+ sender: sub;
+ sender: cross_from_sub(sender);
+ };
+ }: {load_is_admin_and_property_permissions(&collection, &sender);}
}
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -56,6 +56,7 @@
use core::{
ops::{Deref, DerefMut},
slice::from_ref,
+ marker::PhantomData,
};
use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};
use sp_std::vec::Vec;
@@ -97,6 +98,9 @@
pub mod helpers;
#[allow(missing_docs)]
pub mod weights;
+
+use weights::WeightInfo;
+
/// Weight info.
pub type SelfWeightOf<T> = <T as Config>::WeightInfo;
@@ -864,19 +868,7 @@
QueryKind = OptionQuery,
>;
}
-
-/// Represents the change mode for the token property.
-pub enum SetPropertyMode {
- /// The token already exists.
- ExistingToken,
- /// New token.
- NewToken {
- /// The creator of the token is the recipient.
- mint_target_is_sender: bool,
- },
-}
-
/// Value representation with delayed initialization time.
pub struct LazyValue<T, F: FnOnce() -> T> {
value: Option<T>,
@@ -892,19 +884,33 @@
}
}
- /// Get the value. If it call furst time the value will be initialized.
+ /// Get the value. If it is called the first time, the value will be initialized.
pub fn value(&mut self) -> &T {
- if self.value.is_none() {
- self.value = Some(self.f.take().unwrap()())
- }
+ self.compute_value_if_not_already();
+ self.value.as_ref().unwrap()
+ }
- self.value.as_ref().unwrap()
+ /// Get the value. If it is called the first time, the value will be initialized.
+ pub fn value_mut(&mut self) -> &mut T {
+ self.compute_value_if_not_already();
+ self.value.as_mut().unwrap()
}
- /// Is value initialized.
+ fn into_inner(mut self) -> T {
+ self.compute_value_if_not_already();
+ self.value.unwrap()
+ }
+
+ /// Is value initialized?
pub fn has_value(&self) -> bool {
self.value.is_some()
}
+
+ fn compute_value_if_not_already(&mut self) {
+ if self.value.is_none() {
+ self.value = Some(self.f.take().unwrap()())
+ }
+ }
}
fn check_token_permissions<T, FCA, FTO, FTE>(
@@ -926,10 +932,19 @@
fail!(<Error<T>>::NoPermission);
}
- let token_certainly_exist = is_token_owner.has_value() && (*is_token_owner.value())?;
- if !token_certainly_exist && !is_token_exist.value() {
- fail!(<Error<T>>::TokenNotFound);
+ let token_exist_due_to_owner_check_success =
+ is_token_owner.has_value() && (*is_token_owner.value())?;
+
+ // If the token owner check has occurred and succeeded,
+ // we know the token exists (otherwise, the owner check must fail).
+ if !token_exist_due_to_owner_check_success {
+ // If the token owner check didn't occur,
+ // we must check the token's existence ourselves.
+ if !is_token_exist.value() {
+ fail!(<Error<T>>::TokenNotFound);
+ }
}
+
Ok(())
}
@@ -1312,92 +1327,6 @@
Ok(())
}
- /// A batch operation to add, edit or remove properties for a token.
- /// It sets or removes a token's properties according to
- /// `properties_updates` contents:
- /// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`
- /// * removes a property under the <key> if the value is `None` `(<key>, None)`.
- ///
- /// All affected properties should have `mutable` permission
- /// to be **deleted** or to be **set more than once**,
- /// and the sender should have permission to edit those properties.
- ///
- /// This function fires an event for each property change.
- /// In case of an error, all the changes (including the events) will be reverted
- /// since the function is transactional.
- #[allow(clippy::too_many_arguments)]
- pub fn modify_token_properties<FTO, FTE>(
- collection: &CollectionHandle<T>,
- sender: &T::CrossAccountId,
- token_id: TokenId,
- is_token_exist: &mut LazyValue<bool, FTE>,
- properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- mut stored_properties: TokenProperties,
- is_token_owner: &mut LazyValue<Result<bool, DispatchError>, FTO>,
- set_token_properties: impl FnOnce(TokenProperties),
- log: evm_coder::ethereum::Log,
- ) -> DispatchResult
- where
- FTO: FnOnce() -> Result<bool, DispatchError>,
- FTE: FnOnce() -> bool,
- {
- let mut is_collection_admin = LazyValue::new(|| collection.is_owner_or_admin(sender));
- let mut permissions = LazyValue::new(|| Self::property_permissions(collection.id));
-
- let mut changed = false;
- for (key, value) in properties_updates {
- let permission = permissions
- .value()
- .get(&key)
- .cloned()
- .unwrap_or_else(PropertyPermission::none);
-
- let property_exists = stored_properties.get(&key).is_some();
-
- match permission {
- PropertyPermission { mutable: false, .. } if property_exists => {
- return Err(<Error<T>>::NoPermission.into());
- }
-
- PropertyPermission {
- collection_admin,
- token_owner,
- ..
- } => check_token_permissions::<T, _, FTO, FTE>(
- collection_admin,
- token_owner,
- &mut is_collection_admin,
- is_token_owner,
- is_token_exist,
- )?,
- }
-
- match value {
- Some(value) => {
- stored_properties
- .try_set(key.clone(), value)
- .map_err(<Error<T>>::from)?;
-
- Self::deposit_event(Event::TokenPropertySet(collection.id, token_id, key));
- }
- None => {
- stored_properties.remove(&key).map_err(<Error<T>>::from)?;
-
- Self::deposit_event(Event::TokenPropertyDeleted(collection.id, token_id, key));
- }
- }
-
- changed = true;
- }
-
- if changed {
- <PalletEvm<T>>::deposit_log(log);
- set_token_properties(stored_properties);
- }
-
- Ok(())
- }
-
/// Sets or unsets the approval of a given operator.
///
/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.
@@ -2166,6 +2095,22 @@
budget: &dyn Budget,
) -> DispatchResultWithPostInfo;
+ /// Get token properties raw map.
+ ///
+ /// * `token_id` - The token which properties are needed.
+ fn get_token_properties_map(&self, token_id: TokenId) -> TokenProperties;
+
+ /// Set token properties raw map.
+ ///
+ /// * `token_id` - The token for which the properties are being set.
+ /// * `map` - The raw map containing the token's properties.
+ fn set_token_properties_map(&self, token_id: TokenId, map: TokenProperties);
+
+ /// Whether the given token has properties.
+ ///
+ /// * `token_id` - The token in question.
+ fn properties_exist(&self, token: TokenId) -> bool;
+
/// Set token property permissions.
///
/// * `sender` - Must be either the owner of the token or its admin.
@@ -2309,6 +2254,18 @@
/// * `token` - The token for which you need to find out the owner.
fn token_owner(&self, token: TokenId) -> Result<T::CrossAccountId, TokenOwnerError>;
+ /// Checks if the `maybe_owner` is the indirect owner of the `token`.
+ ///
+ /// * `token` - Id token to check.
+ /// * `maybe_owner` - The account to check.
+ /// * `nesting_budget` - A budget that can be spent on nesting tokens.
+ fn check_token_indirect_owner(
+ &self,
+ token: TokenId,
+ maybe_owner: &T::CrossAccountId,
+ nesting_budget: &dyn Budget,
+ ) -> Result<bool, DispatchError>;
+
/// Returns 10 tokens owners in no particular order.
///
/// * `token` - The token for which you need to find out the owners.
@@ -2420,6 +2377,348 @@
}
}
+/// A marker structure that enables the writer implementation
+/// to provide the interface to write properties to **newly created** tokens.
+pub struct NewTokenPropertyWriter;
+
+/// A marker structure that enables the writer implementation
+/// to provide the interface to write properties to **already existing** tokens.
+pub struct ExistingTokenPropertyWriter;
+
+/// The type-safe interface for writing properties (setting or deleting) to tokens.
+/// It has two distinct implementations for newly created tokens and existing ones.
+///
+/// This type utilizes the lazy evaluation to avoid repeating the computation
+/// of several performance-heavy or PoV-heavy tasks,
+/// such as checking the indirect ownership or reading the token property permissions.
+pub struct PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ WriterVariant,
+ FIsAdmin,
+ FPropertyPermissions,
+ FCheckTokenExist,
+ FGetProperties,
+> where
+ T: Config,
+ FIsAdmin: FnOnce() -> bool,
+ FPropertyPermissions: FnOnce() -> PropertiesPermissionMap,
+{
+ collection: &'a Handle,
+ is_collection_admin: LazyValue<bool, FIsAdmin>,
+ property_permissions: LazyValue<PropertiesPermissionMap, FPropertyPermissions>,
+ check_token_exist: FCheckTokenExist,
+ get_properties: FGetProperties,
+ _phantom: PhantomData<(T, WriterVariant)>,
+}
+
+impl<'a, T, Handle, FIsAdmin, FPropertyPermissions, FCheckTokenExist, FGetProperties>
+ PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ NewTokenPropertyWriter,
+ FIsAdmin,
+ FPropertyPermissions,
+ FCheckTokenExist,
+ FGetProperties,
+ > where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+ FIsAdmin: FnOnce() -> bool,
+ FPropertyPermissions: FnOnce() -> PropertiesPermissionMap,
+ FCheckTokenExist: Copy + FnOnce(TokenId) -> bool,
+ FGetProperties: Copy + FnOnce(TokenId) -> TokenProperties,
+{
+ /// A function to write properties to a **newly created** token.
+ pub fn write_token_properties(
+ &mut self,
+ mint_target_is_sender: bool,
+ token_id: TokenId,
+ properties_updates: impl Iterator<Item = Property>,
+ log: evm_coder::ethereum::Log,
+ ) -> DispatchResult {
+ self.internal_write_token_properties(
+ token_id,
+ properties_updates.map(|p| (p.key, Some(p.value))),
+ |_| Ok(mint_target_is_sender),
+ log,
+ )
+ }
+}
+
+impl<'a, T, Handle, FIsAdmin, FPropertyPermissions, FCheckTokenExist, FGetProperties>
+ PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ ExistingTokenPropertyWriter,
+ FIsAdmin,
+ FPropertyPermissions,
+ FCheckTokenExist,
+ FGetProperties,
+ > where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+ FIsAdmin: FnOnce() -> bool,
+ FPropertyPermissions: FnOnce() -> PropertiesPermissionMap,
+ FCheckTokenExist: Copy + FnOnce(TokenId) -> bool,
+ FGetProperties: Copy + FnOnce(TokenId) -> TokenProperties,
+{
+ /// A function to write properties to an **already existing** token.
+ pub fn write_token_properties(
+ &mut self,
+ sender: &T::CrossAccountId,
+ token_id: TokenId,
+ properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
+ nesting_budget: &dyn Budget,
+ log: evm_coder::ethereum::Log,
+ ) -> DispatchResult {
+ self.internal_write_token_properties(
+ token_id,
+ properties_updates,
+ |collection| collection.check_token_indirect_owner(token_id, sender, nesting_budget),
+ log,
+ )
+ }
+}
+
+impl<
+ 'a,
+ T,
+ Handle,
+ WriterVariant,
+ FIsAdmin,
+ FPropertyPermissions,
+ FCheckTokenExist,
+ FGetProperties,
+ >
+ PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ WriterVariant,
+ FIsAdmin,
+ FPropertyPermissions,
+ FCheckTokenExist,
+ FGetProperties,
+ > where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+ FIsAdmin: FnOnce() -> bool,
+ FPropertyPermissions: FnOnce() -> PropertiesPermissionMap,
+ FCheckTokenExist: Copy + FnOnce(TokenId) -> bool,
+ FGetProperties: Copy + FnOnce(TokenId) -> TokenProperties,
+{
+ fn internal_write_token_properties<FCheckTokenOwner>(
+ &mut self,
+ token_id: TokenId,
+ properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
+ check_token_owner: FCheckTokenOwner,
+ log: evm_coder::ethereum::Log,
+ ) -> DispatchResult
+ where
+ FCheckTokenOwner: FnOnce(&Handle) -> Result<bool, DispatchError>,
+ {
+ let get_properties = self.get_properties;
+ let mut stored_properties = LazyValue::new(move || get_properties(token_id));
+
+ let mut is_token_owner = LazyValue::new(|| check_token_owner(self.collection));
+
+ let check_token_exist = self.check_token_exist;
+ let mut is_token_exist = LazyValue::new(move || check_token_exist(token_id));
+
+ for (key, value) in properties_updates {
+ let permission = self
+ .property_permissions
+ .value()
+ .get(&key)
+ .cloned()
+ .unwrap_or_else(PropertyPermission::none);
+
+ match permission {
+ PropertyPermission { mutable: false, .. }
+ if stored_properties.value().get(&key).is_some() =>
+ {
+ return Err(<Error<T>>::NoPermission.into());
+ }
+
+ PropertyPermission {
+ collection_admin,
+ token_owner,
+ ..
+ } => check_token_permissions::<T, _, _, _>(
+ collection_admin,
+ token_owner,
+ &mut self.is_collection_admin,
+ &mut is_token_owner,
+ &mut is_token_exist,
+ )?,
+ }
+
+ match value {
+ Some(value) => {
+ stored_properties
+ .value_mut()
+ .try_set(key.clone(), value)
+ .map_err(<Error<T>>::from)?;
+
+ <Pallet<T>>::deposit_event(Event::TokenPropertySet(
+ self.collection.id,
+ token_id,
+ key,
+ ));
+ }
+ None => {
+ stored_properties
+ .value_mut()
+ .remove(&key)
+ .map_err(<Error<T>>::from)?;
+
+ <Pallet<T>>::deposit_event(Event::TokenPropertyDeleted(
+ self.collection.id,
+ token_id,
+ key,
+ ));
+ }
+ }
+ }
+
+ let properties_changed = stored_properties.has_value();
+ if properties_changed {
+ <PalletEvm<T>>::deposit_log(log);
+
+ self.collection
+ .set_token_properties_map(token_id, stored_properties.into_inner());
+ }
+
+ Ok(())
+ }
+}
+
+/// Create a [`PropertyWriter`] for newly created tokens.
+pub fn property_writer_for_new_token<'a, T, Handle>(
+ collection: &'a Handle,
+ sender: &'a T::CrossAccountId,
+) -> PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ NewTokenPropertyWriter,
+ impl FnOnce() -> bool + 'a,
+ impl FnOnce() -> PropertiesPermissionMap + 'a,
+ impl Copy + FnOnce(TokenId) -> bool + 'a,
+ impl Copy + FnOnce(TokenId) -> TokenProperties + 'a,
+>
+where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+{
+ PropertyWriter {
+ collection,
+ is_collection_admin: LazyValue::new(|| collection.is_owner_or_admin(sender)),
+ property_permissions: LazyValue::new(|| <Pallet<T>>::property_permissions(collection.id)),
+ check_token_exist: |token_id| {
+ debug_assert!(collection.token_exists(token_id));
+ true
+ },
+ get_properties: |token_id| {
+ debug_assert!(!collection.properties_exist(token_id));
+ TokenProperties::new()
+ },
+ _phantom: PhantomData,
+ }
+}
+
+#[cfg(feature = "runtime-benchmarks")]
+/// Create a `PropertyWriter` with preloaded `is_collection_admin` and `property_permissions.
+/// Also:
+/// * it will return `true` for the token ownership check.
+/// * it will return empty stored properties without reading them from the storage.
+pub fn collection_info_loaded_property_writer<T, Handle>(
+ collection: &Handle,
+ is_collection_admin: bool,
+ property_permissions: PropertiesPermissionMap,
+) -> PropertyWriter<
+ T,
+ Handle,
+ NewTokenPropertyWriter,
+ impl FnOnce() -> bool,
+ impl FnOnce() -> PropertiesPermissionMap,
+ impl Copy + FnOnce(TokenId) -> bool,
+ impl Copy + FnOnce(TokenId) -> TokenProperties,
+>
+where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+{
+ PropertyWriter {
+ collection,
+ is_collection_admin: LazyValue::new(move || is_collection_admin),
+ property_permissions: LazyValue::new(move || property_permissions),
+ check_token_exist: |_token_id| true,
+ get_properties: |_token_id| TokenProperties::new(),
+ _phantom: PhantomData,
+ }
+}
+
+/// Create a [`PropertyWriter`] for already existing tokens.
+pub fn property_writer_for_existing_token<'a, T, Handle>(
+ collection: &'a Handle,
+ sender: &'a T::CrossAccountId,
+) -> PropertyWriter<
+ 'a,
+ T,
+ Handle,
+ ExistingTokenPropertyWriter,
+ impl FnOnce() -> bool + 'a,
+ impl FnOnce() -> PropertiesPermissionMap + 'a,
+ impl Copy + FnOnce(TokenId) -> bool + 'a,
+ impl Copy + FnOnce(TokenId) -> TokenProperties + 'a,
+>
+where
+ T: Config,
+ Handle: CommonCollectionOperations<T> + Deref<Target = CollectionHandle<T>>,
+{
+ PropertyWriter {
+ collection,
+ is_collection_admin: LazyValue::new(|| collection.is_owner_or_admin(sender)),
+ property_permissions: LazyValue::new(|| <Pallet<T>>::property_permissions(collection.id)),
+ check_token_exist: |token_id| collection.token_exists(token_id),
+ get_properties: |token_id| collection.get_token_properties_map(token_id),
+ _phantom: PhantomData,
+ }
+}
+
+/// Computes the weight delta for newly created tokens with properties.
+/// * `properties_nums` - The properties num of each created token.
+/// * `init_token_properties` - The function to obtain the weight from a token's properties num.
+pub fn init_token_properties_delta<T: Config, I: Fn(u32) -> Weight>(
+ properties_nums: impl Iterator<Item = u32>,
+ init_token_properties: I,
+) -> Weight {
+ let mut delta = properties_nums
+ .filter_map(|properties_num| {
+ if properties_num > 0 {
+ Some(init_token_properties(properties_num))
+ } else {
+ None
+ }
+ })
+ .fold(Weight::zero(), |a, b| a.saturating_add(b));
+
+ // If at least once the `init_token_properties` was called,
+ // it means at least one newly created token has properties.
+ // Becuase of that, some common collection data also was loaded and we need to add this weight.
+ // However, these common data was loaded only once which is guaranteed by the `PropertyWriter`.
+ if !delta.is_zero() {
+ delta = delta.saturating_add(<SelfWeightOf<T>>::init_token_properties_common())
+ }
+
+ delta
+}
+
#[cfg(any(feature = "tests", test))]
#[allow(missing_docs)]
pub mod tests {
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -25,7 +25,7 @@
weights::WeightInfo as _, SelfWeightOf as PalletCommonWeightOf,
};
use pallet_structure::Error as StructureError;
-use sp_runtime::ArithmeticError;
+use sp_runtime::{ArithmeticError, DispatchError};
use sp_std::{vec::Vec, vec};
use up_data_structs::{Property, PropertyKey, PropertyValue, PropertyKeyPermission};
@@ -364,6 +364,20 @@
fail!(<Error<T>>::SettingPropertiesNotAllowed)
}
+ fn get_token_properties_map(&self, _token_id: TokenId) -> up_data_structs::TokenProperties {
+ // No token properties are defined on fungibles
+ up_data_structs::TokenProperties::new()
+ }
+
+ fn set_token_properties_map(&self, _token_id: TokenId, _map: up_data_structs::TokenProperties) {
+ // No token properties are defined on fungibles
+ }
+
+ fn properties_exist(&self, _token: TokenId) -> bool {
+ // No token properties are defined on fungibles
+ false
+ }
+
fn check_nesting(
&self,
_sender: <T>::CrossAccountId,
@@ -402,6 +416,15 @@
Err(TokenOwnerError::MultipleOwners)
}
+ fn check_token_indirect_owner(
+ &self,
+ _token: TokenId,
+ _maybe_owner: &T::CrossAccountId,
+ _nesting_budget: &dyn Budget,
+ ) -> Result<bool, DispatchError> {
+ Ok(false)
+ }
+
/// Returns 10 tokens owners in no particular order.
fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId> {
<Pallet<T>>::token_owners(self.id, token).unwrap_or_default()
pallets/nonfungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/benchmarking.rs
+++ b/pallets/nonfungible/src/benchmarking.rs
@@ -20,7 +20,9 @@
use frame_benchmarking::{benchmarks, account};
use pallet_common::{
bench_init,
- benchmarking::{create_collection_raw, property_key, property_value},
+ benchmarking::{
+ create_collection_raw, property_key, property_value, load_is_admin_and_property_permissions,
+ },
CommonCollectionOperations,
};
use sp_std::prelude::*;
@@ -198,14 +200,15 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, owner.clone())?;
- }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::ExistingToken, &Unlimited)?}
+ }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), &Unlimited)?}
- reset_token_properties {
+ init_token_properties {
let b in 0..MAX_PROPERTIES_PER_ITEM;
bench_init!{
owner: sub; collection: collection(owner);
owner: cross_from_sub;
};
+
let perms = (0..b).map(|k| PropertyKeyPermission {
key: property_key(k as usize),
permission: PropertyPermission {
@@ -220,8 +223,26 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, owner.clone())?;
- }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::NewToken { mint_target_is_sender: true }, &Unlimited)?}
+ let (is_collection_admin, property_permissions) = load_is_admin_and_property_permissions(&collection, &owner);
+ }: {
+ let mut property_writer = pallet_common::collection_info_loaded_property_writer(
+ &collection,
+ is_collection_admin,
+ property_permissions,
+ );
+
+ property_writer.write_token_properties(
+ true,
+ item,
+ props.into_iter(),
+ crate::erc::ERC721TokenEvent::TokenChanged {
+ token_id: item.into(),
+ }
+ .to_log(T::ContractAddress::get()),
+ )?
+ }
+
delete_token_properties {
let b in 0..MAX_PROPERTIES_PER_ITEM;
bench_init!{
@@ -242,7 +263,7 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, owner.clone())?;
- <Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::ExistingToken, &Unlimited)?;
+ <Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), &Unlimited)?;
let to_delete = (0..b).map(|k| property_key(k as usize)).collect::<Vec<_>>();
}: {<Pallet<T>>::delete_token_properties(&collection, &owner, item, to_delete.into_iter(), &Unlimited)?}
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -23,49 +23,40 @@
};
use pallet_common::{
CommonCollectionOperations, CommonWeightInfo, RefungibleExtensions, with_weight,
- weights::WeightInfo as _, SelfWeightOf as PalletCommonWeightOf,
+ weights::WeightInfo as _, SelfWeightOf as PalletCommonWeightOf, init_token_properties_delta,
};
+use pallet_structure::Pallet as PalletStructure;
use sp_runtime::DispatchError;
use sp_std::{vec::Vec, vec};
use crate::{
AccountBalance, Allowance, Config, CreateItemData, Error, NonfungibleHandle, Owned, Pallet,
- SelfWeightOf, TokenData, weights::WeightInfo, TokensMinted,
+ SelfWeightOf, TokenData, weights::WeightInfo, TokensMinted, TokenProperties,
};
pub struct CommonWeights<T: Config>(PhantomData<T>);
impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
fn create_multiple_items_ex(data: &CreateItemExData<T::CrossAccountId>) -> Weight {
match data {
- CreateItemExData::NFT(t) => {
- <SelfWeightOf<T>>::create_multiple_items_ex(t.len() as u32)
- + t.iter()
- .filter_map(|t| {
- if t.properties.len() > 0 {
- Some(<SelfWeightOf<T>>::reset_token_properties(
- t.properties.len() as u32,
- ))
- } else {
- None
- }
- })
- .fold(Weight::zero(), |a, b| a.saturating_add(b))
- }
+ CreateItemExData::NFT(t) => <SelfWeightOf<T>>::create_multiple_items_ex(t.len() as u32)
+ .saturating_add(init_token_properties_delta::<T, _>(
+ t.iter().map(|t| t.properties.len() as u32),
+ <SelfWeightOf<T>>::init_token_properties,
+ )),
_ => Weight::zero(),
}
}
fn create_multiple_items(data: &[up_data_structs::CreateItemData]) -> Weight {
- <SelfWeightOf<T>>::create_multiple_items(data.len() as u32)
- + data
- .iter()
- .filter_map(|t| match t {
- up_data_structs::CreateItemData::NFT(n) if n.properties.len() > 0 => Some(
- <SelfWeightOf<T>>::reset_token_properties(n.properties.len() as u32),
- ),
- _ => None,
- })
- .fold(Weight::zero(), |a, b| a.saturating_add(b))
+ <SelfWeightOf<T>>::create_multiple_items(data.len() as u32).saturating_add(
+ init_token_properties_delta::<T, _>(
+ data.iter().map(|t| match t {
+ up_data_structs::CreateItemData::NFT(n) => n.properties.len() as u32,
+ _ => 0,
+ }),
+ <SelfWeightOf<T>>::init_token_properties,
+ ),
+ )
}
fn burn_item() -> Weight {
@@ -247,7 +238,6 @@
&sender,
token_id,
properties.into_iter(),
- pallet_common::SetPropertyMode::ExistingToken,
nesting_budget,
),
weight,
@@ -275,6 +265,14 @@
)
}
+ fn get_token_properties_map(&self, token_id: TokenId) -> up_data_structs::TokenProperties {
+ <TokenProperties<T>>::get((self.id, token_id))
+ }
+
+ fn set_token_properties_map(&self, token_id: TokenId, map: up_data_structs::TokenProperties) {
+ <TokenProperties<T>>::set((self.id, token_id), map)
+ }
+
fn set_token_property_permissions(
&self,
sender: &T::CrossAccountId,
@@ -289,6 +287,10 @@
)
}
+ fn properties_exist(&self, token: TokenId) -> bool {
+ <TokenProperties<T>>::contains_key((self.id, token))
+ }
+
fn burn_item(
&self,
sender: T::CrossAccountId,
@@ -459,6 +461,21 @@
.ok_or(TokenOwnerError::NotFound)
}
+ fn check_token_indirect_owner(
+ &self,
+ token: TokenId,
+ maybe_owner: &T::CrossAccountId,
+ nesting_budget: &dyn Budget,
+ ) -> Result<bool, DispatchError> {
+ <PalletStructure<T>>::check_indirectly_owned(
+ maybe_owner.clone(),
+ self.id,
+ token,
+ None,
+ nesting_budget,
+ )
+ }
+
/// Returns token owners.
fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId> {
self.token_owner(token).map_or_else(|_| vec![], |t| vec![t])
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -203,7 +203,6 @@
&caller,
TokenId(token_id),
properties.into_iter(),
- pallet_common::SetPropertyMode::ExistingToken,
&nesting_budget,
)
.map_err(dispatch_to_evm::<T>)
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -109,7 +109,7 @@
use pallet_common::{
Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,
eth::collection_id_to_address, SelfWeightOf as PalletCommonWeightOf,
- weights::WeightInfo as CommonWeightInfo, helpers::add_weight_to_post_info, SetPropertyMode,
+ weights::WeightInfo as CommonWeightInfo, helpers::add_weight_to_post_info,
};
use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};
@@ -598,58 +598,16 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let mut is_token_owner = pallet_common::LazyValue::new(|| {
- if let SetPropertyMode::NewToken {
- mint_target_is_sender,
- } = mode
- {
- return Ok(mint_target_is_sender);
- }
-
- let is_owned = <PalletStructure<T>>::check_indirectly_owned(
- sender.clone(),
- collection.id,
- token_id,
- None,
- nesting_budget,
- )?;
-
- Ok(is_owned)
- });
-
- let is_new_token = matches!(mode, SetPropertyMode::NewToken { .. });
-
- let mut is_token_exist = pallet_common::LazyValue::new(|| {
- if is_new_token {
- debug_assert!(Self::token_exists(collection, token_id));
- true
- } else {
- Self::token_exists(collection, token_id)
- }
- });
-
- let stored_properties = if is_new_token {
- debug_assert!(!<TokenProperties<T>>::contains_key((
- collection.id,
- token_id
- )));
- TokenPropertiesT::new()
- } else {
- <TokenProperties<T>>::get((collection.id, token_id))
- };
+ let mut property_writer =
+ pallet_common::property_writer_for_existing_token(collection, sender);
- <PalletCommon<T>>::modify_token_properties(
- collection,
+ property_writer.write_token_properties(
sender,
token_id,
- &mut is_token_exist,
properties_updates,
- stored_properties,
- &mut is_token_owner,
- |properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
+ nesting_budget,
erc::ERC721TokenEvent::TokenChanged {
token_id: token_id.into(),
}
@@ -680,7 +638,6 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties: impl Iterator<Item = Property>,
- mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::modify_token_properties(
@@ -688,7 +645,6 @@
sender,
token_id,
properties.map(|p| (p.key, Some(p.value))),
- mode,
nesting_budget,
)
}
@@ -710,7 +666,6 @@
sender,
token_id,
[property].into_iter(),
- SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -732,7 +687,6 @@
sender,
token_id,
property_keys.into_iter().map(|key| (key, None)),
- SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -994,6 +948,8 @@
// =========
+ let mut property_writer = pallet_common::property_writer_for_new_token(collection, sender);
+
with_transaction(|| {
for (i, data) in data.iter().enumerate() {
let token = first_token + i as u32 + 1;
@@ -1006,21 +962,22 @@
},
);
+ let token = TokenId(token);
+
<PalletStructure<T>>::nest_if_sent_to_token_unchecked(
&data.owner,
collection.id,
- TokenId(token),
+ token,
);
- if let Err(e) = Self::set_token_properties(
- collection,
- sender,
- TokenId(token),
+ if let Err(e) = property_writer.write_token_properties(
+ sender.conv_eq(&data.owner),
+ token,
data.properties.clone().into_iter(),
- SetPropertyMode::NewToken {
- mint_target_is_sender: sender.conv_eq(&data.owner),
- },
- nesting_budget,
+ erc::ERC721TokenEvent::TokenChanged {
+ token_id: token.into(),
+ }
+ .to_log(T::ContractAddress::get()),
) {
return TransactionOutcome::Rollback(Err(e));
}
pallets/refungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/refungible/src/benchmarking.rs
+++ b/pallets/refungible/src/benchmarking.rs
@@ -22,7 +22,9 @@
use frame_benchmarking::{benchmarks, account};
use pallet_common::{
bench_init,
- benchmarking::{create_collection_raw, property_key, property_value},
+ benchmarking::{
+ create_collection_raw, property_key, property_value, load_is_admin_and_property_permissions,
+ },
};
use sp_std::prelude::*;
use up_data_structs::{
@@ -255,14 +257,15 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, [(owner.clone(), 200)])?;
- }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::ExistingToken, &Unlimited)?}
+ }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), &Unlimited)?}
- reset_token_properties {
+ init_token_properties {
let b in 0..MAX_PROPERTIES_PER_ITEM;
bench_init!{
owner: sub; collection: collection(owner);
owner: cross_from_sub;
};
+
let perms = (0..b).map(|k| PropertyKeyPermission {
key: property_key(k as usize),
permission: PropertyPermission {
@@ -277,8 +280,26 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, [(owner.clone(), 200)])?;
- }: {<Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::NewToken { mint_target_is_sender: true }, &Unlimited)?}
+ let (is_collection_admin, property_permissions) = load_is_admin_and_property_permissions(&collection, &owner);
+ }: {
+ let mut property_writer = pallet_common::collection_info_loaded_property_writer(
+ &collection,
+ is_collection_admin,
+ property_permissions,
+ );
+
+ property_writer.write_token_properties(
+ true,
+ item,
+ props.into_iter(),
+ crate::erc::ERC721TokenEvent::TokenChanged {
+ token_id: item.into(),
+ }
+ .to_log(T::ContractAddress::get()),
+ )?
+ }
+
delete_token_properties {
let b in 0..MAX_PROPERTIES_PER_ITEM;
bench_init!{
@@ -299,7 +320,7 @@
value: property_value(),
}).collect::<Vec<_>>();
let item = create_max_item(&collection, &owner, [(owner.clone(), 200)])?;
- <Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), SetPropertyMode::ExistingToken, &Unlimited)?;
+ <Pallet<T>>::set_token_properties(&collection, &owner, item, props.into_iter(), &Unlimited)?;
let to_delete = (0..b).map(|k| property_key(k as usize)).collect::<Vec<_>>();
}: {<Pallet<T>>::delete_token_properties(&collection, &owner, item, to_delete.into_iter(), &Unlimited)?}
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -20,20 +20,20 @@
use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, traits::Get};
use up_data_structs::{
CollectionId, TokenId, CreateItemExData, budget::Budget, Property, PropertyKey, PropertyValue,
- PropertyKeyPermission, CollectionPropertiesVec, CreateRefungibleExMultipleOwners,
- CreateRefungibleExSingleOwner, TokenOwnerError,
+ PropertyKeyPermission, CreateRefungibleExMultipleOwners, CreateRefungibleExSingleOwner,
+ TokenOwnerError,
};
use pallet_common::{
CommonCollectionOperations, CommonWeightInfo, RefungibleExtensions, with_weight,
- weights::WeightInfo as _,
+ weights::WeightInfo as _, init_token_properties_delta,
};
-use pallet_structure::Error as StructureError;
+use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
use sp_runtime::{DispatchError};
use sp_std::{vec::Vec, vec};
use crate::{
AccountBalance, Allowance, Balance, Config, Error, Owned, Pallet, RefungibleHandle,
- SelfWeightOf, weights::WeightInfo, TokensMinted, TotalSupply, CreateItemData,
+ SelfWeightOf, weights::WeightInfo, TokensMinted, TotalSupply, CreateItemData, TokenProperties,
};
macro_rules! max_weight_of {
@@ -45,26 +45,19 @@
};
}
-fn properties_weight<T: Config>(properties: &CollectionPropertiesVec) -> Weight {
- if properties.len() > 0 {
- <SelfWeightOf<T>>::reset_token_properties(properties.len() as u32)
- } else {
- Weight::zero()
- }
-}
-
pub struct CommonWeights<T: Config>(PhantomData<T>);
impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
fn create_multiple_items(data: &[up_data_structs::CreateItemData]) -> Weight {
<SelfWeightOf<T>>::create_multiple_items(data.len() as u32).saturating_add(
- data.iter()
- .map(|data| match data {
+ init_token_properties_delta::<T, _>(
+ data.iter().map(|data| match data {
up_data_structs::CreateItemData::ReFungible(rft_data) => {
- properties_weight::<T>(&rft_data.properties)
+ rft_data.properties.len() as u32
}
- _ => Weight::zero(),
- })
- .fold(Weight::zero(), |a, b| a.saturating_add(b)),
+ _ => 0,
+ }),
+ <SelfWeightOf<T>>::init_token_properties,
+ ),
)
}
@@ -72,15 +65,17 @@
match call {
CreateItemExData::RefungibleMultipleOwners(i) => {
<SelfWeightOf<T>>::create_multiple_items_ex_multiple_owners(i.users.len() as u32)
- .saturating_add(properties_weight::<T>(&i.properties))
+ .saturating_add(init_token_properties_delta::<T, _>(
+ [i.properties.len() as u32].into_iter(),
+ <SelfWeightOf<T>>::init_token_properties,
+ ))
}
CreateItemExData::RefungibleMultipleItems(i) => {
<SelfWeightOf<T>>::create_multiple_items_ex_multiple_items(i.len() as u32)
- .saturating_add(
- i.iter()
- .map(|d| properties_weight::<T>(&d.properties))
- .fold(Weight::zero(), |a, b| a.saturating_add(b)),
- )
+ .saturating_add(init_token_properties_delta::<T, _>(
+ i.iter().map(|d| d.properties.len() as u32),
+ <SelfWeightOf<T>>::init_token_properties,
+ ))
}
_ => Weight::zero(),
}
@@ -399,7 +394,6 @@
&sender,
token_id,
properties.into_iter(),
- pallet_common::SetPropertyMode::ExistingToken,
nesting_budget,
),
weight,
@@ -441,6 +435,18 @@
)
}
+ fn get_token_properties_map(&self, token_id: TokenId) -> up_data_structs::TokenProperties {
+ <TokenProperties<T>>::get((self.id, token_id))
+ }
+
+ fn set_token_properties_map(&self, token_id: TokenId, map: up_data_structs::TokenProperties) {
+ <TokenProperties<T>>::set((self.id, token_id), map)
+ }
+
+ fn properties_exist(&self, token: TokenId) -> bool {
+ <TokenProperties<T>>::contains_key((self.id, token))
+ }
+
fn check_nesting(
&self,
_sender: <T>::CrossAccountId,
@@ -479,6 +485,29 @@
<Pallet<T>>::token_owner(self.id, token)
}
+ fn check_token_indirect_owner(
+ &self,
+ token: TokenId,
+ maybe_owner: &T::CrossAccountId,
+ nesting_budget: &dyn Budget,
+ ) -> Result<bool, DispatchError> {
+ let balance = self.balance(maybe_owner.clone(), token);
+ let total_pieces: u128 = <Pallet<T>>::total_pieces(self.id, token).unwrap_or(u128::MAX);
+ if balance != total_pieces {
+ return Ok(false);
+ }
+
+ let is_bundle_owner = <PalletStructure<T>>::check_indirectly_owned(
+ maybe_owner.clone(),
+ self.id,
+ token,
+ None,
+ nesting_budget,
+ )?;
+
+ Ok(is_bundle_owner)
+ }
+
/// Returns 10 token in no particular order.
fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId> {
<Pallet<T>>::token_owners(self.id, token).unwrap_or_default()
pallets/refungible/src/erc.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//! # Refungible Pallet EVM API for tokens18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Refungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Refungible Pallet methods.2122extern crate alloc;2324use alloc::string::ToString;25use core::{26 char::{REPLACEMENT_CHARACTER, decode_utf16},27 convert::TryInto,28};29use evm_coder::{abi::AbiType, AbiCoder, ToLog, generate_stubgen, solidity_interface, types::*};30use frame_support::{BoundedBTreeMap, BoundedVec};31use pallet_common::{32 CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,33 Error as CommonError,34 erc::{CommonEvmHandler, CollectionCall, static_property::key},35 eth::{self, TokenUri},36};37use pallet_evm::{account::CrossAccountId, PrecompileHandle};38use pallet_evm_coder_substrate::{39 call, dispatch_to_evm,40 execution::{PreDispatch, Result, Error},41 frontier_contract,42};43use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};44use sp_core::{H160, U256, Get};45use sp_std::{collections::btree_map::BTreeMap, vec::Vec, vec};46use up_data_structs::{47 CollectionId, CollectionPropertiesVec, mapping::TokenAddressMapping, Property, PropertyKey,48 PropertyKeyPermission, PropertyPermission, TokenId, TokenOwnerError,49};5051use crate::{52 AccountBalance, Balance, Config, CreateItemData, Pallet, RefungibleHandle, TokenProperties,53 TokensMinted, TotalSupply, SelfWeightOf, weights::WeightInfo,54};5556frontier_contract! {57 macro_rules! RefungibleHandle_result {...}58 impl<T: Config> Contract for RefungibleHandle<T> {...}59}6061pub const ADDRESS_FOR_PARTIALLY_OWNED_TOKENS: H160 = H160::repeat_byte(0xff);6263/// Rft events.64#[derive(ToLog)]65pub enum ERC721TokenEvent {66 /// The token has been changed.67 TokenChanged {68 /// Token ID.69 #[indexed]70 token_id: U256,71 },72}7374/// Token minting parameters75#[derive(AbiCoder, Default, Debug)]76pub struct OwnerPieces {77 /// Minted token owner78 pub owner: eth::CrossAddress,79 /// Number of token pieces80 pub pieces: u128,81}8283/// Token minting parameters84#[derive(AbiCoder, Default, Debug)]85pub struct MintTokenData {86 /// Minted token owner and number of pieces87 pub owners: Vec<OwnerPieces>,88 /// Minted token properties89 pub properties: Vec<eth::Property>,90}9192/// @title A contract that allows to set and delete token properties and change token property permissions.93#[solidity_interface(name = TokenProperties, events(ERC721TokenEvent), enum(derive(PreDispatch)), enum_attr(weight))]94impl<T: Config> RefungibleHandle<T> {95 /// @notice Set permissions for token property.96 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.97 /// @param key Property key.98 /// @param isMutable Permission to mutate property.99 /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.100 /// @param tokenOwner Permission to mutate property by token owner if property is mutable.101 #[solidity(hide)]102 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(1))]103 fn set_token_property_permission(104 &mut self,105 caller: Caller,106 key: String,107 is_mutable: bool,108 collection_admin: bool,109 token_owner: bool,110 ) -> Result<()> {111 let caller = T::CrossAccountId::from_eth(caller);112 <Pallet<T>>::set_token_property_permissions(113 self,114 &caller,115 vec![PropertyKeyPermission {116 key: <Vec<u8>>::from(key)117 .try_into()118 .map_err(|_| "too long key")?,119 permission: PropertyPermission {120 mutable: is_mutable,121 collection_admin,122 token_owner,123 },124 }],125 )126 .map_err(dispatch_to_evm::<T>)127 }128129 /// @notice Set permissions for token property.130 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.131 /// @param permissions Permissions for keys.132 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(permissions.len() as u32))]133 fn set_token_property_permissions(134 &mut self,135 caller: Caller,136 permissions: Vec<eth::TokenPropertyPermission>,137 ) -> Result<()> {138 let caller = T::CrossAccountId::from_eth(caller);139 let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;140141 <Pallet<T>>::set_token_property_permissions(self, &caller, perms)142 .map_err(dispatch_to_evm::<T>)143 }144145 /// @notice Get permissions for token properties.146 fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {147 let perms = <Pallet<T>>::token_property_permission(self.id);148 Ok(perms149 .into_iter()150 .map(eth::TokenPropertyPermission::from)151 .collect())152 }153154 /// @notice Set token property value.155 /// @dev Throws error if `msg.sender` has no permission to edit the property.156 /// @param tokenId ID of the token.157 /// @param key Property key.158 /// @param value Property value.159 #[solidity(hide)]160 #[weight(<SelfWeightOf<T>>::set_token_properties(1))]161 fn set_property(162 &mut self,163 caller: Caller,164 token_id: U256,165 key: String,166 value: Bytes,167 ) -> Result<()> {168 let caller = T::CrossAccountId::from_eth(caller);169 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;170 let key = <Vec<u8>>::from(key)171 .try_into()172 .map_err(|_| "key too long")?;173 let value = value.0.try_into().map_err(|_| "value too long")?;174175 let nesting_budget = self176 .recorder177 .weight_calls_budget(<StructureWeight<T>>::find_parent());178179 <Pallet<T>>::set_token_property(180 self,181 &caller,182 TokenId(token_id),183 Property { key, value },184 &nesting_budget,185 )186 .map_err(dispatch_to_evm::<T>)187 }188189 /// @notice Set token properties value.190 /// @dev Throws error if `msg.sender` has no permission to edit the property.191 /// @param tokenId ID of the token.192 /// @param properties settable properties193 #[weight(<SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]194 fn set_properties(195 &mut self,196 caller: Caller,197 token_id: U256,198 properties: Vec<eth::Property>,199 ) -> Result<()> {200 let caller = T::CrossAccountId::from_eth(caller);201 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;202203 let nesting_budget = self204 .recorder205 .weight_calls_budget(<StructureWeight<T>>::find_parent());206207 let properties = properties208 .into_iter()209 .map(eth::Property::try_into)210 .collect::<Result<Vec<_>>>()?;211212 <Pallet<T>>::set_token_properties(213 self,214 &caller,215 TokenId(token_id),216 properties.into_iter(),217 pallet_common::SetPropertyMode::ExistingToken,218 &nesting_budget,219 )220 .map_err(dispatch_to_evm::<T>)221 }222223 /// @notice Delete token property value.224 /// @dev Throws error if `msg.sender` has no permission to edit the property.225 /// @param tokenId ID of the token.226 /// @param key Property key.227 #[solidity(hide)]228 #[weight(<SelfWeightOf<T>>::delete_token_properties(1))]229 fn delete_property(&mut self, token_id: U256, caller: Caller, key: String) -> Result<()> {230 let caller = T::CrossAccountId::from_eth(caller);231 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;232 let key = <Vec<u8>>::from(key)233 .try_into()234 .map_err(|_| "key too long")?;235236 let nesting_budget = self237 .recorder238 .weight_calls_budget(<StructureWeight<T>>::find_parent());239240 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)241 .map_err(dispatch_to_evm::<T>)242 }243244 /// @notice Delete token properties value.245 /// @dev Throws error if `msg.sender` has no permission to edit the property.246 /// @param tokenId ID of the token.247 /// @param keys Properties key.248 #[weight(<SelfWeightOf<T>>::delete_token_properties(keys.len() as u32))]249 fn delete_properties(250 &mut self,251 token_id: U256,252 caller: Caller,253 keys: Vec<String>,254 ) -> Result<()> {255 let caller = T::CrossAccountId::from_eth(caller);256 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;257 let keys = keys258 .into_iter()259 .map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))260 .collect::<Result<Vec<_>>>()?;261262 let nesting_budget = self263 .recorder264 .weight_calls_budget(<StructureWeight<T>>::find_parent());265266 <Pallet<T>>::delete_token_properties(267 self,268 &caller,269 TokenId(token_id),270 keys.into_iter(),271 &nesting_budget,272 )273 .map_err(dispatch_to_evm::<T>)274 }275276 /// @notice Get token property value.277 /// @dev Throws error if key not found278 /// @param tokenId ID of the token.279 /// @param key Property key.280 /// @return Property value bytes281 fn property(&self, token_id: U256, key: String) -> Result<Bytes> {282 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;283 let key = <Vec<u8>>::from(key)284 .try_into()285 .map_err(|_| "key too long")?;286287 let props = <TokenProperties<T>>::get((self.id, token_id));288 let prop = props.get(&key).ok_or("key not found")?;289290 Ok(prop.to_vec().into())291 }292}293294#[derive(ToLog)]295pub enum ERC721Events {296 /// @dev This event emits when NFTs are created (`from` == 0) and destroyed297 /// (`to` == 0). Exception: during contract creation, any number of RFTs298 /// may be created and assigned without emitting Transfer.299 Transfer {300 #[indexed]301 from: Address,302 #[indexed]303 to: Address,304 #[indexed]305 token_id: U256,306 },307 /// @dev Not supported308 Approval {309 #[indexed]310 owner: Address,311 #[indexed]312 approved: Address,313 #[indexed]314 token_id: U256,315 },316 /// @dev Not supported317 #[allow(dead_code)]318 ApprovalForAll {319 #[indexed]320 owner: Address,321 #[indexed]322 operator: Address,323 approved: bool,324 },325}326327/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension328/// @dev See https://eips.ethereum.org/EIPS/eip-721329#[solidity_interface(name = ERC721Metadata, enum(derive(PreDispatch)), expect_selector = 0x5b5e139f)]330impl<T: Config> RefungibleHandle<T>331where332 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,333{334 /// @notice A descriptive name for a collection of NFTs in this contract335 /// @dev real implementation of this function lies in `ERC721UniqueExtensions`336 #[solidity(hide, rename_selector = "name")]337 fn name_proxy(&self) -> Result<String> {338 self.name()339 }340341 /// @notice An abbreviated name for NFTs in this contract342 /// @dev real implementation of this function lies in `ERC721UniqueExtensions`343 #[solidity(hide, rename_selector = "symbol")]344 fn symbol_proxy(&self) -> Result<String> {345 self.symbol()346 }347348 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.349 ///350 /// @dev If the token has a `url` property and it is not empty, it is returned.351 /// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.352 /// If the collection property `baseURI` is empty or absent, return "" (empty string)353 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix354 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).355 ///356 /// @return token's const_metadata357 #[solidity(rename_selector = "tokenURI")]358 fn token_uri(&self, token_id: U256) -> Result<String> {359 let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;360361 match get_token_property(self, token_id_u32, &key::url()).as_deref() {362 Err(_) | Ok("") => (),363 Ok(url) => {364 return Ok(url.into());365 }366 };367368 let base_uri =369 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())370 .map(BoundedVec::into_inner)371 .map(String::from_utf8)372 .transpose()373 .map_err(|e| {374 Error::Revert(alloc::format!(375 "Can not convert value \"baseURI\" to string with error \"{e}\""376 ))377 })?;378379 let base_uri = match base_uri.as_deref() {380 None | Some("") => {381 return Ok("".into());382 }383 Some(base_uri) => base_uri.into(),384 };385386 Ok(387 match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {388 Err(_) | Ok("") => base_uri,389 Ok(suffix) => base_uri + suffix,390 },391 )392 }393}394395/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension396/// @dev See https://eips.ethereum.org/EIPS/eip-721397#[solidity_interface(name = ERC721Enumerable, enum(derive(PreDispatch)), expect_selector = 0x780e9d63)]398impl<T: Config> RefungibleHandle<T> {399 /// @notice Enumerate valid RFTs400 /// @param index A counter less than `totalSupply()`401 /// @return The token identifier for the `index`th NFT,402 /// (sort order not specified)403 fn token_by_index(&self, index: U256) -> U256 {404 index405 }406407 /// Not implemented408 fn token_of_owner_by_index(&self, _owner: Address, _index: U256) -> Result<U256> {409 // TODO: Not implemetable410 Err("not implemented".into())411 }412413 /// @notice Count RFTs tracked by this contract414 /// @return A count of valid RFTs tracked by this contract, where each one of415 /// them has an assigned and queryable owner not equal to the zero address416 fn total_supply(&self) -> Result<U256> {417 self.consume_store_reads(1)?;418 Ok(<Pallet<T>>::total_supply(self).into())419 }420}421422/// @title ERC-721 Non-Fungible Token Standard423/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md424#[solidity_interface(name = ERC721, events(ERC721Events), enum(derive(PreDispatch)), enum_attr(weight), expect_selector = 0x80ac58cd)]425impl<T: Config> RefungibleHandle<T> {426 /// @notice Count all RFTs assigned to an owner427 /// @dev RFTs assigned to the zero address are considered invalid, and this428 /// function throws for queries about the zero address.429 /// @param owner An address for whom to query the balance430 /// @return The number of RFTs owned by `owner`, possibly zero431 fn balance_of(&self, owner: Address) -> Result<U256> {432 self.consume_store_reads(1)?;433 let owner = T::CrossAccountId::from_eth(owner);434 let balance = <AccountBalance<T>>::get((self.id, owner));435 Ok(balance.into())436 }437438 /// @notice Find the owner of an RFT439 /// @dev RFTs assigned to zero address are considered invalid, and queries440 /// about them do throw.441 /// Returns special 0xffffffffffffffffffffffffffffffffffffffff address for442 /// the tokens that are partially owned.443 /// @param tokenId The identifier for an RFT444 /// @return The address of the owner of the RFT445 fn owner_of(&self, token_id: U256) -> Result<Address> {446 self.consume_store_reads(2)?;447 let token = token_id.try_into()?;448 let owner = <Pallet<T>>::token_owner(self.id, token);449 owner450 .map(|address| *address.as_eth())451 .or_else(|err| match err {452 TokenOwnerError::NotFound => Err(Error::Revert("token not found".into())),453 TokenOwnerError::MultipleOwners => Ok(ADDRESS_FOR_PARTIALLY_OWNED_TOKENS),454 })455 }456457 /// @dev Not implemented458 #[solidity(rename_selector = "safeTransferFrom")]459 fn safe_transfer_from_with_data(460 &mut self,461 _from: Address,462 _to: Address,463 _token_id: U256,464 _data: Bytes,465 ) -> Result<()> {466 // TODO: Not implemetable467 Err("not implemented".into())468 }469470 /// @dev Not implemented471 #[solidity(rename_selector = "safeTransferFrom")]472 fn safe_transfer_from(&mut self, _from: Address, _to: Address, _token_id: U256) -> Result<()> {473 // TODO: Not implemetable474 Err("not implemented".into())475 }476477 /// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE478 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE479 /// THEY MAY BE PERMANENTLY LOST480 /// @dev Throws unless `msg.sender` is the current owner or an authorized481 /// operator for this RFT. Throws if `from` is not the current owner. Throws482 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.483 /// Throws if RFT pieces have multiple owners.484 /// @param from The current owner of the NFT485 /// @param to The new owner486 /// @param tokenId The NFT to transfer487 #[weight(<SelfWeightOf<T>>::transfer_from_creating_removing())]488 fn transfer_from(489 &mut self,490 caller: Caller,491 from: Address,492 to: Address,493 token_id: U256,494 ) -> Result<()> {495 let caller = T::CrossAccountId::from_eth(caller);496 let from = T::CrossAccountId::from_eth(from);497 let to = T::CrossAccountId::from_eth(to);498 let token = token_id.try_into()?;499 let budget = self500 .recorder501 .weight_calls_budget(<StructureWeight<T>>::find_parent());502503 let balance = balance(self, token, &from)?;504 ensure_single_owner(self, token, balance)?;505506 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, balance, &budget)507 .map_err(dispatch_to_evm::<T>)?;508509 Ok(())510 }511512 /// @dev Not implemented513 fn approve(&mut self, _caller: Caller, _approved: Address, _token_id: U256) -> Result<()> {514 Err("not implemented".into())515 }516517 /// @notice Sets or unsets the approval of a given operator.518 /// The `operator` is allowed to transfer all token pieces of the `caller` on their behalf.519 /// @param operator Operator520 /// @param approved Should operator status be granted or revoked?521 #[weight(<SelfWeightOf<T>>::set_allowance_for_all())]522 fn set_approval_for_all(523 &mut self,524 caller: Caller,525 operator: Address,526 approved: bool,527 ) -> Result<()> {528 let caller = T::CrossAccountId::from_eth(caller);529 let operator = T::CrossAccountId::from_eth(operator);530531 <Pallet<T>>::set_allowance_for_all(self, &caller, &operator, approved)532 .map_err(dispatch_to_evm::<T>)?;533 Ok(())534 }535536 /// @dev Not implemented537 fn get_approved(&self, _token_id: U256) -> Result<Address> {538 // TODO: Not implemetable539 Err("not implemented".into())540 }541542 /// @notice Tells whether the given `owner` approves the `operator`.543 #[weight(<SelfWeightOf<T>>::allowance_for_all())]544 fn is_approved_for_all(&self, owner: Address, operator: Address) -> Result<bool> {545 let owner = T::CrossAccountId::from_eth(owner);546 let operator = T::CrossAccountId::from_eth(operator);547548 Ok(<Pallet<T>>::allowance_for_all(self, &owner, &operator))549 }550}551552/// Returns amount of pieces of `token` that `owner` have553pub fn balance<T: Config>(554 collection: &RefungibleHandle<T>,555 token: TokenId,556 owner: &T::CrossAccountId,557) -> Result<u128> {558 collection.consume_store_reads(1)?;559 let balance = <Balance<T>>::get((collection.id, token, &owner));560 Ok(balance)561}562563/// Throws if `owner_balance` is lower than total amount of `token` pieces564pub fn ensure_single_owner<T: Config>(565 collection: &RefungibleHandle<T>,566 token: TokenId,567 owner_balance: u128,568) -> Result<()> {569 collection.consume_store_reads(1)?;570 let total_supply = <TotalSupply<T>>::get((collection.id, token));571572 if owner_balance == 0 {573 return Err(dispatch_to_evm::<T>(574 <CommonError<T>>::MustBeTokenOwner.into(),575 ));576 }577578 if total_supply != owner_balance {579 return Err("token has multiple owners".into());580 }581 Ok(())582}583584/// @title ERC721 Token that can be irreversibly burned (destroyed).585#[solidity_interface(name = ERC721Burnable, enum(derive(PreDispatch)), enum_attr(weight))]586impl<T: Config> RefungibleHandle<T> {587 /// @notice Burns a specific ERC721 token.588 /// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized589 /// operator of the current owner.590 /// @param tokenId The RFT to approve591 #[weight(<SelfWeightOf<T>>::burn_item_fully())]592 fn burn(&mut self, caller: Caller, token_id: U256) -> Result<()> {593 let caller = T::CrossAccountId::from_eth(caller);594 let token = token_id.try_into()?;595596 let balance = balance(self, token, &caller)?;597 ensure_single_owner(self, token, balance)?;598599 <Pallet<T>>::burn(self, &caller, token, balance).map_err(dispatch_to_evm::<T>)?;600 Ok(())601 }602}603604/// @title ERC721 minting logic.605#[solidity_interface(name = ERC721UniqueMintable, enum(derive(PreDispatch)), enum_attr(weight))]606impl<T: Config> RefungibleHandle<T> {607 /// @notice Function to mint a token.608 /// @param to The new owner609 /// @return uint256 The id of the newly minted token610 #[weight(<SelfWeightOf<T>>::create_item())]611 fn mint(&mut self, caller: Caller, to: Address) -> Result<U256> {612 let token_id: U256 = <TokensMinted<T>>::get(self.id)613 .checked_add(1)614 .ok_or("item id overflow")?615 .into();616 self.mint_check_id(caller, to, token_id)?;617 Ok(token_id)618 }619620 /// @notice Function to mint a token.621 /// @dev `tokenId` should be obtained with `nextTokenId` method,622 /// unlike standard, you can't specify it manually623 /// @param to The new owner624 /// @param tokenId ID of the minted RFT625 #[solidity(hide, rename_selector = "mint")]626 #[weight(<SelfWeightOf<T>>::create_item())]627 fn mint_check_id(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<bool> {628 let caller = T::CrossAccountId::from_eth(caller);629 let to = T::CrossAccountId::from_eth(to);630 let token_id: u32 = token_id.try_into()?;631 let budget = self632 .recorder633 .weight_calls_budget(<StructureWeight<T>>::find_parent());634635 if <TokensMinted<T>>::get(self.id)636 .checked_add(1)637 .ok_or("item id overflow")?638 != token_id639 {640 return Err("item id should be next".into());641 }642643 let users = [(to, 1)]644 .into_iter()645 .collect::<BTreeMap<_, _>>()646 .try_into()647 .unwrap();648 <Pallet<T>>::create_item(649 self,650 &caller,651 CreateItemData::<T> {652 users,653 properties: CollectionPropertiesVec::default(),654 },655 &budget,656 )657 .map_err(dispatch_to_evm::<T>)?;658659 Ok(true)660 }661662 /// @notice Function to mint token with the given tokenUri.663 /// @param to The new owner664 /// @param tokenUri Token URI that would be stored in the NFT properties665 /// @return uint256 The id of the newly minted token666 #[solidity(rename_selector = "mintWithTokenURI")]667 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]668 fn mint_with_token_uri(669 &mut self,670 caller: Caller,671 to: Address,672 token_uri: String,673 ) -> Result<U256> {674 let token_id: U256 = <TokensMinted<T>>::get(self.id)675 .checked_add(1)676 .ok_or("item id overflow")?677 .into();678 self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;679 Ok(token_id)680 }681682 /// @notice Function to mint token with the given tokenUri.683 /// @dev `tokenId` should be obtained with `nextTokenId` method,684 /// unlike standard, you can't specify it manually685 /// @param to The new owner686 /// @param tokenId ID of the minted RFT687 /// @param tokenUri Token URI that would be stored in the RFT properties688 #[solidity(hide, rename_selector = "mintWithTokenURI")]689 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]690 fn mint_with_token_uri_check_id(691 &mut self,692 caller: Caller,693 to: Address,694 token_id: U256,695 token_uri: String,696 ) -> Result<bool> {697 let key = key::url();698 let permission = get_token_permission::<T>(self.id, &key)?;699 if !permission.collection_admin {700 return Err("Operation is not allowed".into());701 }702703 let caller = T::CrossAccountId::from_eth(caller);704 let to = T::CrossAccountId::from_eth(to);705 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;706 let budget = self707 .recorder708 .weight_calls_budget(<StructureWeight<T>>::find_parent());709710 if <TokensMinted<T>>::get(self.id)711 .checked_add(1)712 .ok_or("item id overflow")?713 != token_id714 {715 return Err("item id should be next".into());716 }717718 let mut properties = CollectionPropertiesVec::default();719 properties720 .try_push(Property {721 key,722 value: token_uri723 .into_bytes()724 .try_into()725 .map_err(|_| "token uri is too long")?,726 })727 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {e:?}")))?;728729 let users = [(to, 1)]730 .into_iter()731 .collect::<BTreeMap<_, _>>()732 .try_into()733 .unwrap();734 <Pallet<T>>::create_item(735 self,736 &caller,737 CreateItemData::<T> { users, properties },738 &budget,739 )740 .map_err(dispatch_to_evm::<T>)?;741 Ok(true)742 }743}744745fn get_token_property<T: Config>(746 collection: &CollectionHandle<T>,747 token_id: u32,748 key: &up_data_structs::PropertyKey,749) -> Result<String> {750 collection.consume_store_reads(1)?;751 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))752 .map_err(|_| Error::Revert("Token properties not found".into()))?;753 if let Some(property) = properties.get(key) {754 return Ok(String::from_utf8_lossy(property).into());755 }756757 Err("Property tokenURI not found".into())758}759760fn get_token_permission<T: Config>(761 collection_id: CollectionId,762 key: &PropertyKey,763) -> Result<PropertyPermission> {764 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)765 .map_err(|_| Error::Revert("No permissions for collection".into()))?;766 let a = token_property_permissions767 .get(key)768 .map(Clone::clone)769 .ok_or_else(|| {770 let key = String::from_utf8(key.clone().into_inner()).unwrap_or_default();771 Error::Revert(alloc::format!("No permission for key {key}"))772 })?;773 Ok(a)774}775776/// @title Unique extensions for ERC721.777#[solidity_interface(name = ERC721UniqueExtensions, enum(derive(PreDispatch)), enum_attr(weight))]778impl<T: Config> RefungibleHandle<T>779where780 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,781{782 /// @notice A descriptive name for a collection of NFTs in this contract783 fn name(&self) -> Result<String> {784 Ok(decode_utf16(self.name.iter().copied())785 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))786 .collect::<String>())787 }788789 /// @notice An abbreviated name for NFTs in this contract790 fn symbol(&self) -> Result<String> {791 Ok(String::from_utf8_lossy(&self.token_prefix).into())792 }793794 /// @notice A description for the collection.795 fn description(&self) -> Result<String> {796 Ok(decode_utf16(self.description.iter().copied())797 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))798 .collect::<String>())799 }800801 /// Returns the owner (in cross format) of the token.802 ///803 /// @param tokenId Id for the token.804 #[solidity(hide)]805 fn cross_owner_of(&self, token_id: U256) -> Result<eth::CrossAddress> {806 Self::owner_of_cross(self, token_id)807 }808809 /// Returns the owner (in cross format) of the token.810 ///811 /// @param tokenId Id for the token.812 fn owner_of_cross(&self, token_id: U256) -> Result<eth::CrossAddress> {813 Self::token_owner(self, token_id.try_into()?)814 .map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))815 .or_else(|err| match err {816 TokenOwnerError::NotFound => Err(Error::Revert("token not found".into())),817 TokenOwnerError::MultipleOwners => Ok(eth::CrossAddress::from_eth(818 ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,819 )),820 })821 }822823 /// @notice Count all RFTs assigned to an owner824 /// @param owner An cross address for whom to query the balance825 /// @return The number of RFTs owned by `owner`, possibly zero826 fn balance_of_cross(&self, owner: eth::CrossAddress) -> Result<U256> {827 self.consume_store_reads(1)?;828 let balance = <AccountBalance<T>>::get((self.id, owner.into_sub_cross_account::<T>()?));829 Ok(balance.into())830 }831832 /// Returns the token properties.833 ///834 /// @param tokenId Id for the token.835 /// @param keys Properties keys. Empty keys for all propertyes.836 /// @return Vector of properties key/value pairs.837 fn properties(&self, token_id: U256, keys: Vec<String>) -> Result<Vec<eth::Property>> {838 let keys = keys839 .into_iter()840 .map(|key| {841 <Vec<u8>>::from(key)842 .try_into()843 .map_err(|_| Error::Revert("key too large".into()))844 })845 .collect::<Result<Vec<_>>>()?;846847 <Self as CommonCollectionOperations<T>>::token_properties(848 self,849 token_id.try_into()?,850 if keys.is_empty() { None } else { Some(keys) },851 )852 .into_iter()853 .map(eth::Property::try_from)854 .collect::<Result<Vec<_>>>()855 }856 /// @notice Transfer ownership of an RFT857 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`858 /// is the zero address. Throws if `tokenId` is not a valid RFT.859 /// Throws if RFT pieces have multiple owners.860 /// @param to The new owner861 /// @param tokenId The RFT to transfer862 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]863 fn transfer(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<()> {864 let caller = T::CrossAccountId::from_eth(caller);865 let to = T::CrossAccountId::from_eth(to);866 let token = token_id.try_into()?;867 let budget = self868 .recorder869 .weight_calls_budget(<StructureWeight<T>>::find_parent());870871 let balance = balance(self, token, &caller)?;872 ensure_single_owner(self, token, balance)?;873874 <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)875 .map_err(dispatch_to_evm::<T>)?;876 Ok(())877 }878879 /// @notice Transfer ownership of an RFT880 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`881 /// is the zero address. Throws if `tokenId` is not a valid RFT.882 /// Throws if RFT pieces have multiple owners.883 /// @param to The new owner884 /// @param tokenId The RFT to transfer885 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]886 fn transfer_cross(887 &mut self,888 caller: Caller,889 to: eth::CrossAddress,890 token_id: U256,891 ) -> Result<()> {892 let caller = T::CrossAccountId::from_eth(caller);893 let to = to.into_sub_cross_account::<T>()?;894 let token = token_id.try_into()?;895 let budget = self896 .recorder897 .weight_calls_budget(<StructureWeight<T>>::find_parent());898899 let balance = balance(self, token, &caller)?;900 ensure_single_owner(self, token, balance)?;901902 <Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)903 .map_err(dispatch_to_evm::<T>)?;904 Ok(())905 }906907 /// @notice Transfer ownership of an RFT908 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`909 /// is the zero address. Throws if `tokenId` is not a valid RFT.910 /// Throws if RFT pieces have multiple owners.911 /// @param to The new owner912 /// @param tokenId The RFT to transfer913 #[weight(<SelfWeightOf<T>>::transfer_creating_removing())]914 fn transfer_from_cross(915 &mut self,916 caller: Caller,917 from: eth::CrossAddress,918 to: eth::CrossAddress,919 token_id: U256,920 ) -> Result<()> {921 let caller = T::CrossAccountId::from_eth(caller);922 let from = from.into_sub_cross_account::<T>()?;923 let to = to.into_sub_cross_account::<T>()?;924 let token_id = token_id.try_into()?;925 let budget = self926 .recorder927 .weight_calls_budget(<StructureWeight<T>>::find_parent());928929 let balance = balance(self, token_id, &from)?;930 ensure_single_owner(self, token_id, balance)?;931932 Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, balance, &budget)933 .map_err(dispatch_to_evm::<T>)?;934 Ok(())935 }936937 /// @notice Burns a specific ERC721 token.938 /// @dev Throws unless `msg.sender` is the current owner or an authorized939 /// operator for this RFT. Throws if `from` is not the current owner. Throws940 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.941 /// Throws if RFT pieces have multiple owners.942 /// @param from The current owner of the RFT943 /// @param tokenId The RFT to transfer944 #[solidity(hide)]945 #[weight(<SelfWeightOf<T>>::burn_from())]946 fn burn_from(&mut self, caller: Caller, from: Address, token_id: U256) -> Result<()> {947 let caller = T::CrossAccountId::from_eth(caller);948 let from = T::CrossAccountId::from_eth(from);949 let token = token_id.try_into()?;950 let budget = self951 .recorder952 .weight_calls_budget(<StructureWeight<T>>::find_parent());953954 let balance = balance(self, token, &from)?;955 ensure_single_owner(self, token, balance)?;956957 <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)958 .map_err(dispatch_to_evm::<T>)?;959 Ok(())960 }961962 /// @notice Burns a specific ERC721 token.963 /// @dev Throws unless `msg.sender` is the current owner or an authorized964 /// operator for this RFT. Throws if `from` is not the current owner. Throws965 /// if `to` is the zero address. Throws if `tokenId` is not a valid RFT.966 /// Throws if RFT pieces have multiple owners.967 /// @param from The current owner of the RFT968 /// @param tokenId The RFT to transfer969 #[weight(<SelfWeightOf<T>>::burn_from())]970 fn burn_from_cross(971 &mut self,972 caller: Caller,973 from: eth::CrossAddress,974 token_id: U256,975 ) -> Result<()> {976 let caller = T::CrossAccountId::from_eth(caller);977 let from = from.into_sub_cross_account::<T>()?;978 let token = token_id.try_into()?;979 let budget = self980 .recorder981 .weight_calls_budget(<StructureWeight<T>>::find_parent());982983 let balance = balance(self, token, &from)?;984 ensure_single_owner(self, token, balance)?;985986 <Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)987 .map_err(dispatch_to_evm::<T>)?;988 Ok(())989 }990991 /// @notice Returns next free RFT ID.992 fn next_token_id(&self) -> Result<U256> {993 self.consume_store_reads(1)?;994 Ok(<Pallet<T>>::next_token_id(self)995 .map_err(dispatch_to_evm::<T>)?996 .into())997 }998999 /// @notice Function to mint multiple tokens.1000 /// @dev `tokenIds` should be an array of consecutive numbers and first number1001 /// should be obtained with `nextTokenId` method1002 /// @param to The new owner1003 /// @param tokenIds IDs of the minted RFTs1004 #[solidity(hide)]1005 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]1006 fn mint_bulk(&mut self, caller: Caller, to: Address, token_ids: Vec<U256>) -> Result<bool> {1007 let caller = T::CrossAccountId::from_eth(caller);1008 let to = T::CrossAccountId::from_eth(to);1009 let mut expected_index = <TokensMinted<T>>::get(self.id)1010 .checked_add(1)1011 .ok_or("item id overflow")?;1012 let budget = self1013 .recorder1014 .weight_calls_budget(<StructureWeight<T>>::find_parent());10151016 let total_tokens = token_ids.len();1017 for id in token_ids.into_iter() {1018 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;1019 if id != expected_index {1020 return Err("item id should be next".into());1021 }1022 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;1023 }1024 let users = [(to, 1)]1025 .into_iter()1026 .collect::<BTreeMap<_, _>>()1027 .try_into()1028 .unwrap();1029 let create_item_data = CreateItemData::<T> {1030 users,1031 properties: CollectionPropertiesVec::default(),1032 };1033 let data = (0..total_tokens)1034 .map(|_| create_item_data.clone())1035 .collect();10361037 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1038 .map_err(dispatch_to_evm::<T>)?;1039 Ok(true)1040 }10411042 /// @notice Function to mint a token.1043 /// @param tokenProperties Properties of minted token1044 #[weight(if token_properties.len() == 1 {1045 <SelfWeightOf<T>>::create_multiple_items_ex_multiple_owners(token_properties.iter().next().unwrap().owners.len() as u32)1046 } else {1047 <SelfWeightOf<T>>::create_multiple_items_ex_multiple_items(token_properties.len() as u32)1048 } + <SelfWeightOf<T>>::set_token_properties(token_properties.len() as u32))]1049 fn mint_bulk_cross(1050 &mut self,1051 caller: Caller,1052 token_properties: Vec<MintTokenData>,1053 ) -> Result<bool> {1054 let caller = T::CrossAccountId::from_eth(caller);1055 let budget = self1056 .recorder1057 .weight_calls_budget(<StructureWeight<T>>::find_parent());1058 let has_multiple_tokens = token_properties.len() > 1;10591060 let mut create_rft_data = Vec::with_capacity(token_properties.len());1061 for MintTokenData { owners, properties } in token_properties {1062 let has_multiple_owners = owners.len() > 1;1063 if has_multiple_tokens & has_multiple_owners {1064 return Err(1065 "creation of multiple tokens supported only if they have single owner each"1066 .into(),1067 );1068 }1069 let users: BoundedBTreeMap<_, _, _> = owners1070 .into_iter()1071 .map(|data| Ok((data.owner.into_sub_cross_account::<T>()?, data.pieces)))1072 .collect::<Result<BTreeMap<_, _>>>()?1073 .try_into()1074 .map_err(|_| "too many users")?;1075 create_rft_data.push(CreateItemData::<T> {1076 properties: properties1077 .into_iter()1078 .map(|property| property.try_into())1079 .collect::<Result<Vec<_>>>()?1080 .try_into()1081 .map_err(|_| "too many properties")?,1082 users,1083 });1084 }10851086 <Pallet<T>>::create_multiple_items(self, &caller, create_rft_data, &budget)1087 .map_err(dispatch_to_evm::<T>)?;1088 Ok(true)1089 }10901091 /// @notice Function to mint multiple tokens with the given tokenUris.1092 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive1093 /// numbers and first number should be obtained with `nextTokenId` method1094 /// @param to The new owner1095 /// @param tokens array of pairs of token ID and token URI for minted tokens1096 #[solidity(hide, rename_selector = "mintBulkWithTokenURI")]1097 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32) + <SelfWeightOf<T>>::set_token_properties(tokens.len() as u32))]1098 fn mint_bulk_with_token_uri(1099 &mut self,1100 caller: Caller,1101 to: Address,1102 tokens: Vec<TokenUri>,1103 ) -> Result<bool> {1104 let key = key::url();1105 let caller = T::CrossAccountId::from_eth(caller);1106 let to = T::CrossAccountId::from_eth(to);1107 let mut expected_index = <TokensMinted<T>>::get(self.id)1108 .checked_add(1)1109 .ok_or("item id overflow")?;1110 let budget = self1111 .recorder1112 .weight_calls_budget(<StructureWeight<T>>::find_parent());11131114 let mut data = Vec::with_capacity(tokens.len());1115 let users: BoundedBTreeMap<_, _, _> = [(to, 1)]1116 .into_iter()1117 .collect::<BTreeMap<_, _>>()1118 .try_into()1119 .unwrap();1120 for TokenUri { id, uri } in tokens {1121 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;1122 if id != expected_index {1123 return Err("item id should be next".into());1124 }1125 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;11261127 let mut properties = CollectionPropertiesVec::default();1128 properties1129 .try_push(Property {1130 key: key.clone(),1131 value: uri1132 .into_bytes()1133 .try_into()1134 .map_err(|_| "token uri is too long")?,1135 })1136 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {e:?}")))?;11371138 let create_item_data = CreateItemData::<T> {1139 users: users.clone(),1140 properties,1141 };1142 data.push(create_item_data);1143 }11441145 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1146 .map_err(dispatch_to_evm::<T>)?;1147 Ok(true)1148 }11491150 /// @notice Function to mint a token.1151 /// @param to The new owner crossAccountId1152 /// @param properties Properties of minted token1153 /// @return uint256 The id of the newly minted token1154 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]1155 fn mint_cross(1156 &mut self,1157 caller: Caller,1158 to: eth::CrossAddress,1159 properties: Vec<eth::Property>,1160 ) -> Result<U256> {1161 let token_id = <TokensMinted<T>>::get(self.id)1162 .checked_add(1)1163 .ok_or("item id overflow")?;11641165 let to = to.into_sub_cross_account::<T>()?;11661167 let properties = properties1168 .into_iter()1169 .map(eth::Property::try_into)1170 .collect::<Result<Vec<_>>>()?1171 .try_into()1172 .map_err(|_| Error::Revert("too many properties".to_string()))?;11731174 let caller = T::CrossAccountId::from_eth(caller);11751176 let budget = self1177 .recorder1178 .weight_calls_budget(<StructureWeight<T>>::find_parent());11791180 let users = [(to, 1)]1181 .into_iter()1182 .collect::<BTreeMap<_, _>>()1183 .try_into()1184 .unwrap();1185 <Pallet<T>>::create_item(1186 self,1187 &caller,1188 CreateItemData::<T> { users, properties },1189 &budget,1190 )1191 .map_err(dispatch_to_evm::<T>)?;11921193 Ok(token_id.into())1194 }11951196 /// Returns EVM address for refungible token1197 ///1198 /// @param token ID of the token1199 fn token_contract_address(&self, token: U256) -> Result<Address> {1200 Ok(T::EvmTokenAddressMapping::token_to_address(1201 self.id,1202 token.try_into().map_err(|_| "token id overflow")?,1203 ))1204 }12051206 /// @notice Returns collection helper contract address1207 fn collection_helper_address(&self) -> Result<Address> {1208 Ok(T::ContractAddress::get())1209 }1210}12111212#[solidity_interface(1213 name = UniqueRefungible,1214 is(1215 ERC721,1216 ERC721Enumerable,1217 ERC721UniqueExtensions,1218 ERC721UniqueMintable,1219 ERC721Burnable,1220 ERC721Metadata(if(this.flags.erc721metadata)),1221 Collection(via(common_mut returns CollectionHandle<T>)),1222 TokenProperties,1223 ),1224 enum(derive(PreDispatch)),1225)]1226impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}12271228// Not a tests, but code generators1229generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);1230generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);12311232impl<T: Config> CommonEvmHandler for RefungibleHandle<T>1233where1234 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1235{1236 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");1237 fn call(1238 self,1239 handle: &mut impl PrecompileHandle,1240 ) -> Option<pallet_common::erc::PrecompileResult> {1241 call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)1242 }1243}pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -96,8 +96,8 @@
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
- CommonCollectionOperations, Error as CommonError, eth::collection_id_to_address,
- Event as CommonEvent, Pallet as PalletCommon, SetPropertyMode,
+ Error as CommonError, eth::collection_id_to_address, Event as CommonEvent,
+ Pallet as PalletCommon,
};
use pallet_structure::Pallet as PalletStructure;
use sp_core::{Get, H160};
@@ -533,66 +533,16 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let mut is_token_owner =
- pallet_common::LazyValue::new(|| -> Result<bool, DispatchError> {
- if let SetPropertyMode::NewToken {
- mint_target_is_sender,
- } = mode
- {
- return Ok(mint_target_is_sender);
- }
-
- let balance = collection.balance(sender.clone(), token_id);
- let total_pieces: u128 =
- Self::total_pieces(collection.id, token_id).unwrap_or(u128::MAX);
- if balance != total_pieces {
- return Ok(false);
- }
-
- let is_bundle_owner = <PalletStructure<T>>::check_indirectly_owned(
- sender.clone(),
- collection.id,
- token_id,
- None,
- nesting_budget,
- )?;
-
- Ok(is_bundle_owner)
- });
-
- let is_new_token = matches!(mode, SetPropertyMode::NewToken { .. });
-
- let mut is_token_exist = pallet_common::LazyValue::new(|| {
- if is_new_token {
- debug_assert!(Self::token_exists(collection, token_id));
- true
- } else {
- Self::token_exists(collection, token_id)
- }
- });
-
- let stored_properties = if is_new_token {
- debug_assert!(!<TokenProperties<T>>::contains_key((
- collection.id,
- token_id
- )));
- TokenPropertiesT::new()
- } else {
- <TokenProperties<T>>::get((collection.id, token_id))
- };
+ let mut property_writer =
+ pallet_common::property_writer_for_existing_token(collection, sender);
- <PalletCommon<T>>::modify_token_properties(
- collection,
+ property_writer.write_token_properties(
sender,
token_id,
- &mut is_token_exist,
properties_updates,
- stored_properties,
- &mut is_token_owner,
- |properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
+ nesting_budget,
erc::ERC721TokenEvent::TokenChanged {
token_id: token_id.into(),
}
@@ -618,7 +568,6 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties: impl Iterator<Item = Property>,
- mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::modify_token_properties(
@@ -626,7 +575,6 @@
sender,
token_id,
properties.map(|p| (p.key, Some(p.value))),
- mode,
nesting_budget,
)
}
@@ -643,7 +591,6 @@
sender,
token_id,
[property].into_iter(),
- SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -660,7 +607,6 @@
sender,
token_id,
property_keys.into_iter().map(|key| (key, None)),
- SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -941,11 +887,15 @@
// =========
+ let mut property_writer = pallet_common::property_writer_for_new_token(collection, sender);
+
with_transaction(|| {
for (i, data) in data.iter().enumerate() {
let token_id = first_token_id + i as u32 + 1;
<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);
+ let token = TokenId(token_id);
+
let mut mint_target_is_sender = true;
for (user, amount) in data.users.iter() {
if *amount == 0 {
@@ -955,23 +905,22 @@
mint_target_is_sender = mint_target_is_sender && sender.conv_eq(user);
<Balance<T>>::insert((collection.id, token_id, &user), amount);
- <Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);
+ <Owned<T>>::insert((collection.id, &user, token), true);
<PalletStructure<T>>::nest_if_sent_to_token_unchecked(
user,
collection.id,
- TokenId(token_id),
+ token,
);
}
- if let Err(e) = Self::set_token_properties(
- collection,
- sender,
- TokenId(token_id),
+ if let Err(e) = property_writer.write_token_properties(
+ mint_target_is_sender,
+ token,
data.properties.clone().into_iter(),
- SetPropertyMode::NewToken {
- mint_target_is_sender,
- },
- nesting_budget,
+ erc::ERC721TokenEvent::TokenChanged {
+ token_id: token.into(),
+ }
+ .to_log(T::ContractAddress::get()),
) {
return TransactionOutcome::Rollback(Err(e));
}