mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-01-09 13:56:23 +00:00
3d7bee8502
This refactoring puts the JSON-RPC and REST APIs on more equal footing by renaming and moving things around, creating a separation between client and server, and documenting what they are - the aim is to have a simple-to-use base to start from when developing API clients, as well as make it easier to navigate the code when looking for the legacy JSON-RPC interface vs the new REST API. * move REST client, serialization and supporting types to spec/eth2_apis * REST stuff now starts with `rest_`, JSON-RPC stuff starts with `rpc_`, more or less * simplify imports such that there's a simple module to import for both server and client * map REST type and proc names to yaml spec more closely - in particular, reuse operation and type names in `rest_types` to make comparisons against spec more easy * cleaner separation between client and server modules - modules common between server and client such as `rest_types` and serialization move to the spec folder - this allows the client to be built with less knowledge about server internals
25 lines
1.2 KiB
Nim
25 lines
1.2 KiB
Nim
# Copyright (c) 2018-2021 Status Research & Development GmbH
|
|
# Licensed and distributed under either of
|
|
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
|
|
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
|
|
# at your option. This file may not be copied, modified, or distributed except according to those terms.
|
|
|
|
## The `rpc_api` module is a server implementation of a JSON-RPC-based API
|
|
## for Nimbus - it is based on the common REST API for Ethereum 2 found at
|
|
## https://ethereum.github.io/eth2.0-APIs/# but uses JSON-RPC as transport
|
|
## instead. There are also minor historical differences in encoding and data -
|
|
## these differences will likely remain so as to not break old tooling.
|
|
##
|
|
## The JSON-RPC is used by community utilities and tools and is kept for
|
|
## backwards compatibility mainly.
|
|
## A corresponding client can be found in the
|
|
## `spec/eth2_apis/rpc_beacon_client` module.
|
|
import
|
|
"."/[
|
|
rpc_beacon_api, rpc_config_api, rpc_debug_api, rpc_event_api,
|
|
rpc_nimbus_api, rpc_node_api, rpc_validator_api]
|
|
|
|
export
|
|
rpc_beacon_api, rpc_config_api, rpc_debug_api, rpc_event_api,
|
|
rpc_nimbus_api, rpc_node_api, rpc_validator_api
|