Interface: ReadChainsOptions<S>
Defined in: packages/overcast-core/src/chain-env.ts:154
Options for readChains.
Extends
Type Parameters
| Type Parameter |
|---|
S extends ChainSchemas |
Properties
because?
optional because?: string | ((spec) => string);
Defined in: packages/overcast-core/src/chain-env.ts:169
Context appended when a required field is unset — see ReadConfigOptions.because. Defaults to naming the chain and that it was enabled in CHAINS_ENV.
required?
optional required?: { readonly [P in string | number | symbol]?: readonly (keyof S[P]["shape"] & string)[] };
Defined in: packages/overcast-core/src/chain-env.ts:161
The fields a chain of each protocol cannot proceed without — see ReadConfigOptions.required. Per protocol, because which fields have a safe default is: an EVM chain id does, a Solana one does not exist.
reserved?
optional reserved?: readonly string[];
Defined in: packages/overcast-core/src/chain-env.ts:59
Names a host gives its own meaning, which a chain therefore may not take — e.g. a client's "every chain" selection.