Exonum Explorer Service

exonum-explorer-service provides HTTP endpoints for exploring Exonum blockchains.

This crate is distinct from the base explorer crate. The base explorer provides Rust language APIs for retrieving info from the blockchain, while this crate translates these APIs into REST and WebSocket endpoints and packages this logic as an Exonum service. Thus, this crate is useful if you want to provide the way for external apps to query the blockchain info.

Description

The explorer service does not define transactions, but it has several REST / WebSocket endpoints allowing to retrieve information from the blockchain in a structured way.

Usually, the explorer service should be instantiated at the blockchain start with the default identifiers. There may be no more than one explorer service on a blockchain; an attempt to create a second service instance will lead to an error in the service constructor.

The API types necessary to interact with the service HTTP API are defined in a separate crate, exonum-explorer. The base explorer provides Rust language APIs for retrieving info from the blockchain, while this crate translates these APIs into REST and WebSocket endpoints and packages this logic as an Exonum service.

Thus, this crate is useful if you want to provide the way for external apps to query the blockchain info.

HTTP API

REST and WebSocket APIs of the service is documented in the crate docs.

Usage

Include exonum-explorer-service as a dependency in your Cargo.toml:

[dependencies]
exonum = "1.0.0"
exonum-explorer-service = "1.0.0"

The explorer service should usually be initialized at the blockchain start with the default identifiers. The service will refuse to instantiate if an explorer service is already instantiated on the blockchain.

Consult the crate docs for more details about the service API.

License

exonum-explorer-service is licensed under the Apache License (Version 2.0). See LICENSE for details.