plugin

type Configurator interface {
	// Function that creates the configuration for the node
	Configure(currentNode node.Node) error

	// Removes configuration related to the node
	RemoveConfig(currentNode node.Node) error
}

type DockerLifecycleHandler struct {
	// contains filtered or unexported fields
}

type DockerPlugin struct {
	ParameterValidator
	IdentityCreator
	Configurator
	LifecycleHandler
	Upgrader
	Tester
	// contains filtered or unexported fields
}

type DockerUpgrader struct {
	// contains filtered or unexported fields
}

type DummyTester struct{}

type FileConfigurator struct {
	// contains filtered or unexported fields
}

type IdentityCreator interface {
	// Function that creates the identity of a node
	CreateIdentity(currentNode node.Node) error

	// Removes identity related to the node
	RemoveIdentity(currentNode node.Node) error
}

type LifecycleHandler interface {
	// SetUpEnvironment prepares the runtime environment
	SetUpEnvironment(currentNode node.Node) error
	// Function to start a node
	Start(currentNode node.Node) error
	// Function to stop a running node
	Stop(currentNode node.Node) error
	// Function to return the status (running, incomplete, stopped) of a node
	Status(currentNode node.Node) (string, error)
	// Removes any data (typically the blockchain itself) related to the node
	RemoveData(currentNode node.Node) error
	// Removes everything other than data and configuration related to the node
	RemoveRuntime(currentNode node.Node) error
	// TearDownEnvironment removes everything related to the node from the runtime environment
	TearDownEnvironment(currentNode node.Node) error
}

type MetaInfo struct {
	Name            string
	Version         string
	Description     string
	ProtocolVersion string `yaml:"protocol_version"`
	Parameters      []Parameter
	Supported       []string
}

type Parameter struct {
	Type        string
	Name        string
	Description string
	Mandatory   bool
	Default     string
}

type ParameterValidator interface {
	// ValidateParameters validates the ndoe parameters
	ValidateParameters(currentNode node.Node) error
}

type Plugin interface {
	// Returns the name of the plugin
	Name() string
	// Return plugin meta information such as: What's supported, possible parameters
	Meta() MetaInfo

	ParameterValidator
	IdentityCreator
	Configurator
	LifecycleHandler
	Upgrader
	Tester
}

type SimpleParameterValidator struct {
	// contains filtered or unexported fields
}

type Tester interface {
	// Function to test a node
	Test(currentNode node.Node) (bool, error)
}

type Upgrader interface {
	// Function to upgrade a node with a new plugin version
	Upgrade(currentNode node.Node) error
}