RPC to query transaction fee + weight + info (#3876)

* initial version for testing

* New version that compiles

* optional at block parameter

* Fix some more view grumbles.

* Update srml/transaction-payment/src/lib.rs

Author: kianenigma

Cargo.lock

@@ -82,6 +82,7 @@ members = [
 	"srml/aura",
 	"srml/balances",
 	"srml/contracts",
+	"srml/contracts/rpc",
 	"srml/collective",
 	"srml/democracy",
 	"srml/elections",
@@ -109,6 +110,7 @@ members = [
 	"srml/timestamp",
 	"srml/treasury",
 	"srml/transaction-payment",
+	"srml/transaction-payment/rpc",
 	"srml/utility",
 	"node/cli",
 	"node/executor",

Cargo.toml

@@ -23,6 +23,7 @@ use codec::{Decode, Encode, EncodeLike, Input, Error};
 use crate::{
 	traits::{self, Member, MaybeDisplay, SignedExtension, Checkable, Extrinsic, IdentifyAccount},
 	generic::CheckedExtrinsic, transaction_validity::{TransactionValidityError, InvalidTransaction},
+	weights::{GetDispatchInfo, DispatchInfo},
 };
 
 const TRANSACTION_VERSION: u8 = 4;
@@ -280,6 +281,17 @@ where
 	}
 }
 
+impl<Address, Call, Signature, Extra> GetDispatchInfo
+	for UncheckedExtrinsic<Address, Call, Signature, Extra>
+where
+	Call: GetDispatchInfo,
+	Extra: SignedExtension,
+{
+	fn get_dispatch_info(&self) -> DispatchInfo {
+		self.function.get_dispatch_info()
+	}
+}
+
 #[cfg(test)]
 mod tests {
 	use super::*;

core/sr-primitives/src/generic/unchecked_extrinsic.rs

@@ -35,9 +35,13 @@
 //! 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.
 
+#[cfg(feature = "std")]
+use serde::{Serialize, Deserialize};
+use codec::{Encode, Decode};
 use arithmetic::traits::Bounded;
 use crate::RuntimeDebug;
 
+/// Re-export priority as type
 pub use crate::transaction_validity::TransactionPriority;
 
 /// Numeric range of a transaction weight.
@@ -58,10 +62,10 @@ pub trait ClassifyDispatch<T> {
 	fn classify_dispatch(&self, target: T) -> DispatchClass;
 }
 
-/// A generalized group of dispatch types. This is only distinguishing normal, user-triggered
-/// transactions (`Normal`) and anything beyond which serves a higher purpose to the system
-/// (`Operational`).
-#[derive(PartialEq, Eq, Clone, Copy, RuntimeDebug)]
+/// A generalized group of dispatch types. This is only distinguishing normal, user-triggered transactions
+/// (`Normal`) and anything beyond which serves a higher purpose to the system (`Operational`).
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
+#[derive(PartialEq, Eq, Clone, Copy, Encode, Decode, RuntimeDebug)]
 pub enum DispatchClass {
 	/// A normal dispatch.
 	Normal,

core/sr-primitives/src/weights.rs

@@ -8,7 +8,9 @@ edition = "2018"
 client = { package = "substrate-client", path = "../../core/client" }
 jsonrpc-core = "13.2.0"
 node-primitives = { path = "../primitives" }
+node-runtime = { path = "../runtime" }
 sr-primitives = { path = "../../core/sr-primitives" }
 srml-contracts-rpc = { path = "../../srml/contracts/rpc/" }
+srml-transaction-payment-rpc = { path = "../../srml/transaction-payment/rpc/" }
 srml-system-rpc = { path = "../../srml/system/rpc/" }
 transaction_pool = { package = "substrate-transaction-pool", path = "../../core/transaction-pool" }

node/rpc/Cargo.toml

@@ -32,6 +32,7 @@
 use std::sync::Arc;
 
 use node_primitives::{Block, AccountId, Index, Balance};
+use node_runtime::UncheckedExtrinsic;
 use sr_primitives::traits::ProvideRuntimeApi;
 use transaction_pool::txpool::{ChainApi, Pool};
 
@@ -42,18 +43,23 @@ pub fn create<C, P, M>(client: Arc<C>, pool: Arc<Pool<P>>) -> jsonrpc_core::IoHa
 	C: Send + Sync + 'static,
 	C::Api: srml_system_rpc::AccountNonceApi<Block, AccountId, Index>,
 	C::Api: srml_contracts_rpc::ContractsRuntimeApi<Block, AccountId, Balance>,
+	C::Api: srml_transaction_payment_rpc::TransactionPaymentRuntimeApi<Block, Balance, UncheckedExtrinsic>,
 	P: ChainApi + Sync + Send + 'static,
 	M: jsonrpc_core::Metadata + Default,
 {
 	use srml_system_rpc::{System, SystemApi};
 	use srml_contracts_rpc::{Contracts, ContractsApi};
+	use srml_transaction_payment_rpc::{TransactionPayment, TransactionPaymentApi};
 
 	let mut io = jsonrpc_core::IoHandler::default();
 	io.extend_with(
 		SystemApi::to_delegate(System::new(client.clone(), pool))
 	);
 	io.extend_with(
-		ContractsApi::to_delegate(Contracts::new(client))
+		ContractsApi::to_delegate(Contracts::new(client.clone()))
+	);
+	io.extend_with(
+		TransactionPaymentApi::to_delegate(TransactionPayment::new(client))
 	);
 	io
 }

node/rpc/src/lib.rs

@@ -52,6 +52,7 @@ timestamp = { package = "srml-timestamp", path = "../../srml/timestamp", default
 treasury = { package = "srml-treasury", path = "../../srml/treasury", default-features = false }
 utility = { package = "srml-utility", path = "../../srml/utility", default-features = false }
 transaction-payment = { package = "srml-transaction-payment", path = "../../srml/transaction-payment", default-features = false }
+transaction-payment-rpc-runtime-api = { package = "srml-transaction-payment-rpc-runtime-api", path = "../../srml/transaction-payment/rpc/runtime-api/", default-features = false }
 
 [build-dependencies]
 wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.4", path = "../../core/utils/wasm-builder-runner" }
@@ -103,5 +104,6 @@ std = [
 	"treasury/std",
 	"utility/std",
 	"transaction-payment/std",
+	"transaction-payment-rpc-runtime-api/std",
 	"version/std",
 ]

node/runtime/Cargo.toml

@@ -50,6 +50,8 @@ use version::NativeVersion;
 use primitives::OpaqueMetadata;
 use grandpa::{AuthorityId as GrandpaId, AuthorityWeight as GrandpaWeight};
 use im_online::sr25519::{AuthorityId as ImOnlineId};
+use transaction_payment_rpc_runtime_api::RuntimeDispatchInfo;
+use contracts_rpc_runtime_api::ContractExecResult;
 use system::offchain::TransactionSubmitter;
 
 #[cfg(any(feature = "std", test))]
@@ -661,9 +663,7 @@ impl_runtime_apis! {
 			value: Balance,
 			gas_limit: u64,
 			input_data: Vec<u8>,
-		) -> contracts_rpc_runtime_api::ContractExecResult {
-			use contracts_rpc_runtime_api::ContractExecResult;
-
+		) -> ContractExecResult {
 			let exec_result = Contracts::bare_call(
 				origin,
 				dest.into(),
@@ -681,9 +681,20 @@ impl_runtime_apis! {
 		}
 	}
 
+	impl transaction_payment_rpc_runtime_api::TransactionPaymentApi<
+		Block,
+		Balance,
+		UncheckedExtrinsic,
+	> for Runtime {
+		fn query_info(uxt: UncheckedExtrinsic, len: u32) -> RuntimeDispatchInfo<Balance> {
+			TransactionPayment::query_info(uxt, len)
+		}
+	}
+
 	impl substrate_session::SessionKeys<Block> for Runtime {
 		fn generate_session_keys(seed: Option<Vec<u8>>) -> Vec<u8> {
-			let seed = seed.as_ref().map(|s| rstd::str::from_utf8(&s).expect("Seed is an utf8 string"));
+			let seed = seed.as_ref().map(|s| rstd::str::from_utf8(&s)
+				.expect("Seed is an utf8 string"));
 			SessionKeys::generate(seed)
 		}
 	}

node/runtime/src/lib.rs

@@ -571,7 +571,7 @@ mod tests {
 			assert!(Executive::apply_extrinsic(x2.clone()).unwrap().is_ok());
 
 			// default weight for `TestXt` == encoded length.
-			assert_eq!(<system::Module<Runtime>>::all_extrinsics_weight(), (3 * len).into());
+			assert_eq!(<system::Module<Runtime>>::all_extrinsics_weight(), (3 * len) as u32);
 			assert_eq!(<system::Module<Runtime>>::all_extrinsics_len(), 3 * len);
 
 			let _ = <system::Module<Runtime>>::finalize();

srml/executive/src/lib.rs

@@ -10,6 +10,7 @@ rstd = { package = "sr-std", path = "../../core/sr-std", default-features = fals
 sr-primitives = { path = "../../core/sr-primitives", default-features = false }
 support = { package = "srml-support", path = "../support", default-features = false }
 system = { package = "srml-system", path = "../system", default-features = false }
+transaction-payment-rpc-runtime-api = { package = "srml-transaction-payment-rpc-runtime-api", path = "./rpc/runtime-api", default-features = false }
 
 [dev-dependencies]
 runtime-io = { package = "sr-io", path = "../../core/sr-io" }
@@ -24,4 +25,5 @@ std = [
 	"sr-primitives/std",
 	"support/std",
 	"system/std",
+	"transaction-payment-rpc-runtime-api/std"
 ]

srml/transaction-payment/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "srml-transaction-payment-rpc"
+version = "2.0.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+client = { package = "substrate-client", path = "../../../core/client" }
+codec = { package = "parity-scale-codec", version = "1.0.0" }
+jsonrpc-core = "13.2.0"
+jsonrpc-core-client = "13.2.0"
+jsonrpc-derive = "13.2.0"
+primitives = { package = "substrate-primitives",  path = "../../../core/primitives" }
+rpc-primitives = { package = "substrate-rpc-primitives", path = "../../../core/rpc/primitives" }
+serde = { version = "1.0.101", features = ["derive"] }
+sr-primitives = { path = "../../../core/sr-primitives" }
+srml-transaction-payment-rpc-runtime-api = { path = "./runtime-api" }

srml/transaction-payment/rpc/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "srml-transaction-payment-rpc-runtime-api"
+version = "2.0.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+serde = { version = "1.0.101", optional = true, features = ["derive"] }
+client = { package = "substrate-client", path = "../../../../core/client", default-features = false }
+codec = { package = "parity-scale-codec", version = "1.0.6", default-features = false, features = ["derive"] }
+rstd = { package = "sr-std", path = "../../../../core/sr-std", default-features = false }
+sr-primitives = { path = "../../../../core/sr-primitives", default-features = false }
+
+[features]
+default = ["std"]
+std = [
+	"serde",
+	"client/std",
+	"codec/std",
+	"rstd/std",
+	"sr-primitives/std",
+]

srml/transaction-payment/rpc/runtime-api/Cargo.toml

@@ -0,0 +1,47 @@
+// Copyright 2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Runtime API definition for transaction payment module.
+
+#![cfg_attr(not(feature = "std"), no_std)]
+
+use rstd::prelude::*;
+use sr_primitives::weights::{Weight, DispatchClass};
+use codec::{Encode, Codec, Decode};
+#[cfg(feature = "std")]
+use serde::{Serialize, Deserialize};
+
+/// Some information related to a dispatchable that can be queried from the runtime.
+#[derive(Eq, PartialEq, Encode, Decode, Default)]
+#[cfg_attr(feature = "std", derive(Debug, Serialize, Deserialize))]
+pub struct RuntimeDispatchInfo<Balance> {
+	/// Weight of this dispatch.
+	pub weight: Weight,
+	/// Class of this dispatch.
+	pub class: DispatchClass,
+	/// The partial inclusion fee of this dispatch. This does not include tip or anything else which
+	/// is dependent on the signature (aka. depends on a `SignedExtension`).
+	pub partial_fee: Balance,
+}
+
+client::decl_runtime_apis! {
+	pub trait TransactionPaymentApi<Balance, Extrinsic> where
+		Balance: Codec,
+		Extrinsic: Codec,
+	{
+		fn query_info(uxt: Extrinsic, len: u32) -> RuntimeDispatchInfo<Balance>;
+	}
+}