pezkuwichain
b6d35f6faf
Updated 4763 files with dual copyright: - Parity Technologies (UK) Ltd. - Dijital Kurdistan Tech Institute
80 lines
3.3 KiB
Rust
80 lines
3.3 KiB
Rust
// This file is part of Bizinikiwi.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
|
|
// 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 pezpallet.
|
|
//! Currently supports only one rpc endpoint.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
|
|
use codec::Codec;
|
|
use pezpallet_nomination_pools::PoolId;
|
|
|
|
pezsp_api::decl_runtime_apis! {
|
|
/// Runtime api for accessing information about nomination pools.
|
|
pub trait NominationPoolsApi<AccountId, Balance>
|
|
where
|
|
AccountId: Codec,
|
|
Balance: Codec,
|
|
{
|
|
/// Returns the pending rewards for the member that the AccountId was given for.
|
|
fn pending_rewards(who: AccountId) -> Balance;
|
|
|
|
/// Returns the equivalent balance of `points` for a given pool.
|
|
fn points_to_balance(pool_id: PoolId, points: Balance) -> Balance;
|
|
|
|
/// Returns the equivalent points of `new_funds` for a given pool.
|
|
fn balance_to_points(pool_id: PoolId, new_funds: Balance) -> Balance;
|
|
|
|
/// Returns the pending slash for a given pool.
|
|
fn pool_pending_slash(pool_id: PoolId) -> Balance;
|
|
|
|
/// Returns the pending slash for a given pool member.
|
|
///
|
|
/// If pending slash of the member exceeds `ExistentialDeposit`, it can be reported on
|
|
/// chain.
|
|
fn member_pending_slash(member: AccountId) -> Balance;
|
|
|
|
/// Returns true if the pool with `pool_id` needs migration.
|
|
///
|
|
/// This can happen when the `pezpallet-nomination-pools` has switched to using strategy
|
|
/// [`DelegateStake`](pezpallet_nomination_pools::adapter::DelegateStake) but the pool
|
|
/// still has funds that were staked using the older strategy
|
|
/// [TransferStake](pezpallet_nomination_pools::adapter::TransferStake). Use
|
|
/// [`migrate_pool_to_delegate_stake`](pezpallet_nomination_pools::Call::migrate_pool_to_delegate_stake)
|
|
/// to migrate the pool.
|
|
fn pool_needs_delegate_migration(pool_id: PoolId) -> bool;
|
|
|
|
/// Returns true if the delegated funds of the pool `member` needs migration.
|
|
///
|
|
/// Once a pool has successfully migrated to the strategy
|
|
/// [`DelegateStake`](pezpallet_nomination_pools::adapter::DelegateStake), the funds of the
|
|
/// member can be migrated from pool account to the member's account. Use
|
|
/// [`migrate_delegation`](pezpallet_nomination_pools::Call::migrate_delegation)
|
|
/// to migrate the funds of the pool member.
|
|
fn member_needs_delegate_migration(member: AccountId) -> bool;
|
|
|
|
/// Returns the total contribution of a pool member including any balance that is unbonding.
|
|
fn member_total_balance(who: AccountId) -> Balance;
|
|
|
|
/// 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);
|
|
}
|
|
}
|