node

Documentation

Overview

Package node is the main entry point, where the Node struct, which represents a full node, is defined.

Adding new p2p.Reactor(s)

To add a new p2p.Reactor, use the CustomReactors option:

node, err := NewNode(
		config,
		privVal,
		nodeKey,
		clientCreator,
		genesisDocProvider,
		dbProvider,
		metricsProvider,
		logger,
		CustomReactors(map[string]p2p.Reactor{"CUSTOM": customReactor}),
)

Replacing existing p2p.Reactor(s)

To replace the built-in p2p.Reactor, use the CustomReactors option:

node, err := NewNode(
		config,
		privVal,
		nodeKey,
		clientCreator,
		genesisDocProvider,
		dbProvider,
		metricsProvider,
		logger,
		CustomReactors(map[string]p2p.Reactor{"BLOCKSYNC": customBlocksyncReactor}),
)

The list of existing reactors can be found in CustomReactors documentation.

Index

• func BootstrapState(ctx context.Context, config *cfg.Config, dbProvider cfg.DBProvider, ...) (err error)
• func LoadStateFromDBOrGenesisDocProvider(stateDB dbm.DB, genesisDocProvider GenesisDocProvider, ...) (sm.State, *types.GenesisDoc, error)
• func LoadStateFromDBOrGenesisDocProviderWithConfig(stateDB dbm.DB, genesisDocProvider GenesisDocProvider, ...) (sm.State, *types.GenesisDoc, error)
• type ChecksummedGenesisDoc
• type GenesisDocProvider
  • func DefaultGenesisDocProviderFunc(config *cfg.Config) GenesisDocProvider
• type MetricsProvider
  • func DefaultMetricsProvider(config *cfg.InstrumentationConfig) MetricsProvider
• type Node
  • func DefaultNewNode(config *cfg.Config, logger log.Logger) (*Node, error)
  • func NewNode(ctx context.Context, config *cfg.Config, privValidator types.PrivValidator, ...) (*Node, error)
  • func (n *Node) BlockStore() *store.BlockStore
  • func (n *Node) Config() *cfg.Config
  • func (n *Node) ConfigureRPC() (*rpccore.Environment, error)
  • func (n *Node) ConsensusReactor() *cs.Reactor
  • func (n *Node) EventBus() *types.EventBus
  • func (n *Node) EvidencePool() *evidence.Pool
  • func (n *Node) GenesisDoc() *types.GenesisDoc
  • func (n *Node) IsListening() bool
  • func (n *Node) Listeners() []string
  • func (n *Node) Mempool() mempl.Mempool
  • func (n *Node) MempoolReactor() p2p.Reactor
  • func (n *Node) NodeInfo() p2p.NodeInfo
  • func (n *Node) OnStart() error
  • func (n *Node) OnStop()
  • func (n *Node) PEXReactor() *pex.Reactor
  • func (n *Node) PrivValidator() types.PrivValidator
  • func (n *Node) ProxyApp() proxy.AppConns
  • func (n *Node) Switch() *p2p.Switch
• type Option
  • func CustomReactors(reactors map[string]p2p.Reactor) Option
  • func StateProvider(stateProvider statesync.StateProvider) Option
• type Provider

Functions

func BootstrapState

func BootstrapState(ctx context.Context, config *cfg.Config, dbProvider cfg.DBProvider, height uint64, appHash []byte) (err error)

BootstrapState synchronizes the stores with the application after state sync has been performed offline. It is expected that the block store and state store are empty at the time the function is called.

If the block store is not empty, the function returns an error.

func LoadStateFromDBOrGenesisDocProvider

func LoadStateFromDBOrGenesisDocProvider(
	stateDB dbm.DB,
	genesisDocProvider GenesisDocProvider,
	operatorGenesisHashHex string,
) (sm.State, *types.GenesisDoc, error)

Note that if you don't have a version of the key layout set in your DB already, and no config is passed, it will default to v1.

func LoadStateFromDBOrGenesisDocProviderWithConfig

func LoadStateFromDBOrGenesisDocProviderWithConfig(
	stateDB dbm.DB,
	genesisDocProvider GenesisDocProvider,
	operatorGenesisHashHex string,
	config *cfg.Config,
) (sm.State, *types.GenesisDoc, error)

Types

type ChecksummedGenesisDoc

type ChecksummedGenesisDoc struct {
	GenesisDoc     *types.GenesisDoc
	Sha256Checksum []byte
}

ChecksummedGenesisDoc combines a GenesisDoc together with its SHA256 checksum.

type GenesisDocProvider

type GenesisDocProvider func() (ChecksummedGenesisDoc, error)

GenesisDocProvider returns a GenesisDoc together with its SHA256 checksum. It allows the GenesisDoc to be pulled from sources other than the filesystem, for instance from a distributed key-value store cluster.

func DefaultGenesisDocProviderFunc

func DefaultGenesisDocProviderFunc(config *cfg.Config) GenesisDocProvider

