From 0a0889109f29b40d24805dd52f64cece573a1953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Vincent?= <28714795+leovct@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:55:22 +0200 Subject: [PATCH] docs: document unused cdk-erigon flags in the code (#290) * chore: document unused flag in the code * fix: config * docs: document flag issues --- templates/cdk-erigon/config.yml | 50 ++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/templates/cdk-erigon/config.yml b/templates/cdk-erigon/config.yml index c41e5cfb..f4fbc9f9 100644 --- a/templates/cdk-erigon/config.yml +++ b/templates/cdk-erigon/config.yml @@ -13,7 +13,8 @@ # Default: false log.console.json: false -# Set the log level for console logs +# Set the log verbosity for console logs. +# Options: crit, error, warn, info, debug, trace # Default: info log.console.verbosity: {{.global_log_level}} @@ -21,14 +22,15 @@ log.console.verbosity: {{.global_log_level}} # Default: false log.dir.json: false -# Path to store user and errors logs to disk. -# Default: "" -log.dir.path: /tmp/cdk-erigon.log - # Set the log verbosity for logs stored to disk. +# Options: crit, error, warn, info, debug, trace # Default: info log.dir.verbosity: {{.global_log_level}} +# Path to store user and errors logs to disk. +# Default: "" +log.dir.path: /tmp/cdk-erigon.log + # -------------------------------------------------------------------------------------------------- # ____ _____ _ _ _____ ____ _ _ @@ -41,15 +43,6 @@ log.dir.verbosity: {{.global_log_level}} # The data directory for the databases. datadir: ./data/dynamic-kurtosis-sequencer -# The data directory for ancient chain segments. -# Default: inside chaindata -# datadir.ancient: - -# The minimum free disk space in MB, once reached triggers auto shut down. -# Set to 0 to disable this chec. -# Default: --cache.gc converted to MB -# datadir.minfreedisk: - # The network identifier. # For testnets, use --chain instead. networkid: 1 # ethereum @@ -188,7 +181,8 @@ zkevm.pool-manager-url: {{.pool_manager_url}} # Set the maximum number of RPC requests allowed per second. # This helps prevent server overload and ensures fair resource allocation among clients. # A value of 0 disables rate limiting, while higher values enforce stricter limits. -# It looks like this flag is not used! +# NOTE: The flag must be specified but it is not used in the code! +# https://github.com/0xPolygonHermez/cdk-erigon/issues/1254 # Default: 0 zkevm.rpc-ratelimit: 250 @@ -348,7 +342,7 @@ zkevm.executor-request-timeout: 60s # Limit the number of simultaneous requests that can be sent to the executor. # Higher values may improve throughput but could overload the executor. # Adjust based on your executor's capacity and system resources. -# Default: # +# Default: 1 zkevm.executor-max-concurrent-requests: 1 # If set, specifies a directory where serialized executor requests will be stored. @@ -377,11 +371,15 @@ zkevm.address-sequencer: "{{.zkevm_l2_sequencer_address}}" # Specify the address of the PolygonRollupManager smart contract. # This contract manages the overall rollup process and coordinates different rollups. +# NOTE: This flag should be renamed `zkevm.address-rollup-manager`. +# https://github.com/0xPolygonHermez/cdk-erigon/issues/1253 # Default: "" zkevm.address-rollup: "{{.zkevm_rollup_manager_address}}" # Specify the address of the Rollup smart contract, specific to a rollup (or validium) chain. # Essential for submitting batches and managing the state of the rollup. +# NOTE: This flag should be renamed `zkevm.address-rollup`. +# https://github.com/0xPolygonHermez/cdk-erigon/issues/1253 # Default: "" zkevm.address-zkevm: "{{.zkevm_rollup_address}}" @@ -429,6 +427,8 @@ zkevm.l1-cache-enabled: false zkevm.l1-cache-port: 6969 # The rollup identifier. +# NOTE: This flag should be renamed `zkevm.rollup-id`. +# https://github.com/0xPolygonHermez/cdk-erigon/issues/1253 # Default: 1 (zkEVM mainnet) zkevm.l1-rollup-id: {{.zkevm_rollup_id}} @@ -536,8 +536,9 @@ txpool.disable: {{not .is_sequencer}} # txpool.locals: "" # Disables price exemptions for locally submitted transactions. +# NOTE: The flag is not used in the code! # Default: false -txpool.nolocals: false +# txpool.nolocals: false # The minimum gas price (fee cap) limit to enforce for acceptance into the pool. # Default: 1 @@ -560,24 +561,27 @@ txpool.globalslots: 10_000 txpool.globalbasefeeslots: 30_000 # The maximum number of non-executable transaction slots permitted per account. +# NOTE: The flag is not used in the code! # Default: 64 -txpool.accountqueue: 64 +# txpool.accountqueue: 64 # The maximum number of non-executable transaction slots for all accounts. # Default: 30_000 txpool.globalqueue: 30_000 # The maximum amount of time non-executable transaction are queued. +# NOTE: The flag is not used in the code! # Default: 3h -txpool.lifetime: 3h +# txpool.lifetime: 3h # A comma separared list of addresses, whoes transactions will traced in transaction pool with debug printing. # Default: "" txpool.trace.senders: "" # How often transactions should be committed to the storage. +# NOTE: The flag is not used in the code! # Default: 15s -txpool.commit.every: 15s +# txpool.commit.every: 15s # The address of the transaction pool API. # Default: use the value of --private.api.addr @@ -827,10 +831,10 @@ ws: true # -------------------------------------------------------------------------------------------------- # The listening interface of the engine API. # Default: localhost -#authrpc.addr: 0.0.0.0 +# authrpc.addr: 0.0.0.0 # The listening port of the engine API. -#authrpc.port: 8551 +# authrpc.port: 8551 # The path to the token that ensures safe connection between CL and EL. # Default: "" @@ -838,7 +842,7 @@ ws: true # A comma separated list of virtual hostnames from which to accept Engine API requests (server enforced). # Accepts '*' wildcard. -#authrpc.vhosts: "*" +# authrpc.vhosts: "*" # ==============================================================================