Documentation
¶
Index ¶
- func DefaultLogLevel() string
- func DefaultPackageLogLevels() string
- func EnsureRoot(rootDir string)
- type BaseConfig
- type Config
- type ConsensusConfig
- func (cfg *ConsensusConfig) Commit(t time.Time) time.Time
- func (cfg *ConsensusConfig) Precommit(round int) time.Duration
- func (cfg *ConsensusConfig) Prevote(round int) time.Duration
- func (cfg *ConsensusConfig) Propose(round int) time.Duration
- func (c *ConsensusConfig) SetWalFile(walFile string)
- func (c *ConsensusConfig) WalFile() string
- type MempoolConfig
- type P2PConfig
- type RPCConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultLogLevel ¶
func DefaultLogLevel() string
func DefaultPackageLogLevels ¶
func DefaultPackageLogLevels() string
func EnsureRoot ¶
func EnsureRoot(rootDir string)
Types ¶
type BaseConfig ¶
type BaseConfig struct {
// The root directory for all data.
// This should be set in viper so it can unmarshal into this struct
RootDir string `mapstructure:"home"`
// The ID of the chain to join (should be signed with every transaction and vote)
ChainID string `mapstructure:"chain_id"`
// A JSON file containing the initial validator set and other meta data
Genesis string `mapstructure:"genesis_file"`
// A JSON file containing the private key to use as a validator in the consensus protocol
PrivValidator string `mapstructure:"priv_validator_file"`
// A custom human readable name for this node
Moniker string `mapstructure:"moniker"`
// TCP or UNIX socket address of the ABCI application,
// or the name of an ABCI application compiled in with the Tendermint binary
ProxyApp string `mapstructure:"proxy_app"`
// Mechanism to connect to the ABCI application: socket | grpc
ABCI string `mapstructure:"abci"`
// Output level for logging
LogLevel string `mapstructure:"log_level"`
// TCP or UNIX socket address for the profiling server to listen on
ProfListenAddress string `mapstructure:"prof_laddr"`
// If this node is many blocks behind the tip of the chain, FastSync
// allows them to catchup quickly by downloading blocks in parallel
// and verifying their commits
FastSync bool `mapstructure:"fast_sync"`
// If true, query the ABCI app on connecting to a new peer
// so the app can decide if we should keep the connection or not
FilterPeers bool `mapstructure:"filter_peers"` // false
// What indexer to use for transactions
TxIndex string `mapstructure:"tx_index"`
// Database backend: leveldb | memdb
DBBackend string `mapstructure:"db_backend"`
// Database directory
DBPath string `mapstructure:"db_dir"`
}
BaseConfig struct for a Tendermint node
func DefaultBaseConfig ¶
func DefaultBaseConfig() BaseConfig
func TestBaseConfig ¶
func TestBaseConfig() BaseConfig
func (BaseConfig) DBDir ¶
func (b BaseConfig) DBDir() string
func (BaseConfig) GenesisFile ¶
func (b BaseConfig) GenesisFile() string
func (BaseConfig) PrivValidatorFile ¶ added in v0.10.0
func (b BaseConfig) PrivValidatorFile() string
type Config ¶
type Config struct {
// Top level options use an anonymous struct
BaseConfig `mapstructure:",squash"`
// Options for services
RPC *RPCConfig `mapstructure:"rpc"`
P2P *P2PConfig `mapstructure:"p2p"`
Mempool *MempoolConfig `mapstructure:"mempool"`
Consensus *ConsensusConfig `mapstructure:"consensus"`
}
func DefaultConfig ¶
func DefaultConfig() *Config
func ResetTestRoot ¶
func TestConfig ¶
func TestConfig() *Config
type ConsensusConfig ¶
type ConsensusConfig struct {
RootDir string `mapstructure:"home"`
WalPath string `mapstructure:"wal_file"`
WalLight bool `mapstructure:"wal_light"`
// All timeouts are in ms
TimeoutPropose int `mapstructure:"timeout_propose"`
TimeoutProposeDelta int `mapstructure:"timeout_propose_delta"`
TimeoutPrevote int `mapstructure:"timeout_prevote"`
TimeoutPrevoteDelta int `mapstructure:"timeout_prevote_delta"`
TimeoutPrecommit int `mapstructure:"timeout_precommit"`
TimeoutPrecommitDelta int `mapstructure:"timeout_precommit_delta"`
TimeoutCommit int `mapstructure:"timeout_commit"`
// Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
SkipTimeoutCommit bool `mapstructure:"skip_timeout_commit"`
// BlockSize
MaxBlockSizeTxs int `mapstructure:"max_block_size_txs"`
MaxBlockSizeBytes int `mapstructure:"max_block_size_bytes"`
// TODO: This probably shouldn't be exposed but it makes it
// easy to write tests for the wal/replay
BlockPartSize int `mapstructure:"block_part_size"`
// contains filtered or unexported fields
}
ConsensusConfig holds timeouts and details about the WAL, the block structure, and timeouts in the consensus protocol.
func DefaultConsensusConfig ¶
func DefaultConsensusConfig() *ConsensusConfig
func TestConsensusConfig ¶
func TestConsensusConfig() *ConsensusConfig
func (*ConsensusConfig) Commit ¶
func (cfg *ConsensusConfig) Commit(t time.Time) time.Time
After receiving +2/3 precommits for a single block (a commit), wait this long for stragglers in the next height's RoundStepNewHeight
func (*ConsensusConfig) Precommit ¶
func (cfg *ConsensusConfig) Precommit(round int) time.Duration
After receiving any +2/3 precommits, wait this long for stragglers
func (*ConsensusConfig) Prevote ¶
func (cfg *ConsensusConfig) Prevote(round int) time.Duration
After receiving any +2/3 prevote, wait this long for stragglers
func (*ConsensusConfig) Propose ¶
func (cfg *ConsensusConfig) Propose(round int) time.Duration
Wait this long for a proposal
func (*ConsensusConfig) SetWalFile ¶
func (c *ConsensusConfig) SetWalFile(walFile string)
func (*ConsensusConfig) WalFile ¶
func (c *ConsensusConfig) WalFile() string
type MempoolConfig ¶
type MempoolConfig struct {
RootDir string `mapstructure:"home"`
Recheck bool `mapstructure:"recheck"`
RecheckEmpty bool `mapstructure:"recheck_empty"`
Broadcast bool `mapstructure:"broadcast"`
WalPath string `mapstructure:"wal_dir"`
}
func DefaultMempoolConfig ¶
func DefaultMempoolConfig() *MempoolConfig
func (*MempoolConfig) WalDir ¶
func (m *MempoolConfig) WalDir() string
type P2PConfig ¶
type P2PConfig struct {
RootDir string `mapstructure:"home"`
ListenAddress string `mapstructure:"laddr"`
Seeds string `mapstructure:"seeds"`
SkipUPNP bool `mapstructure:"skip_upnp"`
AddrBook string `mapstructure:"addr_book_file"`
AddrBookStrict bool `mapstructure:"addr_book_strict"`
PexReactor bool `mapstructure:"pex"`
MaxNumPeers int `mapstructure:"max_num_peers"`
}
func DefaultP2PConfig ¶
func DefaultP2PConfig() *P2PConfig
func TestP2PConfig ¶
func TestP2PConfig() *P2PConfig
func (*P2PConfig) AddrBookFile ¶
type RPCConfig ¶
type RPCConfig struct {
RootDir string `mapstructure:"home"`
// TCP or UNIX socket address for the RPC server to listen on
ListenAddress string `mapstructure:"laddr"`
// TCP or UNIX socket address for the gRPC server to listen on
// NOTE: This server only supports /broadcast_tx_commit
GRPCListenAddress string `mapstructure:"grpc_laddr"`
// Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
Unsafe bool `mapstructure:"unsafe"`
}
func DefaultRPCConfig ¶
func DefaultRPCConfig() *RPCConfig
func TestRPCConfig ¶
func TestRPCConfig() *RPCConfig
Click to show internal directories.
Click to hide internal directories.