eth2.0-specs/tests/core/pyspec/eth2spec/config
protolambda 9030270369
update config util to make preset loading optional, update docs
2021-05-18 09:58:54 +02:00
..
README.md update config util to make preset loading optional, update docs 2021-05-18 09:58:54 +02:00
__init__.py merge in dev (v0.10) and fix reorg/lint issues 2020-01-13 18:55:21 +01:00
config_util.py update config util to make preset loading optional, update docs 2021-05-18 09:58:54 +02:00

README.md

Eth2 config util

For configuration, see Configs documentation.

Usage:

from eth2spec.config import config_util
from eth2spec.phase0 import spec
from importlib import reload
from pathlib import Path

# To load the presets and configurations
config_util.load_defaults(Path("eth2.0-specs/configs"))  # change path to point to equivalent of specs `configs` dir.
# After loading the defaults, a config can be chosen: 'mainnet', 'minimal', or custom network config
config_util.prepare_config('minimal')
# Alternatively, load a custom testnet config:
config_util.prepare_config('my_config.yaml')
# reload spec to make loaded config effective
reload(spec)

Note: previously the testnet config files included both preset and runtime-configuration data. The new config loader is compatible with this: just run prepare_config without loading preset defaults, and omit the PRESET_BASE from the config.

WARNING: this overwrites globals, make sure to prevent accidental collisions with other usage of the same imported specs package.