nimbus-eth2/beacon_chain/rpc/config_rest_api.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.

import
  stew/[endians2, base10],
  presto,
  rest_utils,
  chronicles,
  nimcrypto/utils as ncrutils,
  ../beacon_node_common, ../eth1/eth1_monitor,
  ../spec/datatypes/base,
  ../spec/[digest, forkedbeaconstate_helpers, presets],
  ./eth2_json_rest_serialization, ./rest_utils

logScope: topics = "rest_config"

func getDepositAddress(node: BeaconNode): string =
  if isNil(node.eth1Monitor):
    ""
  else:
    $node.eth1Monitor.depositContractAddress

proc installConfigApiHandlers*(router: var RestRouter, node: BeaconNode) =
  router.api(MethodGet,
             "/api/eth/v1/config/fork_schedule") do () -> RestApiResponse:
    # TODO: Implemenation needs a fix, when forks infrastructure will be
    # established.
    return RestApiResponse.jsonResponse(
      [getStateField(node.dag.headState.data, fork)]
    )

  router.api(MethodGet,
             "/api/eth/v1/config/spec") do () -> RestApiResponse:
    return RestApiResponse.jsonResponse(
      (
        CONFIG_NAME:
          const_preset,
        MAX_COMMITTEES_PER_SLOT:
          Base10.toString(MAX_COMMITTEES_PER_SLOT),
        TARGET_COMMITTEE_SIZE:
          Base10.toString(TARGET_COMMITTEE_SIZE),
        MAX_VALIDATORS_PER_COMMITTEE:
          Base10.toString(MAX_VALIDATORS_PER_COMMITTEE),
        MIN_PER_EPOCH_CHURN_LIMIT:
          Base10.toString(MIN_PER_EPOCH_CHURN_LIMIT),
        CHURN_LIMIT_QUOTIENT:
          Base10.toString(CHURN_LIMIT_QUOTIENT),
        SHUFFLE_ROUND_COUNT:
          Base10.toString(SHUFFLE_ROUND_COUNT),
        MIN_GENESIS_ACTIVE_VALIDATOR_COUNT:
          Base10.toString(
            node.runtimePreset.MIN_GENESIS_ACTIVE_VALIDATOR_COUNT
          ),
        MIN_GENESIS_TIME:
          Base10.toString(node.runtimePreset.MIN_GENESIS_TIME),
        HYSTERESIS_QUOTIENT:
          Base10.toString(HYSTERESIS_QUOTIENT),
        HYSTERESIS_DOWNWARD_MULTIPLIER:
          Base10.toString(HYSTERESIS_DOWNWARD_MULTIPLIER),
        HYSTERESIS_UPWARD_MULTIPLIER:
          Base10.toString(HYSTERESIS_UPWARD_MULTIPLIER),
        SAFE_SLOTS_TO_UPDATE_JUSTIFIED:
          Base10.toString(SAFE_SLOTS_TO_UPDATE_JUSTIFIED),
        ETH1_FOLLOW_DISTANCE:
          Base10.toString(node.runtimePreset.ETH1_FOLLOW_DISTANCE),
        TARGET_AGGREGATORS_PER_COMMITTEE:
          Base10.toString(TARGET_AGGREGATORS_PER_COMMITTEE),
        RANDOM_SUBNETS_PER_VALIDATOR:
          Base10.toString(RANDOM_SUBNETS_PER_VALIDATOR),
        EPOCHS_PER_RANDOM_SUBNET_SUBSCRIPTION:
          Base10.toString(EPOCHS_PER_RANDOM_SUBNET_SUBSCRIPTION),
        SECONDS_PER_ETH1_BLOCK:
          Base10.toString(SECONDS_PER_ETH1_BLOCK),
        DEPOSIT_CHAIN_ID:
          Base10.toString(uint64(DEPOSIT_CHAIN_ID)),
        DEPOSIT_NETWORK_ID:
          Base10.toString(uint64(DEPOSIT_NETWORK_ID)),
        DEPOSIT_CONTRACT_ADDRESS:
          node.getDepositAddress(),
        MIN_DEPOSIT_AMOUNT:
          Base10.toString(MIN_DEPOSIT_AMOUNT),
        MAX_EFFECTIVE_BALANCE:
          Base10.toString(MAX_EFFECTIVE_BALANCE),
        EJECTION_BALANCE:
          Base10.toString(EJECTION_BALANCE),
        EFFECTIVE_BALANCE_INCREMENT:
          Base10.toString(EFFECTIVE_BALANCE_INCREMENT),
        GENESIS_FORK_VERSION:
          "0x" & $node.runtimePreset.GENESIS_FORK_VERSION,
        BLS_WITHDRAWAL_PREFIX:
          "0x" & ncrutils.toHex([BLS_WITHDRAWAL_PREFIX]),
        GENESIS_DELAY:
          Base10.toString(node.runtimePreset.GENESIS_DELAY),
        SECONDS_PER_SLOT:
          Base10.toString(SECONDS_PER_SLOT),
        MIN_ATTESTATION_INCLUSION_DELAY:
          Base10.toString(MIN_ATTESTATION_INCLUSION_DELAY),
        SLOTS_PER_EPOCH:
          Base10.toString(SLOTS_PER_EPOCH),
        MIN_SEED_LOOKAHEAD:
          Base10.toString(MIN_SEED_LOOKAHEAD),
        MAX_SEED_LOOKAHEAD:
          Base10.toString(MAX_SEED_LOOKAHEAD),
        EPOCHS_PER_ETH1_VOTING_PERIOD:
          Base10.toString(EPOCHS_PER_ETH1_VOTING_PERIOD),
        SLOTS_PER_HISTORICAL_ROOT:
          Base10.toString(SLOTS_PER_HISTORICAL_ROOT),
        MIN_VALIDATOR_WITHDRAWABILITY_DELAY:
          Base10.toString(MIN_VALIDATOR_WITHDRAWABILITY_DELAY),
        SHARD_COMMITTEE_PERIOD:
          Base10.toString(SHARD_COMMITTEE_PERIOD),
        MIN_EPOCHS_TO_INACTIVITY_PENALTY:
          Base10.toString(MIN_EPOCHS_TO_INACTIVITY_PENALTY),
        EPOCHS_PER_HISTORICAL_VECTOR:
          Base10.toString(EPOCHS_PER_HISTORICAL_VECTOR),
        EPOCHS_PER_SLASHINGS_VECTOR:
          Base10.toString(EPOCHS_PER_SLASHINGS_VECTOR),
        HISTORICAL_ROOTS_LIMIT:
          Base10.toString(HISTORICAL_ROOTS_LIMIT),
        VALIDATOR_REGISTRY_LIMIT:
          Base10.toString(VALIDATOR_REGISTRY_LIMIT),
        BASE_REWARD_FACTOR:
          Base10.toString(BASE_REWARD_FACTOR),
        WHISTLEBLOWER_REWARD_QUOTIENT:
          Base10.toString(WHISTLEBLOWER_REWARD_QUOTIENT),
        PROPOSER_REWARD_QUOTIENT:
          Base10.toString(PROPOSER_REWARD_QUOTIENT),
        INACTIVITY_PENALTY_QUOTIENT:
          Base10.toString(INACTIVITY_PENALTY_QUOTIENT),
        MIN_SLASHING_PENALTY_QUOTIENT:
          Base10.toString(MIN_SLASHING_PENALTY_QUOTIENT),
        PROPORTIONAL_SLASHING_MULTIPLIER:
          Base10.toString(PROPORTIONAL_SLASHING_MULTIPLIER),
        MAX_PROPOSER_SLASHINGS:
          Base10.toString(MAX_PROPOSER_SLASHINGS),
        MAX_ATTESTER_SLASHINGS:
          Base10.toString(MAX_ATTESTER_SLASHINGS),
        MAX_ATTESTATIONS:
          Base10.toString(MAX_ATTESTATIONS),
        MAX_DEPOSITS:
          Base10.toString(MAX_DEPOSITS),
        MAX_VOLUNTARY_EXITS:
          Base10.toString(MAX_VOLUNTARY_EXITS),
        DOMAIN_BEACON_PROPOSER:
          "0x" & ncrutils.toHex(uint32(DOMAIN_BEACON_PROPOSER).toBytesLE()),
        DOMAIN_BEACON_ATTESTER:
          "0x" & ncrutils.toHex(uint32(DOMAIN_BEACON_ATTESTER).toBytesLE()),
        DOMAIN_RANDAO:
          "0x" & ncrutils.toHex(uint32(DOMAIN_RANDAO).toBytesLE()),
        DOMAIN_DEPOSIT:
          "0x" & ncrutils.toHex(uint32(DOMAIN_DEPOSIT).toBytesLE()),
        DOMAIN_VOLUNTARY_EXIT:
          "0x" & ncrutils.toHex(uint32(DOMAIN_VOLUNTARY_EXIT).toBytesLE()),
        DOMAIN_SELECTION_PROOF:
          "0x" & ncrutils.toHex(uint32(DOMAIN_SELECTION_PROOF).toBytesLE()),
        DOMAIN_AGGREGATE_AND_PROOF:
          "0x" & ncrutils.toHex(uint32(DOMAIN_AGGREGATE_AND_PROOF).toBytesLE())
      )
    )

  router.api(MethodGet,
             "/api/eth/v1/config/deposit_contract") do () -> RestApiResponse:
    return RestApiResponse.jsonResponse(
      (chain_id: $DEPOSIT_CHAIN_ID, address: node.getDepositAddress())
    )

  router.redirect(
    MethodGet,
    "/eth/v1/config/fork_schedule",
    "/api/eth/v1/config/fork_schedule"
  )
  router.redirect(
    MethodGet,
    "/eth/v1/config/spec",
    "/api/eth/v1/config/spec"
  )
  router.redirect(
    MethodGet,
    "/eth/v1/config/deposit_contract",
    "/api/eth/v1/config/deposit_contract"
  )