DefaultGenesisDocProviderFunc returns a GenesisDocProvider that loads the GenesisDoc from the config.GenesisFile() on the filesystem.

type MetricsProvider

type MetricsProvider func(chainID string) (*cs.Metrics, *p2p.Metrics, *mempl.Metrics, *sm.Metrics, *store.Metrics, *proxy.Metrics, *blocksync.Metrics, *statesync.Metrics)

MetricsProvider returns a consensus, p2p and mempool Metrics.

func DefaultMetricsProvider

func DefaultMetricsProvider(config *cfg.InstrumentationConfig) MetricsProvider

DefaultMetricsProvider returns Metrics build using Prometheus client library if Prometheus is enabled. Otherwise, it returns no-op Metrics.

type Node

type Node struct {
	service.BaseService
	// contains filtered or unexported fields
}

Node is the highest level interface to a full CometBFT node. It includes all configuration information and running services.

func DefaultNewNode

func DefaultNewNode(config *cfg.Config, logger log.Logger) (*Node, error)

DefaultNewNode returns a CometBFT node with default settings for the PrivValidator, ClientCreator, GenesisDoc, and DBProvider. It implements NodeProvider.

func NewNode

func NewNode(ctx context.Context,
	config *cfg.Config,
	privValidator types.PrivValidator,
	nodeKey *p2p.NodeKey,
	clientCreator proxy.ClientCreator,
	genesisDocProvider GenesisDocProvider,
	dbProvider cfg.DBProvider,
	metricsProvider MetricsProvider,
	logger log.Logger,
	options ...Option,
) (*Node, error)

NewNode returns a new, ready to go, CometBFT Node.

func (*Node) BlockStore

func (n *Node) BlockStore() *store.BlockStore

BlockStore returns the Node's BlockStore.

func (*Node) Config

func (n *Node) Config() *cfg.Config

Config returns the Node's config.

func (*Node) ConfigureRPC

func (n *Node) ConfigureRPC() (*rpccore.Environment, error)

ConfigureRPC makes sure RPC has all the objects it needs to operate.

func (*Node) ConsensusReactor

func (n *Node) ConsensusReactor() *cs.Reactor

ConsensusReactor returns the Node's ConsensusReactor.

func (*Node) EventBus

func (n *Node) EventBus() *types.EventBus

EventBus returns the Node's EventBus.

func (*Node) EvidencePool

func (n *Node) EvidencePool() *evidence.Pool

EvidencePool returns the Node's EvidencePool.

func (*Node) GenesisDoc

func (n *Node) GenesisDoc() *types.GenesisDoc

GenesisDoc returns the Node's GenesisDoc.

func (*Node) IsListening

func (n *Node) IsListening() bool

func (*Node) Listeners

func (n *Node) Listeners() []string

func (*Node) Mempool

func (n *Node) Mempool() mempl.Mempool

Mempool returns the Node's mempool.

func (*Node) MempoolReactor

func (n *Node) MempoolReactor() p2p.Reactor

MempoolReactor returns the Node's mempool reactor.

func (*Node) NodeInfo

func (n *Node) NodeInfo() p2p.NodeInfo

NodeInfo returns the Node's Info from the Switch.

func (*Node) OnStart

func (n *Node) OnStart() error

OnStart starts the Node. It implements service.Service.

func (*Node) OnStop

func (n *Node) OnStop()

OnStop stops the Node. It implements service.Service.

func (*Node) PEXReactor

func (n *Node) PEXReactor() *pex.Reactor

PEXReactor returns the Node's PEXReactor. It returns nil if PEX is disabled.

func (*Node) PrivValidator

func (n *Node) PrivValidator() types.PrivValidator

PrivValidator returns the Node's PrivValidator. XXX: for convenience only!

func (*Node) ProxyApp

func (n *Node) ProxyApp() proxy.AppConns

ProxyApp returns the Node's AppConns, representing its connections to the ABCI application.

func (*Node) Switch

func (n *Node) Switch() *p2p.Switch

Switch returns the Node's Switch.

type Option

type Option func(*Node)

Option sets a parameter for the node.

func CustomReactors

func CustomReactors(reactors map[string]p2p.Reactor) Option

CustomReactors allows you to add custom reactors (name -> p2p.Reactor) to the node's Switch.

WARNING: using any name from the below list of the existing reactors will result in replacing it with the custom one.

• MEMPOOL
• BLOCKSYNC
• CONSENSUS
• EVIDENCE
• PEX
• STATESYNC

func StateProvider

func StateProvider(stateProvider statesync.StateProvider) Option

StateProvider overrides the state provider used by state sync to retrieve trusted app hashes and build a State object for bootstrapping the node. WARNING: this interface is considered unstable and subject to change.

type Provider

type Provider func(*cfg.Config, log.Logger) (*Node, error)

Provider takes a config and a logger and returns a ready to go Node.