checkconsensusslotrange

README

check_consensus_slot_range Task

Description

The check_consensus_slot_range task verifies that the current wall clock time on the consensus chain falls within a specified range of slots and epochs. This is important for ensuring that the chain operates within expected time boundaries.

Configuration Parameters

• minSlotNumber:
  The minimum slot number that the consensus wall clock should be at or above. This sets the lower bound for the check.

• maxSlotNumber:
  The maximum slot number that the consensus wall clock should not exceed. This sets the upper bound for the slot range.

• minEpochNumber:
  The minimum epoch number that the consensus wall clock should be in or above. Similar to the minSlotNumber, this sets a lower limit, but in terms of epochs.

• maxEpochNumber:
  The maximum epoch number that the consensus wall clock should not go beyond. This parameter sets the upper limit for the epoch range.

• failIfLower:
  A flag that determines the task's behavior if the current wall clock time is below the specified minimum slot or epoch number. If true, the task will fail in such cases; if false, it will continue without failing.

Defaults

These are the default settings for the check_consensus_slot_range task:

- name: check_consensus_slot_range
  config:
    minSlotNumber: 0
    maxSlotNumber: 18446744073709551615
    minEpochNumber: 0
    maxEpochNumber: 18446744073709551615
    failIfLower: false

Documentation

Index

• Variables
• func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
• type Config
  • func DefaultConfig() Config
  • func (c *Config) Validate() error
• type Task
  • func (t *Task) Config() interface{}
  • func (t *Task) Description() string
  • func (t *Task) Execute(ctx context.Context) error
  • func (t *Task) LoadConfig() error
  • func (t *Task) Logger() logrus.FieldLogger
  • func (t *Task) Name() string
  • func (t *Task) Timeout() time.Duration
  • func (t *Task) Title() string

Variables

var (
	TaskName       = "check_consensus_slot_range"
	TaskDescriptor = &types.TaskDescriptor{
		Name:        TaskName,
		Description: "Check if consensus wallclock is in a specific range.",
		Config:      DefaultConfig(),
		NewTask:     NewTask,
	}
)

Functions

func NewTask

func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)

Types

type Config

type Config struct {
	MinSlotNumber  uint64 `yaml:"minSlotNumber" json:"minSlotNumber"`
	MaxSlotNumber  uint64 `yaml:"maxSlotNumber" json:"maxSlotNumber"`
	MinEpochNumber uint64 `yaml:"minEpochNumber" json:"minEpochNumber"`
	MaxEpochNumber uint64 `yaml:"maxEpochNumber" json:"maxEpochNumber"`
	FailIfLower    bool   `yaml:"failIfLower" json:"failIfLower"`
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) Validate

func (c *Config) Validate() error

type Task

type Task struct {
	// contains filtered or unexported fields
}

func (*Task) Config

func (t *Task) Config() interface{}

func (*Task) Description

func (t *Task) Description() string

func (*Task) Execute

func (t *Task) Execute(ctx context.Context) error

func (*Task) LoadConfig

func (t *Task) LoadConfig() error

func (*Task) Logger

func (t *Task) Logger() logrus.FieldLogger

func (*Task) Name

func (t *Task) Name() string

func (*Task) Timeout

func (t *Task) Timeout() time.Duration

func (*Task) Title

func (t *Task) Title() string