nimbus-eth1/fluffy/network_metadata.nim

98 lines
3.9 KiB
Nim

# Nimbus
# Copyright (c) 2022-2024 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: [].}
import std/[sequtils, strutils, os, macros], stew/results, chronos/timer
proc loadBootstrapNodes(path: string): seq[string] {.raises: [IOError].} =
# Read a list of ENR URIs from a file containing a flat list of entries.
# If the file can't be read, this will raise. This is intentionally.
splitLines(readFile(path)).filterIt(it.startsWith("enr:")).mapIt(it.strip())
proc loadCompileTimeBootstrapNodes(path: string): seq[string] =
try:
return loadBootstrapNodes(path)
# TODO: This error doesn't seem to get printed. It instead dies with an
# unhandled exception (IOError)
except IOError as err:
macros.error "Failed to load bootstrap nodes metadata at '" & path & "': " & err.msg
# Need to use std/io readFile because:
# https://github.com/status-im/nim-stew/issues/145
proc loadEncodedAccumulator(path: string): string =
try:
return readFile(path).string
except IOError as err:
macros.error "Failed to read finished accumulator at '" & path & "': " & err.msg
const
# TODO: Change this from our local repo to an eth-client repo if/when this
# gets created for the Portal networks.
portalNetworksDir = currentSourcePath.parentDir.replace('\\', '/') / "network_data"
# TODO: Using a repo for test vectors for now, as it is something to test
# against, but at the same time could also go in a network metadata repo.
portalTestDir =
currentSourcePath.parentDir.parentDir.replace('\\', '/') / "vendor" /
"portal-spec-tests" / "tests"
# Note:
# For now it gets called testnet0 but this Portal network serves Eth1 mainnet
# data. Giving the actual Portal (test)networks different names might not be
# that useful as there is no way to distinguish the networks currently.
#
# When more config data is required per Portal network, a metadata object can
# be created, but right now only bootstrap nodes can be different.
# TODO: It would be nice to be able to use `loadBootstrapFile` here, but that
# doesn't work at compile time. The main issue seems to be the usage of
# rlp.rawData() in the enr code.
testnet0BootstrapNodes* = loadCompileTimeBootstrapNodes(
portalNetworksDir / "testnet0" / "bootstrap_nodes.txt"
)
finishedAccumulator* = loadEncodedAccumulator(
portalTestDir / "mainnet" / "history" / "accumulator" / "finished_accumulator.ssz"
)
type
# TODO: I guess we could use the nimbus ChainConfig but:
# - Only need some of the values right now
# - `EthTime` uses std/times while chronos Moment is sufficient and more
# sensible
ChainConfig* = object
mergeForkBlock*: uint64
shanghaiTime*: Opt[Moment]
cancunTime*: Opt[Moment]
const
# Allow this to be adjusted at compile time for testing. If more constants
# need to be adjusted we can add some more ChainConfig presets either at
# compile or runtime.
mergeBlockNumber* {.intdefine.}: uint64 = 15537394
chainConfig* = ChainConfig(
mergeForkBlock: mergeBlockNumber,
shanghaiTime: Opt.some(Moment.init(1681338455'i64, Second)),
cancunTime: Opt.none(Moment),
)
func isTimestampForked(forkTime: Opt[Moment], timestamp: Moment): bool =
if forkTime.isNone():
false
else:
forkTime.get() <= timestamp
func isPoSBlock*(c: ChainConfig, blockNumber: uint64): bool =
c.mergeForkBlock <= blockNumber
func isShanghai*(c: ChainConfig, timestamp: Moment): bool =
isTimestampForked(c.shanghaiTime, timestamp)
func isCancun*(c: ChainConfig, timestamp: Moment): bool =
isTimestampForked(c.cancunTime, timestamp)