command

Documentation

Index

• Constants
• Variables
• func GetValidatorsFromPrefixPath(root string, prefix string, validatorType validators.ValidatorType) (validators.Validators, error)
• func ValidateMinMaxValidatorsNumber(minValidatorCount uint64, maxValidatorCount uint64) error
• type CommandResult
• type OutputFormatter
  • func InitializeOutputter(cmd *cobra.Command) OutputFormatter
• type Results
  • func (r Results) GetOutput() string

Constants

const (
	ConsensusFlag  = "consensus"
	NoDiscoverFlag = "no-discover"
	BootnodeFlag   = "bootnode"
	LogLevelFlag   = "log-level"

	ValidatorFlag         = "validators"
	ValidatorRootFlag     = "validators-path"
	ValidatorPrefixFlag   = "validators-prefix"
	MinValidatorCountFlag = "min-validator-count"
	MaxValidatorCountFlag = "max-validator-count"

	IBFTValidatorTypeFlag = "ibft-validator-type"
)

Flags shared across multiple spaces

const (
	DefaultValidatorRoot   = "./"
	DefaultValidatorPrefix = "test-chain-"
)

const (
	DefaultGenesisFileName           = "genesis.json"
	DefaultChainName                 = "polygon-edge"
	DefaultChainID                   = 100
	DefaultConsensus                 = server.PolyBFTConsensus
	DefaultGenesisGasUsed            = 458752  // 0x70000
	DefaultGenesisGasLimit           = 5242880 // 0x500000
	DefaultGenesisBaseFeeEM          = chain.GenesisBaseFeeEM
	DefaultGenesisBaseFeeChangeDenom = chain.BaseFeeChangeDenom
)

const (
	JSONOutputFlag  = "json"
	GRPCAddressFlag = "grpc-address"
	JSONRPCFlag     = "jsonrpc"
)

const (
	GRPCAddressFlagLEGACY = "grpc"
)

GRPCAddressFlagLEGACY Legacy flag that needs to be present to preserve backwards compatibility with running clients

Variables

var (
	ErrValidatorNumberExceedsMax = errors.New("validator number exceeds max validator number")
	ErrECDSAKeyNotFound          = errors.New("ECDSA key not found in given path")
	ErrBLSKeyNotFound            = errors.New("BLS key not found in given path")
)

var (
	DefaultStake                = ethgo.Ether(1e6)
	DefaultPremineBalance       = ethgo.Ether(1e6)
	DefaultGenesisBaseFee       = chain.GenesisBaseFee
	DefaultGenesisBaseFeeConfig = fmt.Sprintf(
		"%d:%d:%d",
		DefaultGenesisBaseFee,
		DefaultGenesisBaseFeeEM,
		DefaultGenesisBaseFeeChangeDenom,
	)
)

Functions

func GetValidatorsFromPrefixPath

func GetValidatorsFromPrefixPath(
	root string,
	prefix string,
	validatorType validators.ValidatorType,
) (validators.Validators, error)

GetValidatorsFromPrefixPath extracts the addresses of the validators based on the directory prefix. It scans the directories for validator private keys and compiles a list of addresses

func ValidateMinMaxValidatorsNumber

func ValidateMinMaxValidatorsNumber(minValidatorCount uint64, maxValidatorCount uint64) error

Types

type CommandResult

type CommandResult interface {
	GetOutput() string
}

type OutputFormatter

type OutputFormatter interface {
	// SetError sets the encountered error
	SetError(err error)

	// SetCommandResult sets the result of the command execution
	SetCommandResult(result CommandResult)

	// WriteOutput writes the previously set result / error output
	WriteOutput()

	// WriteCommandResult immediately writes the given command result without waiting for WriteOutput func call.
	WriteCommandResult(result CommandResult)

	// Write extends io.Writer interface
	Write(p []byte) (n int, err error)
}

OutputFormatter is the standardized interface all output formatters should use

func InitializeOutputter

func InitializeOutputter(cmd *cobra.Command) OutputFormatter

type Results

type Results []CommandResult

Results implements CommandResult interface by aggregating multiple commands outputs into one

func (Results) GetOutput

func (r Results) GetOutput() string