eth2.0-specs/tests/core/pyspec/eth2spec/config/README.md

24 lines
1020 B
Markdown
Raw Normal View History

# Consensus specs config util
For run-time configuration, see [Configs documentation](../../../../../configs/README.md).
For compile-time presets, see [Presets documentation](../../../../../presets/README.md)
and the `build-targets` flag for the `pyspec` distutils command.
## Config usage:
```python
from eth2spec.config import config_util
2021-05-18 19:31:27 +00:00
from eth2spec.phase0 import mainnet as spec
from pathlib import Path
2021-05-18 10:48:42 +00:00
# To load the default configurations
config_util.load_defaults(Path("consensus-specs/configs")) # change path to point to equivalent of specs `configs` dir.
2021-05-18 10:48:42 +00:00
# After loading the defaults, a config can be chosen: 'mainnet', 'minimal', or custom network config (by file path)
2021-05-18 19:31:27 +00:00
spec.config = spec.Configuration(**config_util.load_config_file(Path('mytestnet.yaml')))
```
Note: previously the testnet config files included both preset and runtime-configuration data.
2021-05-18 10:48:42 +00:00
The new config loader is compatible with this: all config vars are loaded from the file,
but those that have become presets can be ignored.