status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/beacon_chain/spec/eth2_apis/rest_node_calls.nim

51 lines
2.0 KiB
Nim
Raw Normal View History

REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
# 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.
{.push raises: [Defect].}
import
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
chronos, presto/client,
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
"."/[rest_types, eth2_rest_serialization]
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
export chronos, client, rest_types, eth2_rest_serialization
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getNetworkIdentity*(): RestResponse[GetNetworkIdentityResponse] {.
rest, endpoint: "/eth/v1/node/identity",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getNetworkIdentity
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getPeers*(
state: seq[PeerStateKind],
direction: seq[PeerDirectKind]): RestResponse[GetPeersResponse] {.
rest, endpoint: "/eth/v1/node/peers",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getPeers
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getPeer*(peer_id: PeerId): RestResponse[GetPeerResponse] {.
rest, endpoint: "/eth/v1/node/peers/{peer_id}",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getPeer
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getPeerCount*(): RestResponse[GetPeerCountResponse] {.
rest, endpoint: "/eth/v1/node/peer_count",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getPeerCount
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getNodeVersion*(): RestResponse[GetVersionResponse] {.
rest, endpoint: "/eth/v1/node/version",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getNodeVersion
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getSyncingStatus*(): RestResponse[GetSyncingStatusResponse] {.
rest, endpoint: "/eth/v1/node/syncing",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getSyncingStatus
REST API client, JSON-RPC cleanups (#2756) 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
2021-08-03 15:17:11 +00:00
proc getHealth*(): RestPlainResponse {.
rest, endpoint: "/eth/v1/node/health",
meth: MethodGet.}
cleanups and fixes (#2827) * import cleanup * fix json-rpc exception handlers * avoid unnecessary presto client import * introduce ForkedBeaconBlock, some altair logging * url fixes
2021-08-27 09:00:06 +00:00
## https://ethereum.github.io/beacon-APIs/#/Node/getHealth