sp_authority_discovery/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 to help discover authorities.
19
20#![cfg_attr(not(feature = "std"), no_std)]
21
22extern crate alloc;
23
24use alloc::vec::Vec;
25
26mod app {
27 use sp_application_crypto::{app_crypto, key_types::AUTHORITY_DISCOVERY, sr25519};
28 app_crypto!(sr25519, AUTHORITY_DISCOVERY);
29}
30
31sp_application_crypto::with_pair! {
32 /// An authority discovery authority keypair.
33 pub type AuthorityPair = app::Pair;
34}
35
36/// An authority discovery authority identifier.
37pub type AuthorityId = app::Public;
38
39/// An authority discovery authority signature.
40pub type AuthoritySignature = app::Signature;
41
42sp_api::decl_runtime_apis! {
43 /// The authority discovery api.
44 ///
45 /// This api is used by the `client/authority-discovery` module to retrieve identifiers
46 /// of the current and next authority set.
47 pub trait AuthorityDiscoveryApi {
48 /// Retrieve authority identifiers of the current and next authority set.
49 fn authorities() -> Vec<AuthorityId>;
50 }
51}