nimbus-eth1/fluffy/tools/portal_bridge/portal_bridge_conf.nim

147 lines
4.4 KiB
Nim

# Fluffy
# Copyright (c) 2023-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/[strutils, os, uri], confutils, confutils/std/net, nimcrypto/hash, ../../logging
export net
proc defaultEthDataDir*(): string =
let dataDir =
when defined(windows):
"AppData" / "Roaming" / "EthData"
elif defined(macosx):
"Library" / "Application Support" / "EthData"
else:
".cache" / "eth-data"
getHomeDir() / dataDir
proc defaultEra1DataDir*(): string =
defaultEthDataDir() / "era1"
type
TrustedDigest* = MDigest[32 * 8]
JsonRpcUrlKind* = enum
HttpUrl
WsUrl
JsonRpcUrl* = object
kind*: JsonRpcUrlKind
value*: string
PortalBridgeCmd* = enum
beacon = "Run a Portal bridge for the beacon network"
history = "Run a Portal bridge for the history network"
state = "Run a Portal bridge for the state network"
PortalBridgeConf* = object # Logging
logLevel* {.desc: "Sets the log level", defaultValue: "INFO", name: "log-level".}:
string
logStdout* {.
hidden,
desc:
"Specifies what kind of logs should be written to stdout (auto, colors, nocolors, json)",
defaultValueDesc: "auto",
defaultValue: StdoutLogKind.Auto,
name: "log-format"
.}: StdoutLogKind
portalRpcUrl* {.desc: "Portal node JSON-RPC API URL", name: "portal-rpc-url".}:
JsonRpcUrl
case cmd* {.command, desc: "".}: PortalBridgeCmd
of PortalBridgeCmd.beacon:
# Beacon node REST API URL
restUrl* {.
desc: "URL of the beacon node REST service",
defaultValue: "http://127.0.0.1:5052",
name: "rest-url"
.}: string
# Backfill options
backfillAmount* {.
desc: "Amount of beacon LC updates to backfill gossip into the network",
defaultValue: 64,
name: "backfill-amount"
.}: uint64
trustedBlockRoot* {.
desc:
"Trusted finalized block root for which to gossip a LC bootstrap into the network",
defaultValue: none(TrustedDigest),
name: "trusted-block-root"
.}: Option[TrustedDigest]
of PortalBridgeCmd.history:
web3Url* {.desc: "Execution layer JSON-RPC API URL", name: "web3-url".}:
JsonRpcUrl
blockVerify* {.
desc: "Verify the block header, body and receipts",
defaultValue: false,
name: "block-verify"
.}: bool
latest* {.
desc:
"Follow the head of the chain and gossip latest block header, body and receipts into the network",
defaultValue: true,
name: "latest"
.}: bool
backfill* {.
desc:
"Randomly backfill pre-merge block headers, bodies and receipts into the network from the era1 files",
defaultValue: false,
name: "backfill"
.}: bool
audit* {.
desc:
"Run pre-merge backfill in audit mode, which will only gossip content that if failed to fetch from the network",
defaultValue: true,
name: "audit"
.}: bool
era1Dir* {.
desc: "The directory where all era1 files are stored",
defaultValue: defaultEra1DataDir(),
defaultValueDesc: defaultEra1DataDir(),
name: "era1-dir"
.}: InputDir
of PortalBridgeCmd.state:
web3UrlState* {.desc: "Execution layer JSON-RPC API URL", name: "web3-url".}:
JsonRpcUrl
func parseCmdArg*(T: type TrustedDigest, input: string): T {.raises: [ValueError].} =
TrustedDigest.fromHex(input)
func completeCmdArg*(T: type TrustedDigest, input: string): seq[string] =
return @[]
proc parseCmdArg*(T: type JsonRpcUrl, p: string): T {.raises: [ValueError].} =
let
url = parseUri(p)
normalizedScheme = url.scheme.toLowerAscii()
if (normalizedScheme == "http" or normalizedScheme == "https"):
JsonRpcUrl(kind: HttpUrl, value: p)
elif (normalizedScheme == "ws" or normalizedScheme == "wss"):
JsonRpcUrl(kind: WsUrl, value: p)
else:
raise newException(
ValueError,
"The Web3 URL must specify one of following protocols: http/https/ws/wss",
)
proc completeCmdArg*(T: type JsonRpcUrl, val: string): seq[string] =
return @[]