forkmanager

Documentation

Index

• Constants
• func GetInstance() *forkManager
• type Fork
• type ForkParams
• type HandlerDesc

Constants

const InitialFork = "initialfork"

Functions

func GetInstance

func GetInstance() *forkManager

GeInstance returns fork manager singleton instance. Thread safe

Types

type Fork

type Fork struct {
	// name of the fork
	Name string
	// after the fork is activated, `FromBlockNumber` shows from which block is enabled
	FromBlockNumber uint64
	// fork consensus parameters
	Params *ForkParams
	// this value is false if fork is registered but not activated
	IsActive bool
	// map of all handlers registered for this fork
	Handlers map[HandlerDesc]interface{}
}

Fork structure defines one fork

type ForkParams

type ForkParams struct {
	// MaxValidatorSetSize indicates the maximum size of validator set
	MaxValidatorSetSize *uint64 `json:"maxValidatorSetSize,omitempty"`

	// EpochSize is size of epoch
	EpochSize *uint64 `json:"epochSize,omitempty"`

	// SprintSize is size of sprint
	SprintSize *uint64 `json:"sprintSize,omitempty"`

	// BlockTime is target frequency of blocks production
	BlockTime *common.Duration `json:"blockTime,omitempty"`

	// BlockTimeDrift defines the time slot in which a new block can be created
	BlockTimeDrift *uint64 `json:"blockTimeDrift,omitempty"`
}

ForkParams hard-coded fork params

type HandlerDesc

type HandlerDesc string

HandlerDesc gives description for the handler eq: "extra", "proposer_calculator", etc