difftreelog
feat budgets
in: master
19 files changed
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -33,7 +33,7 @@
COLLECTION_ADMINS_LIMIT, MetaUpdatePermission, TokenId, CollectionStats, MAX_TOKEN_OWNERSHIP,
CollectionMode, NFT_SPONSOR_TRANSFER_TIMEOUT, FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,
REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT, MAX_SPONSOR_TIMEOUT, CUSTOM_DATA_LIMIT, CollectionLimits,
- CustomDataLimit, CreateCollectionData, SponsorshipState, CreateItemExData, SponsoringRateLimit,
+ CustomDataLimit, CreateCollectionData, SponsorshipState, CreateItemExData, SponsoringRateLimit, budget::Budget,
};
pub use pallet::*;
use sp_core::H160;
@@ -763,6 +763,7 @@
to: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo;
fn burn_from(
&self,
@@ -770,6 +771,7 @@
from: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo;
fn set_variable_metadata(
pallets/evm-coder-substrate/Cargo.tomldiffbeforeafterboth--- a/pallets/evm-coder-substrate/Cargo.toml
+++ b/pallets/evm-coder-substrate/Cargo.toml
@@ -17,6 +17,7 @@
frame-support = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.20" }
frame-system = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.20" }
frame-benchmarking = { default-features = false, optional = true, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.20" }
+up-data-structs = { default-features = false, path = "../../primitives/data-structs" }
[dependencies.codec]
default-features = false
pallets/evm-coder-substrate/src/lib.rsdiffbeforeafterboth--- a/pallets/evm-coder-substrate/src/lib.rs
+++ b/pallets/evm-coder-substrate/src/lib.rs
@@ -18,33 +18,43 @@
#[cfg(not(feature = "std"))]
extern crate alloc;
+#[cfg(not(feature = "std"))]
+use alloc::format;
+use frame_support::dispatch::Weight;
+
+use core::marker::PhantomData;
+use sp_std::cell::RefCell;
+use sp_std::vec::Vec;
+
+use frame_support::pallet_prelude::DispatchError;
+use frame_support::traits::PalletInfo;
+use frame_support::{ensure, sp_runtime::ModuleError};
+use up_data_structs::budget;
+use pallet_evm::{
+ ExitError, ExitRevert, ExitSucceed, GasWeightMapping, PrecompileFailure, PrecompileOutput,
+ PrecompileResult, runner::stack::MaybeMirroredLog,
+};
+use ethereum::TransactionV2;
+use sp_core::{H160, H256};
+use pallet_ethereum::EthereumTransactionSender;
// #[cfg(feature = "runtime-benchmarks")]
// pub mod benchmarking;
+use evm_coder::{
+ ToLog,
+ abi::{AbiReader, AbiWrite, AbiWriter},
+ execution::{self, Result},
+ types::{Msg, value},
+};
+
pub use pallet::*;
#[frame_support::pallet]
pub mod pallet {
- #[cfg(not(feature = "std"))]
- use alloc::format;
+ use super::*;
- use evm_coder::{
- ToLog,
- abi::{AbiReader, AbiWrite, AbiWriter},
- execution::{self, Result},
- types::{Msg, value},
- };
- use frame_support::{ensure, sp_runtime::ModuleError};
- use pallet_evm::{
- ExitError, ExitRevert, ExitSucceed, GasWeightMapping, PrecompileFailure, PrecompileOutput,
- PrecompileResult, runner::stack::MaybeMirroredLog,
- };
use frame_system::ensure_signed;
pub use frame_support::dispatch::DispatchResult;
- use pallet_ethereum::EthereumTransactionSender;
- use sp_std::cell::RefCell;
- use sp_std::vec::Vec;
- use sp_core::H160;
use frame_support::{pallet_prelude::*, traits::PalletInfo};
use frame_system::pallet_prelude::*;
@@ -76,214 +86,258 @@
Ok(())
}
}
+}
- // From instabul hardfork configuration: https://github.com/rust-blockchain/evm/blob/fd4fd6acc0ca3208d6770fdb3ba407c94cdf97c6/runtime/src/lib.rs#L284
- pub const G_SLOAD_WORD: u64 = 800;
- pub const G_SSTORE_WORD: u64 = 20000;
+// From instabul hardfork configuration: https://github.com/rust-blockchain/evm/blob/fd4fd6acc0ca3208d6770fdb3ba407c94cdf97c6/runtime/src/lib.rs#L284
+pub const G_SLOAD_WORD: u64 = 800;
+pub const G_SSTORE_WORD: u64 = 20000;
- #[derive(Default)]
- pub struct SubstrateRecorder<T: Config> {
- contract: H160,
- logs: RefCell<Vec<MaybeMirroredLog>>,
- initial_gas: u64,
- gas_limit: RefCell<u64>,
- _phantom: PhantomData<*const T>,
+pub fn generate_transaction() -> TransactionV2 {
+ use ethereum::{TransactionV0, TransactionAction, TransactionSignature};
+ TransactionV2::Legacy(TransactionV0 {
+ nonce: 0.into(),
+ gas_price: 0.into(),
+ gas_limit: 0.into(),
+ action: TransactionAction::Call(H160([0; 20])),
+ value: 0.into(),
+ // zero selector, this transaction always has same sender, so all data should be acquired from logs
+ input: Vec::from([0, 0, 0, 0]),
+ // if v is not 27 - then we need to pass some other validity checks
+ signature: TransactionSignature::new(27, H256([0x88; 32]), H256([0x88; 32])).unwrap(),
+ })
+}
+
+pub struct GasCallsBudget<'r, T: Config> {
+ recorder: &'r SubstrateRecorder<T>,
+ gas_per_call: u64,
+}
+impl<T: Config> budget::Budget for GasCallsBudget<'_, T> {
+ fn consume_custom(&self, calls: u32) -> bool {
+ let (gas, overflown) = (calls as u64).overflowing_add(self.gas_per_call);
+ if overflown {
+ return false;
+ }
+ self.recorder.consume_gas(gas).is_ok()
}
+}
- impl<T: Config> SubstrateRecorder<T> {
- pub fn new(contract: H160, gas_limit: u64) -> Self {
- Self {
- contract,
- logs: RefCell::new(Vec::new()),
- initial_gas: gas_limit,
- gas_limit: RefCell::new(gas_limit),
- _phantom: PhantomData,
- }
+#[derive(Default)]
+pub struct SubstrateRecorder<T: Config> {
+ contract: H160,
+ logs: RefCell<Vec<MaybeMirroredLog>>,
+ initial_gas: u64,
+ gas_limit: RefCell<u64>,
+ _phantom: PhantomData<*const T>,
+}
+
+impl<T: Config> SubstrateRecorder<T> {
+ pub fn new(contract: H160, gas_limit: u64) -> Self {
+ Self {
+ contract,
+ logs: RefCell::new(Vec::new()),
+ initial_gas: gas_limit,
+ gas_limit: RefCell::new(gas_limit),
+ _phantom: PhantomData,
}
+ }
+
+ pub fn is_empty(&self) -> bool {
+ self.logs.borrow().is_empty()
+ }
+ // Logs emitted with log_direct appear as substrate evm.Log event
+ pub fn log_direct(&self, log: impl ToLog) {
+ self.logs
+ .borrow_mut()
+ .push(MaybeMirroredLog::direct(log.to_log(self.contract)))
+ }
+ /// If log already has substrate equivalent - then we don't need to emit evm.Log
+ pub fn log_mirrored(&self, log: impl ToLog) {
+ self.logs
+ .borrow_mut()
+ .push(MaybeMirroredLog::mirrored(log.to_log(self.contract)))
+ }
+ pub fn retrieve_logs(self) -> Vec<MaybeMirroredLog> {
+ self.logs.into_inner()
+ }
- pub fn is_empty(&self) -> bool {
- self.logs.borrow().is_empty()
- }
- // Logs emitted with log_direct appear as substrate evm.Log event
- pub fn log_direct(&self, log: impl ToLog) {
- self.logs
- .borrow_mut()
- .push(MaybeMirroredLog::direct(log.to_log(self.contract)))
- }
- /// If log already has substrate equivalent - then we don't need to emit evm.Log
- pub fn log_mirrored(&self, log: impl ToLog) {
- self.logs
- .borrow_mut()
- .push(MaybeMirroredLog::mirrored(log.to_log(self.contract)))
+ pub fn gas_left(&self) -> u64 {
+ *self.gas_limit.borrow()
+ }
+ pub fn gas_calls_budget(&self, gas_per_call: u64) -> GasCallsBudget<T> {
+ GasCallsBudget {
+ recorder: self,
+ gas_per_call,
}
- pub fn retrieve_logs(self) -> Vec<MaybeMirroredLog> {
- self.logs.into_inner()
+ }
+ pub fn weight_calls_budget(&self, weight_per_call: Weight) -> GasCallsBudget<T> {
+ GasCallsBudget {
+ recorder: self,
+ gas_per_call: T::GasWeightMapping::weight_to_gas(weight_per_call),
}
+ }
+ pub fn consume_sload_sub(&self) -> DispatchResult {
+ self.consume_gas_sub(G_SLOAD_WORD)
+ }
+ pub fn consume_sstores_sub(&self, amount: usize) -> DispatchResult {
+ self.consume_gas_sub(G_SSTORE_WORD.saturating_mul(amount as u64))
+ }
+ pub fn consume_sstore_sub(&self) -> DispatchResult {
+ self.consume_gas_sub(G_SSTORE_WORD)
+ }
+ pub fn consume_gas_sub(&self, gas: u64) -> DispatchResult {
+ ensure!(gas != u64::MAX, Error::<T>::OutOfGas);
+ let mut gas_limit = self.gas_limit.borrow_mut();
+ ensure!(gas <= *gas_limit, Error::<T>::OutOfGas);
+ *gas_limit -= gas;
+ Ok(())
+ }
- pub fn gas_left(&self) -> u64 {
- *self.gas_limit.borrow()
+ pub fn consume_sload(&self) -> Result<()> {
+ self.consume_gas(G_SLOAD_WORD)
+ }
+ pub fn consume_sstore(&self) -> Result<()> {
+ self.consume_gas(G_SSTORE_WORD)
+ }
+ pub fn consume_gas(&self, gas: u64) -> Result<()> {
+ if gas == u64::MAX {
+ return Err(execution::Error::Error(ExitError::OutOfGas));
}
- pub fn consume_sload_sub(&self) -> DispatchResult {
- self.consume_gas_sub(G_SLOAD_WORD)
+ let mut gas_limit = self.gas_limit.borrow_mut();
+ if gas > *gas_limit {
+ return Err(execution::Error::Error(ExitError::OutOfGas));
}
- pub fn consume_sstores_sub(&self, amount: usize) -> DispatchResult {
- self.consume_gas_sub(G_SSTORE_WORD.saturating_mul(amount as u64))
- }
- pub fn consume_sstore_sub(&self) -> DispatchResult {
- self.consume_gas_sub(G_SSTORE_WORD)
- }
- pub fn consume_gas_sub(&self, gas: u64) -> DispatchResult {
- ensure!(gas != u64::MAX, Error::<T>::OutOfGas);
- let mut gas_limit = self.gas_limit.borrow_mut();
- ensure!(gas <= *gas_limit, Error::<T>::OutOfGas);
- *gas_limit -= gas;
- Ok(())
- }
+ *gas_limit -= gas;
+ Ok(())
+ }
+ pub fn return_gas(&self, gas: u64) {
+ let mut gas_limit = self.gas_limit.borrow_mut();
+ *gas_limit += gas;
+ }
- pub fn consume_sload(&self) -> Result<()> {
- self.consume_gas(G_SLOAD_WORD)
- }
- pub fn consume_sstore(&self) -> Result<()> {
- self.consume_gas(G_SSTORE_WORD)
- }
- pub fn consume_gas(&self, gas: u64) -> Result<()> {
- if gas == u64::MAX {
- return Err(execution::Error::Error(ExitError::OutOfGas));
- }
- let mut gas_limit = self.gas_limit.borrow_mut();
- if gas > *gas_limit {
- return Err(execution::Error::Error(ExitError::OutOfGas));
- }
- *gas_limit -= gas;
- Ok(())
- }
- pub fn return_gas(&self, gas: u64) {
- let mut gas_limit = self.gas_limit.borrow_mut();
- *gas_limit += gas;
- }
+ pub fn evm_to_precompile_output(
+ self,
+ result: evm_coder::execution::Result<Option<AbiWriter>>,
+ ) -> Option<PrecompileResult> {
+ use evm_coder::execution::Error;
+ Some(match result {
+ Ok(Some(v)) => Ok(PrecompileOutput {
+ exit_status: ExitSucceed::Returned,
+ cost: self.initial_gas - self.gas_left(),
+ // TODO: preserve mirroring status
+ logs: self.retrieve_logs().into_iter().map(|l| l.log).collect(),
+ output: v.finish(),
+ }),
+ Ok(None) => return None,
+ Err(Error::Revert(e)) => {
+ let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));
+ (&e as &str).abi_write(&mut writer);
- pub fn evm_to_precompile_output(
- self,
- result: evm_coder::execution::Result<Option<AbiWriter>>,
- ) -> Option<PrecompileResult> {
- use evm_coder::execution::Error;
- Some(match result {
- Ok(Some(v)) => Ok(PrecompileOutput {
- exit_status: ExitSucceed::Returned,
+ Err(PrecompileFailure::Revert {
+ exit_status: ExitRevert::Reverted,
cost: self.initial_gas - self.gas_left(),
- // TODO: preserve mirroring status
- logs: self.retrieve_logs().into_iter().map(|l| l.log).collect(),
- output: v.finish(),
- }),
- Ok(None) => return None,
- Err(Error::Revert(e)) => {
- let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));
- (&e as &str).abi_write(&mut writer);
+ output: writer.finish(),
+ })
+ }
+ Err(Error::Fatal(f)) => Err(f.into()),
+ Err(Error::Error(e)) => Err(e.into()),
+ })
+ }
- Err(PrecompileFailure::Revert {
- exit_status: ExitRevert::Reverted,
- cost: self.initial_gas - self.gas_left(),
- output: writer.finish(),
- })
- }
- Err(Error::Fatal(f)) => Err(f.into()),
- Err(Error::Error(e)) => Err(e.into()),
- })
+ pub fn submit_logs(self) {
+ let logs = self.retrieve_logs();
+ if logs.is_empty() {
+ return;
}
+ T::EthereumTransactionSender::submit_logs_transaction(
+ Default::default(),
+ generate_transaction(),
+ logs,
+ )
+ }
+}
- pub fn submit_logs(self) {
- let logs = self.retrieve_logs();
- if logs.is_empty() {
- return;
+pub fn dispatch_to_evm<T: Config>(err: DispatchError) -> evm_coder::execution::Error {
+ use evm_coder::execution::Error as ExError;
+ match err {
+ DispatchError::Module(ModuleError { index, error, .. })
+ if index
+ == T::PalletInfo::index::<Pallet<T>>()
+ .expect("evm-coder-substrate is a pallet, which should be added to runtime")
+ as u8 =>
+ {
+ match error {
+ v if v == Error::<T>::OutOfGas.as_u8() => ExError::Error(ExitError::OutOfGas),
+ v if v == Error::<T>::OutOfFund.as_u8() => ExError::Error(ExitError::OutOfFund),
+ _ => unreachable!("this pallet only defines two possible errors"),
}
- T::EthereumTransactionSender::submit_logs_transaction(Default::default(), logs)
}
+ DispatchError::Module(ModuleError {
+ message: Some(msg), ..
+ }) => ExError::Revert(msg.into()),
+ DispatchError::Module(ModuleError { index, error, .. }) => {
+ ExError::Revert(format!("error {} in pallet {}", error, index))
+ }
+ e => ExError::Revert(format!("substrate error: {:?}", e)),
}
+}
+
+pub trait WithRecorder<T: Config> {
+ fn recorder(&self) -> &SubstrateRecorder<T>;
+ fn into_recorder(self) -> SubstrateRecorder<T>;
+}
- pub fn dispatch_to_evm<T: Config>(err: DispatchError) -> evm_coder::execution::Error {
- use evm_coder::execution::Error as ExError;
- match err {
- DispatchError::Module(ModuleError { index, error, .. })
- if index
- == T::PalletInfo::index::<Pallet<T>>()
- .expect("evm-coder-substrate is a pallet, which should be added to runtime")
- as u8 =>
- {
- let mut read = &error as &[u8];
- match Error::<T>::decode(&mut read) {
- Ok(Error::<T>::OutOfGas) => ExError::Error(ExitError::OutOfGas),
- Ok(Error::<T>::OutOfFund) => ExError::Error(ExitError::OutOfFund),
- _ => unreachable!("this pallet only defines two possible errors"),
- }
- }
- DispatchError::Module(ModuleError {
- message: Some(msg), ..
- }) => ExError::Revert(msg.into()),
- DispatchError::Module(ModuleError { index, error, .. }) => {
- ExError::Revert(format!("error {:?} in pallet {}", error, index))
- }
- e => ExError::Revert(format!("substrate error: {:?}", e)),
- }
- }
+/// Helper to simplify implementing bridge between evm-coder definitions and pallet-evm
+pub fn call<
+ T: Config,
+ C: evm_coder::Call + evm_coder::Weighted,
+ E: evm_coder::Callable<C> + WithRecorder<T>,
+>(
+ caller: H160,
+ mut e: E,
+ value: value,
+ input: &[u8],
+) -> Option<PrecompileResult> {
+ let result = call_internal(caller, &mut e, value, input);
+ e.into_recorder().evm_to_precompile_output(result)
+}
- pub trait WithRecorder<T: Config> {
- fn recorder(&self) -> &SubstrateRecorder<T>;
- fn into_recorder(self) -> SubstrateRecorder<T>;
+fn call_internal<
+ T: Config,
+ C: evm_coder::Call + evm_coder::Weighted,
+ E: evm_coder::Callable<C> + WithRecorder<T>,
+>(
+ caller: H160,
+ e: &mut E,
+ value: value,
+ input: &[u8],
+) -> evm_coder::execution::Result<Option<AbiWriter>> {
+ let (selector, mut reader) = AbiReader::new_call(input)?;
+ let call = C::parse(selector, &mut reader)?;
+ if call.is_none() {
+ return Ok(None);
}
+ let call = call.unwrap();
- /// Helper to simplify implementing bridge between evm-coder definitions and pallet-evm
- pub fn call<
- T: Config,
- C: evm_coder::Call + evm_coder::Weighted,
- E: evm_coder::Callable<C> + WithRecorder<T>,
- >(
- caller: H160,
- mut e: E,
- value: value,
- input: &[u8],
- ) -> Option<PrecompileResult> {
- let result = call_internal(caller, &mut e, value, input);
- e.into_recorder().evm_to_precompile_output(result)
- }
+ let dispatch_info = call.weight();
+ e.recorder()
+ .consume_gas(T::GasWeightMapping::weight_to_gas(dispatch_info.weight))?;
- fn call_internal<
- T: Config,
- C: evm_coder::Call + evm_coder::Weighted,
- E: evm_coder::Callable<C> + WithRecorder<T>,
- >(
- caller: H160,
- e: &mut E,
- value: value,
- input: &[u8],
- ) -> evm_coder::execution::Result<Option<AbiWriter>> {
- let (selector, mut reader) = AbiReader::new_call(input)?;
- let call = C::parse(selector, &mut reader)?;
- if call.is_none() {
- return Ok(None);
+ match e.call(Msg {
+ call,
+ caller,
+ value,
+ }) {
+ Ok(v) => {
+ let unspent = v.post_info.calc_unspent(&dispatch_info);
+ e.recorder()
+ .return_gas(T::GasWeightMapping::weight_to_gas(unspent));
+ Ok(Some(v.data))
}
- let call = call.unwrap();
-
- let dispatch_info = call.weight();
- e.recorder()
- .consume_gas(T::GasWeightMapping::weight_to_gas(dispatch_info.weight))?;
-
- match e.call(Msg {
- call,
- caller,
- value,
- }) {
- Ok(v) => {
- let unspent = v.post_info.calc_unspent(&dispatch_info);
- e.recorder()
- .return_gas(T::GasWeightMapping::weight_to_gas(unspent));
- Ok(Some(v.data))
- }
- Err(v) => {
- let unspent = v.post_info.calc_unspent(&dispatch_info);
- e.recorder()
- .return_gas(T::GasWeightMapping::weight_to_gas(unspent));
- Err(v.data)
- }
+ Err(v) => {
+ let unspent = v.post_info.calc_unspent(&dispatch_info);
+ e.recorder()
+ .return_gas(T::GasWeightMapping::weight_to_gas(unspent));
+ Err(v.data)
}
}
}
pallets/fungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/fungible/src/benchmarking.rs
+++ b/pallets/fungible/src/benchmarking.rs
@@ -20,7 +20,7 @@
use sp_std::prelude::*;
use pallet_common::benchmarking::create_collection_raw;
use frame_benchmarking::{benchmarks, account};
-use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH};
+use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, budget::Unlimited};
use pallet_common::bench_init;
const SEED: u32 = 1;
@@ -52,7 +52,7 @@
bench_init!(to: cross_sub(i););
(to, 200)
}).collect::<BTreeMap<_, _>>().try_into().unwrap();
- }: {<Pallet<T>>::create_multiple_items(&collection, &sender, data)}
+ }: {<Pallet<T>>::create_multiple_items(&collection, &sender, data)?}
burn_item {
bench_init!{
@@ -85,7 +85,7 @@
};
<Pallet<T>>::create_item(&collection, &owner, (sender.clone(), 200))?;
<Pallet<T>>::set_allowance(&collection, &sender, &spender, 200)?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, 100)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, 100, &Unlimited)?}
burn_from {
bench_init!{
@@ -94,5 +94,5 @@
};
<Pallet<T>>::create_item(&collection, &owner, (sender.clone(), 200))?;
<Pallet<T>>::set_allowance(&collection, &sender, &burner, 200)?;
- }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, 100)?}
+ }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, 100, &Unlimited)?}
}
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -17,7 +17,7 @@
use core::marker::PhantomData;
use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, BoundedVec};
-use up_data_structs::{TokenId, CreateItemExData};
+use up_data_structs::{TokenId, CreateItemExData, budget::Budget};
use pallet_common::{CommonCollectionOperations, CommonWeightInfo, with_weight};
use sp_runtime::ArithmeticError;
use sp_std::{vec::Vec, vec};
@@ -189,6 +189,7 @@
to: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
ensure!(
token == TokenId::default(),
@@ -196,7 +197,7 @@
);
with_weight(
- <Pallet<T>>::transfer_from(self, &sender, &from, &to, amount),
+ <Pallet<T>>::transfer_from(self, &sender, &from, &to, amount, nesting_budget),
<CommonWeights<T>>::transfer_from(),
)
}
@@ -207,6 +208,7 @@
from: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
ensure!(
token == TokenId::default(),
@@ -214,7 +216,7 @@
);
with_weight(
- <Pallet<T>>::burn_from(self, &sender, &from, amount),
+ <Pallet<T>>::burn_from(self, &sender, &from, amount, nesting_budget),
<CommonWeights<T>>::burn_from(),
)
}
pallets/fungible/src/erc.rsdiffbeforeafterboth--- a/pallets/fungible/src/erc.rs
+++ b/pallets/fungible/src/erc.rs
@@ -23,6 +23,7 @@
use sp_std::vec::Vec;
use pallet_evm::account::CrossAccountId;
use pallet_evm_coder_substrate::{call, dispatch_to_evm};
+use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};
use crate::{
Allowance, Balance, Config, FungibleHandle, Pallet, SelfWeightOf, TotalSupply,
@@ -96,8 +97,11 @@
let from = T::CrossAccountId::from_eth(from);
let to = T::CrossAccountId::from_eth(to);
let amount = amount.try_into().map_err(|_| "amount overflow")?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
- <Pallet<T>>::transfer_from(self, &caller, &from, &to, amount)
+ <Pallet<T>>::transfer_from(self, &caller, &from, &to, amount, &budget)
.map_err(dispatch_to_evm::<T>)?;
Ok(true)
}
@@ -127,8 +131,12 @@
let caller = T::CrossAccountId::from_eth(caller);
let from = T::CrossAccountId::from_eth(from);
let amount = amount.try_into().map_err(|_| "amount overflow")?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
- <Pallet<T>>::burn_from(self, &caller, &from, amount).map_err(dispatch_to_evm::<T>)?;
+ <Pallet<T>>::burn_from(self, &caller, &from, amount, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
Ok(true)
}
}
pallets/fungible/src/lib.rsdiffbeforeafterboth--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -21,6 +21,7 @@
use pallet_evm::account::CrossAccountId;
use up_data_structs::{
AccessMode, CollectionId, TokenId, CreateCollectionData, mapping::TokenAddressMapping,
+ budget::Budget,
};
use pallet_common::{
Error as CommonError, Event as CommonEvent, Pallet as PalletCommon,
@@ -361,6 +362,7 @@
spender: &T::CrossAccountId,
from: &T::CrossAccountId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> Result<Option<u128>, DispatchError> {
if spender.conv_eq(from) {
return Ok(None);
@@ -372,7 +374,12 @@
if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {
// TODO: should collection owner be allowed to perform this transfer?
ensure!(
- <PalletStructure<T>>::indirectly_owned(spender.clone(), source.0, source.1, 1)?,
+ <PalletStructure<T>>::indirectly_owned(
+ spender.clone(),
+ source.0,
+ source.1,
+ nesting_budget
+ )?,
<CommonError<T>>::ApprovedValueTooLow,
);
return Ok(None);
@@ -394,8 +401,9 @@
from: &T::CrossAccountId,
to: &T::CrossAccountId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- let allowance = Self::check_allowed(collection, spender, from, amount)?;
+ let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;
// =========
@@ -411,8 +419,9 @@
spender: &T::CrossAccountId,
from: &T::CrossAccountId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- let allowance = Self::check_allowed(collection, spender, from, amount)?;
+ let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;
// =========
pallets/nonfungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/benchmarking.rs
+++ b/pallets/nonfungible/src/benchmarking.rs
@@ -20,7 +20,7 @@
use sp_std::prelude::*;
use pallet_common::benchmarking::{create_collection_raw, create_data, create_var_data};
use frame_benchmarking::{benchmarks, account};
-use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, CUSTOM_DATA_LIMIT};
+use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, CUSTOM_DATA_LIMIT, budget::Unlimited};
use pallet_common::bench_init;
use core::convert::TryInto;
@@ -115,7 +115,7 @@
};
let item = create_max_item(&collection, &owner, sender.clone())?;
<Pallet<T>>::set_allowance(&collection, &sender, item, Some(&spender))?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, &Unlimited)?}
burn_from {
bench_init!{
@@ -124,7 +124,7 @@
};
let item = create_max_item(&collection, &owner, sender.clone())?;
<Pallet<T>>::set_allowance(&collection, &sender, item, Some(&burner))?;
- }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, item)?}
+ }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, item, &Unlimited)?}
set_variable_metadata {
let b in 0..CUSTOM_DATA_LIMIT;
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -17,7 +17,7 @@
use core::marker::PhantomData;
use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, BoundedVec};
-use up_data_structs::{TokenId, CustomDataLimit, CreateItemExData, CollectionId};
+use up_data_structs::{TokenId, CustomDataLimit, CreateItemExData, CollectionId, budget::Budget};
use pallet_common::{CommonCollectionOperations, CommonWeightInfo, with_weight};
use sp_runtime::DispatchError;
use sp_std::vec::Vec;
@@ -192,12 +192,13 @@
to: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
ensure!(amount <= 1, <Error<T>>::NonfungibleItemsHaveNoAmount);
if amount == 1 {
with_weight(
- <Pallet<T>>::transfer_from(self, &sender, &from, &to, token),
+ <Pallet<T>>::transfer_from(self, &sender, &from, &to, token, nesting_budget),
<CommonWeights<T>>::transfer_from(),
)
} else {
@@ -211,12 +212,13 @@
from: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
ensure!(amount <= 1, <Error<T>>::NonfungibleItemsHaveNoAmount);
if amount == 1 {
with_weight(
- <Pallet<T>>::burn_from(self, &sender, &from, token),
+ <Pallet<T>>::burn_from(self, &sender, &from, token, nesting_budget),
<CommonWeights<T>>::burn_from(),
)
} else {
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -30,6 +30,7 @@
};
use pallet_evm::account::CrossAccountId;
use pallet_evm_coder_substrate::call;
+use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};
use crate::{
AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,
@@ -180,8 +181,11 @@
let from = T::CrossAccountId::from_eth(from);
let to = T::CrossAccountId::from_eth(to);
let token = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
- <Pallet<T>>::transfer_from(self, &caller, &from, &to, token)
+ <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)
.map_err(dispatch_to_evm::<T>)?;
Ok(())
}
@@ -350,8 +354,12 @@
let caller = T::CrossAccountId::from_eth(caller);
let from = T::CrossAccountId::from_eth(from);
let token = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
- <Pallet<T>>::burn_from(self, &caller, &from, token).map_err(dispatch_to_evm::<T>)?;
+ <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
Ok(())
}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -20,7 +20,7 @@
use frame_support::{BoundedVec, ensure, fail};
use up_data_structs::{
AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,
- mapping::TokenAddressMapping, NestingRule,
+ mapping::TokenAddressMapping, NestingRule, budget::Budget,
};
use pallet_evm::account::CrossAccountId;
use pallet_common::{
@@ -511,6 +511,7 @@
spender: &T::CrossAccountId,
from: &T::CrossAccountId,
token: TokenId,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
if spender.conv_eq(from) {
return Ok(());
@@ -522,7 +523,12 @@
if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {
// TODO: should collection owner be allowed to perform this transfer?
ensure!(
- <PalletStructure<T>>::indirectly_owned(spender.clone(), source.0, source.1, 1)?,
+ <PalletStructure<T>>::indirectly_owned(
+ spender.clone(),
+ source.0,
+ source.1,
+ nesting_budget
+ )?,
<CommonError<T>>::ApprovedValueTooLow,
);
return Ok(());
@@ -543,8 +549,9 @@
from: &T::CrossAccountId,
to: &T::CrossAccountId,
token: TokenId,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- Self::check_allowed(collection, spender, from, token)?;
+ Self::check_allowed(collection, spender, from, token, nesting_budget)?;
// =========
@@ -557,8 +564,9 @@
spender: &T::CrossAccountId,
from: &T::CrossAccountId,
token: TokenId,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- Self::check_allowed(collection, spender, from, token)?;
+ Self::check_allowed(collection, spender, from, token, nesting_budget)?;
// =========
pallets/refungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/refungible/src/benchmarking.rs
+++ b/pallets/refungible/src/benchmarking.rs
@@ -20,7 +20,7 @@
use sp_std::prelude::*;
use pallet_common::benchmarking::{create_collection_raw, create_data, create_var_data};
use frame_benchmarking::{benchmarks, account};
-use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, CUSTOM_DATA_LIMIT};
+use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, CUSTOM_DATA_LIMIT, budget::Unlimited};
use pallet_common::bench_init;
use core::convert::TryInto;
use core::iter::IntoIterator;
@@ -165,7 +165,7 @@
};
let item = create_max_item(&collection, &owner, [(sender.clone(), 200), (receiver.clone(), 200)])?;
<Pallet<T>>::set_allowance(&collection, &sender, &spender, item, 100)?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 100)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 100, &Unlimited)?}
// Target account is created
transfer_from_creating {
bench_init!{
@@ -174,7 +174,7 @@
};
let item = create_max_item(&collection, &owner, [(sender.clone(), 200)])?;
<Pallet<T>>::set_allowance(&collection, &sender, &spender, item, 100)?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 100)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 100, &Unlimited)?}
// Source account is destroyed
transfer_from_removing {
bench_init!{
@@ -183,7 +183,7 @@
};
let item = create_max_item(&collection, &owner, [(sender.clone(), 200), (receiver.clone(), 200)])?;
<Pallet<T>>::set_allowance(&collection, &sender, &spender, item, 200)?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 200)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 200, &Unlimited)?}
// Source account destroyed, target created
transfer_from_creating_removing {
bench_init!{
@@ -192,7 +192,7 @@
};
let item = create_max_item(&collection, &owner, [(sender.clone(), 200)])?;
<Pallet<T>>::set_allowance(&collection, &sender, &spender, item, 200)?;
- }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 200)?}
+ }: {<Pallet<T>>::transfer_from(&collection, &spender, &sender, &receiver, item, 200, &Unlimited)?}
// Both source account and token is destroyed
burn_from {
@@ -202,7 +202,7 @@
};
let item = create_max_item(&collection, &owner, [(sender.clone(), 200)])?;
<Pallet<T>>::set_allowance(&collection, &sender, &burner, item, 200)?;
- }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, item, 200)?}
+ }: {<Pallet<T>>::burn_from(&collection, &burner, &sender, item, 200, &Unlimited)?}
set_variable_metadata {
let b in 0..CUSTOM_DATA_LIMIT;
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -18,7 +18,9 @@
use sp_std::collections::btree_map::BTreeMap;
use frame_support::{dispatch::DispatchResultWithPostInfo, fail, weights::Weight, BoundedVec};
-use up_data_structs::{TokenId, CustomDataLimit, CreateItemExData, CreateRefungibleExData};
+use up_data_structs::{
+ TokenId, CustomDataLimit, CreateItemExData, CreateRefungibleExData, budget::Budget,
+};
use pallet_common::{CommonCollectionOperations, CommonWeightInfo, with_weight};
use sp_runtime::DispatchError;
use sp_std::{vec::Vec, vec};
@@ -210,9 +212,10 @@
to: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
with_weight(
- <Pallet<T>>::transfer_from(self, &sender, &from, &to, token, amount),
+ <Pallet<T>>::transfer_from(self, &sender, &from, &to, token, amount, nesting_budget),
<CommonWeights<T>>::transfer_from(),
)
}
@@ -223,9 +226,10 @@
from: T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
with_weight(
- <Pallet<T>>::burn_from(self, &sender, &from, token, amount),
+ <Pallet<T>>::burn_from(self, &sender, &from, token, amount, nesting_budget),
<CommonWeights<T>>::burn_from(),
)
}
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -19,7 +19,7 @@
use frame_support::{ensure, BoundedVec};
use up_data_structs::{
AccessMode, CollectionId, CustomDataLimit, MAX_REFUNGIBLE_PIECES, TokenId,
- CreateCollectionData, CreateRefungibleExData, mapping::TokenAddressMapping,
+ CreateCollectionData, CreateRefungibleExData, mapping::TokenAddressMapping, budget::Budget,
};
use pallet_evm::account::CrossAccountId;
use pallet_common::{
@@ -544,6 +544,7 @@
from: &T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> Result<Option<u128>, DispatchError> {
if spender.conv_eq(from) {
return Ok(None);
@@ -555,7 +556,12 @@
if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {
// TODO: should collection owner be allowed to perform this transfer?
ensure!(
- <PalletStructure<T>>::indirectly_owned(spender.clone(), source.0, source.1, 1)?,
+ <PalletStructure<T>>::indirectly_owned(
+ spender.clone(),
+ source.0,
+ source.1,
+ nesting_budget
+ )?,
<CommonError<T>>::ApprovedValueTooLow,
);
return Ok(None);
@@ -578,8 +584,10 @@
to: &T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- let allowance = Self::check_allowed(collection, spender, from, token, amount)?;
+ let allowance =
+ Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;
// =========
@@ -596,8 +604,10 @@
from: &T::CrossAccountId,
token: TokenId,
amount: u128,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
- let allowance = Self::check_allowed(collection, spender, from, token, amount)?;
+ let allowance =
+ Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;
// =========
pallets/structure/src/lib.rsdiffbeforeafterboth--- a/pallets/structure/src/lib.rs
+++ b/pallets/structure/src/lib.rs
@@ -6,8 +6,14 @@
use frame_support::fail;
pub use pallet::*;
use pallet_common::{dispatch::CollectionDispatch, CollectionHandle};
-use up_data_structs::{CollectionId, TokenId, mapping::TokenAddressMapping};
+use up_data_structs::{CollectionId, TokenId, mapping::TokenAddressMapping, budget::Budget};
+#[cfg(feature = "runtime-benchmarks")]
+pub mod benchmarking;
+pub mod weights;
+
+pub type SelfWeightOf<T> = <T as crate::Config>::WeightInfo;
+
#[frame_support::pallet]
pub mod pallet {
use frame_support::Parameter;
@@ -35,6 +41,7 @@
#[pallet::config]
pub trait Config: frame_system::Config + pallet_common::Config {
+ type WeightInfo: weights::WeightInfo;
type Event: IsType<<Self as frame_system::Config>::Event> + From<Event<Self>>;
type Call: Parameter + UnfilteredDispatchable<Origin = Self::Origin> + GetDispatchInfo;
}
@@ -127,10 +134,10 @@
pub fn find_topmost_owner(
collection: CollectionId,
token: TokenId,
- max_depth: u32,
+ budget: &dyn Budget,
) -> Result<T::CrossAccountId, DispatchError> {
let owner = Self::parent_chain(collection, token)
- .take(max_depth as usize)
+ .take_while(|_| budget.consume())
.find(|p| matches!(p, Ok(Parent::Normal(_) | Parent::TokenNotFound)))
.ok_or(<Error<T>>::DepthLimit)??;
@@ -145,7 +152,7 @@
user: T::CrossAccountId,
collection: CollectionId,
token: TokenId,
- max_depth: u32,
+ budget: &dyn Budget,
) -> Result<bool, DispatchError> {
let target_parent = match T::CrossTokenAddressMapping::address_to_token(&user) {
Some((collection, token)) => Parent::Token(collection, token),
@@ -153,7 +160,7 @@
};
Ok(Self::parent_chain(collection, token)
- .take(max_depth as usize)
+ .take_while(|_| budget.consume())
.any(|parent| Ok(&target_parent) == parent.as_ref()))
}
}
pallets/unique/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/unique/src/benchmarking.rs
+++ b/pallets/unique/src/benchmarking.rs
@@ -19,8 +19,8 @@
use super::*;
use crate::Pallet;
use frame_system::RawOrigin;
+use frame_support::traits::{tokens::currency::Currency, Get};
use frame_benchmarking::{benchmarks, account};
-use up_data_structs::*;
use sp_runtime::DispatchError;
use pallet_common::benchmarking::{create_data, create_var_data, create_u16_data};
@@ -173,6 +173,7 @@
owner_can_transfer: Some(true),
sponsored_data_rate_limit: None,
transfers_enabled: Some(true),
+ nesting_rule: None,
};
}: set_collection_limits(RawOrigin::Signed(caller.clone()), collection, cl)
pallets/unique/src/lib.rsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617#![recursion_limit = "1024"]18#![cfg_attr(not(feature = "std"), no_std)]19#![allow(20 clippy::too_many_arguments,21 clippy::unnecessary_mut_passed,22 clippy::unused_unit23)]2425extern crate alloc;2627pub use serde::{Serialize, Deserialize};2829use frame_support::{30 decl_module, decl_storage, decl_error, decl_event,31 dispatch::DispatchResult,32 ensure,33 weights::{Weight},34 transactional,35 pallet_prelude::{DispatchResultWithPostInfo, ConstU32},36 BoundedVec,37};38use scale_info::TypeInfo;39use frame_system::{self as system, ensure_signed};40use sp_runtime::{sp_std::prelude::Vec};41use up_data_structs::{42 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, OFFCHAIN_SCHEMA_LIMIT,43 MAX_COLLECTION_NAME_LENGTH, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,44 AccessMode, CreateItemData, CollectionLimits, CollectionId, CollectionMode, TokenId,45 SchemaVersion, SponsorshipState, MetaUpdatePermission, CreateCollectionData, CustomDataLimit,46 CreateItemExData,47};48use pallet_evm::account::CrossAccountId;49use pallet_common::{50 CollectionHandle, Pallet as PalletCommon, Error as CommonError, CommonWeightInfo,51 dispatch::dispatch_call, dispatch::CollectionDispatch,52};5354#[cfg(test)]55mod mock;5657#[cfg(test)]58mod tests;5960mod eth;61mod sponsorship;62pub use sponsorship::{UniqueSponsorshipHandler, UniqueSponsorshipPredict};63pub use eth::sponsoring::UniqueEthSponsorshipHandler;6465pub mod common;66use common::CommonWeights;6768#[cfg(feature = "runtime-benchmarks")]69mod benchmarking;70pub mod weights;71use weights::WeightInfo;7273pub trait SponsorshipPredict<T: Config> {74 fn predict(collection: CollectionId, account: T::CrossAccountId, token: TokenId) -> Option<u64>75 where76 u64: From<<T as frame_system::Config>::BlockNumber>;77}7879decl_error! {80 /// Error for non-fungible-token module.81 pub enum Error for Module<T: Config> {82 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.83 CollectionDecimalPointLimitExceeded,84 /// This address is not set as sponsor, use setCollectionSponsor first.85 ConfirmUnsetSponsorFail,86 /// Length of items properties must be greater than 0.87 EmptyArgument,88 }89}9091pub trait Config:92 system::Config93 + pallet_evm_coder_substrate::Config94 + pallet_common::Config95 + pallet_nonfungible::Config96 + pallet_refungible::Config97 + pallet_fungible::Config98 + Sized99 + TypeInfo100{101 type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;102103 /// Weight information for extrinsics in this pallet.104 type WeightInfo: WeightInfo;105}106107decl_event! {108 pub enum Event<T>109 where110 <T as frame_system::Config>::AccountId,111 <T as pallet_evm::account::Config>::CrossAccountId,112 {113 /// Collection sponsor was removed114 ///115 /// # Arguments116 ///117 /// * collection_id: Globally unique collection identifier.118 CollectionSponsorRemoved(CollectionId),119120 /// Collection admin was added121 ///122 /// # Arguments123 ///124 /// * collection_id: Globally unique collection identifier.125 ///126 /// * admin: Admin address.127 CollectionAdminAdded(CollectionId, CrossAccountId),128129 /// Collection owned was change130 ///131 /// # Arguments132 ///133 /// * collection_id: Globally unique collection identifier.134 ///135 /// * owner: New owner address.136 CollectionOwnedChanged(CollectionId, AccountId),137138 /// Collection sponsor was set139 ///140 /// # Arguments141 ///142 /// * collection_id: Globally unique collection identifier.143 ///144 /// * owner: New sponsor address.145 CollectionSponsorSet(CollectionId, AccountId),146147 /// const on chain schema was set148 ///149 /// # Arguments150 ///151 /// * collection_id: Globally unique collection identifier.152 ConstOnChainSchemaSet(CollectionId),153154 /// New sponsor was confirm155 ///156 /// # Arguments157 ///158 /// * collection_id: Globally unique collection identifier.159 ///160 /// * sponsor: New sponsor address.161 SponsorshipConfirmed(CollectionId, AccountId),162163 /// Collection admin was removed164 ///165 /// # Arguments166 ///167 /// * collection_id: Globally unique collection identifier.168 ///169 /// * admin: Admin address.170 CollectionAdminRemoved(CollectionId, CrossAccountId),171172 /// Address was remove from allow list173 ///174 /// # Arguments175 ///176 /// * collection_id: Globally unique collection identifier.177 ///178 /// * user: Address.179 AllowListAddressRemoved(CollectionId, CrossAccountId),180181 /// Address was add to allow list182 ///183 /// # Arguments184 ///185 /// * collection_id: Globally unique collection identifier.186 ///187 /// * user: Address.188 AllowListAddressAdded(CollectionId, CrossAccountId),189190 /// Collection limits was set191 ///192 /// # Arguments193 ///194 /// * collection_id: Globally unique collection identifier.195 CollectionLimitSet(CollectionId),196197 /// Mint permission was set198 ///199 /// # Arguments200 ///201 /// * collection_id: Globally unique collection identifier.202 MintPermissionSet(CollectionId),203204 /// Offchain schema was set205 ///206 /// # Arguments207 ///208 /// * collection_id: Globally unique collection identifier.209 OffchainSchemaSet(CollectionId),210211 /// Public access mode was set212 ///213 /// # Arguments214 ///215 /// * collection_id: Globally unique collection identifier.216 ///217 /// * mode: New access state.218 PublicAccessModeSet(CollectionId, AccessMode),219220 /// Schema version was set221 ///222 /// # Arguments223 ///224 /// * collection_id: Globally unique collection identifier.225 SchemaVersionSet(CollectionId),226227 /// Variable on chain schema was set228 ///229 /// # Arguments230 ///231 /// * collection_id: Globally unique collection identifier.232 VariableOnChainSchemaSet(CollectionId),233 }234}235236type SelfWeightOf<T> = <T as Config>::WeightInfo;237238// # Used definitions239//240// ## User control levels241//242// chain-controlled - key is uncontrolled by user243// i.e autoincrementing index244// can use non-cryptographic hash245// real - key is controlled by user246// but it is hard to generate enough colliding values, i.e owner of signed txs247// can use non-cryptographic hash248// controlled - key is completly controlled by users249// i.e maps with mutable keys250// should use cryptographic hash251//252// ## User control level downgrade reasons253//254// ?1 - chain-controlled -> controlled255// collections/tokens can be destroyed, resulting in massive holes256// ?2 - chain-controlled -> controlled257// same as ?1, but can be only added, resulting in easier exploitation258// ?3 - real -> controlled259// no confirmation required, so addresses can be easily generated260decl_storage! {261 trait Store for Module<T: Config> as Unique {262263 //#region Private members264 /// Used for migrations265 ChainVersion: u64;266 //#endregion267268 //#region Tokens transfer rate limit baskets269 /// (Collection id (controlled?2), who created (real))270 /// TODO: Off chain worker should remove from this map when collection gets removed271 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;272 /// Collection id (controlled?2), token id (controlled?2)273 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;274 /// Collection id (controlled?2), owning user (real)275 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;276 /// Collection id (controlled?2), token id (controlled?2)277 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;278 //#endregion279280 /// Variable metadata sponsoring281 /// Collection id (controlled?2), token id (controlled?2)282 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;283 /// Approval sponsoring284 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;285 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;286 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>;287 }288}289290decl_module! {291 pub struct Module<T: Config> for enum Call292 where293 origin: T::Origin294 {295 type Error = Error<T>;296297 fn deposit_event() = default;298299 fn on_initialize(_now: T::BlockNumber) -> Weight {300 0301 }302303 /// This method creates a Collection of NFTs. Each Token may have multiple properties encoded as an array of bytes of certain length. The initial owner of the collection is set to the address that signed the transaction and can be changed later.304 ///305 /// # Permissions306 ///307 /// * Anyone.308 ///309 /// # Arguments310 ///311 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.312 ///313 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.314 ///315 /// * token_prefix: UTF-8 string with token prefix.316 ///317 /// * mode: [CollectionMode] collection type and type dependent data.318 // returns collection ID319 #[weight = <SelfWeightOf<T>>::create_collection()]320 #[transactional]321 #[deprecated]322 pub fn create_collection(origin,323 collection_name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,324 collection_description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,325 token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,326 mode: CollectionMode) -> DispatchResult {327 let data: CreateCollectionData<T::AccountId> = CreateCollectionData {328 name: collection_name,329 description: collection_description,330 token_prefix,331 mode,332 ..Default::default()333 };334 Self::create_collection_ex(origin, data)335 }336337 /// This method creates a collection338 ///339 /// Prefer it to deprecated [`created_collection`] method340 #[weight = <SelfWeightOf<T>>::create_collection()]341 #[transactional]342 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {343 let sender = ensure_signed(origin)?;344345 // =========346347 T::CollectionDispatch::create(sender, data)?;348349 Ok(())350 }351352 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.353 ///354 /// # Permissions355 ///356 /// * Collection Owner.357 ///358 /// # Arguments359 ///360 /// * collection_id: collection to destroy.361 #[weight = <SelfWeightOf<T>>::destroy_collection()]362 #[transactional]363 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {364 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);365 let collection = <CollectionHandle<T>>::try_get(collection_id)?;366367 // =========368369 T::CollectionDispatch::destroy(sender, collection)?;370371 <NftTransferBasket<T>>::remove_prefix(collection_id, None);372 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);373 <ReFungibleTransferBasket<T>>::remove_prefix((collection_id,), None);374375 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);376 <NftApproveBasket<T>>::remove_prefix(collection_id, None);377 <FungibleApproveBasket<T>>::remove_prefix(collection_id, None);378 <RefungibleApproveBasket<T>>::remove_prefix((collection_id,), None);379380 Ok(())381 }382383 /// Add an address to allow list.384 ///385 /// # Permissions386 ///387 /// * Collection Owner388 /// * Collection Admin389 ///390 /// # Arguments391 ///392 /// * collection_id.393 ///394 /// * address.395 #[weight = <SelfWeightOf<T>>::add_to_allow_list()]396 #[transactional]397 pub fn add_to_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{398399 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);400 let collection = <CollectionHandle<T>>::try_get(collection_id)?;401402 <PalletCommon<T>>::toggle_allowlist(403 &collection,404 &sender,405 &address,406 true,407 )?;408409 Self::deposit_event(Event::<T>::AllowListAddressAdded(410 collection_id,411 address412 ));413414 Ok(())415 }416417 /// Remove an address from allow list.418 ///419 /// # Permissions420 ///421 /// * Collection Owner422 /// * Collection Admin423 ///424 /// # Arguments425 ///426 /// * collection_id.427 ///428 /// * address.429 #[weight = <SelfWeightOf<T>>::remove_from_allow_list()]430 #[transactional]431 pub fn remove_from_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{432433 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);434 let collection = <CollectionHandle<T>>::try_get(collection_id)?;435436 <PalletCommon<T>>::toggle_allowlist(437 &collection,438 &sender,439 &address,440 false,441 )?;442443 <Pallet<T>>::deposit_event(Event::<T>::AllowListAddressRemoved(444 collection_id,445 address446 ));447448 Ok(())449 }450451 /// Toggle between normal and allow list access for the methods with access for `Anyone`.452 ///453 /// # Permissions454 ///455 /// * Collection Owner.456 ///457 /// # Arguments458 ///459 /// * collection_id.460 ///461 /// * mode: [AccessMode]462 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]463 #[transactional]464 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult465 {466 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);467468 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;469 target_collection.check_is_owner(&sender)?;470471 target_collection.access = mode.clone();472473 <Pallet<T>>::deposit_event(Event::<T>::PublicAccessModeSet(474 collection_id,475 mode476 ));477478 target_collection.save()479 }480481 /// Allows Anyone to create tokens if:482 /// * Allow List is enabled, and483 /// * Address is added to allow list, and484 /// * This method was called with True parameter485 ///486 /// # Permissions487 /// * Collection Owner488 ///489 /// # Arguments490 ///491 /// * collection_id.492 ///493 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.494 #[weight = <SelfWeightOf<T>>::set_mint_permission()]495 #[transactional]496 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult497 {498 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);499500 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;501 target_collection.check_is_owner(&sender)?;502503 target_collection.mint_mode = mint_permission;504505 <Pallet<T>>::deposit_event(Event::<T>::MintPermissionSet(506 collection_id507 ));508509 target_collection.save()510 }511512 /// Change the owner of the collection.513 ///514 /// # Permissions515 ///516 /// * Collection Owner.517 ///518 /// # Arguments519 ///520 /// * collection_id.521 ///522 /// * new_owner.523 #[weight = <SelfWeightOf<T>>::change_collection_owner()]524 #[transactional]525 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {526527 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);528529 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;530 target_collection.check_is_owner(&sender)?;531532 target_collection.owner = new_owner.clone();533 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnedChanged(534 collection_id,535 new_owner536 ));537538 target_collection.save()539 }540541 /// Adds an admin of the Collection.542 /// 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.543 ///544 /// # Permissions545 ///546 /// * Collection Owner.547 /// * Collection Admin.548 ///549 /// # Arguments550 ///551 /// * collection_id: ID of the Collection to add admin for.552 ///553 /// * new_admin_id: Address of new admin to add.554 #[weight = <SelfWeightOf<T>>::add_collection_admin()]555 #[transactional]556 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {557 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);558 let collection = <CollectionHandle<T>>::try_get(collection_id)?;559560 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(561 collection_id,562 new_admin_id.clone()563 ));564565 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)566 }567568 /// 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.569 ///570 /// # Permissions571 ///572 /// * Collection Owner.573 /// * Collection Admin.574 ///575 /// # Arguments576 ///577 /// * collection_id: ID of the Collection to remove admin for.578 ///579 /// * account_id: Address of admin to remove.580 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]581 #[transactional]582 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {583 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);584 let collection = <CollectionHandle<T>>::try_get(collection_id)?;585586 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminRemoved(587 collection_id,588 account_id.clone()589 ));590591 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)592 }593594 /// # Permissions595 ///596 /// * Collection Owner597 ///598 /// # Arguments599 ///600 /// * collection_id.601 ///602 /// * new_sponsor.603 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]604 #[transactional]605 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {606 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);607608 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;609 target_collection.check_is_owner(&sender)?;610611 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor.clone());612613 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(614 collection_id,615 new_sponsor616 ));617618 target_collection.save()619 }620621 /// # Permissions622 ///623 /// * Sponsor.624 ///625 /// # Arguments626 ///627 /// * collection_id.628 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]629 #[transactional]630 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {631 let sender = ensure_signed(origin)?;632633 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;634 ensure!(635 target_collection.sponsorship.pending_sponsor() == Some(&sender),636 Error::<T>::ConfirmUnsetSponsorFail637 );638639 target_collection.sponsorship = SponsorshipState::Confirmed(sender.clone());640641 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(642 collection_id,643 sender644 ));645646 target_collection.save()647 }648649 /// Switch back to pay-per-own-transaction model.650 ///651 /// # Permissions652 ///653 /// * Collection owner.654 ///655 /// # Arguments656 ///657 /// * collection_id.658 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]659 #[transactional]660 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {661 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);662663 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;664 target_collection.check_is_owner(&sender)?;665666 target_collection.sponsorship = SponsorshipState::Disabled;667668 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(669 collection_id670 ));671 target_collection.save()672 }673674 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.675 ///676 /// # Permissions677 ///678 /// * Collection Owner.679 /// * Collection Admin.680 /// * Anyone if681 /// * Allow List is enabled, and682 /// * Address is added to allow list, and683 /// * MintPermission is enabled (see SetMintPermission method)684 ///685 /// # Arguments686 ///687 /// * collection_id: ID of the collection.688 ///689 /// * owner: Address, initial owner of the NFT.690 ///691 /// * data: Token data to store on chain.692 #[weight = <CommonWeights<T>>::create_item()]693 #[transactional]694 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {695 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);696697 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data))698 }699700 /// This method creates multiple items in a collection created with CreateCollection method.701 ///702 /// # Permissions703 ///704 /// * Collection Owner.705 /// * Collection Admin.706 /// * Anyone if707 /// * Allow List is enabled, and708 /// * Address is added to allow list, and709 /// * MintPermission is enabled (see SetMintPermission method)710 ///711 /// # Arguments712 ///713 /// * collection_id: ID of the collection.714 ///715 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].716 ///717 /// * owner: Address, initial owner of the NFT.718 #[weight = <CommonWeights<T>>::create_multiple_items(items_data.len() as u32)]719 #[transactional]720 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {721 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);722 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);723724 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data))725 }726727 #[weight = <CommonWeights<T>>::create_multiple_items_ex(&data)]728 #[transactional]729 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {730 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);731732 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data))733 }734735 // TODO! transaction weight736737 /// Set transfers_enabled value for particular collection738 ///739 /// # Permissions740 ///741 /// * Collection Owner.742 ///743 /// # Arguments744 ///745 /// * collection_id: ID of the collection.746 ///747 /// * value: New flag value.748 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]749 #[transactional]750 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {751 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);752 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;753 target_collection.check_is_owner(&sender)?;754755 // =========756757 target_collection.limits.transfers_enabled = Some(value);758 target_collection.save()759 }760761 /// Destroys a concrete instance of NFT.762 ///763 /// # Permissions764 ///765 /// * Collection Owner.766 /// * Collection Admin.767 /// * Current NFT Owner.768 ///769 /// # Arguments770 ///771 /// * collection_id: ID of the collection.772 ///773 /// * item_id: ID of NFT to burn.774 #[weight = <CommonWeights<T>>::burn_item()]775 #[transactional]776 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {777 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);778779 let post_info = dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))?;780 if value == 1 {781 <NftTransferBasket<T>>::remove(collection_id, item_id);782 <NftApproveBasket<T>>::remove(collection_id, item_id);783 }784 // Those maps should be cleared only if token disappears completly, need to move this part of logic to pallets?785 // <FungibleApproveBasket<T>>::remove(collection_id, sender.as_sub());786 // <RefungibleApproveBasket<T>>::remove((collection_id, item_id, sender.as_sub()));787 Ok(post_info)788 }789790 /// Destroys a concrete instance of NFT on behalf of the owner791 /// See also: [`approve`]792 ///793 /// # Permissions794 ///795 /// * Collection Owner.796 /// * Collection Admin.797 /// * Current NFT Owner.798 ///799 /// # Arguments800 ///801 /// * collection_id: ID of the collection.802 ///803 /// * item_id: ID of NFT to burn.804 ///805 /// * from: owner of item806 #[weight = <CommonWeights<T>>::burn_from()]807 #[transactional]808 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {809 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);810811 dispatch_call::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value))812 }813814 /// Change ownership of the token.815 ///816 /// # Permissions817 ///818 /// * Collection Owner819 /// * Collection Admin820 /// * Current NFT owner821 ///822 /// # Arguments823 ///824 /// * recipient: Address of token recipient.825 ///826 /// * collection_id.827 ///828 /// * item_id: ID of the item829 /// * Non-Fungible Mode: Required.830 /// * Fungible Mode: Ignored.831 /// * Re-Fungible Mode: Required.832 ///833 /// * value: Amount to transfer.834 /// * Non-Fungible Mode: Ignored835 /// * Fungible Mode: Must specify transferred amount836 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)837 #[weight = <CommonWeights<T>>::transfer()]838 #[transactional]839 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {840 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);841842 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value))843 }844845 /// Set, change, or remove approved address to transfer the ownership of the NFT.846 ///847 /// # Permissions848 ///849 /// * Collection Owner850 /// * Collection Admin851 /// * Current NFT owner852 ///853 /// # Arguments854 ///855 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).856 ///857 /// * collection_id.858 ///859 /// * item_id: ID of the item.860 #[weight = <CommonWeights<T>>::approve()]861 #[transactional]862 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {863 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);864865 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))866 }867868 /// 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.869 ///870 /// # Permissions871 /// * Collection Owner872 /// * Collection Admin873 /// * Current NFT owner874 /// * Address approved by current NFT owner875 ///876 /// # Arguments877 ///878 /// * from: Address that owns token.879 ///880 /// * recipient: Address of token recipient.881 ///882 /// * collection_id.883 ///884 /// * item_id: ID of the item.885 ///886 /// * value: Amount to transfer.887 #[weight = <CommonWeights<T>>::transfer_from()]888 #[transactional]889 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {890 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);891892 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value))893 }894895 /// Set off-chain data schema.896 ///897 /// # Permissions898 ///899 /// * Collection Owner900 /// * Collection Admin901 ///902 /// # Arguments903 ///904 /// * collection_id.905 ///906 /// * schema: String representing the offchain data schema.907 #[weight = <CommonWeights<T>>::set_variable_metadata(data.len() as u32)]908 #[transactional]909 pub fn set_variable_meta_data (910 origin,911 collection_id: CollectionId,912 item_id: TokenId,913 data: BoundedVec<u8, CustomDataLimit>,914 ) -> DispatchResultWithPostInfo {915 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);916917 dispatch_call::<T, _>(collection_id, |d| d.set_variable_metadata(sender, item_id, data))918 }919920 /// Set meta_update_permission value for particular collection921 ///922 /// # Permissions923 ///924 /// * Collection Owner.925 ///926 /// # Arguments927 ///928 /// * collection_id: ID of the collection.929 ///930 /// * value: New flag value.931 #[weight = <SelfWeightOf<T>>::set_meta_update_permission_flag()]932 #[transactional]933 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {934 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);935 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;936937 ensure!(938 target_collection.meta_update_permission != MetaUpdatePermission::None,939 <CommonError<T>>::MetadataFlagFrozen,940 );941 target_collection.check_is_owner(&sender)?;942943 target_collection.meta_update_permission = value;944945 target_collection.save()946 }947948 /// Set schema standard949 /// ImageURL950 /// Unique951 ///952 /// # Permissions953 ///954 /// * Collection Owner955 /// * Collection Admin956 ///957 /// # Arguments958 ///959 /// * collection_id.960 ///961 /// * schema: SchemaVersion: enum962 #[weight = <SelfWeightOf<T>>::set_schema_version()]963 #[transactional]964 pub fn set_schema_version(965 origin,966 collection_id: CollectionId,967 version: SchemaVersion968 ) -> DispatchResult {969 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);970 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;971 target_collection.check_is_owner_or_admin(&sender)?;972 target_collection.schema_version = version;973974 <Pallet<T>>::deposit_event(Event::<T>::SchemaVersionSet(975 collection_id976 ));977978 target_collection.save()979 }980981 /// Set off-chain data schema.982 ///983 /// # Permissions984 ///985 /// * Collection Owner986 /// * Collection Admin987 ///988 /// # Arguments989 ///990 /// * collection_id.991 ///992 /// * schema: String representing the offchain data schema.993 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]994 #[transactional]995 pub fn set_offchain_schema(996 origin,997 collection_id: CollectionId,998 schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,999 ) -> DispatchResult {1000 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1001 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1002 target_collection.check_is_owner_or_admin(&sender)?;10031004 target_collection.offchain_schema = schema;10051006 <Pallet<T>>::deposit_event(Event::<T>::OffchainSchemaSet(1007 collection_id1008 ));10091010 target_collection.save()1011 }10121013 /// Set const on-chain data schema.1014 ///1015 /// # Permissions1016 ///1017 /// * Collection Owner1018 /// * Collection Admin1019 ///1020 /// # Arguments1021 ///1022 /// * collection_id.1023 ///1024 /// * schema: String representing the const on-chain data schema.1025 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1026 #[transactional]1027 pub fn set_const_on_chain_schema (1028 origin,1029 collection_id: CollectionId,1030 schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>1031 ) -> DispatchResult {1032 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1033 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1034 target_collection.check_is_owner_or_admin(&sender)?;10351036 target_collection.const_on_chain_schema = schema;10371038 <Pallet<T>>::deposit_event(Event::<T>::ConstOnChainSchemaSet(1039 collection_id1040 ));10411042 target_collection.save()1043 }10441045 /// Set variable on-chain data schema.1046 ///1047 /// # Permissions1048 ///1049 /// * Collection Owner1050 /// * Collection Admin1051 ///1052 /// # Arguments1053 ///1054 /// * collection_id.1055 ///1056 /// * schema: String representing the variable on-chain data schema.1057 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1058 #[transactional]1059 pub fn set_variable_on_chain_schema (1060 origin,1061 collection_id: CollectionId,1062 schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>1063 ) -> DispatchResult {1064 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1065 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1066 target_collection.check_is_owner_or_admin(&sender)?;10671068 target_collection.variable_on_chain_schema = schema;10691070 <Pallet<T>>::deposit_event(Event::<T>::VariableOnChainSchemaSet(1071 collection_id1072 ));10731074 target_collection.save()1075 }10761077 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1078 #[transactional]1079 pub fn set_collection_limits(1080 origin,1081 collection_id: CollectionId,1082 new_limit: CollectionLimits,1083 ) -> DispatchResult {1084 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1085 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1086 target_collection.check_is_owner(&sender)?;1087 let old_limit = &target_collection.limits;10881089 target_collection.limits = <PalletCommon<T>>::clamp_limits(target_collection.mode.clone(), &old_limit, new_limit)?;10901091 <Pallet<T>>::deposit_event(Event::<T>::CollectionLimitSet(1092 collection_id1093 ));10941095 target_collection.save()1096 }1097 }1098}primitives/data-structs/src/budget.rsdiffbeforeafterboth--- /dev/null
+++ b/primitives/data-structs/src/budget.rs
@@ -0,0 +1,38 @@
+use core::cell::Cell;
+
+pub trait Budget {
+ /// Returns true while not exceeded
+ fn consume(&self) -> bool {
+ self.consume_custom(1)
+ }
+ /// Returns true while not exceeded
+ /// Implementations should use interior mutabilitiy
+ fn consume_custom(&self, calls: u32) -> bool;
+}
+
+pub struct Unlimited;
+impl Budget for Unlimited {
+ fn consume_custom(&self, _calls: u32) -> bool {
+ true
+ }
+}
+
+pub struct Value(Cell<u32>);
+impl Value {
+ pub fn new(v: u32) -> Self {
+ Self(Cell::new(v))
+ }
+ pub fn refund(self) -> u32 {
+ self.0.get()
+ }
+}
+impl Budget for Value {
+ fn consume_custom(&self, calls: u32) -> bool {
+ let (result, overflown) = self.0.get().overflowing_sub(calls);
+ if overflown {
+ return false;
+ }
+ self.0.set(result);
+ true
+ }
+}
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -35,6 +35,7 @@
use scale_info::TypeInfo;
mod bounded;
+pub mod budget;
pub mod mapping;
mod migration;