Skip to main content

ProtocolConfigs

Namespace: IotaSdk

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.

public record class ProtocolConfigs : System.IEquatable`1[[IotaSdk.ProtocolConfigs, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance ObjectProtocolConfigs
Implements IEquatable<ProtocolConfigs>
Attributes NullableContextAttribute, NullableAttribute

Properties

ProtocolVersion

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.

public ulong ProtocolVersion { get; init; }

Property Value

UInt64

FeatureFlags

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.

public ProtocolConfigFeatureFlag[] FeatureFlags { get; init; }

Property Value

ProtocolConfigFeatureFlag[]

Configs

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.

public ProtocolConfigAttr[] Configs { get; init; }

Property Value

ProtocolConfigAttr[]

Constructors

ProtocolConfigs(UInt64, ProtocolConfigFeatureFlag[], ProtocolConfigAttr[])

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.

public ProtocolConfigs(ulong ProtocolVersion, ProtocolConfigFeatureFlag[] FeatureFlags, ProtocolConfigAttr[] Configs)

Parameters

ProtocolVersion UInt64
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.

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.

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.