Skip to main content

Interface: ReadConfigOptions<S>

Defined in: packages/overcast-core/src/config-schema.ts:337

Options for readConfig.

Type Parameters​

Type Parameter
S extends ConfigSchema

Properties​

because?​

optional because?: string;

Defined in: packages/overcast-core/src/config-schema.ts:358

Context appended when one of required turns out to be unset, for a host that can say why a field it demands is load-bearing — "chain "base" is enabled in OVERCAST_CHAINS but has no wallet to sign and pay with" beats "PRIVATE_KEY is required".

Only on a missing field, not on a malformed one: an operator who typo'd a commitment is not being told that a wallet is needed to sign, which is the kind of unrelated advice that makes an error message read as noise.

required?​

optional required?: readonly keyof S["shape"] & string[];

Defined in: packages/overcast-core/src/config-schema.ts:347

The fields this host cannot proceed without.

A host policy rather than a property of the schema, because the same field is required in one host and optional in another: the backend relays other people's transactions so a chain with no privateKey is useless to it, while the CLI runs read-only commands with no wallet at all. Encoding it on the field would force one of them to lie.