genesis

Documentation

Overview

Package genesis provides consensus config flags that should be part of the genesis state.

Index

• Constants
• type Genesis
  • func (g *Genesis) SanityCheck() error
• type Parameters
  • func (p *Parameters) IsFeatureVersion(minVersion version.Version) bool

Constants

const (
	// GasOpTxByte is the gas operation identifier for costing each transaction byte.
	GasOpTxByte transaction.Op = "tx_byte"
)

Types

type Genesis

type Genesis struct {
	Backend    string     `json:"backend"`
	Parameters Parameters `json:"params"`
}

Genesis contains various consensus config flags that should be part of the genesis state.

func (*Genesis) SanityCheck

func (g *Genesis) SanityCheck() error

SanityCheck does basic sanity checking on the genesis state.

type Parameters

type Parameters struct {
	TimeoutCommit      time.Duration `json:"timeout_commit"`
	SkipTimeoutCommit  bool          `json:"skip_timeout_commit"`
	EmptyBlockInterval time.Duration `json:"empty_block_interval"`

	MaxTxSize       uint64          `json:"max_tx_size"`
	MaxBlockSize    uint64          `json:"max_block_size"`
	MaxBlockGas     transaction.Gas `json:"max_block_gas"`
	MaxEvidenceSize uint64          `json:"max_evidence_size"`

	// MinGasPrice is the minimum gas price.
	MinGasPrice uint64 `json:"min_gas_price,omitempty"`

	// StateCheckpointInterval is the expected state checkpoint interval (in blocks).
	StateCheckpointInterval uint64 `json:"state_checkpoint_interval"`
	// StateCheckpointNumKept is the expected minimum number of state checkpoints to keep.
	StateCheckpointNumKept uint64 `json:"state_checkpoint_num_kept,omitempty"`
	// StateCheckpointChunkSize is the chunk size parameter for checkpoint creation.
	StateCheckpointChunkSize uint64 `json:"state_checkpoint_chunk_size,omitempty"`

	// GasCosts are the base transaction gas costs.
	GasCosts transaction.Costs `json:"gas_costs,omitempty"`

	// PublicKeyBlacklist is the network-wide public key blacklist.
	PublicKeyBlacklist []signature.PublicKey `json:"public_key_blacklist,omitempty"`

	// FeatureVersion represents the latest consensus-breaking software version
	// that follows calendar versioning (yy.minor[.micro]).
	FeatureVersion *version.Version `json:"feature_version,omitempty"`
}

Parameters are the consensus parameters.

func (*Parameters) IsFeatureVersion

func (p *Parameters) IsFeatureVersion(minVersion version.Version) bool

IsFeatureVersion returns true iff the consensus feature version is high enough for the feature to be enabled.