cmd

Documentation

Overview

Copyright © 2020 Jack Zampolin jack.zampolin@gmail.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Execute()
• type Config
  • func LoadConfigFromFile(file string) (*Config, error)
  • func (c *Config) LoadPrivVal() *signer.PvGuard
  • func (c *Config) Logger() tmlog.Logger
  • func (c *Config) PrivValStateExists() error
  • func (c *Config) PrivValStateFile() string
• type NodeConfig

Variables

var (
	// Version defines the application version (defined at compile time)
	Version = ""
	// Commit defines the application commit hash (defined at compile time)
	Commit = ""
	// TMCommit defines the TMCommit commit hash (defined at compile time)
	TMCommit = ""
)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Config

type Config struct {
	PrivValKeyFile  string        `toml:"priv_val_key_file,omitempty"`
	PrivValStateDir string        `toml:"priv_val_state_file,omitempty"`
	ChainID         string        `toml:"chain_id"`
	Nodes           []*NodeConfig `toml:"node"`
}

Config represents the configuration file

func LoadConfigFromFile

func LoadConfigFromFile(file string) (*Config, error)

LoadConfigFromFile returns the config struct from the file

func (*Config) LoadPrivVal

func (c *Config) LoadPrivVal() *signer.PvGuard

LoadPrivVal returns the parsed priv validator json

func (*Config) Logger

func (c *Config) Logger() tmlog.Logger

Logger returns the tendermint logger

func (*Config) PrivValStateExists

func (c *Config) PrivValStateExists() error

PrivValStateExists returns an error if the priv val state doesn't exist

func (*Config) PrivValStateFile

func (c *Config) PrivValStateFile() string

PrivValStateFile returns the path to the priv_validator_state.json file for the instance

type NodeConfig

type NodeConfig struct {
	Address string `toml:"address"`
}

NodeConfig contains the configuration for an individual node