peer

Documentation

Index

• Constants
• Variables
• type ParametersDefinition

Constants

const PluginName = "Peer"

PluginName is the name of the Peer plugin.

Variables

var (
	// Plugin is the plugin instance of the Peer plugin.
	Plugin *node.Plugin

	// ErrMismatchedPrivateKeys is returned when the private key derived from the config does not correspond to the private
	// key stored in an already existing peer database.
	ErrMismatchedPrivateKeys = errors.New("private key derived from the seed defined in the config does not correspond with the already stored private key in the database")
)

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the local peer's network.

Types

type ParametersDefinition

type ParametersDefinition struct {
	// Seed defines the config flag of the autopeering private key seed.
	Seed string `` /* 156-byte string literal not displayed */

	// OverwriteStoredSeed defines whether the private key stored in an existing peerdb should be overwritten.
	OverwriteStoredSeed bool `default:"false" usage:"whether to overwrite the private key if an existing peerdb exists"`

	// ExternalAddress defines the config flag of the network external address.
	ExternalAddress string `default:"auto" usage:"external IP address under which the node is reachable; or 'auto' to determine it automatically"`

	// PeerDBDirectory defines the path to the peer database.
	PeerDBDirectory string `default:"peerdb" usage:"path to the peer database directory"`
}

ParametersDefinition contains the definition of configuration parameters used by the local peer's network.