node

package

v0.1.0 Latest Latest Go to latest Published: Aug 4, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Details

This section is empty.

View Source

var DefaultConfig = Config{}

DefaultConfig returns a default configuration for a node

func RegisterAPI(node *Node)

type API struct {
	// contains filtered or unexported fields
}

func (api *API) Status() map[string]bool

type Config struct {
}

Config defines the top level configuration for a node

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

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

func NewNode(logger log.Logger, options ...Option) (*Node, error)

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

func (n *Node) Chain() *core.BlockChain

func (n *Node) OnStart() error

OnStart starts the Node. It implements service.Service.

func (n *Node) OnStop()

OnStop stops the Node. It implements service.Service.

type Option func(*Node)

Option sets a parameter for the node.