node

package

v1.5.0 Latest Latest Go to latest Published: Apr 18, 2024 License: MIT Imports: 95 Imported by: 1

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

Repository

github.com/spacemeshos/go-spacemesh

Links

Open Source Insights

Documentation ¶

Overview ¶

Package node contains the main executable for go-spacemesh node

Index ¶

Constants
func GetCommand() *cobra.Command
func WithErrorUnused() viper.DecoderConfigOption
func WithIgnoreUntagged() viper.DecoderConfigOption
func WithZeroFields() viper.DecoderConfigOption
type App
- func New(opts ...Option) *App
- func NewApp(t *testing.T, conf *config.Config, l log.Log) *App
type Option
- func WithConfig(conf *config.Config) Option
- func WithLog(logger log.Log) Option
type TestApp
- func NewTestNetwork(t *testing.T, conf config.Config, l log.Log, size int) []*TestApp

Constants ¶

View Source

const (
	ClockLogger            = "clock"
	P2PLogger              = "p2p"
	PostLogger             = "post"
	PostServiceLogger      = "postService"
	PostInfoServiceLogger  = "postInfoService"
	StateDbLogger          = "stateDb"
	BeaconLogger           = "beacon"
	CachedDBLogger         = "cachedDB"
	PoetDbLogger           = "poetDb"
	TrtlLogger             = "trtl"
	ATXHandlerLogger       = "atxHandler"
	ATXBuilderLogger       = "atxBuilder"
	MeshLogger             = "mesh"
	SyncLogger             = "sync"
	HareOracleLogger       = "hareOracle"
	HareLogger             = "hare"
	BlockCertLogger        = "blockCert"
	BlockGenLogger         = "blockGenerator"
	BlockHandlerLogger     = "blockHandler"
	TxHandlerLogger        = "txHandler"
	ProposalStoreLogger    = "proposalStore"
	ProposalBuilderLogger  = "proposalBuilder"
	ProposalListenerLogger = "proposalListener"
	NipostBuilderLogger    = "nipostBuilder"
	NipostValidatorLogger  = "nipostValidator"
	Fetcher                = "fetcher"
	TimeSyncLogger         = "timesync"
	VMLogger               = "vm"
	GRPCLogger             = "grpc"
	ConStateLogger         = "conState"
	ExecutorLogger         = "executor"
	MalfeasanceLogger      = "malfeasance"
	BootstrapLogger        = "bootstrap"
)

Logger names.

Variables ¶

This section is empty.

Functions ¶

func GetCommand ¶

func GetCommand() *cobra.Command

func WithErrorUnused ¶ added in v1.5.0

func WithErrorUnused() viper.DecoderConfigOption

func WithIgnoreUntagged ¶ added in v1.4.0

func WithIgnoreUntagged() viper.DecoderConfigOption

func WithZeroFields ¶ added in v1.4.0

func WithZeroFields() viper.DecoderConfigOption

Types ¶

type App ¶

type App struct {
	*cobra.Command

	Config *config.Config
	// contains filtered or unexported fields
}

App is the cli app singleton.

func New ¶

func New(opts ...Option) *App

New creates an instance of the spacemesh app.

func NewApp ¶ added in v1.3.0

func NewApp(t *testing.T, conf *config.Config, l log.Log) *App

func (*App) Cleanup ¶

func (app *App) Cleanup(ctx context.Context)

Cleanup stops all app services.

func (*App) Host ¶

func (app *App) Host() *p2p.Host

func (*App) Initialize ¶

func (app *App) Initialize() error

Initialize parses and validates the node configuration and sets up logging.

func (*App) LoadCheckpoint ¶

func (app *App) LoadCheckpoint(ctx context.Context) (*checkpoint.PreservedData, error)

func (*App) LoadIdentities ¶ added in v1.4.0

func (app *App) LoadIdentities() error

LoadIdentities loads all existing identities from the config directory.

func (*App) Lock ¶

func (app *App) Lock() error

Lock locks the app for exclusive use. It returns an error if the app is already locked.

func (*App) MigrateExistingIdentity ¶ added in v1.4.0

func (app *App) MigrateExistingIdentity() error

MigrateExistingIdentity migrates the legacy identity file to the new location.

The legacy identity file is expected to be located at `app.Config.SMESHING.Opts.DataDir/key.bin`.

TODO(mafa): this can be removed in a future version when the legacy identity file is no longer expected to exist.

func (*App) NewIdentity ¶ added in v1.4.0

func (app *App) NewIdentity() error

NewIdentity creates a new identity, saves it to `keyDir/supervisedIDKeyFileName` in the config directory and initializes app.signers with that identity.

func (*App) SetLogLevel ¶

func (app *App) SetLogLevel(name, loglevel string) error

SetLogLevel updates the log level of an existing logger.

func (*App) Start ¶

func (app *App) Start(ctx context.Context) error

Start starts the Spacemesh node and initializes all relevant services according to command line arguments provided.

func (*App) Started ¶

func (app *App) Started() <-chan struct{}

func (*App) TestIdentity ¶ added in v1.4.0

func (app *App) TestIdentity() ([]*signing.EdSigner, error)

TestIdentity loads a pre-configured identity for testing purposes.

func (*App) Unlock ¶

func (app *App) Unlock()

Unlock unlocks the app. It is a no-op if the app is not locked.

type Option ¶

type Option func(app *App)

Option to modify an App instance.

func WithConfig ¶

func WithConfig(conf *config.Config) Option

WithConfig overwrites default App config.

func WithLog ¶

func WithLog(logger log.Log) Option

WithLog enables logger for an App.

type TestApp ¶ added in v1.3.0

type TestApp struct {
	*App
	Conn *grpc.ClientConn
}

func NewTestNetwork ¶ added in v1.3.0

func NewTestNetwork(t *testing.T, conf config.Config, l log.Log, size int) []*TestApp

NewTestNetwork creates a network of fully connected nodes.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
flags
mapstructureutil

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL