https://github.com/protolambda/eth2-config-tester
Test eth2 configurations for interopability, correctness, formatting
https://github.com/protolambda/eth2-config-tester
Last synced: about 2 months ago
JSON representation
Test eth2 configurations for interopability, correctness, formatting
- Host: GitHub
- URL: https://github.com/protolambda/eth2-config-tester
- Owner: protolambda
- License: cc0-1.0
- Created: 2020-09-13T01:25:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-14T01:01:30.000Z (over 4 years ago)
- Last Synced: 2023-03-04T21:08:23.555Z (about 2 years ago)
- Language: Go
- Size: 23.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eth2 config tester
The goals is to make configs:
- Simple to parse, key-value
- Valid YAML, but no advanced features
- Compatible, no unexpected or missing keys
- Consistent, no formatting differences
- Minimal, no super long names
- Familiar, use common (within ethereum) 0x prefix for bytes
- Structured, prefer a specific order of config keys
- Bare, no inline comments, head/foot comments are ok.
- Standard, following a spec for the config
## Usage
```shell script
# install
go get github.com/protolambda/eth2-config-tester
# feed config file into tester
cat my_eth2_config.yml | eth2-config-tester --config-spec=config_spec.yaml
# Test
cat spec_configs/minimal_phase0.yaml | go run . --forks=phase0
cat spec_configs/minimal_phase1.yaml | go run . --forks=phase0,phase1
cat spec_configs/mainnet_phase0.yaml | go run . --forks=phase0
cat spec_configs/mainnet_phase1.yaml | go run . --forks=phase0,phase1
```
## Planned
- Check config value correctness, bounds etc. See https://github.com/ethereum/eth2.0-specs/issues/407
- After checking for all bad config values, output a best-effort properly formatted config
## License
CC0 1.0 Universal, see [LICENSE](./LICENSE) file.