Struct Explorerd

pub struct Explorerd {
    pub service: ExplorerService,
    pub rpc_connections: Mutex<HashSet<StoppableTaskPtr>>,
    pub darkfid_client: Arc<DarkfidRpcClient>,
    pub(crate) darkfid_endpoint: Url,
    pub(crate) executor: Arc<Executor<'static>>,
}

Defines a daemon structure responsible for handling incoming JSON-RPC requests and delegating them to the backend layer for processing. It provides a JSON-RPC interface for managing operations related to blocks, transactions, contracts, and metrics.

Upon startup, the daemon initializes a background task to handle incoming JSON-RPC requests. This includes processing operations related to blocks, transactions, contracts, and metrics by delegating them to the backend and returning appropriate RPC responses. Additionally, the daemon synchronizes blocks from the darkfid daemon into the explorer database and subscribes to new blocks, ensuring that the local database remains updated in real-time.

Fields

service: ExplorerService

Explorer service instance

rpc_connections: Mutex<HashSet<StoppableTaskPtr>>

JSON-RPC connection tracker

darkfid_client: Arc<DarkfidRpcClient>

JSON-RPC client to execute requests to darkfid daemon

darkfid_endpoint: Url

Darkfi blockchain node endpoint to sync with when not in no-sync mode

executor: Arc<Executor<'static>>

A asynchronous executor used to create an RPC client when not in no-sync mode

Implementations

impl Explorerd

pub async fn blocks_get_last_n_blocks( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn blocks_get_blocks_in_heights_range( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn blocks_get_block_by_hash( &self, params: &JsonValue, ) -> Result<JsonValue>

impl Explorerd

pub async fn contracts_get_native_contracts( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn contracts_get_contract_source_code_paths( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn contracts_get_contract_source( &self, params: &JsonValue, ) -> Result<JsonValue>

impl Explorerd

pub async fn statistics_get_basic_statistics( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn statistics_get_metric_statistics( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn statistics_get_latest_metric_statistics( &self, params: &JsonValue, ) -> Result<JsonValue>

impl Explorerd

pub async fn transactions_get_transactions_by_header_hash( &self, params: &JsonValue, ) -> Result<JsonValue>

pub async fn transactions_get_transaction_by_hash( &self, params: &JsonValue, ) -> Result<JsonValue>

impl Explorerd

async fn ping_darkfid(&self, params: &JsonValue) -> Result<JsonValue>

impl Explorerd

pub(crate) async fn new( db_path: String, darkfid_endpoint: Url, ex: Arc<Executor<'static>>, ) -> Result<Self>

Creates a new BlockchainExplorer instance.

pub(crate) async fn connect(&self) -> Result<()>

Establishes a connection to the configured darkfid endpoint, returning a successful result if the connection is successful, or an error otherwise.

Trait Implementations

impl RequestHandler<()> for Explorerd

fn handle_request<'life0, 'async_trait>( &'life0 self, req: JsonRequest, ) -> Pin<Box<dyn Future<Output = JsonResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles an incoming JSON-RPC request by executing the appropriate individual request handler implementation based on the request’s method field and using the provided parameters. Supports methods across various categories, including block-related queries, contract interactions, transaction lookups, statistical queries, and miscellaneous operations. If an invalid method is requested, an appropriate error is returned.

The function performs the error handling, allowing individual RPC method handlers to propagate errors via the ? operator. It ensures uniform translation of errors into JSON-RPC error responses. Additionally, it handles the creation of JsonResponse or JsonError objects, enabling method handlers to focus solely on core logic. Individual RPC handlers return a JsonValue, which this function translates into the corresponding JsonResult.

Unified logging is incorporated, so individual handlers only propagate the error for it to be logged. Logs include detailed error information, such as method names, parameters, and JSON-RPC errors, providing consistent and informative error trails for debugging.

Example Log Message

05:11:02 [ERROR] RPC Request Failure: method: transactions.get_transactions_by_header_hash,
params: ["0x0222"], error: {"error":{"code":-32602,"message":"Invalid header hash: 0x0222"},
"id":1,"jsonrpc":"2.0"}

fn connections_mut<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = MutexGuard<'_, HashSet<StoppableTaskPtr>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn pong<'life0, 'async_trait>( &'life0 self, id: u16, _params: JsonValue, ) -> Pin<Box<dyn Future<Output = JsonResult> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

fn connections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Vec<Arc<StoppableTask>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

fn mark_connection<'life0, 'async_trait>( &'life0 self, task: Arc<StoppableTask>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

fn unmark_connection<'life0, 'async_trait>( &'life0 self, task: Arc<StoppableTask>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

fn active_connections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = usize> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

fn stop_connections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,