Skip to main content

Reference

The following tables break down each configuration section and field available for customizing your devnet. Use these references to understand the structure, defaults, and purpose of every option.

tip

For the latest defaults and advanced options, always refer to the source code in src/config/input_parser.star.

L1 Configuration

To customize the L1 devnet, include an ethereum_package property in your args file. The available options mirror those from the ethereum-package. For the complete YAML schema and default values, refer to the ethereum-package configuration documentation.

params.yml
ethereum_package:
participants:
- cl_type: lighthouse
el_type: geth
network_params:
preset: minimal
seconds_per_slot: 1

participants

FieldTypeDefaultDescription
cl_typestringlighthouseConsensus Layer (CL) client type.
cl_imagestringethpandaops/lighthouse:unstable-6135f41Image for the CL client.
el_typestringgethExecution Layer (EL) client type.
el_imagestringethereum/client-go:v1.15.11Image for the EL client.

network_params

FieldTypeDefaultDescription
presetstringminimalNetwork preset, useful for rapid testing and development.
seconds_per_slotint1Number of seconds per slot on the Beacon chain.

L2 Configuration

To customize the L2 devnet, include a polygon_pos_package property in your args file.

params.yml
polygon_pos_package:
participants:
- kind: validator
cl_type: heimdall
el_type: bor
count: 2
network_params:
el_block_interval_seconds: 2
el_gas_limit: 10_000_000
additional_services:
- prometheus_grafana

participants

Default: two validators and one rpc.

FieldTypeDefaultDescription
kindstringvalidatorRole of the node in the network: validator or rpc.
cl_typestringheimdallConsensus Layer (CL) client type.
cl_imagestring0xpolygon/heimdall:1.2.3Image for the CL client.
cl_db_imagestringrabbitmq:4.1Image for the CL database.
cl_log_levelstringinfoLog level for the CL client.
el_typestringborExecution Layer (EL) client type.
el_imagestring0xpolygon/bor:2.1.1Image for the EL client.
el_log_levelstringinfoLog level for the EL client.
countint1Number of nodes to spin up for this participant.

setup_images

FieldTypeDefaultDescription
contract_deployerstringleovct/pos-contract-deployer-node-20:ed58f8aImage used to deploy MATIC contracts to L1.
el_genesis_builderstringleovct/pos-el-genesis-builder:96a19ddImage used to create the L2 EL genesis file.
validator_config_generatorstringleovct/pos-validator-config-generator:1.2.3-0.2.4Image used to generate validator configs.

network_params

tip

You can check the admin private key and mnemonic default values at src/config/input_parser.star.

FieldTypeDefaultDescription
admin_private_keystring0xd403...60eaPrivate key used to deploy Polygon PoS contracts on both L1 and L2
preregistered_validator_keys_mnemonicstringsibling lend brave ...Mnemonic for validator keystores.
validator_stake_amount_ethint10000Amount of ether to stake for each validator.
validator_top_up_fee_amount_ethint2000Top up fee amount in ether for each validator.
cl_chain_idstringheimdall-4927CL network ID.
cl_environmentstringmainnetCL environment.
cl_span_poll_intervalstring0m15sSpan poll interval on the CL chain.
cl_checkpoint_poll_intervalstring1m0sCheckpoint poll interval on the CL chain.
el_chain_idstring"4927"EL network ID.
el_block_interval_secondsint2Seconds per block on the EL chain.
el_sprint_durationint16Duration of an EL sprint (blocks).
el_span_durationint128Duration of an EL span (blocks).
el_gas_limitint10_000_000EL gas limit.

additional_services

The additional_services array lets you enable optional tools and utilities alongside your devnet. These are not configuration options themselves, but rather extra services you can include by listing their names in the array.

ServiceDescription
blockscoutBlockchain explorer for viewing blocks, transactions, and accounts. (Coming soon)
prometheus_grafanaMonitoring stack: deploys Prometheus, Grafana, and Panoptichain.
test_runnerRuns agglayer/e2e end-to-end tests against the devnet.
tx_spammerSends spam transactions to the network to simulate load. (Coming soon)

test_runner_params

FieldTypeDefaultDescription
imagestringleovct/e2e:9fe80e1Image used to deploy the test runner - used to run agglayer/e2e tests.