Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var GoShimmerPorts = []GoShimmerPort{ WebApiPort, DashboardPort, DagVizPort, DebugPort, ProfilingPort, }
GoShimmerPorts is the collection of ports that should be exposed by socat
Functions ¶
This section is empty.
Types ¶
type Activity ¶
type Activity struct { Enabled bool activity.ParametersDefinition }
Activity defines the parameters of the activity plugin.
type AutoPeering ¶
type AutoPeering struct { Enabled bool autopeering.ParametersDefinition discovery.ParametersDefinitionDiscovery }
AutoPeering defines the parameters of the autopeering plugin.
type BlockIssuer ¶
type BlockIssuer struct { Enabled bool blockissuer.ParametersDefinition }
BlockIssuer defines the parameters of the BlockIssuer plugin.
type Dagsvisualizer ¶
type Dagsvisualizer struct { Enabled bool dagsvisualizer.ParametersDefinition }
Dagsvisualizer defines the parameters of the Dag Visualizer plugin.
type Dashboard ¶
type Dashboard struct { Enabled bool dashboard.ParametersDefinition }
Dashboard defines the parameters of the Dashboard plugin.
type Database ¶
type Database struct { Enabled bool protocol.DatabaseParametersDefinition }
Database defines the parameters of the database plugin.
type Faucet ¶
type Faucet struct { Enabled bool faucet.ParametersDefinition }
Faucet defines the parameters of the faucet plugin.
type GoShimmer ¶
type GoShimmer struct { // Name specifies the GoShimmer instance. Name string // Image specifies the docker image for the instance Image string // DisabledPlugins specifies the plugins that are disabled with a config. DisabledPlugins []string // Seed specifies identity. Seed []byte // Whether to use the same seed for the node's wallet. UseNodeSeedAsWalletSeed bool // Network specifies network-level configurations Network // individual plugin configurations Database P2P WebAPI BlockIssuer AutoPeering Protocol Faucet Activity Metrics Profiling Dashboard Dagsvisualizer Notarization }
GoShimmer defines the config of a GoShimmer node.
func NewGoShimmer ¶
func NewGoShimmer() (config GoShimmer)
NewGoShimmer creates a GoShimmer config initialized with default values.
func (GoShimmer) CreateFlags ¶
CreateFlags converts a GoShimmer config into the corresponding command line flags.
type GoShimmerPort ¶
type GoShimmerPort int
const ( WebApiPort GoShimmerPort = 8080 DashboardPort GoShimmerPort = 8081 DagVizPort GoShimmerPort = 8061 DebugPort GoShimmerPort = 40000 ProfilingPort GoShimmerPort = 6061 )
type Metrics ¶
type Metrics struct { Enabled bool metrics.ParametersDefinition }
Metrics defines the parameters of the Metrics plugin.
type Notarization ¶
type Notarization struct { Enabled bool protocol.NotarizationParametersDefinition }
Notarization defines the parameters of the Notarization plugin.
type P2P ¶
type P2P struct { Enabled bool p2p.ParametersDefinition }
P2P defines the parameters of the gossip plugin.
type Profiling ¶
type Profiling struct { Enabled bool profiling.ParametersDefinition }
Profiling defines the parameters of the Profiling plugin.
type Protocol ¶
type Protocol struct { Enabled bool protocol.ParametersDefinition }
Protocol defines the parameters used by the block layer.
type WebAPI ¶
type WebAPI struct { Enabled bool webapi.ParametersDefinition }
WebAPI defines the parameters of the Web API plugin.