Make api and primitives generic over Runtime (#340)

* add interface traits

add traits

add balanes impl

add Runtime trait

make api generic over Runtime

remove interfaces

fix clippy

fix staking feature

fix doc

make RuntimeVersion generic over Runtime

revert last commit

fix examples

* fix rebase changes

* add missing contracts

* amke staking generic over BalanceType

* cargo fmt

* make these types truly generic

* cargo fmt

* fix tests

* fix staking payout example

* add pallets trait

* add no_std traits

* remove obsoltete sp_std

* add missing re-export

* remove frame-support and frame-system from node-api

* add pallet contracts

* add pallets contracts

* add std impl for pallet traits

* add pallet staking

* remove pallet dependencies

* add tpyes.rs

* cargo fmt

* fix taplo

* remove substrate comment

* fix toml formatting

* fix taplo

* add links to the types where taken from substrate

Author: haerdib

Cargo.lock

@@ -19,18 +19,14 @@ codec = { package = "parity-scale-codec", version = "3.0.0", default-features =
 hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
 log = { version = "0.4.14", default-features = false }
 primitive-types = { version = "0.12.1", optional = true, features = ["codec"] }
-serde = { version = "1.0.136", optional = true, features = ["derive"] }
-serde_json = { version = "1.0.79", optional = true }
+serde = { version = "1.0.136", default-features = false, features = ["derive"] }
+serde_json = { version = "1.0.79", default-features = false }
 thiserror = { version = "1.0.30", optional = true }
 ws = { version = "0.9.2", optional = true, features = ["ssl"] }
 
 # Substrate dependencies
 frame-metadata = { default-features = false, git = "https://github.com/paritytech/frame-metadata", features = ["v14", "serde_full", "decode"] }
-frame-support = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "master" }
-frame-system = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
-pallet-balances = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
-pallet-staking = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
-pallet-transaction-payment = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
+frame-support = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-core = { default-features = false, features = ["full_crypto"], git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-rpc = { optional = true, git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-runtime = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "master" }
@@ -45,10 +41,13 @@ ac-primitives = { path = "primitives", default-features = false }
 
 [dev-dependencies]
 env_logger = "0.9.0"
+frame-system = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
 kitchensink-runtime = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
+pallet-balances = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
+pallet-identity = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
+pallet-staking = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-keyring = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
 wabt = "0.10.0"
-pallet-identity = { git = "https://github.com/paritytech/substrate.git", branch = "master" }
 
 [features]
 default = ["std", "ws-client"]
@@ -63,14 +62,11 @@ std = [
     "log/std",
     "primitive-types",
     "serde/std",
-    "serde_json",
+    "serde_json/std",
     "thiserror",
     # substrate
     "frame-metadata/std",
-    "frame-support/std",
-    "frame-system",
-    "pallet-balances",
-    "pallet-transaction-payment/std",
+    "frame-support",
     "sp-core/std",
     "sp-rpc",
     "sp-runtime/std",
@@ -83,4 +79,4 @@ std = [
     "ac-primitives/std",
 ]
 ws-client = ["ws"]
-staking-xt = ["std", "pallet-staking"]
+staking-xt = ["std"]

Cargo.toml

@@ -12,7 +12,6 @@ log = { version = "0.4.14", default-features = false }
 # substrate
 sp-core = { default-features = false, features = ["full_crypto"], git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-runtime = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "master" }
-sp-std = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "master" }
 
 # need to add this for the app_crypto macro
 sp-application-crypto = { default-features = false, git = "https://github.com/paritytech/substrate.git", features = ["full_crypto"], branch = "master" }
@@ -28,7 +27,6 @@ std = [
     # substrate
     "sp-core/std",
     "sp-runtime/std",
-    "sp-std/std",
     "sp-application-crypto/std",
     # local
     "ac-primitives/std",

compose-macros/Cargo.toml

@@ -1,6 +1,8 @@
 #[cfg(feature = "staking-xt")]
 use codec::{Decode, Encode};
 #[cfg(feature = "staking-xt")]
+use kitchensink_runtime::Runtime;
+#[cfg(feature = "staking-xt")]
 use pallet_staking::{ActiveEraInfo, Exposure};
 #[cfg(feature = "staking-xt")]
 use serde_json::Value;
@@ -17,7 +19,7 @@ fn main() {
 
 	let from = AccountKeyring::Alice.pair();
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
-	let mut api = Api::<_, _, PlainTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, PlainTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from);
 	let grace_period: GracePeriod = GracePeriod { enabled: false, eras: 0 };
 	let mut results: Vec<Value> = Vec::new();
@@ -86,7 +88,12 @@ fn main() {
 #[cfg(feature = "staking-xt")]
 pub fn get_last_reward(
 	validator_address: &str,
-	api: &substrate_api_client::Api<sp_core::sr25519::Pair, WsRpcClient, PlainTipExtrinsicParams>,
+	api: &substrate_api_client::Api<
+		sp_core::sr25519::Pair,
+		WsRpcClient,
+		PlainTipExtrinsicParams<Runtime>,
+		Runtime,
+	>,
 ) -> u32 {
 	let account = match AccountId32::from_ss58check(validator_address) {
 		Ok(address) => address,

examples/batch_payout.rs

@@ -18,7 +18,7 @@
 // run this against test node with
 // > substrate-test-node --dev --execution native --ws-port 9979 -ltxpool=debug
 
-use kitchensink_runtime::{BalancesCall, RuntimeCall};
+use kitchensink_runtime::{BalancesCall, Runtime, RuntimeCall};
 use sp_keyring::AccountKeyring;
 use substrate_api_client::{
 	compose_extrinsic_offline, rpc::WsRpcClient, Api, AssetTipExtrinsicParams,
@@ -31,11 +31,9 @@ fn main() {
 	// initialize api and set the signer (sender) that is used to sign the extrinsics
 	let from = AccountKeyring::Alice.pair();
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
-	let mut api = Api::<_, _, AssetTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, AssetTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from);
 
-	println!("[+] Alice's Account Nonce is {}\n", api.get_nonce().unwrap());
-
 	// define the recipient
 	let to = AccountKeyring::Bob.to_account_id();
 

examples/benchmark_bulk_xt.rs

@@ -17,7 +17,7 @@
 //! without asking the node for nonce and does not need to know the metadata
 
 use ac_primitives::AssetTipExtrinsicParamsBuilder;
-use kitchensink_runtime::{BalancesCall, Header, RuntimeCall};
+use kitchensink_runtime::{BalancesCall, Header, Runtime, RuntimeCall};
 use sp_keyring::AccountKeyring;
 use sp_runtime::{generic::Era, MultiAddress};
 use substrate_api_client::{
@@ -32,14 +32,14 @@ fn main() {
 	let from = AccountKeyring::Alice.pair();
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
 
-	let mut api = Api::<_, _, AssetTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, AssetTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from);
 
 	// Information for Era for mortal transactions.
 	let head = api.get_finalized_head().unwrap().unwrap();
 	let h: Header = api.get_header(Some(head)).unwrap().unwrap();
 	let period = 5;
-	let tx_params = AssetTipExtrinsicParamsBuilder::new()
+	let tx_params = AssetTipExtrinsicParamsBuilder::<Runtime>::new()
 		.era(Era::mortal(period, h.number.into()), head)
 		.tip(0);
 

examples/compose_extrinsic_offline.rs

@@ -16,6 +16,7 @@
 //! This example is community maintained and not CI tested, therefore it may not work as is.
 
 use codec::Decode;
+use kitchensink_runtime::Runtime;
 use sp_keyring::AccountKeyring;
 use std::sync::mpsc::channel;
 use substrate_api_client::{
@@ -40,7 +41,7 @@ fn main() {
 	// initialize api and set the signer (sender) that is used to sign the extrinsics
 	let from = AccountKeyring::Alice.pair();
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
-	let mut api = Api::<_, _, PlainTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, PlainTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from);
 
 	println!("[+] Alice's Account Nonce is {}", api.get_nonce().unwrap());

examples/contract_instantiate_with_code.rs

@@ -17,7 +17,7 @@
 //! without asking the node for nonce and does not need to know the metadata
 
 use ac_primitives::AssetTipExtrinsicParamsBuilder;
-use kitchensink_runtime::{BalancesCall, Header, RuntimeCall};
+use kitchensink_runtime::{BalancesCall, Header, Runtime, RuntimeCall};
 use sp_keyring::AccountKeyring;
 use sp_runtime::{generic::Era, MultiAddress};
 use substrate_api_client::{
@@ -32,14 +32,14 @@ fn main() {
 	let from = AccountKeyring::Alice.pair();
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
 
-	let mut api = Api::<_, _, AssetTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, AssetTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from);
 
 	// Information for Era for mortal transactions.
 	let head = api.get_finalized_head().unwrap().unwrap();
 	let h: Header = api.get_header(Some(head)).unwrap().unwrap();
 	let period = 5;
-	let tx_params = AssetTipExtrinsicParamsBuilder::new()
+	let tx_params = AssetTipExtrinsicParamsBuilder::<Runtime>::new()
 		.era(Era::mortal(period, h.number.into()), head)
 		.tip(0);
 

examples/custom_nonce.rs

@@ -13,12 +13,13 @@
 	limitations under the License.
 */
 
-///! Very simple example that shows how to subscribe to events.
-use std::sync::mpsc::channel;
+//! Very simple example that shows how to subscribe to events.
 
 use codec::Decode;
+use kitchensink_runtime::Runtime;
 use log::debug;
 use sp_core::{sr25519, H256 as Hash};
+use std::sync::mpsc::channel;
 
 // This module depends on node_runtime.
 // To avoid dependency collisions, node_runtime has been removed from the substrate-api-client library.
@@ -31,7 +32,8 @@ fn main() {
 	env_logger::init();
 
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
-	let api = Api::<sr25519::Pair, _, AssetTipExtrinsicParams>::new(client).unwrap();
+	let api =
+		Api::<sr25519::Pair, _, AssetTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 
 	println!("Subscribe to events");
 	let (events_in, events_out) = channel();

examples/event_callback.rs

@@ -14,6 +14,7 @@ limitations under the License.
 */
 
 use codec::Decode;
+use kitchensink_runtime::Runtime;
 use sp_core::crypto::Pair;
 use sp_keyring::AccountKeyring;
 use sp_runtime::{AccountId32 as AccountId, MultiAddress};
@@ -42,7 +43,7 @@ fn main() {
 	let from = AccountKeyring::Alice.pair();
 
 	let client = WsRpcClient::new("ws://127.0.0.1:9944");
-	let mut api = Api::<_, _, AssetTipExtrinsicParams>::new(client).unwrap();
+	let mut api = Api::<_, _, AssetTipExtrinsicParams<Runtime>, Runtime>::new(client).unwrap();
 	api.set_signer(from.clone());
 
 	let from_account_id = AccountKeyring::Alice.to_account_id();