pallet_staking_async_runtime_api/lib.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Runtime API definition for the staking pallet.
19
20#![cfg_attr(not(feature = "std"), no_std)]
21
22use codec::Codec;
23
24sp_api::decl_runtime_apis! {
25 pub trait StakingApi<Balance, AccountId>
26 where
27 Balance: Codec,
28 AccountId: Codec,
29 {
30 /// Returns the nominations quota for a nominator with a given balance.
31 fn nominations_quota(balance: Balance) -> u32;
32
33 /// Returns the page count of exposures for a validator `account` in a given era.
34 fn eras_stakers_page_count(era: sp_staking::EraIndex, account: AccountId) -> sp_staking::Page;
35
36 /// Returns true if validator `account` has pages to be claimed for the given era.
37 fn pending_rewards(era: sp_staking::EraIndex, account: AccountId) -> bool;
38 }
39}