sc_consensus_grandpa/notification.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19use sc_utils::notification::{NotificationSender, NotificationStream, TracingKeyStr};
20
21use crate::justification::GrandpaJustification;
22
23/// The sending half of the Grandpa justification channel(s).
24///
25/// Used to send notifications about justifications generated
26/// at the end of a Grandpa round.
27pub type GrandpaJustificationSender<Block> = NotificationSender<GrandpaJustification<Block>>;
28
29/// The receiving half of the Grandpa justification channel.
30///
31/// Used to receive notifications about justifications generated
32/// at the end of a Grandpa round.
33/// The `GrandpaJustificationStream` entity stores the `SharedJustificationSenders`
34/// so it can be used to add more subscriptions.
35pub type GrandpaJustificationStream<Block> =
36 NotificationStream<GrandpaJustification<Block>, GrandpaJustificationsTracingKey>;
37
38/// Provides tracing key for GRANDPA justifications stream.
39#[derive(Clone)]
40pub struct GrandpaJustificationsTracingKey;
41impl TracingKeyStr for GrandpaJustificationsTracingKey {
42 const TRACING_KEY: &'static str = "mpsc_grandpa_justification_notification_stream";
43}