node

Documentation

Index

• func Address(c *gin.Context)
• func HeartbeatStatus(c *gin.Context)
• func Routes(router *gin.RouterGroup)
• func StartNode(c *gin.Context)
• func Statistics(c *gin.Context)
• func Status(c *gin.Context)
• func StopNode(c *gin.Context)
• type FacadeHandler

Functions

func Address

func Address(c *gin.Context)

Address returns the information about the address passed as parameter

func HeartbeatStatus

func HeartbeatStatus(c *gin.Context)

HeartbeatStatus respond with the heartbeat status of the node

func Routes

func Routes(router *gin.RouterGroup)

Routes defines node related routes

func StartNode

func StartNode(c *gin.Context)

StartNode will start the node instance

func Statistics

func Statistics(c *gin.Context)

Statistics returns the blockchain statistics

func Status

func Status(c *gin.Context)

Status returns the state of the node e.g. running/stopped

func StopNode

func StopNode(c *gin.Context)

StopNode will stop the node instance

Types

type FacadeHandler

type FacadeHandler interface {
	IsNodeRunning() bool
	StartNode() error
	StopNode() error
	GetCurrentPublicKey() string
	GetHeartbeats() ([]heartbeat.PubKeyHeartbeat, error)
	TpsBenchmark() *statistics.TpsBenchmark
}

Handler interface defines methods that can be used from `numbatFacade` context variable