Rpc for pending rewards

Cargo.toml

@@ -116,6 +116,8 @@ members = [
 	"frame/nomination-pools",
 	"frame/nomination-pools/benchmarking",
 	"frame/nomination-pools/test-staking",
+	"frame/nomination-pools/rpc",
+	"frame/nomination-pools/rpc/runtime-api",
 	"frame/randomness-collective-flip",
 	"frame/ranked-collective",
 	"frame/recovery",

bin/node/runtime/Cargo.toml

@@ -79,6 +79,7 @@ pallet-mmr = { version = "4.0.0-dev", default-features = false, path = "../../..
 pallet-multisig = { version = "4.0.0-dev", default-features = false, path = "../../../frame/multisig" }
 pallet-nomination-pools = { version = "1.0.0", default-features = false, path = "../../../frame/nomination-pools"}
 pallet-nomination-pools-benchmarking = { version = "1.0.0", default-features = false, optional = true, path = "../../../frame/nomination-pools/benchmarking" }
+pallet-nomination-pools-rpc-runtime-api = { version = "1.0.0-dev", default-features = false, path = "../../../frame/nomination-pools/rpc/runtime-api"}
 pallet-offences = { version = "4.0.0-dev", default-features = false, path = "../../../frame/offences" }
 pallet-offences-benchmarking = { version = "4.0.0-dev", path = "../../../frame/offences/benchmarking", default-features = false, optional = true }
 pallet-preimage = { version = "4.0.0-dev", default-features = false, path = "../../../frame/preimage" }
@@ -145,6 +146,7 @@ std = [
 	"pallet-mmr/std",
 	"pallet-multisig/std",
 	"pallet-nomination-pools/std",
+	"pallet-nomination-pools-rpc-runtime-api/std",
 	"pallet-identity/std",
 	"pallet-scheduler/std",
 	"node-primitives/std",

bin/node/runtime/src/lib.rs

@@ -1835,6 +1835,14 @@ impl_runtime_apis! {
 		}
 	}
 
+	impl pallet_nomination_pools_rpc_runtime_api::NominationPoolsApi<Block, AccountId, Balance> for Runtime {
+		fn pending_rewards(member_account: AccountId) -> Balance {
+			let member = pallet_nomination_pools::PoolMembers::<Runtime>::get(member_account).unwrap();
+
+			member.pending_rewards(member.last_recorded_reward_counter).unwrap()
+		}
+	}
+
 	impl sp_consensus_babe::BabeApi<Block> for Runtime {
 		fn configuration() -> sp_consensus_babe::BabeGenesisConfiguration {
 			// The choice of `c` parameter (where `1 - c` represents the

frame/nomination-pools/rpc/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "pallet-nomination-pools-rpc"
+version = "1.0.0-dev"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https://github.com/paritytech/substrate/"
+description = "RPC interface for the nomination-pools pallet."
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0" }
+jsonrpc-core = "18.0.0"
+jsonrpc-core-client = "18.0.0"
+jsonrpc-derive = "18.0.0"
+
+sp-api = { version = "4.0.0-dev", path = "../../../primitives/api" }
+sp-blockchain = { version = "4.0.0-dev", path = "../../../primitives/blockchain" }
+sp-core = { version = "6.0.0", path = "../../../primitives/core" }
+sp-rpc = { version = "6.0.0", path = "../../../primitives/rpc" }
+sp-runtime = { version = "6.0.0", path = "../../../primitives/runtime" }
+pallet-nomination-pools-rpc-runtime-api = { path = "./runtime-api" }

frame/nomination-pools/rpc/runtime-api/Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "pallet-nomination-pools-rpc-runtime-api"
+version = "1.0.0-dev"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https://github.com/paritytech/substrate/"
+description = "RPC runtime API for nomination-pools FRAME pallet"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+sp-api = { version = "4.0.0-dev", default-features = false, path = "../../../../primitives/api" }
+sp-std = { version = "4.0.0-dev", default-features = false, path = "../../../../primitives/std" }
+pallet-nomination-pools = { default-features = false, path = "../../" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"sp-api/std",
+	"sp-std/std",
+	"pallet-nomination-pools/std",
+]

frame/nomination-pools/rpc/runtime-api/README.md

@@ -0,0 +1,3 @@
+Runtime API definition for nomination-pools pallet.
+
+License: Apache-2.0

frame/nomination-pools/rpc/runtime-api/src/lib.rs

@@ -0,0 +1,31 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2019-2022 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Runtime API definition for nomination-pools pallet.
+
+#![cfg_attr(not(feature = "std"), no_std)]
+
+use codec::Codec;
+pub use pallet_nomination_pools::PoolId;
+
+sp_api::decl_runtime_apis! {
+	pub trait NominationPoolsApi<AccountId, Balance> where AccountId: Codec, Balance: Codec
+	{
+		/// Returns the pending rewards for the given member.
+		fn pending_rewards(member: AccountId) -> Balance;
+	}
+}

frame/nomination-pools/rpc/src/README.md

@@ -0,0 +1,3 @@
+RPC interface for the nomination-pools pallet.
+
+License: Apache-2.0

frame/nomination-pools/rpc/src/lib.rs

@@ -0,0 +1,74 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2019-2022 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! RPC interface for the nomination-pools pallet.
+
+pub use self::gen_client::Client as NominationPoolsClient;
+use codec::Codec;
+use jsonrpc_core::Error;
+use jsonrpc_derive::rpc;
+pub use pallet_nomination_pools_rpc_runtime_api::NominationPoolsApi as NominationPoolsRuntimeApi;
+use sp_api::ProvideRuntimeApi;
+use sp_blockchain::HeaderBackend;
+use sp_runtime::{generic::BlockId, traits::Block as BlockT};
+use std::sync::Arc;
+
+#[rpc]
+pub trait NominationPoolsRpc<BlockHash, AccountId, ResponseType> {
+	#[rpc(name = "nompools_pending_rewards")]
+	fn pending_rewards(
+		&self,
+		member: AccountId,
+		at: Option<BlockHash>,
+	) -> Result<ResponseType, Error>;
+}
+
+pub struct NominationPoolsRpcType<C, P> {
+	client: Arc<C>,
+	_marker: std::marker::PhantomData<P>,
+}
+
+impl<C, P> NominationPoolsRpcType<C, P> {
+	pub fn new(client: Arc<C>) -> Self {
+		Self { client, _marker: Default::default() }
+	}
+}
+
+impl<C, Block, AccountId, Balance> NominationPoolsRpc<<Block as BlockT>::Hash, AccountId, Balance>
+	for NominationPoolsRpcType<C, Block>
+where
+	Block: BlockT,
+	C: 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,
+	C::Api: NominationPoolsRuntimeApi<Block, AccountId, Balance>,
+	AccountId: Codec,
+	Balance: Codec,
+{
+	fn pending_rewards(
+		&self,
+		member: AccountId,
+		at: Option<Block::Hash>,
+	) -> Result<Balance, Error> {
+		let api = self.client.runtime_api();
+		let at = BlockId::hash(at.unwrap_or_else(|| self.client.info().best_hash));
+
+		api.pending_rewards(&at, member).map_err(|e| Error {
+			code: jsonrpc_core::ErrorCode::ServerError(1),
+			message: format!("{:?}", e),
+			data: None,
+		})
+	}
+}

frame/nomination-pools/src/lib.rs

@@ -378,7 +378,7 @@ pub struct PoolMember<T: Config> {
 
 impl<T: Config> PoolMember<T> {
 	/// The pending rewards of this member.
-	fn pending_rewards(
+	pub fn pending_rewards(
 		&self,
 		current_reward_counter: T::RewardCounter,
 	) -> Result<BalanceOf<T>, Error<T>> {