Cannot rewrite `SLOTS_PER_EPOCH` through `config.yaml`

[varasev]

Description

It seems that something is wrong when we try to define SLOTS_PER_EPOCH explicitly in config.yaml:

If I set PRESET_BASE to mainnet in config.yaml and set SLOTS_PER_EPOCH to 16, it doesn't rewrite mainnet's value and the epoch length is still 32. But if I try to set PRESET_BASE to gnosis, the epoch length becomes 16.

Version

It is observed for v2.1.2-modern (docker image).

[michaelsproul]

This is due to some values only being configurable at compile-time. The specs from the EF define two types of configuration: presets and configs, and Lighthouse only allows the latter to be set from a config.yaml file.

If the Gnosis preset matches the chain you want to run then it would be great if you could use that, as we would like to keep the set of presets maintained upstream to a minimum. Alternatively you can create your own *EthSpec type and set the compile-time constants accordingly. You can see the EthSpec implementation for Gnosis here:

lighthouse/consensus/types/src/eth_spec.rs

Lines 329 to 365 in c3a793f

	impl EthSpec for GnosisEthSpec {
	type JustificationBitsLength = U4;
	type SubnetBitfieldLength = U64;
	type MaxValidatorsPerCommittee = U2048;
	type GenesisEpoch = U0;
	type SlotsPerEpoch = U16;
	type EpochsPerEth1VotingPeriod = U64;
	type SlotsPerHistoricalRoot = U8192;
	type EpochsPerHistoricalVector = U65536;
	type EpochsPerSlashingsVector = U8192;
	type HistoricalRootsLimit = U16777216;
	type ValidatorRegistryLimit = U1099511627776;
	type MaxProposerSlashings = U16;
	type MaxAttesterSlashings = U2;
	type MaxAttestations = U128;
	type MaxDeposits = U16;
	type MaxVoluntaryExits = U16;
	type SyncCommitteeSize = U512;
	type SyncCommitteeSubnetCount = U4;
	type MaxBytesPerTransaction = U1073741824; // 1,073,741,824
	type MaxTransactionsPerPayload = U1048576; // 1,048,576
	type BytesPerLogsBloom = U256;
	type GasLimitDenominator = U1024;
	type MinGasLimit = U5000;
	type MaxExtraDataBytes = U32;
	type SyncSubcommitteeSize = U128; // 512 committee size / 4 sync committee subnet count
	type MaxPendingAttestations = U2048; // 128 max attestations * 16 slots per epoch
	type SlotsPerEth1VotingPeriod = U1024; // 64 epochs * 16 slots per epoch
	fn default_spec() -> ChainSpec {
	ChainSpec::gnosis()
	}
	fn spec_name() -> EthSpecId {
	EthSpecId::Gnosis
	}
	}

I'll leave this issue open as this seems to be an increasingly common question (surely a good sign for LH adoption 😊 ), and there are two things Lighthouse could probably do better in this case:

1. Output a warning when the config.yaml read for a network contains extra unread fields (like SLOTS_PER_EPOCH), and/or fields that are mismatched with the selected preset.
2. Make it easier to drop in new presets at compile time by adding a preset.yaml file to some directory. We could use a procedural macro to generate EthSpec instances from these files.

[varasev]

This is due to some values only being configurable at compile-time

So, SLOTS_PER_EPOCH is not rewritable through config.yaml?

However, we could override it when using Lighthouse v2.0.1 (our LH fork, though). Example: https://github.com/gnosischain/lighthouse-launch/blob/c6c74ac05b04217868e94042e369b21f5c733d01/config/config.yaml#L76

I guess, that was rewritable, but became unrewritable in the latest releases, right?

[varasev]

And do I get it correctly that all configurable fields are listed in the file https://github.com/ethereum/consensus-specs/blob/dev/configs/mainnet.yaml?

[michaelsproul]

So, SLOTS_PER_EPOCH is not rewritable through config.yaml?

Yeah that's right

I guess, that was rewritable, but became unrewritable in the latest releases, right?

Nah, it's been like this since before Lighthouse v2.0.0 and the Altair fork (this PR: #2279).

However, we could override it when using Lighthouse v2.0.1 (our LH fork, though).

I think that config value is just being ignored by Lighthouse as it would be today. The gbc-lighthouse fork also contained commits like this one to hardcode the type-level values: https://github.com/gnosischain/gbc-lighthouse/commit/087af83ee92ee234161c4d13daa4e3e2240a9d27.

And do I get it correctly that all configurable fields are listed in the file https://github.com/ethereum/consensus-specs/blob/dev/configs/mainnet.yaml?

Yep! That's right 👍

[varasev]

@michaelsproul Got it, thank you for your answers

[jimmygchen]

Would be good to at least implement this suggestion:

Output a warning when the config.yaml read for a network contains extra unread fields (like SLOTS_PER_EPOCH), and/or fields that are mismatched with the selected preset.

As it seems like one of the most common custom testnet issues we've seen (user overriding preset config that gets silently ignored).