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_config_calls.nim

30 lines
1.3 KiB
Nim
Raw Permalink 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 getForkSchedule*(): RestResponse[GetForkScheduleResponse] {.
rest, endpoint: "/eth/v1/config/fork_schedule", 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/#/Config/getForkSchedule
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 getSpec*(): RestResponse[GetSpecResponse] {.
rest, endpoint: "/eth/v1/config/spec", 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/#/Config/getSpec
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
widen allowed specs for validator client The validator client was only able to connect to beacon nodes exposing the exact same set of spec constants that are locally known via their config/spec REST API. However, that set of spec constants is dynamic. As the validator client only requires a subset of relevant constants, this may lead to compatible specs being rejected. This patch widens the allowed specs by only verifying that the required set of constants are present in the spec response, ignoring any spec constants that are not locally known, and ignoring missing spec constants that are locally known but not included by the remote beacon node when not relevant for operation of the validator client.
2021-10-20 09:58:38 +00:00
proc getSpecVC*(): RestResponse[GetSpecVCResponse] {.
rest, endpoint: "/eth/v1/config/spec", meth: MethodGet.}
## https://ethereum.github.io/beacon-APIs/#/Config/getSpec
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 getDepositContract*(): RestResponse[GetDepositContractResponse] {.
rest, endpoint: "/eth/v1/config/deposit_contract", 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/#/Config/getDepositContract