nodebuilder

Documentation

Index

• type AppInfo
• type BeaconApp
• type NodeBuilder
  • func NewNodeBuilder[T servertypes.Application]() *NodeBuilder[T]
  • func (nb *NodeBuilder[T]) BuildRootCmd() *cobra.Command
  • func (nb *NodeBuilder[T]) DefaultAppConfig() any
  • func (nb *NodeBuilder[T]) DefaultAppConfigTemplate() string
  • func (nb *NodeBuilder[T]) DefaultCometConfig() *cmtcfg.Config
  • func (nb *NodeBuilder[T]) RunNode()
  • func (nb *NodeBuilder[T]) WithAppInfo(appInfo *AppInfo[T]) *NodeBuilder[T]

Types

type AppInfo

type AppInfo[T servertypes.Application] struct {
	// Name is the name of the application.
	Name string
	// Description is a short description of the application.
	Description string
	// Creator is a function that creates the application.
	Creator servertypes.AppCreator[T]
	// DepInjectConfig is the configuration for the application.
	DepInjectConfig depinject.Config
}

AppInfo is a struct that holds the application information.

type BeaconApp

type BeaconApp interface {
	PostStartup(
		ctx context.Context,
		clientCtx client.Context,
	) error
}

BeaconApp is an interface that defines the PostStartup method.

type NodeBuilder

type NodeBuilder[T servertypes.Application] struct {
	// contains filtered or unexported fields
}

NodeBuilder is a struct that holds the application information.

func NewNodeBuilder

func NewNodeBuilder[T servertypes.Application]() *NodeBuilder[T]

NewNodeBuilder creates a new NodeBuilder.

func (*NodeBuilder[T]) BuildRootCmd

func (nb *NodeBuilder[T]) BuildRootCmd() *cobra.Command

BuildRootCmd builds the root command for the application.

func (*NodeBuilder[T]) DefaultAppConfig

func (nb *NodeBuilder[T]) DefaultAppConfig() any

DefaultAppConfig returns the default configuration for the application.

func (*NodeBuilder[T]) DefaultAppConfigTemplate

func (nb *NodeBuilder[T]) DefaultAppConfigTemplate() string

DefaultAppConfigTemplate returns the default configuration template for the application.

func (*NodeBuilder[T]) DefaultCometConfig

func (nb *NodeBuilder[T]) DefaultCometConfig() *cmtcfg.Config

DefaultCometConfig returns the default configuration for the CometBFT consensus engine.

func (*NodeBuilder[T]) RunNode

func (nb *NodeBuilder[T]) RunNode()

Run runs the application.

func (*NodeBuilder[T]) WithAppInfo

func (nb *NodeBuilder[T]) WithAppInfo(appInfo *AppInfo[T]) *NodeBuilder[T]

WithAppInfo sets the application information.