Skip to main content

Type Alias: ProtocolConfigs

type ProtocolConfigs = {
  configs: ProtocolConfigAttr[];
  featureFlags: ProtocolConfigFeatureFlag[];
  protocolVersion: bigint;
};

Information about the configuration of the protocol. Constants that control how the chain operates. These can only change during protocol upgrades which happen on epoch boundaries.

Properties​

configs​

configs: ProtocolConfigAttr[];

List all available configurations and their values. These configurations can take any value (but they will all be represented in string form), and do not include feature flags.

featureFlags​

featureFlags: ProtocolConfigFeatureFlag[];

List all available feature flags and their values. Feature flags are a form of boolean configuration that are usually used to gate features while they are in development. Once a flag has been enabled, it is rare for it to be disabled.

protocolVersion​

protocolVersion: bigint;

The protocol is not required to change on every epoch boundary, so the protocol version tracks which change to the protocol these configs are from.