Staking and nomination pools runtime API improvements

Cargo.toml

@@ -141,6 +141,7 @@ members = [
 	"frame/staking",
 	"frame/staking/reward-curve",
 	"frame/staking/reward-fn",
+	"frame/staking/runtime-api",
 	"frame/state-trie-migration",
 	"frame/sudo",
 	"frame/root-offences",

bin/node/runtime/Cargo.toml

@@ -96,6 +96,7 @@ pallet-session = { version = "4.0.0-dev", features = [ "historical" ], path = ".
 pallet-session-benchmarking = { version = "4.0.0-dev", path = "../../../frame/session/benchmarking", default-features = false, optional = true }
 pallet-staking = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking" }
 pallet-staking-reward-curve = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking/reward-curve" }
+pallet-staking-runtime-api = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking/runtime-api" }
 pallet-state-trie-migration = { version = "4.0.0-dev", default-features = false, path = "../../../frame/state-trie-migration" }
 pallet-scheduler = { version = "4.0.0-dev", default-features = false, path = "../../../frame/scheduler" }
 pallet-society = { version = "4.0.0-dev", default-features = false, path = "../../../frame/society" }

bin/node/runtime/src/lib.rs

@@ -1972,7 +1972,21 @@ impl_runtime_apis! {
 
 	impl pallet_nomination_pools_runtime_api::NominationPoolsApi<Block, AccountId, Balance> for Runtime {
 		fn pending_rewards(member_account: AccountId) -> Balance {
-			NominationPools::pending_rewards(member_account).unwrap_or_default()
+			NominationPools::api_pending_rewards(member_account).unwrap_or_default()
+		}
+
+		fn points_to_balance(pool_id: u32) -> Result<Balance, ()> {
+			NominationPools::api_points_to_balance(pool_id)
+		}
+
+		fn balance_to_point(pool_id: u32, new_funds: Balance) -> Result<Balance, ()> {
+			NominationPools::api_balance_to_point(pool_id, new_funds)
+		}
+	}
+
+	impl pallet_staking_runtime_api::StakingApi<Block> for Runtime {
+		fn nominations_quota() -> u32 {
+			Staking::api_nominations_quota()
 		}
 	}
 

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

@@ -24,10 +24,19 @@ use codec::Codec;
 
 sp_api::decl_runtime_apis! {
 	/// Runtime api for accessing information about nomination pools.
+	#[api_version(1)]
 	pub trait NominationPoolsApi<AccountId, Balance>
-		where AccountId: Codec, Balance: Codec
+		where
+			AccountId: Codec,
+			Balance: Codec,
 	{
 		/// Returns the pending rewards for the member that the AccountId was given for.
 		fn pending_rewards(member: AccountId) -> Balance;
+
+		/// Returns the points to balance conversion for a given pool.
+		fn points_to_balance(pool_id: u32) -> Result<Balance, ()>;
+
+		/// Returns the equivalent points of `new_funds` for a given pool
+		fn balance_to_point(pool_id: u32, new_funds: Balance) -> Result<Balance, ()>;
 	}
 }

frame/nomination-pools/src/lib.rs

@@ -2144,8 +2144,8 @@ pub mod pallet {
 impl<T: Config> Pallet<T> {
 	/// Returns the pending rewards for the specified `member_account`.
 	///
-	/// In the case of error, `None` is returned.
-	pub fn pending_rewards(member_account: T::AccountId) -> Option<BalanceOf<T>> {
+	/// In the case of error, `None` is returned. Used by runtime API.
+	pub fn api_pending_rewards(member_account: T::AccountId) -> Option<BalanceOf<T>> {
 		if let Some(pool_member) = PoolMembers::<T>::get(member_account) {
 			if let Some((reward_pool, bonded_pool)) = RewardPools::<T>::get(pool_member.pool_id)
 				.zip(BondedPools::<T>::get(pool_member.pool_id))
@@ -2160,6 +2160,30 @@ impl<T: Config> Pallet<T> {
 		None
 	}
 
+	/// Returns the points to balance conversion for a specified pool.
+	///
+	/// If the pool ID does not exist, return an error. Used by runtime API.
+	pub fn api_points_to_balance(pool_id: u32) -> Result<BalanceOf<T>, ()> {
+		if let Some(pool) = BondedPool::<T>::get(pool_id) {
+			Ok(pool.points_to_balance(pool.points))
+		} else {
+			Err(())
+		}
+	}
+
+	/// Returns the equivalent `new_funds` balance to point conversion for a specified pool.
+	///
+	/// If the pool ID does not exist, return an error. Used by runtime API.
+	pub fn api_balance_to_point(pool_id: u32, new_funds: BalanceOf<T>) -> Result<BalanceOf<T>, ()> {
+		if let Some(pool) = BondedPool::<T>::get(pool_id) {
+			let bonded_balance =
+				T::Staking::active_stake(&pool.bonded_account()).unwrap_or(Zero::zero());
+			Ok(Pallet::<T>::balance_to_point(bonded_balance, pool.points, new_funds))
+		} else {
+			Err(())
+		}
+	}
+
 	/// The amount of bond that MUST REMAIN IN BONDED in ALL POOLS.
 	///
 	/// It is the responsibility of the depositor to put these funds into the pool initially. Upon

frame/staking/runtime-api/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "pallet-staking-runtime-api"
+version = "4.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 transaction payment 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" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"sp-api/std",
+]

frame/staking/runtime-api/README.md

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

frame/staking/runtime-api/src/lib.rs

@@ -0,0 +1,28 @@
+// 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 the staking pallet.
+
+#![cfg_attr(not(feature = "std"), no_std)]
+
+sp_api::decl_runtime_apis! {
+	#[api_version(1)]
+	pub trait StakingApi {
+		/// Returns the current nominations quota for nominators.
+		fn nominations_quota() -> u32;
+	}
+}

frame/staking/src/pallet/impls.rs

@@ -59,6 +59,13 @@ use super::{pallet::*, STAKING_ID};
 const NPOS_MAX_ITERATIONS_COEFFICIENT: u32 = 2;
 
 impl<T: Config> Pallet<T> {
+	/// Returns the current nominations quota for nominators.
+	///
+	/// Used by runtime API.
+	pub fn api_nominations_quota() -> u32 {
+		T::MaxNominations::get()
+	}
+
 	/// The total balance that can be slashed from a stash account as of right now.
 	pub fn slashable_balance_of(stash: &T::AccountId) -> BalanceOf<T> {
 		// Weight note: consider making the stake accessible through stash.