node

package

v0.2.0 Latest Latest Go to latest Published: Aug 24, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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() NodeStatus

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 NodeStatus struct {
	IsRuning  bool `json:"is_runing"`
	NetworkId byte `json:"network_id"`
}

type Option func(*Node)

Option sets a parameter for the node.