refactor: Transaction-Payment module

Cargo.toml

@@ -106,6 +106,7 @@ members = [
 	"srml/system/rpc",
 	"srml/timestamp",
 	"srml/treasury",
+	"srml/transaction-payment",
 	"srml/utility",
 	"node/cli",
 	"node/executor",

core/sr-primitives/src/sr_arithmetic.rs

@@ -543,7 +543,6 @@ implement_per_thing!(
 
 /// An unsigned fixed point number. Can hold any value in the range [-9_223_372_036, 9_223_372_036]
 /// with fixed point accuracy of one billion.
-#[cfg_attr(feature = "std", derive(Debug))]
 #[derive(Encode, Decode, Default, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Fixed64(i64);
 
@@ -668,6 +667,13 @@ impl CheckedAdd for Fixed64 {
 	}
 }
 
+#[cfg(feature = "std")]
+impl rstd::fmt::Debug for Fixed64 {
+	fn fmt(&self, f: &mut rstd::fmt::Formatter<'_>) -> rstd::fmt::Result {
+		write!(f, "Fixed64({},{})", self.0 / DIV, (self.0 % DIV) / 1000)
+	}
+}
+
 /// Infinite precision unsigned integer for substrate runtime.
 pub mod biguint {
 	use super::Zero;
@@ -981,8 +987,6 @@ pub mod biguint {
 			let mut q = Self::with_capacity(m + 1);
 			let mut r = Self::with_capacity(n);
 
-			debug_assert!(other.msb() != 0);
-
 			// PROOF: 0 <= normalizer_bits < SHIFT 0 <= normalizer < B. all conversions are
 			// safe.
 			let normalizer_bits = other.msb().leading_zeros() as Single;
@@ -2136,6 +2140,35 @@ mod tests_fixed64 {
 		assert_eq!(max(), Fixed64::from_natural(9_223_372_037));
 	}
 
+	#[test]
+	fn fixed_64_growth_decrease_curve() {
+		let test_set = vec![0u32, 1, 10, 1000, 1_000_000_000];
+
+		// negative (1/2)
+		let mut fm = Fixed64::from_rational(-1, 2);
+		test_set.clone().into_iter().for_each(|i| {
+			assert_eq!(fm.saturated_multiply_accumulate(i) as i32, i as i32 - i as i32 / 2);
+		});
+
+		// unit (1) multiplier
+		fm = Fixed64::from_parts(0);
+		test_set.clone().into_iter().for_each(|i| {
+			assert_eq!(fm.saturated_multiply_accumulate(i), i);
+		});
+
+		// i.5 multiplier
+		fm = Fixed64::from_rational(1, 2);
+		test_set.clone().into_iter().for_each(|i| {
+			assert_eq!(fm.saturated_multiply_accumulate(i), i * 3 / 2);
+		});
+
+		// dual multiplier
+		fm = Fixed64::from_rational(1, 1);
+		test_set.clone().into_iter().for_each(|i| {
+			assert_eq!(fm.saturated_multiply_accumulate(i), i * 2);
+		});
+	}
+
 	macro_rules! saturating_mul_acc_test {
 		($num_type:tt) => {
 			assert_eq!(

core/sr-primitives/src/weights.rs

@@ -23,9 +23,6 @@
 //! Note that the decl_module macro _cannot_ enforce this and will simply fail if an invalid struct
 //! (something that does not  implement `Weighable`) is passed in.
 
-use crate::{Fixed64, traits::Saturating};
-use crate::codec::{Encode, Decode};
-
 pub use crate::transaction_validity::TransactionPriority;
 use crate::traits::Bounded;
 
@@ -167,76 +164,3 @@ impl Default for SimpleDispatchInfo {
 		SimpleDispatchInfo::FixedNormal(10_000)
 	}
 }
-
-/// Representation of a weight multiplier. This represents how a fee value can be computed from a
-/// weighted transaction.
-///
-/// This is basically a wrapper for the `Fixed64` type a slightly tailored multiplication to u32
-/// in the form of the `apply_to` method.
-#[cfg_attr(feature = "std", derive(Debug))]
-#[derive(Encode, Decode, Default, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
-pub struct WeightMultiplier(Fixed64);
-
-impl WeightMultiplier {
-	/// Apply the inner Fixed64 as a weight multiplier to a weight value.
-	///
-	/// This will perform a saturated  `weight + weight * self.0`.
-	pub fn apply_to(&self, weight: Weight) -> Weight {
-		self.0.saturated_multiply_accumulate(weight)
-	}
-
-	/// build self from raw parts per billion.
-	#[cfg(feature = "std")]
-	pub fn from_parts(parts: i64) -> Self {
-		Self(Fixed64::from_parts(parts))
-	}
-
-	/// build self from a fixed64 value.
-	pub fn from_fixed(f: Fixed64) -> Self {
-		Self(f)
-	}
-
-	/// Approximate the fraction `n/d`.
-	pub fn from_rational(n: i64, d: u64) -> Self {
-		Self(Fixed64::from_rational(n, d))
-	}
-}
-
-impl Saturating for WeightMultiplier {
-	fn saturating_add(self, rhs: Self) -> Self {
-		Self(self.0.saturating_add(rhs.0))
-	}
-	fn saturating_mul(self, rhs: Self) -> Self {
-		Self(self.0.saturating_mul(rhs.0))
-
-	}
-	fn saturating_sub(self, rhs: Self) -> Self {
-		Self(self.0.saturating_sub(rhs.0))
-	}
-}
-
-#[cfg(test)]
-mod tests {
-	use super::*;
-
-	#[test]
-	fn multiplier_apply_to_works() {
-		let test_set = vec![0, 1, 10, 1000, 1_000_000_000];
-
-		// negative (1/2)
-		let mut fm = WeightMultiplier::from_rational(-1, 2);
-		test_set.clone().into_iter().for_each(|i| { assert_eq!(fm.apply_to(i) as i32, i as i32  - i as i32 / 2); });
-
-		// unit (1) multiplier
-		fm = WeightMultiplier::from_parts(0);
-		test_set.clone().into_iter().for_each(|i| { assert_eq!(fm.apply_to(i), i); });
-
-		// i.5 multiplier
-		fm = WeightMultiplier::from_rational(1, 2);
-		test_set.clone().into_iter().for_each(|i| { assert_eq!(fm.apply_to(i), i * 3 / 2); });
-
-		// dual multiplier
-		fm = WeightMultiplier::from_rational(1, 1);
-		test_set.clone().into_iter().for_each(|i| { assert_eq!(fm.apply_to(i), i * 2); });
-	}
-}

core/test-runtime/src/lib.rs

@@ -382,7 +382,6 @@ impl srml_system::Trait for Runtime {
 	type Lookup = IdentityLookup<Self::AccountId>;
 	type Header = Header;
 	type Event = Event;
-	type WeightMultiplierUpdate = ();
 	type BlockHashCount = BlockHashCount;
 	type MaximumBlockWeight = MaximumBlockWeight;
 	type MaximumBlockLength = MaximumBlockLength;

node-template/runtime/Cargo.toml

@@ -24,6 +24,7 @@ randomness-collective-flip = { package = "srml-randomness-collective-flip", path
 system = { package = "srml-system", path = "../../srml/system", default_features = false }
 timestamp = { package = "srml-timestamp", path = "../../srml/timestamp", default_features = false }
 sudo = { package = "srml-sudo", path = "../../srml/sudo", default_features = false }
+transaction-payment = { package = "srml-transaction-payment", path = "../../srml/transaction-payment", default_features = false }
 sr-primitives = { path = "../../core/sr-primitives", default_features = false }
 client = { package = "substrate-client", path = "../../core/client", default_features = false }
 offchain-primitives = { package = "substrate-offchain-primitives", path = "../../core/offchain/primitives", default-features = false }
@@ -51,6 +52,7 @@ std = [
 	"system/std",
 	"timestamp/std",
 	"sudo/std",
+	"transaction-payment/std",
 	"version/std",
 	"serde",
 	"safe-mix/std",

node-template/runtime/src/lib.rs

@@ -166,18 +166,17 @@ impl system::Trait for Runtime {
 	type Header = generic::Header<BlockNumber, BlakeTwo256>;
 	/// The ubiquitous event type.
 	type Event = Event;
-	/// Update weight (to fee) multiplier per-block.
-	type WeightMultiplierUpdate = ();
 	/// The ubiquitous origin type.
 	type Origin = Origin;
 	/// Maximum number of block number to block hash mappings to keep (oldest pruned first).
 	type BlockHashCount = BlockHashCount;
-	/// Maximum weight of each block. With a default weight system of 1byte == 1weight, 4mb is ok.
+	/// Maximum weight of each block.
 	type MaximumBlockWeight = MaximumBlockWeight;
 	/// Maximum size of all encoded transactions (in bytes) that are allowed in one block.
 	type MaximumBlockLength = MaximumBlockLength;
 	/// Portion of the block weight that is available to all normal transactions.
 	type AvailableBlockRatio = AvailableBlockRatio;
+	/// Version of the runtime.
 	type Version = Version;
 }
 
@@ -223,8 +222,6 @@ parameter_types! {
 	pub const ExistentialDeposit: u128 = 500;
 	pub const TransferFee: u128 = 0;
 	pub const CreationFee: u128 = 0;
-	pub const TransactionBaseFee: u128 = 0;
-	pub const TransactionByteFee: u128 = 1;
 }
 
 impl balances::Trait for Runtime {
@@ -236,15 +233,25 @@ impl balances::Trait for Runtime {
 	type OnNewAccount = Indices;
 	/// The ubiquitous event type.
 	type Event = Event;
-	type TransactionPayment = ();
 	type DustRemoval = ();
 	type TransferPayment = ();
 	type ExistentialDeposit = ExistentialDeposit;
 	type TransferFee = TransferFee;
 	type CreationFee = CreationFee;
+}
+
+parameter_types! {
+	pub const TransactionBaseFee: Balance = 0;
+	pub const TransactionByteFee: Balance = 1;
+}
+
+impl transaction_payment::Trait for Runtime {
+	type Currency = balances::Module<Runtime>;
+	type OnTransactionPayment = ();
 	type TransactionBaseFee = TransactionBaseFee;
 	type TransactionByteFee = TransactionByteFee;
 	type WeightToFee = ConvertInto;
+	type FeeMultiplierUpdate = ();
 }
 
 impl sudo::Trait for Runtime {
@@ -269,6 +276,7 @@ construct_runtime!(
 		Grandpa: grandpa::{Module, Call, Storage, Config, Event},
 		Indices: indices::{default, Config<T>},
 		Balances: balances::{default, Error},
+		TransactionPayment: transaction_payment::{Module, Storage},
 		Sudo: sudo,
 		// Used for the module template in `./template.rs`
 		TemplateModule: template::{Module, Call, Storage, Event<T>},
@@ -293,7 +301,7 @@ pub type SignedExtra = (
 	system::CheckEra<Runtime>,
 	system::CheckNonce<Runtime>,
 	system::CheckWeight<Runtime>,
-	balances::TakeFees<Runtime>
+	transaction_payment::ChargeTransactionPayment<Runtime>
 );
 /// Unchecked extrinsic type as expected by this runtime.
 pub type UncheckedExtrinsic = generic::UncheckedExtrinsic<Address, Call, Signature, SignedExtra>;

node-template/runtime/src/template.rs

@@ -100,7 +100,6 @@ mod tests {
 		type AccountId = u64;
 		type Lookup = IdentityLookup<Self::AccountId>;
 		type Header = Header;
-		type WeightMultiplierUpdate = ();
 		type Event = ();
 		type BlockHashCount = BlockHashCount;
 		type MaximumBlockWeight = MaximumBlockWeight;

node/cli/Cargo.toml

@@ -45,6 +45,7 @@ finality_tracker = { package = "srml-finality-tracker", path = "../../srml/final
 contracts = { package = "srml-contracts", path = "../../srml/contracts" }
 system = { package = "srml-system", path = "../../srml/system" }
 balances = { package = "srml-balances", path = "../../srml/balances" }
+transaction-payment = { package = "srml-transaction-payment", path = "../../srml/transaction-payment" }
 support = { package = "srml-support", path = "../../srml/support", default-features = false }
 im_online = { package = "srml-im-online", path = "../../srml/im-online", default-features = false }
 sr-authority-discovery = { package = "srml-authority-discovery", path = "../../srml/authority-discovery", default-features = false }

node/cli/src/factory_impl.rs

@@ -56,7 +56,7 @@ impl<Number> FactoryState<Number> {
 			system::CheckEra::from(Era::mortal(256, phase)),
 			system::CheckNonce::from(index),
 			system::CheckWeight::new(),
-			balances::TakeFees::from(0),
+			transaction_payment::ChargeTransactionPayment::from(0),
 			Default::default(),
 		)
 	}

node/cli/src/service.rs

@@ -528,14 +528,14 @@ mod tests {
 				let check_era = system::CheckEra::from(Era::Immortal);
 				let check_nonce = system::CheckNonce::from(index);
 				let check_weight = system::CheckWeight::new();
-				let take_fees = balances::TakeFees::from(0);
+				let payment = transaction_payment::ChargeTransactionPayment::from(0);
 				let extra = (
 					check_version,
 					check_genesis,
 					check_era,
 					check_nonce,
 					check_weight,
-					take_fees,
+					payment,
 					Default::default(),
 				);
 				let raw_payload = SignedPayload::from_raw(

node/executor/Cargo.toml

@@ -22,6 +22,7 @@ test-client = { package = "substrate-test-client", path = "../../core/test-clien
 sr-primitives = { path = "../../core/sr-primitives" }
 runtime_support = { package = "srml-support", path = "../../srml/support" }
 balances = { package = "srml-balances", path = "../../srml/balances" }
+transaction-payment = { package = "srml-transaction-payment", path = "../../srml/transaction-payment" }
 session = { package = "srml-session", path = "../../srml/session" }
 system = { package = "srml-system", path = "../../srml/system" }
 timestamp = { package = "srml-timestamp", path = "../../srml/timestamp" }