From 1f381f606033f3ae67c86dbe57bbb94c96dc3092 Mon Sep 17 00:00:00 2001
From: Ankan <10196091+Ank4n@users.noreply.github.com>
Date: Wed, 6 Nov 2024 23:46:57 +0100
Subject: [PATCH] [Pools] New runtime api that returns the pot accounts
associated with the pool (#6357)
closes https://github.com/paritytech/polkadot-sdk/issues/6358
Adds the following runtime api to pallet-nomination-pools.
`pool_accounts(pool_id)`: Returns `(bonded_account, reward_account)`
associated with the `pool_id`.
cc: @rossbulat
---------
Co-authored-by: command-bot <>
Co-authored-by: Branislav Kontur <bkontur@gmail.com>
---
polkadot/runtime/westend/src/lib.rs | 15 +++++++++-----
prdoc/pr_6357.prdoc | 20 +++++++++++++++++++
substrate/bin/node/runtime/src/lib.rs | 15 +++++++++-----
.../nomination-pools/runtime-api/src/lib.rs | 3 +++
substrate/frame/nomination-pools/src/lib.rs | 7 +++++++
5 files changed, 50 insertions(+), 10 deletions(-)
create mode 100644 prdoc/pr_6357.prdoc
diff --git a/polkadot/runtime/westend/src/lib.rs b/polkadot/runtime/westend/src/lib.rs
index a9a76dbced1..4c04af111f8 100644
--- a/polkadot/runtime/westend/src/lib.rs
+++ b/polkadot/runtime/westend/src/lib.rs
@@ -46,6 +46,7 @@ use frame_support::{
use frame_system::{EnsureRoot, EnsureSigned};
use pallet_grandpa::{fg_primitives, AuthorityId as GrandpaId};
use pallet_identity::legacy::IdentityInfo;
+use pallet_nomination_pools::PoolId;
use pallet_session::historical as session_historical;
use pallet_transaction_payment::{FeeDetails, FungibleAdapter, RuntimeDispatchInfo};
use polkadot_primitives::{
@@ -2492,15 +2493,15 @@ sp_api::impl_runtime_apis! {
NominationPools::api_pending_rewards(member).unwrap_or_default()
}
- fn points_to_balance(pool_id: pallet_nomination_pools::PoolId, points: Balance) -> Balance {
+ fn points_to_balance(pool_id: PoolId, points: Balance) -> Balance {
NominationPools::api_points_to_balance(pool_id, points)
}
- fn balance_to_points(pool_id: pallet_nomination_pools::PoolId, new_funds: Balance) -> Balance {
+ fn balance_to_points(pool_id: PoolId, new_funds: Balance) -> Balance {
NominationPools::api_balance_to_points(pool_id, new_funds)
}
- fn pool_pending_slash(pool_id: pallet_nomination_pools::PoolId) -> Balance {
+ fn pool_pending_slash(pool_id: PoolId) -> Balance {
NominationPools::api_pool_pending_slash(pool_id)
}
@@ -2508,7 +2509,7 @@ sp_api::impl_runtime_apis! {
NominationPools::api_member_pending_slash(member)
}
- fn pool_needs_delegate_migration(pool_id: pallet_nomination_pools::PoolId) -> bool {
+ fn pool_needs_delegate_migration(pool_id: PoolId) -> bool {
NominationPools::api_pool_needs_delegate_migration(pool_id)
}
@@ -2520,9 +2521,13 @@ sp_api::impl_runtime_apis! {
NominationPools::api_member_total_balance(member)
}
- fn pool_balance(pool_id: pallet_nomination_pools::PoolId) -> Balance {
+ fn pool_balance(pool_id: PoolId) -> Balance {
NominationPools::api_pool_balance(pool_id)
}
+
+ fn pool_accounts(pool_id: PoolId) -> (AccountId, AccountId) {
+ NominationPools::api_pool_accounts(pool_id)
+ }
}
impl pallet_staking_runtime_api::StakingApi<Block, Balance, AccountId> for Runtime {
diff --git a/prdoc/pr_6357.prdoc b/prdoc/pr_6357.prdoc
new file mode 100644
index 00000000000..b3155b1a605
--- /dev/null
+++ b/prdoc/pr_6357.prdoc
@@ -0,0 +1,20 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: New runtime api that returns the associated pool accounts with a nomination pool.
+
+doc:
+ - audience: Runtime User
+ description: |
+ Each nomination pool has two associated pot accounts: the bonded account, where funds are pooled for staking, and
+ the reward account. This update introduces a runtime api that clients can query to retrieve these accounts.
+
+crates:
+ - name: westend-runtime
+ bump: minor
+ - name: kitchensink-runtime
+ bump: minor
+ - name: pallet-nomination-pools
+ bump: minor
+ - name: pallet-nomination-pools-runtime-api
+ bump: minor
diff --git a/substrate/bin/node/runtime/src/lib.rs b/substrate/bin/node/runtime/src/lib.rs
index 18db43b1c12..5a2ff3ceb7f 100644
--- a/substrate/bin/node/runtime/src/lib.rs
+++ b/substrate/bin/node/runtime/src/lib.rs
@@ -83,6 +83,7 @@ use pallet_identity::legacy::IdentityInfo;
use pallet_im_online::sr25519::AuthorityId as ImOnlineId;
use pallet_nfts::PalletFeatures;
use pallet_nis::WithMaximumOf;
+use pallet_nomination_pools::PoolId;
use pallet_revive::{evm::runtime::EthExtra, AddressMapper};
use pallet_session::historical as pallet_session_historical;
// Can't use `FungibleAdapter` here until Treasury pallet migrates to fungibles
@@ -3004,15 +3005,15 @@ impl_runtime_apis! {
NominationPools::api_pending_rewards(who).unwrap_or_default()
}
- fn points_to_balance(pool_id: pallet_nomination_pools::PoolId, points: Balance) -> Balance {
+ fn points_to_balance(pool_id: PoolId, points: Balance) -> Balance {
NominationPools::api_points_to_balance(pool_id, points)
}
- fn balance_to_points(pool_id: pallet_nomination_pools::PoolId, new_funds: Balance) -> Balance {
+ fn balance_to_points(pool_id: PoolId, new_funds: Balance) -> Balance {
NominationPools::api_balance_to_points(pool_id, new_funds)
}
- fn pool_pending_slash(pool_id: pallet_nomination_pools::PoolId) -> Balance {
+ fn pool_pending_slash(pool_id: PoolId) -> Balance {
NominationPools::api_pool_pending_slash(pool_id)
}
@@ -3020,7 +3021,7 @@ impl_runtime_apis! {
NominationPools::api_member_pending_slash(member)
}
- fn pool_needs_delegate_migration(pool_id: pallet_nomination_pools::PoolId) -> bool {
+ fn pool_needs_delegate_migration(pool_id: PoolId) -> bool {
NominationPools::api_pool_needs_delegate_migration(pool_id)
}
@@ -3032,9 +3033,13 @@ impl_runtime_apis! {
NominationPools::api_member_total_balance(member)
}
- fn pool_balance(pool_id: pallet_nomination_pools::PoolId) -> Balance {
+ fn pool_balance(pool_id: PoolId) -> Balance {
NominationPools::api_pool_balance(pool_id)
}
+
+ fn pool_accounts(pool_id: PoolId) -> (AccountId, AccountId) {
+ NominationPools::api_pool_accounts(pool_id)
+ }
}
impl pallet_staking_runtime_api::StakingApi<Block, Balance, AccountId> for Runtime {
diff --git a/substrate/frame/nomination-pools/runtime-api/src/lib.rs b/substrate/frame/nomination-pools/runtime-api/src/lib.rs
index d81ad1dd495..4138dd22d89 100644
--- a/substrate/frame/nomination-pools/runtime-api/src/lib.rs
+++ b/substrate/frame/nomination-pools/runtime-api/src/lib.rs
@@ -69,5 +69,8 @@ sp_api::decl_runtime_apis! {
/// Total balance contributed to the pool.
fn pool_balance(pool_id: PoolId) -> Balance;
+
+ /// Returns the bonded account and reward account associated with the pool_id.
+ fn pool_accounts(pool_id: PoolId) -> (AccountId, AccountId);
}
}
diff --git a/substrate/frame/nomination-pools/src/lib.rs b/substrate/frame/nomination-pools/src/lib.rs
index 177c5da74d4..201b0af1d60 100644
--- a/substrate/frame/nomination-pools/src/lib.rs
+++ b/substrate/frame/nomination-pools/src/lib.rs
@@ -4020,6 +4020,13 @@ impl<T: Config> Pallet<T> {
T::StakeAdapter::total_balance(Pool::from(Self::generate_bonded_account(pool_id)))
.unwrap_or_default()
}
+
+ /// Returns the bonded account and reward account associated with the pool_id.
+ pub fn api_pool_accounts(pool_id: PoolId) -> (T::AccountId, T::AccountId) {
+ let bonded_account = Self::generate_bonded_account(pool_id);
+ let reward_account = Self::generate_reward_account(pool_id);
+ (bonded_account, reward_account)
+ }
}
impl<T: Config> sp_staking::OnStakingUpdate<T::AccountId, BalanceOf<T>> for Pallet<T> {
--
GitLab