/* This file is part of DarkFi (https://dark.fi)
*
* Copyright (C) 2020-2024 Dyne.org foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*/
use std::{collections::HashSet, time::Instant};
use async_trait::async_trait;
use log::{debug, error};
use smol::lock::MutexGuard;
use tinyjson::JsonValue;
use darkfi::{
rpc::{
jsonrpc::{ErrorCode, JsonError, JsonRequest, JsonResponse, JsonResult},
server::RequestHandler,
},
system::StoppableTaskPtr,
util::time::Timestamp,
Error, Result,
};
use crate::{
error::{server_error, RpcError},
Darkfid,
};
#[async_trait]
#[rustfmt::skip]
impl RequestHandler for Darkfid {
async fn handle_request(&self, req: JsonRequest) -> JsonResult {
debug!(target: "darkfid::rpc", "--> {}", req.stringify().unwrap());
match req.method.as_str() {
// =====================
// Miscellaneous methods
// =====================
"ping" => return self.pong(req.id, req.params).await,
"clock" => return self.clock(req.id, req.params).await,
"sync_dnet_switch" => return self.sync_dnet_switch(req.id, req.params).await,
"consensus_dnet_switch" => return self.consensus_dnet_switch(req.id, req.params).await,
"ping_miner" => return self.ping_miner(req.id, req.params).await,
// ==================
// Blockchain methods
// ==================
"blockchain.get_slot" => return self.blockchain_get_slot(req.id, req.params).await,
"blockchain.get_tx" => return self.blockchain_get_tx(req.id, req.params).await,
"blockchain.last_known_slot" => return self.blockchain_last_known_slot(req.id, req.params).await,
"blockchain.lookup_zkas" => return self.blockchain_lookup_zkas(req.id, req.params).await,
"blockchain.subscribe_blocks" => return self.blockchain_subscribe_blocks(req.id, req.params).await,
"blockchain.subscribe_txs" => return self.blockchain_subscribe_txs(req.id, req.params).await,
"blockchain.subscribe_proposals" => return self.blockchain_subscribe_proposals(req.id, req.params).await,
"merge_mining_get_chain_id" => return self.merge_mining_get_chain_id(req.id, req.params).await,
// ===================
// Transaction methods
// ===================
"tx.simulate" => return self.tx_simulate(req.id, req.params).await,
"tx.broadcast" => return self.tx_broadcast(req.id, req.params).await,
"tx.pending" => return self.tx_pending(req.id, req.params).await,
"tx.clean_pending" => return self.tx_pending(req.id, req.params).await,
// ==============
// Invalid method
// ==============
_ => JsonError::new(ErrorCode::MethodNotFound, None, req.id).into(),
}
}
async fn connections_mut(&self) -> MutexGuard<'_, HashSet> {
self.rpc_connections.lock().await
}
}
impl Darkfid {
// RPCAPI:
// Returns current system clock as `u64` (String) timestamp.
//
// --> {"jsonrpc": "2.0", "method": "clock", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "result": "1234", "id": 1}
async fn clock(&self, id: u16, _params: JsonValue) -> JsonResult {
JsonResponse::new(JsonValue::String(Timestamp::current_time().0.to_string()), id).into()
}
// RPCAPI:
// Activate or deactivate dnet in the sync P2P stack.
// By sending `true`, dnet will be activated, and by sending `false` dnet
// will be deactivated. Returns `true` on success.
//
// --> {"jsonrpc": "2.0", "method": "sync_dnet_switch", "params": [true], "id": 42}
// <-- {"jsonrpc": "2.0", "result": true, "id": 42}
async fn sync_dnet_switch(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::>().unwrap();
if params.len() != 1 || !params[0].is_bool() {
return JsonError::new(ErrorCode::InvalidParams, None, id).into()
}
let switch = params[0].get::().unwrap();
if *switch {
self.sync_p2p.dnet_enable().await;
} else {
self.sync_p2p.dnet_disable().await;
}
JsonResponse::new(JsonValue::Boolean(true), id).into()
}
// RPCAPI:
// Activate or deactivate dnet in the consensus P2P stack.
// By sending `true`, dnet will be activated, and by sending `false` dnet
// will be deactivated. Returns `true` on success.
//
// --> {"jsonrpc": "2.0", "method": "consensus_dnet_switch", "params": [true], "id": 42}
// <-- {"jsonrpc": "2.0", "result": true, "id": 42}
async fn consensus_dnet_switch(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::>().unwrap();
if params.len() != 1 || !params[0].is_bool() {
return JsonError::new(ErrorCode::InvalidParams, None, id).into()
}
if self.consensus_p2p.is_some() {
let switch = params[0].get::().unwrap();
if *switch {
self.consensus_p2p.clone().unwrap().dnet_enable().await;
} else {
self.consensus_p2p.clone().unwrap().dnet_disable().await;
}
}
JsonResponse::new(JsonValue::Boolean(true), id).into()
}
// RPCAPI:
// Pings configured miner daemon for livenes.
// Returns `true` on success.
//
// --> {"jsonrpc": "2.0", "method": "ping_miner", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "result": "true", "id": 1}
async fn ping_miner(&self, id: u16, _params: JsonValue) -> JsonResult {
if let Err(e) = self.ping_miner_daemon().await {
error!(target: "darkfid::rpc::ping_miner", "Failed to ping miner daemon: {}", e);
return server_error(RpcError::PingFailed, id, None)
}
JsonResponse::new(JsonValue::Boolean(true), id).into()
}
pub async fn ping_miner_daemon(&self) -> Result<()> {
debug!(target: "darkfid::ping_miner_daemon", "Pinging miner daemon...");
self.miner_daemon_request("ping", JsonValue::Array(vec![])).await?;
Ok(())
}
pub async fn miner_daemon_request(&self, method: &str, params: JsonValue) -> Result {
let Some(ref rpc_client) = self.rpc_client else { return Err(Error::RpcClientStopped) };
debug!(target: "darkfid::rpc::miner_daemon_request", "Executing request {} with params: {:?}", method, params);
let latency = Instant::now();
let req = JsonRequest::new(method, params);
let rep = rpc_client.request(req).await?;
let latency = latency.elapsed();
debug!(target: "darkfid::rpc::miner_daemon_request", "Got reply: {:?}", rep);
debug!(target: "darkfid::rpc::miner_daemon_request", "Latency: {:?}", latency);
Ok(rep)
}
}