difftreelog
Add economic model POC
in: master
5 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -3085,10 +3085,12 @@
dependencies = [
"frame-support",
"frame-system",
+ "pallet-transaction-payment",
"parity-scale-codec",
"sp-core",
"sp-io",
"sp-runtime",
+ "sp-std",
]
[[package]]
doc/application_development.mddiffbeforeafterboth--- a/doc/application_development.md
+++ b/doc/application_development.md
@@ -16,6 +16,54 @@
+## Custom Types for JS API
+
+```
+{
+ "Schedule": {
+ "version": "u32",
+ "put_code_per_byte_cost": "Gas",
+ "grow_mem_cost": "Gas",
+ "regular_op_cost": "Gas",
+ "return_data_per_byte_cost": "Gas",
+ "event_data_per_byte_cost": "Gas",
+ "event_per_topic_cost": "Gas",
+ "event_base_cost": "Gas",
+ "call_base_cost": "Gas",
+ "instantiate_base_cost": "Gas",
+ "dispatch_base_cost": "Gas",
+ "sandbox_data_read_cost": "Gas",
+ "sandbox_data_write_cost": "Gas",
+ "transfer_cost": "Gas",
+ "instantiate_cost": "Gas",
+ "max_event_topics": "u32",
+ "max_stack_height": "u32",
+ "max_memory_pages": "u32",
+ "max_table_size": "u32",
+ "enable_println": "bool",
+ "max_subject_len": "u32"
+ },
+ "NftItemType": {
+ "Collection": "u64",
+ "Owner": "AccountId",
+ "Data": "Vec<u8>"
+ },
+ "CollectionType": {
+ "Owner": "AccountId",
+ "NextItemId": "u64",
+ "Name": "Vec<u16>",
+ "Description": "Vec<u16>",
+ "TokenPrefix": "Vec<u8>",
+ "CustomDataSize": "u32",
+ "Sponsor": "AccountId",
+ "UnconfirmedSponsor": "AccountId"
+ },
+ "Address": "AccountId",
+ "LookupSource": "AccountId",
+ "Weight": "u64"
+}
+```
+
## NFT Palette Methods
### Collection Management
pallets/nft/Cargo.tomldiffbeforeafterboth--- a/pallets/nft/Cargo.toml
+++ b/pallets/nft/Cargo.toml
@@ -33,6 +33,19 @@
branch = 'rc4_ext_dispatch_reenabled'
version = '2.0.0-rc4'
+[dependencies.sp-std]
+default-features = false
+git = 'https://github.com/usetech-llc/substrate.git'
+branch = 'rc4_ext_dispatch_reenabled'
+version = '2.0.0-rc4'
+
+[dependencies.transaction-payment]
+default-features = false
+git = 'https://github.com/usetech-llc/substrate.git'
+package = 'pallet-transaction-payment'
+branch = 'rc4_ext_dispatch_reenabled'
+version = '2.0.0-rc4'
+
[package]
authors = ['Substrate DevHub <https://github.com/substrate-developer-hub>']
description = 'FRAME pallet nft'
@@ -52,4 +65,5 @@
'frame-support/std',
'frame-system/std',
'sp-runtime/std',
+ 'sp-std/std',
]
pallets/nft/src/lib.rsdiffbeforeafterboth9910/// For more guidance on Substrate FRAME, see the example pallet10/// For more guidance on Substrate FRAME, see the example pallet11/// https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs11/// https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs12use frame_support::{decl_event, decl_module, decl_storage, dispatch::DispatchResult, ensure};12pub use frame_support::{13 decl_event, decl_module, decl_storage,14 construct_runtime, parameter_types,15 traits::{Currency, Get, ExistenceRequirement, KeyOwnerProofSystem, OnUnbalanced, Randomness, WithdrawReason, Imbalance},16 weights::{17 DispatchInfo, PostDispatchInfo, constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},18 IdentityFee, Weight, WeightToFeePolynomial, GetDispatchInfo, Pays,19 },20 StorageValue,21 dispatch::DispatchResult, 22 IsSubType,23 ensure24};2513use frame_system::{self as system, ensure_signed};26use frame_system::{self as system, ensure_signed};14use sp_runtime::sp_std::prelude::Vec;27use sp_runtime::sp_std::prelude::Vec;28use sp_std::prelude::*;29use sp_runtime::{30 FixedU128, FixedPointOperand, 31 transaction_validity::{32 TransactionPriority, ValidTransaction, InvalidTransaction, TransactionValidityError, TransactionValidity33 },34 traits::{35 Saturating, Dispatchable, DispatchInfoOf, PostDispatchInfoOf, SignedExtension, Zero, SaturatedConversion,36 },37};153816#[cfg(test)]39#[cfg(test)]17mod mock;40mod mock;28 pub description: Vec<u16>, // 256 include null escape char51 pub description: Vec<u16>, // 256 include null escape char29 pub token_prefix: Vec<u8>, // 16 include null escape char52 pub token_prefix: Vec<u8>, // 16 include null escape char30 pub custom_data_size: u32,53 pub custom_data_size: u32,54 pub sponsor: AccountId, // Who pays fees. If set to default address, the fees are applied to the transaction sender55 pub unconfirmed_sponsor: AccountId, // Sponsor address that has not yet confirmed sponsorship31}56}325733#[derive(Encode, Decode, Default, Clone, PartialEq)]58#[derive(Encode, Decode, Default, Clone, PartialEq)]138 token_prefix: prefix,164 token_prefix: prefix,139 next_item_id: next_id,165 next_item_id: next_id,140 custom_data_size: custom_data_sz,166 custom_data_size: custom_data_sz,167 sponsor: T::AccountId::default(),168 unconfirmed_sponsor: T::AccountId::default(),141 };169 };142170143 // Add new collection to map171 // Add new collection to map237 }265 }238266239 #[weight = 0]267 #[weight = 0]268 pub fn set_collection_sponsor(origin, collection_id: u64, new_sponsor: T::AccountId) -> DispatchResult {269270 let sender = ensure_signed(origin)?;271 ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");272273 let mut target_collection = <Collection<T>>::get(collection_id);274 ensure!(sender == target_collection.owner, "You do not own this collection");275276 target_collection.unconfirmed_sponsor = new_sponsor;277 <Collection<T>>::insert(collection_id, target_collection);278279 Ok(())280 }281282 #[weight = 0]283 pub fn confirm_sponsorship(origin, collection_id: u64) -> DispatchResult {284285 let sender = ensure_signed(origin)?;286 ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");287288 let mut target_collection = <Collection<T>>::get(collection_id);289 ensure!(sender == target_collection.unconfirmed_sponsor, "This address is not set as sponsor, use setCollectionSponsor first");290291 target_collection.sponsor = target_collection.unconfirmed_sponsor;292 target_collection.unconfirmed_sponsor = T::AccountId::default();293 <Collection<T>>::insert(collection_id, target_collection);294295 Ok(())296 }297298 #[weight = 0]299 pub fn remove_collection_sponsor(origin, collection_id: u64) -> DispatchResult {300301 let sender = ensure_signed(origin)?;302 ensure!(<Collection<T>>::contains_key(collection_id), "This collection does not exist");303304 let mut target_collection = <Collection<T>>::get(collection_id);305 ensure!(sender == target_collection.owner, "You do not own this collection");306307 target_collection.sponsor = T::AccountId::default();308 <Collection<T>>::insert(collection_id, target_collection);309310 Ok(())311 }312 313314315 #[weight = 0]240 pub fn create_item(origin, collection_id: u64, properties: Vec<u8>) -> DispatchResult {316 pub fn create_item(origin, collection_id: u64, properties: Vec<u8>) -> DispatchResult {241317242 let sender = ensure_signed(origin)?;318 let sender = ensure_signed(origin)?;492}568}569570571////////////////////////////////////////////////////////////////////////////////////////////////////572// Economic models573574/// Fee multiplier.575pub type Multiplier = FixedU128;576577type BalanceOf<T> =578 <<T as transaction_payment::Trait>::Currency as Currency<<T as system::Trait>::AccountId>>::Balance;579type NegativeImbalanceOf<T> = <<T as transaction_payment::Trait>::Currency as Currency<580 <T as system::Trait>::AccountId,>>::NegativeImbalance;581582583584/// Require the transactor pay for themselves and maybe include a tip to gain additional priority585/// in the queue.586#[derive(Encode, Decode, Clone, Eq, PartialEq)]587pub struct ChargeTransactionPayment<T: transaction_payment::Trait + Send + Sync>(#[codec(compact)] BalanceOf<T>);588589impl<T:Trait + transaction_payment::Trait + Send + Sync> sp_std::fmt::Debug for ChargeTransactionPayment<T> {590 #[cfg(feature = "std")]591 fn fmt(&self, f: &mut sp_std::fmt::Formatter) -> sp_std::fmt::Result {592 write!(f, "ChargeTransactionPayment<{:?}>", self.0)593 }594 #[cfg(not(feature = "std"))]595 fn fmt(&self, _: &mut sp_std::fmt::Formatter) -> sp_std::fmt::Result {596 Ok(())597 }598}599600impl<T:Trait + transaction_payment::Trait + Send + Sync> ChargeTransactionPayment<T> where601 T::Call: Dispatchable<Info=DispatchInfo, PostInfo=PostDispatchInfo> + IsSubType<Module<T>, T>,602 BalanceOf<T>: Send + Sync + FixedPointOperand,603{604 /// utility constructor. Used only in client/factory code.605 pub fn from(fee: BalanceOf<T>) -> Self {606 Self(fee)607 }608609 pub fn traditional_fee(610 len: usize,611 info: &DispatchInfoOf<T::Call>,612 tip: BalanceOf<T>,613 ) -> BalanceOf<T> where614 T::Call: Dispatchable<Info=DispatchInfo>,615 {616 <transaction_payment::Module<T>>::compute_fee(len as u32, info, tip)617 }618619 fn withdraw_fee(620 &self,621 who: &T::AccountId,622 call: &T::Call,623 info: &DispatchInfoOf<T::Call>,624 len: usize,625 ) -> Result<(BalanceOf<T>, Option<NegativeImbalanceOf<T>>), TransactionValidityError> {626 let tip = self.0;627628 // Set fee based on call type. Creating collection costs 1 Unique.629 // All other transactions have traditional fees so far630 let fee = match call.is_sub_type() {631 Some(Call::create_collection(..)) => <BalanceOf<T>>::from(1_000_000_000),632 _ => Self::traditional_fee(len, info, tip)633634 // Flat fee model, use only for testing purposes635 // _ => <BalanceOf<T>>::from(100)636 };637638 // Determine who is paying transaction fee based on ecnomic model639 // Parse call to extract collection ID and access collection sponsor640 let sponsor: T::AccountId = match call.is_sub_type() {641 Some(Call::create_item(collection_id, _properties)) => {642 <Collection<T>>::get(collection_id).sponsor643 },644 Some(Call::transfer(collection_id, _item_id, _new_owner)) => {645 <Collection<T>>::get(collection_id).sponsor646 },647648 _ => T::AccountId::default()649 };650651 let mut who_pays_fee: T::AccountId = sponsor.clone();652 if sponsor == T::AccountId::default() {653 who_pays_fee = who.clone();654 }655656 // Only mess with balances if fee is not zero.657 if fee.is_zero() {658 return Ok((fee, None));659 }660661 match <T as transaction_payment::Trait>::Currency::withdraw(662 &who_pays_fee,663 fee,664 if tip.is_zero() {665 WithdrawReason::TransactionPayment.into()666 } else {667 WithdrawReason::TransactionPayment | WithdrawReason::Tip668 },669 ExistenceRequirement::KeepAlive,670 ) {671 Ok(imbalance) => Ok((fee, Some(imbalance))),672 Err(_) => Err(InvalidTransaction::Payment.into()),673 }674 }675}676677impl<T:Trait + transaction_payment::Trait + Send + Sync> SignedExtension for ChargeTransactionPayment<T> where678 BalanceOf<T>: Send + Sync + From<u64> + FixedPointOperand,679 T::Call: Dispatchable<Info=DispatchInfo, PostInfo=PostDispatchInfo> + IsSubType<Module<T>, T>,680{681 const IDENTIFIER: &'static str = "ChargeTransactionPayment";682 type AccountId = T::AccountId;683 type Call = T::Call;684 type AdditionalSigned = ();685 type Pre = (BalanceOf<T>, Self::AccountId, Option<NegativeImbalanceOf<T>>, BalanceOf<T>);686 fn additional_signed(&self) -> sp_std::result::Result<(), TransactionValidityError> { Ok(()) }687688 fn validate(689 &self,690 who: &Self::AccountId,691 call: &Self::Call,692 info: &DispatchInfoOf<Self::Call>,693 len: usize,694 ) -> TransactionValidity {695 let (fee, _) = self.withdraw_fee(who, call, info, len)?;696697 let mut r = ValidTransaction::default();698 // NOTE: we probably want to maximize the _fee (of any type) per weight unit_ here, which699 // will be a bit more than setting the priority to tip. For now, this is enough.700 r.priority = fee.saturated_into::<TransactionPriority>();701 Ok(r)702 }703704 fn pre_dispatch(705 self,706 who: &Self::AccountId,707 call: &Self::Call,708 info: &DispatchInfoOf<Self::Call>,709 len: usize710 ) -> Result<Self::Pre, TransactionValidityError> {711 let (fee, imbalance) = self.withdraw_fee(who, call, info, len)?;712 Ok((self.0, who.clone(), imbalance, fee))713 }714715 fn post_dispatch(716 pre: Self::Pre,717 info: &DispatchInfoOf<Self::Call>,718 post_info: &PostDispatchInfoOf<Self::Call>,719 len: usize,720 _result: &DispatchResult,721 ) -> Result<(), TransactionValidityError> {722 let (tip, who, imbalance, fee) = pre;723 if let Some(payed) = imbalance {724 let actual_fee = <transaction_payment::Module<T>>::compute_actual_fee(725 len as u32,726 info,727 post_info,728 tip,729 );730 let refund = fee.saturating_sub(actual_fee);731 let actual_payment = match <T as transaction_payment::Trait>::Currency::deposit_into_existing(&who, refund) {732 Ok(refund_imbalance) => {733 // The refund cannot be larger than the up front payed max weight.734 // `PostDispatchInfo::calc_unspent` guards against such a case.735 match payed.offset(refund_imbalance) {736 Ok(actual_payment) => actual_payment,737 Err(_) => return Err(InvalidTransaction::Payment.into()),738 }739 }740 // We do not recreate the account using the refund. The up front payment741 // is gone in that case.742 Err(_) => payed,743 };744 let imbalances = actual_payment.split(tip);745 <T as transaction_payment::Trait>::OnTransactionPayment::on_unbalanceds(Some(imbalances.0).into_iter()746 .chain(Some(imbalances.1)));747 }748 Ok(())749 }750}493751runtime/src/lib.rsdiffbeforeafterboth--- a/runtime/src/lib.rs
+++ b/runtime/src/lib.rs
@@ -14,13 +14,13 @@
use sp_api::impl_runtime_apis;
use sp_consensus_aura::sr25519::AuthorityId as AuraId;
use sp_core::{crypto::KeyTypeId, OpaqueMetadata};
-use sp_runtime::traits::{
- BlakeTwo256, Block as BlockT, IdentifyAccount, IdentityLookup, NumberFor, Saturating, Verify,
-};
use sp_runtime::{
create_runtime_str, generic, impl_opaque_keys,
transaction_validity::{TransactionSource, TransactionValidity},
ApplyExtrinsicResult, MultiSignature,
+ traits::{
+ BlakeTwo256, Block as BlockT, IdentifyAccount, IdentityLookup, NumberFor, Saturating, Verify,
+ },
};
use sp_std::prelude::*;
#[cfg(feature = "std")]
@@ -32,16 +32,22 @@
pub use contracts::Schedule as ContractsSchedule;
pub use frame_support::{
construct_runtime, parameter_types,
- traits::{KeyOwnerProofSystem, Randomness},
+ traits::{Currency, Get, ExistenceRequirement, KeyOwnerProofSystem, OnUnbalanced, Randomness, WithdrawReason},
weights::{
- constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},
- IdentityFee, Weight,
+ DispatchInfo, PostDispatchInfo, constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},
+ IdentityFee, Weight, WeightToFeePolynomial, GetDispatchInfo, Pays,
},
StorageValue,
+ dispatch::DispatchResult,
};
+use system::{self as system};
#[cfg(any(feature = "std", test))]
pub use sp_runtime::BuildStorage;
-pub use sp_runtime::{Perbill, Permill};
+use sp_runtime::{
+ Perbill,
+};
+
+
pub use timestamp::Call as TimestampCall;
/// Importing a nft pallet
@@ -228,7 +234,8 @@
}
parameter_types! {
- pub const ExistentialDeposit: u128 = 500;
+ // pub const ExistentialDeposit: u128 = 500;
+ pub const ExistentialDeposit: u128 = 0;
}
impl balances::Trait for Runtime {
@@ -331,7 +338,7 @@
system::CheckEra<Runtime>,
system::CheckNonce<Runtime>,
system::CheckWeight<Runtime>,
- transaction_payment::ChargeTransactionPayment<Runtime>,
+ nft::ChargeTransactionPayment<Runtime>,
);
/// Unchecked extrinsic type as expected by this runtime.
pub type UncheckedExtrinsic = generic::UncheckedExtrinsic<Address, Call, Signature, SignedExtra>;
@@ -486,3 +493,4 @@
}
}
}
+