# Nimbus
# Copyright (c) 2018 Status Research & Development GmbH
# Licensed under either of
#  * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
#  * MIT license ([LICENSE-MIT](LICENSE-MIT))
# at your option.
# This file may not be copied, modified, or distributed except according to
# those terms.

import
  strutils, hexstrings, eth_p2p, options,
  ../db/[db_chain, state_db, storage_types],
  json_rpc/rpcserver, json, macros, rpc_utils,
  eth_common, ../tracer, ../vm_state, ../vm_types

type
  TraceTxOptions = object
    disableStorage: Option[bool]
    disableMemory: Option[bool]
    disableStack: Option[bool]
    disableState: Option[bool]

proc isTrue(x: Option[bool]): bool =
  result = x.isSome and x.get() == true

proc setupDebugRpc*(chainDB: BaseChainDB, rpcsrv: RpcServer) =

  proc getBlockBody(hash: Hash256): BlockBody =
    if not chainDB.getBlockBody(hash, result):
      raise newException(ValueError, "Error when retrieving block body")

  rpcsrv.rpc("debug_traceTransaction") do(data: EthHashStr, options: Option[TraceTxOptions]) -> JsonNode:
    ## The traceTransaction debugging method will attempt to run the transaction in the exact
    ## same manner as it was executed on the network. It will replay any transaction that may
    ## have been executed prior to this one before it will finally attempt to execute the
    ## transaction that corresponds to the given hash.
    ##
    ## In addition to the hash of the transaction you may give it a secondary optional argument,
    ## which specifies the options for this specific call. The possible options are:
    ##
    ## * disableStorage: BOOL. Setting this to true will disable storage capture (default = false).
    ## * disableMemory: BOOL. Setting this to true will disable memory capture (default = false).
    ## * disableStack: BOOL. Setting this to true will disable stack capture (default = false).
    ## * disableState: BOOL. Setting this to true will disable state trie capture (default = false).
    let
      txHash = toHash(data)
      txDetails = chainDB.getTransactionKey(txHash)
      blockHeader = chainDB.getBlockHeader(txDetails.blockNumber)
      blockHash = chainDB.getBlockHash(txDetails.blockNumber)
      blockBody = getBlockBody(blockHash)

    var
      flags: set[TracerFlags]

    if options.isSome:
      let opts = options.get
      if opts.disableStorage.isTrue: flags.incl TracerFlags.DisableStorage
      if opts.disableMemory.isTrue: flags.incl TracerFlags.DisableMemory
      if opts.disableStack.isTrue: flags.incl TracerFlags.DisableStack
      if opts.disableState.isTrue: flags.incl TracerFlags.DisableState

    traceTransaction(chainDB, blockHeader, blockBody, txDetails.index, flags)

  rpcsrv.rpc("debug_dumpBlockStateByNumber") do(quantityTag: string) -> JsonNode:
    ## Retrieves the state that corresponds to the block number and returns
    ## a list of accounts (including storage and code).
    ##
    ## quantityTag: integer of a block number, or the string "earliest",
    ## "latest" or "pending", as in the default block parameter.
    let
      header = chainDB.headerFromTag(quantityTag)
      blockHash = chainDB.getBlockHash(header.blockNumber)
      body = getBlockBody(blockHash)

    dumpBlockState(chainDB, header, body)

  rpcsrv.rpc("debug_dumpBlockStateByHash") do(data: EthHashStr) -> JsonNode:
    ## Retrieves the state that corresponds to the block number and returns
    ## a list of accounts (including storage and code).
    ##
    ## data: Hash of a block.
    let
      h = data.toHash
      header = chainDB.getBlockHeader(h)
      blockHash = chainDB.getBlockHash(header.blockNumber)
      body = getBlockBody(blockHash)

    dumpBlockState(chainDB, header, body)