app

Documentation

Overview

Package app provides the cli app shell of a Spacemesh p2p node

Index

• Variables
• func Main(commit, branch, version string)
• type SpacemeshApp

Variables

var (

	// ExitApp is a channel used to signal the app to gracefully exit.
	ExitApp = make(chan bool, 1)

	// Version is the app's semantic version. Designed to be overwritten by make.
	Version = "0.0.1"

	// Branch is the git branch used to build the App. Designed to be overwritten by make.
	Branch = ""

	// Commit is the git commit used to build the app. Designed to be overwritten by make.
	Commit = ""
)

var EntryPointCreated = make(chan bool, 1)

EntryPointCreated channel is used to announce that the main App instance was created mainly used for testing now.

Functions

func Main

func Main(commit, branch, version string)

Main is the entry point for the Spacemesh console app - responsible for parsing and routing cli flags and commands. This is the root of all evil, called from Main.main().

Types

type SpacemeshApp

type SpacemeshApp struct {
	*cli.App
	Node             p2p.LocalNode
	NodeInitCallback chan bool
	// contains filtered or unexported fields
}

SpacemeshApp is the cli app singleton

var App *SpacemeshApp

App is main app entry point. It provides access the local node and other top-level modules.