fc_rpc_v2_api/eth/pubsub.rs
1// This file is part of Frontier.
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 jsonrpsee::{core::SubscriptionResult, proc_macros::rpc};
20
21use crate::types::pubsub::{PubSubKind, PubSubParams, PubSubResult};
22
23/// (Non-standard) Ethereum pubsub interface.
24///
25/// It's not part of the standard interface for Ethereum clients, but this interface is very useful
26/// and almost all Ethereum clients implement this interface. So we also provide the interface
27/// compatible with geth.
28#[rpc(client, server, namespace = "eth")]
29#[async_trait]
30pub trait EthPubSubApi {
31 /// Create an ethereum subscription for the given params
32 #[subscription(
33 name = "subscribe" => "subscription",
34 unsubscribe = "unsubscribe",
35 item = PubSubResult
36 )]
37 async fn sub(&self, kind: PubSubKind, params: Option<PubSubParams>) -> SubscriptionResult;
38}