coordinator

Documentation

Index

• Constants
• Variables
• func Events() *coordinator.Events

Constants

const (
	// CfgCoordinatorStateFilePath is the path to the state file of the coordinator.
	CfgCoordinatorStateFilePath = "coordinator.stateFilePath"
	// CfgCoordinatorInterval is the interval at which milestones are issued.
	CfgCoordinatorInterval = "coordinator.interval"
	// CfgCoordinatorSigningProvider the signing provider the coordinator uses to sign a milestone (local/remote).
	CfgCoordinatorSigningProvider = "coordinator.signing.provider"
	// CfgCoordinatorSigningRetryAmount defines the number of signing retries to perform before shutting down the node.
	CfgCoordinatorSigningRetryAmount = "coordinator.signing.retryAmount"
	// CfgCoordinatorSigningRetryTimeout defines the timeout between signing retries.
	CfgCoordinatorSigningRetryTimeout = "coordinator.signing.retryTimeout"
	// CfgCoordinatorSigningRemoteAddress the address of the remote signing provider (insecure connection!).
	CfgCoordinatorSigningRemoteAddress = "coordinator.signing.remoteAddress"
	// CfgCoordinatorPoWWorkerCount the amount of workers used for calculating PoW when issuing checkpoints and milestones.
	CfgCoordinatorPoWWorkerCount = "coordinator.powWorkerCount"
	// CfgCoordinatorQuorumEnabled defines whether the coordinator quorum is enabled.
	CfgCoordinatorQuorumEnabled = "coordinator.quorum.enabled"
	// CfgCoordinatorQuorumGroups defines the quorum groups used to ask other nodes for correct ledger state of the coordinator.
	CfgCoordinatorQuorumGroups = "coordinator.quorum.groups"
	// CfgCoordinatorQuorumTimeout defines the timeout until a node in the quorum must have answered.
	CfgCoordinatorQuorumTimeout = "coordinator.quorum.timeout"
	// CfgCoordinatorCheckpointsMaxTrackedMessages defines the maximum amount of known messages for milestone tipselection
	// if this limit is exceeded, a new checkpoint is issued.
	CfgCoordinatorCheckpointsMaxTrackedMessages = "coordinator.checkpoints.maxTrackedMessages"
	// CfgCoordinatorTipselectMinHeaviestBranchUnreferencedMessagesThreshold defines the minimum threshold of unreferenced messages in the heaviest branch for milestone tipselection
	// if the value falls below that threshold, no more heaviest branch tips are picked.
	CfgCoordinatorTipselectMinHeaviestBranchUnreferencedMessagesThreshold = "coordinator.tipsel.minHeaviestBranchUnreferencedMessagesThreshold"
	// CfgCoordinatorTipselectMaxHeaviestBranchTipsPerCheckpoint defines the maximum amount of checkpoint messages with heaviest branch tips that are picked
	// if the heaviest branch is not below "UnreferencedMessagesThreshold" before.
	CfgCoordinatorTipselectMaxHeaviestBranchTipsPerCheckpoint = "coordinator.tipsel.maxHeaviestBranchTipsPerCheckpoint"
	// CfgCoordinatorTipselectRandomTipsPerCheckpoint defines the amount of checkpoint messages with random tips that are picked if a checkpoint is issued and at least
	// one heaviest branch tip was found, otherwise no random tips will be picked.
	CfgCoordinatorTipselectRandomTipsPerCheckpoint = "coordinator.tipsel.randomTipsPerCheckpoint"
	// CfgCoordinatorTipselectHeaviestBranchSelectionTimeout defines the maximum duration to select the heaviest branch tips.
	CfgCoordinatorTipselectHeaviestBranchSelectionTimeout = "coordinator.tipsel.heaviestBranchSelectionTimeout"
)

const (
	// whether to bootstrap the network
	CfgCoordinatorBootstrap = "cooBootstrap"
	// the index of the first milestone at bootstrap
	CfgCoordinatorStartIndex = "cooStartIndex"
	// the maximum limit of additional tips that fit into a milestone (besides the last milestone and checkpoint hash)
	MilestoneMaxAdditionalTipsLimit = 6
)

Variables

var (
	ErrDatabaseTainted = errors.New("database is tainted. delete the coordinator database and start again with a snapshot")
)

var (
	Plugin *node.Plugin
)

Functions

func Events

func Events() *coordinator.Events

Events returns the events of the coordinator