// This file is part of Bizinikiwi. // Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see . //! Bizinikiwi system API. #[cfg(test)] mod tests; use futures::channel::oneshot; use jsonrpsee::{ core::{async_trait, JsonValue}, Extensions, }; use pezsc_rpc_api::check_if_safe; use pezsc_tracing::logging; use pezsc_utils::mpsc::TracingUnboundedSender; use pezsp_runtime::traits::{self, Header as HeaderT}; pub use self::helpers::{Health, NodeRole, PeerInfo, SyncState, SystemInfo}; pub use pezsc_rpc_api::system::*; /// System API implementation pub struct System { info: SystemInfo, send_back: TracingUnboundedSender>, } /// Request to be processed. pub enum Request { /// Must return the health of the network. Health(oneshot::Sender), /// Must return the base58-encoded local `PeerId`. LocalPeerId(oneshot::Sender), /// Must return the string representation of the addresses we listen on, including the /// trailing `/p2p/`. LocalListenAddresses(oneshot::Sender>), /// Must return information about the peers we are connected to. Peers(oneshot::Sender::Number>>>), /// Must return the state of the network. NetworkState(oneshot::Sender), /// Must return any potential parse error. NetworkAddReservedPeer(String, oneshot::Sender>), /// Must return any potential parse error. NetworkRemoveReservedPeer(String, oneshot::Sender>), /// Must return the list of reserved peers NetworkReservedPeers(oneshot::Sender>), /// Must return the node role. NodeRoles(oneshot::Sender>), /// Must return the state of the node syncing. SyncState(oneshot::Sender::Number>>), } impl System { /// Creates new `System`. /// /// The `send_back` will be used to transmit some of the requests. The user is responsible for /// reading from that channel and answering the requests. pub fn new(info: SystemInfo, send_back: TracingUnboundedSender>) -> Self { System { info, send_back } } } #[async_trait] impl SystemApiServer::Number> for System { fn system_name(&self) -> Result { Ok(self.info.impl_name.clone()) } fn system_version(&self) -> Result { Ok(self.info.impl_version.clone()) } fn system_chain(&self) -> Result { Ok(self.info.chain_name.clone()) } fn system_type(&self) -> Result { Ok(self.info.chain_type.clone()) } fn system_properties(&self) -> Result { Ok(self.info.properties.clone()) } async fn system_health(&self) -> Result { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::Health(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_local_peer_id(&self) -> Result { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::LocalPeerId(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_local_listen_addresses(&self) -> Result, Error> { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::LocalListenAddresses(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_peers( &self, ext: &Extensions, ) -> Result::Number>>, Error> { check_if_safe(ext)?; let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::Peers(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_network_state(&self, ext: &Extensions) -> Result { check_if_safe(ext)?; let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::NetworkState(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_add_reserved_peer(&self, ext: &Extensions, peer: String) -> Result<(), Error> { check_if_safe(ext)?; let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::NetworkAddReservedPeer(peer, tx)); match rx.await { Ok(Ok(())) => Ok(()), Ok(Err(e)) => Err(e), Err(e) => Err(Error::Internal(e.to_string())), } } async fn system_remove_reserved_peer( &self, ext: &Extensions, peer: String, ) -> Result<(), Error> { check_if_safe(ext)?; let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::NetworkRemoveReservedPeer(peer, tx)); match rx.await { Ok(Ok(())) => Ok(()), Ok(Err(e)) => Err(e), Err(e) => Err(Error::Internal(e.to_string())), } } async fn system_reserved_peers(&self) -> Result, Error> { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::NetworkReservedPeers(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_node_roles(&self) -> Result, Error> { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::NodeRoles(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } async fn system_sync_state(&self) -> Result::Number>, Error> { let (tx, rx) = oneshot::channel(); let _ = self.send_back.unbounded_send(Request::SyncState(tx)); rx.await.map_err(|e| Error::Internal(e.to_string())) } fn system_add_log_filter(&self, ext: &Extensions, directives: String) -> Result<(), Error> { check_if_safe(ext)?; logging::add_directives(&directives); logging::reload_filter().map_err(|e| Error::Internal(e)) } fn system_reset_log_filter(&self, ext: &Extensions) -> Result<(), Error> { check_if_safe(ext)?; logging::reset_log_filter().map_err(|e| Error::Internal(e)) } }