node

Documentation

Overview

Package node implements the Oasis node.

Index

• Constants
• Variables
• func Register(parentCmd *cobra.Command)
• func Run(cmd *cobra.Command, args []string)
• type Node
  • func NewNode() (node *Node, err error)
  • func (n *Node) Cleanup()
  • func (n *Node) GetIdentity() *identity.Identity
  • func (n *Node) GetPendingUpgrades(ctx context.Context) ([]*upgrade.PendingUpgrade, error)
  • func (n *Node) GetRegistrationStatus(ctx context.Context) (*control.RegistrationStatus, error)
  • func (n *Node) GetRuntimeStatus(ctx context.Context) (map[common.Namespace]control.RuntimeStatus, error)
  • func (n *Node) Ready() <-chan struct{}
  • func (n *Node) RegistrationStopped()
  • func (n *Node) RequestShutdown() (<-chan struct{}, error)
  • func (n *Node) Stop()
  • func (n *Node) Wait()

Constants

const (
	// CfgPreserveLocalStorage exempts the untrusted local storage from
	// the unsafe-reset sub-command.
	CfgPreserveLocalStorage = "preserve.local_storage"

	// CfgPreserveMKVSDatabase exempts the MKVS database from the unsafe-reset
	// sub-command.
	CfgPreserveMKVSDatabase = "preserve.mkvs_database"
)

Variables

var Flags = flag.NewFlagSet("", flag.ContinueOnError)

Flags has the configuration flags.

Functions

func Register

func Register(parentCmd *cobra.Command)

Register registers the node maintenance sub-commands and all of it's children.

func Run

func Run(cmd *cobra.Command, args []string)

Run runs the Oasis node.

Types

type Node

type Node struct {
	NodeController  controlAPI.NodeController
	DebugController controlAPI.DebugController

	Consensus consensusAPI.Backend

	Upgrader upgradeAPI.Backend
	Genesis  genesisAPI.Provider
	Identity *identity.Identity
	Sentry   sentryAPI.LocalBackend
	IAS      iasAPI.Endpoint

	RuntimeRegistry runtimeRegistry.Registry

	CommonWorker       *workerCommon.Worker
	ExecutorWorker     *executor.Worker
	StorageWorker      *workerStorage.Worker
	ClientWorker       *workerClient.Worker
	SentryWorker       *workerSentry.Worker
	P2P                *p2p.P2P
	RegistrationWorker *registration.Worker
	KeymanagerWorker   *workerKeymanager.Worker
	ConsensusWorker    *workerConsensusRPC.Worker
	BeaconWorker       *workerBeacon.Worker
	// contains filtered or unexported fields
}

Node is the Oasis node service.

WARNING: This is exposed for the benefit of tests and the interface is not guaranteed to be stable.

func NewNode

func NewNode() (node *Node, err error)

NewNode initializes and launches the Oasis node service.

WARNING: This will misbehave iff cmd != RootCommand(). This is exposed for the benefit of tests and the interface is not guaranteed to be stable.

Note: the reason for having the named err return value here is for the deferred func below to propagate the error.

func (*Node) Cleanup

func (n *Node) Cleanup()

Cleanup cleans up after the node has terminated.

func (*Node) GetIdentity

func (n *Node) GetIdentity() *identity.Identity

Implements control.ControlledNode.

func (*Node) GetPendingUpgrades

func (n *Node) GetPendingUpgrades(ctx context.Context) ([]*upgrade.PendingUpgrade, error)

Implements control.ControlledNode.

func (*Node) GetRegistrationStatus

func (n *Node) GetRegistrationStatus(ctx context.Context) (*control.RegistrationStatus, error)

Implements control.ControlledNode.

func (*Node) GetRuntimeStatus

func (n *Node) GetRuntimeStatus(ctx context.Context) (map[common.Namespace]control.RuntimeStatus, error)

Implements control.ControlledNode.

func (*Node) Ready

func (n *Node) Ready() <-chan struct{}

Implements control.ControlledNode.

func (*Node) RegistrationStopped

func (n *Node) RegistrationStopped()

Implements registration.Delegate.

func (*Node) RequestShutdown

func (n *Node) RequestShutdown() (<-chan struct{}, error)

Implements control.ControlledNode.

func (*Node) Stop

func (n *Node) Stop()

Stop gracefully terminates the node.

func (*Node) Wait

func (n *Node) Wait()

Wait waits for the node to gracefully terminate. Callers MUST call Cleanup() after wait returns.