1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
/* 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 <https://www.gnu.org/licenses/>.
*/
use std::{collections::HashMap, str::FromStr};
use darkfi_sdk::{crypto::ContractId, tx::TransactionHash};
use darkfi_serial::{deserialize_async, serialize_async};
use log::{debug, error};
use tinyjson::JsonValue;
use darkfi::{
blockchain::contract_store::SMART_CONTRACT_ZKAS_DB_NAME,
rpc::jsonrpc::{
ErrorCode::{InternalError, InvalidParams, ParseError},
JsonError, JsonResponse, JsonResult,
},
util::encoding::base64,
};
use crate::{server_error, DarkfiNode, RpcError};
impl DarkfiNode {
// RPCAPI:
// Queries the blockchain database for a block in the given height.
// Returns a readable block upon success.
//
// **Params:**
// * `array[0]`: `u64` Block height (as string)
//
// **Returns:**
// * [`BlockInfo`](https://darkrenaissance.github.io/darkfi/dev/darkfi/blockchain/block_store/struct.BlockInfo.html)
// struct serialized into base64.
//
// --> {"jsonrpc": "2.0", "method": "blockchain.get_block", "params": ["0"], "id": 1}
// <-- {"jsonrpc": "2.0", "result": {...}, "id": 1}
pub async fn blockchain_get_block(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if params.len() != 1 || !params[0].is_string() {
return JsonError::new(InvalidParams, None, id).into()
}
let block_height = match params[0].get::<String>().unwrap().parse::<u32>() {
Ok(v) => v,
Err(_) => return JsonError::new(ParseError, None, id).into(),
};
let blocks = match self.validator.blockchain.get_blocks_by_heights(&[block_height]) {
Ok(v) => v,
Err(e) => {
error!(target: "darkfid::rpc::blockchain_get_block", "Failed fetching block by height: {}", e);
return JsonError::new(InternalError, None, id).into()
}
};
if blocks.is_empty() {
return server_error(RpcError::UnknownBlockHeight, id, None)
}
let block = base64::encode(&serialize_async(&blocks[0]).await);
JsonResponse::new(JsonValue::String(block), id).into()
}
// RPCAPI:
// Queries the blockchain database for a given transaction.
// Returns a serialized `Transaction` object.
//
// **Params:**
// * `array[0]`: Hex-encoded transaction hash string
//
// **Returns:**
// * Serialized [`Transaction`](https://darkrenaissance.github.io/darkfi/dev/darkfi/tx/struct.Transaction.html)
// object encoded with base64
//
// --> {"jsonrpc": "2.0", "method": "blockchain.get_tx", "params": ["TxHash"], "id": 1}
// <-- {"jsonrpc": "2.0", "result": "ABCD...", "id": 1}
pub async fn blockchain_get_tx(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if params.len() != 1 {
return JsonError::new(InvalidParams, None, id).into()
}
let tx_hash = params[0].get::<String>().unwrap();
let tx_hash = match TransactionHash::from_str(tx_hash) {
Ok(v) => v,
Err(_) => return JsonError::new(ParseError, None, id).into(),
};
let txs = match self.validator.blockchain.transactions.get(&[tx_hash], true) {
Ok(txs) => txs,
Err(e) => {
error!(target: "darkfid::rpc::blockchain_get_tx", "Failed fetching tx by hash: {}", e);
return JsonError::new(InternalError, None, id).into()
}
};
// This would be an logic error somewhere
assert_eq!(txs.len(), 1);
// and strict was used during .get()
let tx = txs[0].as_ref().unwrap();
let tx_enc = base64::encode(&serialize_async(tx).await);
JsonResponse::new(JsonValue::String(tx_enc), id).into()
}
// RPCAPI:
// Queries the blockchain database to find the last finalized block.
//
// **Params:**
// * `None`
//
// **Returns:**
// * `f64` : Height of the last finalized block
// * `String`: Header hash of the last finalized block
//
// --> {"jsonrpc": "2.0", "method": "blockchain.last_finalized_block", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "result": [1234, "HeaderHash"], "id": 1}
pub async fn blockchain_last_finalized_block(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
let Ok((height, hash)) = self.validator.blockchain.last() else {
return JsonError::new(InternalError, None, id).into()
};
JsonResponse::new(
JsonValue::Array(vec![
JsonValue::Number(height as f64),
JsonValue::String(hash.to_string()),
]),
id,
)
.into()
}
// RPCAPI:
// Queries the validator to find the current best fork next block height.
//
// **Params:**
// * `None`
//
// **Returns:**
// * `f64`: Current best fork next block height
//
// --> {"jsonrpc": "2.0", "method": "blockchain.best_fork_next_block_height", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "result": 1234, "id": 1}
pub async fn blockchain_best_fork_next_block_height(
&self,
id: u16,
params: JsonValue,
) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
let Ok(next_block_height) = self.validator.best_fork_next_block_height().await else {
return JsonError::new(InternalError, None, id).into()
};
JsonResponse::new(JsonValue::Number(next_block_height as f64), id).into()
}
// RPCAPI:
// Queries the validator to get the currently configured block target time.
//
// **Params:**
// * `None`
//
// **Returns:**
// * `f64`: Current block target time
//
// --> {"jsonrpc": "2.0", "method": "blockchain.block_target", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "result": 1234, "id": 1}
pub async fn blockchain_block_target(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
let block_target = self.validator.consensus.module.read().await.target;
JsonResponse::new(JsonValue::Number(block_target as f64), id).into()
}
// RPCAPI:
// Initializes a subscription to new incoming blocks.
// Once a subscription is established, `darkfid` will send JSON-RPC notifications of
// new incoming blocks to the subscriber.
//
// --> {"jsonrpc": "2.0", "method": "blockchain.subscribe_blocks", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_blocks", "params": [`blockinfo`]}
pub async fn blockchain_subscribe_blocks(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
self.subscribers.get("blocks").unwrap().clone().into()
}
// RPCAPI:
// Initializes a subscription to new incoming transactions.
// Once a subscription is established, `darkfid` will send JSON-RPC notifications of
// new incoming transactions to the subscriber.
//
// --> {"jsonrpc": "2.0", "method": "blockchain.subscribe_txs", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_txs", "params": [`tx_hash`]}
pub async fn blockchain_subscribe_txs(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
self.subscribers.get("txs").unwrap().clone().into()
}
// RPCAPI:
// Initializes a subscription to new incoming proposals. Once a subscription is established,
// `darkfid` will send JSON-RPC notifications of new incoming proposals to the subscriber.
//
// --> {"jsonrpc": "2.0", "method": "blockchain.subscribe_proposals", "params": [], "id": 1}
// <-- {"jsonrpc": "2.0", "method": "blockchain.subscribe_proposals", "params": [`blockinfo`]}
pub async fn blockchain_subscribe_proposals(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if !params.is_empty() {
return JsonError::new(InvalidParams, None, id).into()
}
self.subscribers.get("proposals").unwrap().clone().into()
}
// RPCAPI:
// Performs a lookup of zkas bincodes for a given contract ID and returns all of
// them, including their namespace.
//
// **Params:**
// * `array[0]`: base58-encoded contract ID string
//
// **Returns:**
// * `array[n]`: Pairs of: `zkas_namespace` string, serialized
// [`ZkBinary`](https://darkrenaissance.github.io/darkfi/dev/darkfi/zkas/decoder/struct.ZkBinary.html)
// object
//
// --> {"jsonrpc": "2.0", "method": "blockchain.lookup_zkas", "params": ["6Ef42L1KLZXBoxBuCDto7coi9DA2D2SRtegNqNU4sd74"], "id": 1}
// <-- {"jsonrpc": "2.0", "result": [["Foo", "ABCD..."], ["Bar", "EFGH..."]], "id": 1}
pub async fn blockchain_lookup_zkas(&self, id: u16, params: JsonValue) -> JsonResult {
let params = params.get::<Vec<JsonValue>>().unwrap();
if params.len() != 1 || !params[0].is_string() {
return JsonError::new(InvalidParams, None, id).into()
}
let contract_id = params[0].get::<String>().unwrap();
let contract_id = match ContractId::from_str(contract_id) {
Ok(v) => v,
Err(e) => {
error!(target: "darkfid::rpc::blockchain_lookup_zkas", "Error decoding string to ContractId: {}", e);
return JsonError::new(InvalidParams, None, id).into()
}
};
let Ok(zkas_db) = self.validator.blockchain.contracts.lookup(
&self.validator.blockchain.sled_db,
&contract_id,
SMART_CONTRACT_ZKAS_DB_NAME,
) else {
error!(
target: "darkfid::rpc::blockchain_lookup_zkas", "Did not find zkas db for ContractId: {}",
contract_id
);
return server_error(RpcError::ContractZkasDbNotFound, id, None)
};
let mut ret = vec![];
for i in zkas_db.iter() {
debug!(target: "darkfid::rpc::blockchain_lookup_zkas", "Iterating over zkas db");
let Ok((zkas_ns, zkas_bytes)) = i else {
error!(target: "darkfid::rpc::blockchain_lookup_zkas", "Internal sled error iterating db");
return JsonError::new(InternalError, None, id).into()
};
let Ok(zkas_ns) = deserialize_async(&zkas_ns).await else {
return JsonError::new(InternalError, None, id).into()
};
let (zkbin, _): (Vec<u8>, Vec<u8>) = match deserialize_async(&zkas_bytes).await {
Ok(pair) => pair,
Err(_) => return JsonError::new(InternalError, None, id).into(),
};
let zkas_bincode = base64::encode(&zkbin);
ret.push(JsonValue::Array(vec![
JsonValue::String(zkas_ns),
JsonValue::String(zkas_bincode),
]));
}
JsonResponse::new(JsonValue::Array(ret), id).into()
}
// RPCAPI:
// Returns the `chain_id` used for merge mining. A 32-byte hash of the genesis block.
//
// --> {"jsonrpc": "2.0", "method": "merge_mining_get_chain_id", "params": [], "id": 0}
// <-- {"jsonrpc": "2.0", "result": {"chain_id": 02f8...7863"}, "id": 0}
pub async fn merge_mining_get_chain_id(&self, id: u16, _params: JsonValue) -> JsonResult {
let chain_id = match self.validator.blockchain.genesis() {
Ok((_, v)) => v,
Err(e) => {
error!(
target: "darkfid::rpc::merge_mining_get_chain_id",
"[RPC] Error looking up genesis block: {}", e,
);
return JsonError::new(InternalError, None, id).into()
}
};
JsonResponse::new(
JsonValue::Object(HashMap::from([(
"chain_id".to_string(),
chain_id.as_string().into(),
)])),
id,
)
.into()
}
}