nimbus-eth1/nimbus/genesis.nim

import
  std/tables,
  eth/[common, rlp],
  chronicles, eth/trie/[db, trie_defs],
  ./db/[db_chain, state_db],
  "."/[constants, chain_config, forks, p2p/gaslimit]

{.push raises: [Defect].}

# ------------------------------------------------------------------------------
# Public functions
# ------------------------------------------------------------------------------
proc newStateDB*(db: TrieDatabaseRef, pruneTrie: bool): AccountStateDB =
  newAccountStateDB(db, emptyRlpHash, pruneTrie)

proc toGenesisHeader*(db: BaseChainDB, sdb: AccountStateDB): BlockHeader
    {.raises: [Defect, RlpError].} =
  ## Initialise block chain DB accounts derived from the `genesis.alloc` table
  ## of the `db` descriptor argument.
  ##
  ## The function returns the `Genesis` block header.
  ##

  # For `eth/trie/db.newMemoryDB()`, the following initialisation is part of
  # the constructor function which is missing for the permanent constructor
  # function `eth/trie/db.trieDB()`.
  db.db.put(emptyRlpHash.data, emptyRlp)

  let g = db.genesis

  for address, account in g.alloc:
    sdb.setAccount(address, newAccount(account.nonce, account.balance))
    sdb.setCode(address, account.code)

    # Kludge:
    #
    #   With the pruning persistent version, the initial/trivial key-value
    #   pair `(emptyRlpHash.data,emptyRlp)` will have been deleted after
    #   adding a non-trivial key-value pair in one of the above functions.
    #   This happens in the function/template
    #
    #      eth/trie/db.del() called by
    #      eth/trie/hexary.prune() invoked by
    #      eth/trie/hexary.origWithNewValue() invoked by
    #      eth/trie/hexary.mergeAt() called by
    #      eth/trie/hexary.put()
    #
    #   if the database contains the trivial key-value pair, only.
    #   Unfortunately, the *trie* is now empty but the previous root hash
    #   is re-used. This leads to an assert exception in any subsequent
    #   invocation of `eth/trie/hexary.put()`.
    #
    # See also https://github.com/status-im/nim-eth/issues/9 where other,
    # probably related debilities are discussed.
    #
    # This kludge also fixes the initial crash described in
    # https://github.com/status-im/nimbus-eth1/issues/932.
    if not db.isNil and db.pruneTrie and 0 < account.storage.len:
      db.db.put(emptyRlpHash.data, emptyRlp) # <-- kludge

    for k, v in account.storage:
      sdb.setStorage(address, k, v)

  result = BlockHeader(
    nonce: g.nonce,
    timestamp: g.timestamp,
    extraData: g.extraData,
    gasLimit: g.gasLimit,
    difficulty: g.difficulty,
    mixDigest: g.mixHash,
    coinbase: g.coinbase,
    stateRoot: sdb.rootHash,
    parentHash: GENESIS_PARENT_HASH,
    txRoot: EMPTY_ROOT_HASH,
    receiptRoot: EMPTY_ROOT_HASH,
    ommersHash: EMPTY_UNCLE_HASH
  )

  let fork = db.config.toFork(0.toBlockNumber)
  if g.baseFeePerGas.isSome:
    result.baseFee = g.baseFeePerGas.get()
  elif fork >= FkLondon:
    result.baseFee = EIP1559_INITIAL_BASE_FEE.u256

  if g.gasLimit.isZero:
    result.gasLimit = GENESIS_GAS_LIMIT

  if g.difficulty.isZero and fork <= FkLondon:
    result.difficulty = GENESIS_DIFFICULTY

proc toGenesisHeader*(params: NetworkParams): BlockHeader
    {.raises: [Defect, RlpError].} =
  ## Generate the genesis block header from the `params` argument value.
  let cdb = newBaseChainDB(
    db        = newMemoryDB(),
    id        = params.config.chainId.NetworkId,
    params    = params,
    pruneTrie = true)
  let sdb = newStateDB(cdb.db, cdb.pruneTrie)
  cdb.toGenesisHeader(sdb)

proc toGenesisHeader*(db: BaseChainDB): BlockHeader
    {.raises: [Defect, RlpError].} =
  ## Generate the genesis block header from the `genesis` and `config`
  ## fields of the argument `db` descriptor.
  NetworkParams(
    config:  db.config,
    genesis: db.genesis).toGenesisHeader()

proc initializeEmptyDb*(cdb: BaseChainDB)
    {.raises: [Defect, CatchableError].} =
  trace "Writing genesis to DB"
  let sdb = newStateDB(cdb.db, cdb.pruneTrie)
  let header = cdb.toGenesisHeader(sdb)
  doAssert(header.blockNumber.isZero, "can't commit genesis block with number > 0")
  # faster lookup of curent total difficulty
  discard cdb.persistHeaderToDb(header)

# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------