-
Notifications
You must be signed in to change notification settings - Fork 211
/
root.go
263 lines (232 loc) · 15.8 KB
/
root.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
package cmd
import (
"fmt"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"github.com/spacemeshos/go-spacemesh/cmd/flags"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/config"
"github.com/spacemeshos/go-spacemesh/config/presets"
)
var cfg = config.DefaultConfig()
func ResetConfig() {
cfg = config.DefaultConfig()
}
// AddCommands adds cobra commands to the app.
func AddCommands(cmd *cobra.Command) {
cmd.PersistentFlags().StringP("preset", "p", "",
fmt.Sprintf("preset overwrites default values of the config. options %+s", presets.Options()))
/** ======================== BaseConfig Flags ========================== **/
cmd.PersistentFlags().StringVarP(&cfg.BaseConfig.ConfigFile,
"config", "c", cfg.BaseConfig.ConfigFile, "Set Load configuration from file")
cmd.PersistentFlags().StringVarP(&cfg.BaseConfig.DataDirParent, "data-folder", "d",
cfg.BaseConfig.DataDirParent, "Specify data directory for spacemesh")
cmd.PersistentFlags().StringVar(&cfg.LOGGING.Encoder, "log-encoder",
cfg.LOGGING.Encoder, "Log as JSON instead of plain text")
cmd.PersistentFlags().BoolVar(&cfg.CollectMetrics, "metrics",
cfg.CollectMetrics, "collect node metrics")
cmd.PersistentFlags().IntVar(&cfg.MetricsPort, "metrics-port",
cfg.MetricsPort, "metric server port")
cmd.PersistentFlags().StringVar(&cfg.MetricsPush, "metrics-push",
cfg.MetricsPush, "Push metrics to url")
cmd.PersistentFlags().IntVar(&cfg.MetricsPushPeriod, "metrics-push-period",
cfg.MetricsPushPeriod, "Push period")
cmd.PersistentFlags().StringVar(&cfg.OracleServer, "oracle_server",
cfg.OracleServer, "The oracle server url. (temporary) ")
cmd.PersistentFlags().IntVar(&cfg.OracleServerWorldID, "oracle_server_worldid",
cfg.OracleServerWorldID, "The worldid to use with the oracle server (temporary) ")
cmd.PersistentFlags().StringArrayVar(&cfg.PoETServers, "poet-server",
cfg.PoETServers, "The poet server url. (temporary) Can be passed multiple times")
cmd.PersistentFlags().StringVar(&cfg.Genesis.GenesisTime, "genesis-time",
cfg.Genesis.GenesisTime, "Time of the genesis layer in 2019-13-02T17:02:00+00:00 format")
cmd.PersistentFlags().StringVar(&cfg.Genesis.ExtraData, "genesis-extra-data",
cfg.Genesis.ExtraData, "genesis extra-data will be committed to the genesis id")
cmd.PersistentFlags().DurationVar(&cfg.LayerDuration, "layer-duration",
cfg.LayerDuration, "Duration between layers")
cmd.PersistentFlags().Uint32Var(&cfg.LayerAvgSize, "layer-average-size",
cfg.LayerAvgSize, "Layer Avg size")
cmd.PersistentFlags().BoolVar(&cfg.PprofHTTPServer, "pprof-server",
cfg.PprofHTTPServer, "enable http pprof server")
cmd.PersistentFlags().Uint64Var(&cfg.TickSize, "tick-size", cfg.TickSize, "number of poet leaves in a single tick")
cmd.PersistentFlags().StringVar(&cfg.ProfilerURL, "profiler-url",
cfg.ProfilerURL, "send profiler data to certain url, if no url no profiling will be sent, format: http://<IP>:<PORT>")
cmd.PersistentFlags().StringVar(&cfg.ProfilerName, "profiler-name",
cfg.ProfilerName, "the name to use when sending profiles")
cmd.PersistentFlags().IntVar(&cfg.SyncRequestTimeout, "sync-request-timeout",
cfg.SyncRequestTimeout, "the timeout in ms for direct requests in the sync")
cmd.PersistentFlags().IntVar(&cfg.TxsPerProposal, "txs-per-proposal",
cfg.TxsPerProposal, "the number of transactions to select per proposal")
cmd.PersistentFlags().Uint64Var(&cfg.BlockGasLimit, "block-gas-limit",
cfg.BlockGasLimit, "max gas allowed per block")
cmd.PersistentFlags().IntVar(&cfg.OptFilterThreshold, "optimistic-filtering-threshold",
cfg.OptFilterThreshold, "threshold for optimistic filtering in percentage")
cmd.PersistentFlags().VarP(flags.NewStringToUint64Value(cfg.Genesis.Accounts), "accounts", "a",
"List of prefunded accounts")
cmd.PersistentFlags().IntVar(&cfg.DatabaseConnections, "db-connections",
cfg.DatabaseConnections, "configure number of active connections to enable parallel read requests")
cmd.PersistentFlags().BoolVar(&cfg.P2P.Flood, "db-latency-metering",
cfg.DatabaseLatencyMetering, "if enabled collect latency histogram for every database query")
/** ======================== P2P Flags ========================== **/
cmd.PersistentFlags().StringVar(&cfg.P2P.Listen, "listen",
cfg.P2P.Listen, "address for listening")
cmd.PersistentFlags().BoolVar(&cfg.P2P.Flood, "flood",
cfg.P2P.Flood, "flood created messages to all peers")
cmd.PersistentFlags().BoolVar(&cfg.P2P.DisableNatPort, "disable-natport",
cfg.P2P.DisableNatPort, "disable nat port-mapping (if enabled upnp protocol is used to negotiate external port with router)")
cmd.PersistentFlags().IntVar(&cfg.P2P.LowPeers, "low-peers",
cfg.P2P.LowPeers, "low watermark for the number of connections")
cmd.PersistentFlags().IntVar(&cfg.P2P.HighPeers, "high-peers",
cfg.P2P.HighPeers,
"high watermark for the number of connections; once reached, connections are pruned until low watermark remains")
cmd.PersistentFlags().IntVar(&cfg.P2P.MinPeers, "min-peers",
cfg.P2P.MinPeers, "actively search for peers until you get this much")
cmd.PersistentFlags().StringSliceVar(&cfg.P2P.Bootnodes, "bootnodes",
cfg.P2P.Bootnodes, "entrypoints into the network")
cmd.PersistentFlags().StringVar(&cfg.P2P.AdvertiseAddress, "advertise-address",
cfg.P2P.AdvertiseAddress, "libp2p address with identity (example: /dns4/bootnode.spacemesh.io/tcp/5003)")
/** ======================== TIME Flags ========================== **/
cmd.PersistentFlags().BoolVar(&cfg.TIME.Peersync.Disable, "peersync-disable", cfg.TIME.Peersync.Disable,
"disable verification that local time is in sync with peers")
cmd.PersistentFlags().DurationVar(&cfg.TIME.Peersync.RoundRetryInterval, "peersync-round-retry-interval",
cfg.TIME.Peersync.RoundRetryInterval, "when to retry a sync round after a failure")
cmd.PersistentFlags().DurationVar(&cfg.TIME.Peersync.RoundInterval, "peersync-round-interval",
cfg.TIME.Peersync.RoundRetryInterval, "when to run a next sync round")
cmd.PersistentFlags().DurationVar(&cfg.TIME.Peersync.RoundTimeout, "peersync-round-timeout",
cfg.TIME.Peersync.RoundRetryInterval, "how long to wait for a round to complete")
cmd.PersistentFlags().DurationVar(&cfg.TIME.Peersync.MaxClockOffset, "peersync-max-clock-offset",
cfg.TIME.Peersync.MaxClockOffset, "max difference between local clock and peers clock")
cmd.PersistentFlags().IntVar(&cfg.TIME.Peersync.MaxOffsetErrors, "peersync-max-offset-errors",
cfg.TIME.Peersync.MaxOffsetErrors, "the node will exit when max number of consecutive offset errors will be reached")
cmd.PersistentFlags().IntVar(&cfg.TIME.Peersync.RequiredResponses, "peersync-required-responses",
cfg.TIME.Peersync.RequiredResponses, "min number of clock samples from other that need to be collected to verify time")
/** ======================== API Flags ========================== **/
// StartJSONServer determines if json api server should be started
cmd.PersistentFlags().BoolVar(&cfg.API.StartJSONServer, "json-server",
cfg.API.StartJSONServer, "Start the grpc-gateway (json http) server. "+
"The gateway server will be enabled for all corresponding, enabled GRPC services.",
)
// JSONServerPort determines the json api server local listening port
cmd.PersistentFlags().IntVar(&cfg.API.JSONServerPort, "json-port",
cfg.API.JSONServerPort, "JSON api server port")
// StartGrpcServices determines which (if any) GRPC API services should be started
cmd.PersistentFlags().StringSliceVar(&cfg.API.StartGrpcServices, "grpc",
cfg.API.StartGrpcServices, "Comma-separated list of individual grpc services to enable "+
"(gateway,globalstate,mesh,node,smesher,transaction)")
// GrpcServerPort determines the grpc server local listening port
cmd.PersistentFlags().IntVar(&cfg.API.GrpcServerPort, "grpc-port",
cfg.API.GrpcServerPort, "GRPC api server port")
// GrpcServerInterface determines the interface the GRPC server listens on
cmd.PersistentFlags().StringVar(&cfg.API.GrpcServerInterface, "grpc-interface",
cfg.API.GrpcServerInterface, "GRPC api server interface")
cmd.PersistentFlags().IntVar(&cfg.API.GrpcRecvMsgSize, "grpc-recv-msg-size",
cfg.API.GrpcServerPort, "GRPC api recv message size")
cmd.PersistentFlags().IntVar(&cfg.API.GrpcSendMsgSize, "grpc-send-msg-size",
cfg.API.GrpcServerPort, "GRPC api send message size")
/**======================== Hare Flags ========================== **/
// N determines the size of the hare committee
cmd.PersistentFlags().IntVar(&cfg.HARE.N, "hare-committee-size",
cfg.HARE.N, "Size of Hare committee")
// RoundDuration determines the duration of a round in the Hare protocol
cmd.PersistentFlags().DurationVar(&cfg.HARE.RoundDuration, "hare-round-duration",
cfg.HARE.RoundDuration, "Duration of round in the Hare protocol")
cmd.PersistentFlags().DurationVar(&cfg.HARE.WakeupDelta, "hare-wakeup-delta",
cfg.HARE.WakeupDelta, "Wakeup delta after tick for hare protocol")
cmd.PersistentFlags().IntVar(&cfg.HARE.ExpectedLeaders, "hare-exp-leaders",
cfg.HARE.ExpectedLeaders, "The expected number of leaders in the hare protocol")
cmd.PersistentFlags().IntVar(&cfg.HARE.LimitIterations, "hare-limit-iterations",
cfg.HARE.LimitIterations, "The limit of the number of iteration per consensus process")
cmd.PersistentFlags().IntVar(&cfg.HARE.LimitConcurrent, "hare-limit-concurrent",
cfg.HARE.LimitConcurrent, "The number of consensus processes running concurrently")
/**======================== Hare Eligibility Oracle Flags ========================== **/
cmd.PersistentFlags().Uint32Var(&cfg.HareEligibility.ConfidenceParam, "eligibility-confidence-param",
cfg.HareEligibility.ConfidenceParam, "The relative layer (with respect to the current layer) we are confident to have consensus about")
cmd.PersistentFlags().Uint32Var(&cfg.HareEligibility.EpochOffset, "eligibility-epoch-offset",
cfg.HareEligibility.EpochOffset, "The constant layer (within an epoch) for which we traverse its view for the purpose of counting consensus active set")
/**======================== Beacon Flags ========================== **/
cmd.PersistentFlags().IntVar(&cfg.Beacon.Kappa, "beacon-kappa",
cfg.Beacon.Kappa, "Security parameter (for calculating ATX threshold)")
cmd.PersistentFlags().Var((*types.RatVar)(cfg.Beacon.Q), "beacon-q",
"Ratio of dishonest spacetime (for calculating ATX threshold). It should be a string representing a rational number.")
cmd.PersistentFlags().Uint32Var((*uint32)(&cfg.Beacon.RoundsNumber), "beacon-rounds-number",
uint32(cfg.Beacon.RoundsNumber), "Amount of rounds in every epoch")
cmd.PersistentFlags().DurationVar(&cfg.Beacon.GracePeriodDuration, "beacon-grace-period-duration",
cfg.Beacon.GracePeriodDuration, "Grace period duration in milliseconds")
cmd.PersistentFlags().DurationVar(&cfg.Beacon.ProposalDuration, "beacon-proposal-duration",
cfg.Beacon.ProposalDuration, "Proposal duration in milliseconds")
cmd.PersistentFlags().DurationVar(&cfg.Beacon.FirstVotingRoundDuration, "beacon-first-voting-round-duration",
cfg.Beacon.FirstVotingRoundDuration, "First voting round duration in milliseconds")
cmd.PersistentFlags().DurationVar(&cfg.Beacon.VotingRoundDuration, "beacon-voting-round-duration",
cfg.Beacon.VotingRoundDuration, "Voting round duration in milliseconds")
cmd.PersistentFlags().DurationVar(&cfg.Beacon.WeakCoinRoundDuration, "beacon-weak-coin-round-duration",
cfg.Beacon.WeakCoinRoundDuration, "Weak coin round duration in milliseconds")
cmd.PersistentFlags().Var((*types.RatVar)(cfg.Beacon.Theta), "beacon-theta",
"Ratio of votes for reaching consensus")
cmd.PersistentFlags().Uint32Var(&cfg.Beacon.VotesLimit, "beacon-votes-limit",
cfg.Beacon.VotesLimit, "Maximum allowed number of votes to be sent")
cmd.PersistentFlags().IntVar(&cfg.Beacon.BeaconSyncWeightUnits, "beacon-sync-weight-units",
cfg.Beacon.BeaconSyncWeightUnits, "Numbers of weight units to wait before determining beacon values from them.")
/**======================== Tortoise Flags ========================== **/
cmd.PersistentFlags().Uint32Var(&cfg.Tortoise.Hdist, "tortoise-hdist",
cfg.Tortoise.Hdist, "the distance for tortoise to vote according to hare output")
cmd.PersistentFlags().Uint32Var(&cfg.Tortoise.Zdist, "tortoise-zdist",
cfg.Tortoise.Zdist, "the distance for tortoise to wait for hare output")
cmd.PersistentFlags().Uint32Var(&cfg.Tortoise.WindowSize, "tortoise-window-size",
cfg.Tortoise.WindowSize, "size of the tortoise sliding window in layers")
cmd.PersistentFlags().IntVar(&cfg.Tortoise.MaxExceptions, "tortoise-max-exceptions",
cfg.Tortoise.MaxExceptions, "number of exceptions tolerated for a base ballot")
cmd.PersistentFlags().Uint32Var(&cfg.Tortoise.BadBeaconVoteDelayLayers, "tortoise-delay-layers",
cfg.Tortoise.BadBeaconVoteDelayLayers, "number of layers to ignore a ballot with a different beacon")
// TODO(moshababo): add usage desc
cmd.PersistentFlags().Uint64Var(&cfg.POST.LabelsPerUnit, "post-labels-per-unit",
cfg.POST.LabelsPerUnit, "")
cmd.PersistentFlags().Uint32Var(&cfg.POST.MinNumUnits, "post-min-numunits",
cfg.POST.MinNumUnits, "")
cmd.PersistentFlags().Uint32Var(&cfg.POST.MaxNumUnits, "post-max-numunits",
cfg.POST.MaxNumUnits, "")
cmd.PersistentFlags().Uint32Var(&cfg.POST.K1, "post-k1",
cfg.POST.K1, "difficulty factor for finding a good label when generating a proof")
cmd.PersistentFlags().Uint32Var(&cfg.POST.K2, "post-k2",
cfg.POST.K2, "number of labels to prove")
cmd.PersistentFlags().Uint32Var(&cfg.POST.K3, "post-k3",
cfg.POST.K3, "subset of labels to verify in a proof")
cmd.PersistentFlags().Uint64Var(&cfg.POST.K2PowDifficulty, "post-k2pow-difficulty",
cfg.POST.K2PowDifficulty, "difficulty of K2 proof of work")
cmd.PersistentFlags().Uint64Var(&cfg.POST.K3PowDifficulty, "post-k3pow-difficulty",
cfg.POST.K3PowDifficulty, "difficulty of K3 proof of work")
/**======================== Smeshing Flags ========================== **/
// TODO(moshababo): add usage desc
cmd.PersistentFlags().BoolVar(&cfg.SMESHING.Start, "smeshing-start",
cfg.SMESHING.Start, "")
cmd.PersistentFlags().StringVar(&cfg.SMESHING.CoinbaseAccount, "smeshing-coinbase",
cfg.SMESHING.CoinbaseAccount, "coinbase account to accumulate rewards")
cmd.PersistentFlags().StringVar(&cfg.SMESHING.Opts.DataDir, "smeshing-opts-datadir",
cfg.SMESHING.Opts.DataDir, "")
cmd.PersistentFlags().Uint32Var(&cfg.SMESHING.Opts.NumUnits, "smeshing-opts-numunits",
cfg.SMESHING.Opts.NumUnits, "")
cmd.PersistentFlags().Uint64Var(&cfg.SMESHING.Opts.MaxFileSize, "smeshing-opts-maxfilesize",
cfg.SMESHING.Opts.MaxFileSize, "")
cmd.PersistentFlags().IntVar(&cfg.SMESHING.Opts.ComputeProviderID, "smeshing-opts-provider",
cfg.SMESHING.Opts.ComputeProviderID, "")
cmd.PersistentFlags().BoolVar(&cfg.SMESHING.Opts.Throttle, "smeshing-opts-throttle",
cfg.SMESHING.Opts.Throttle, "")
/**======================== Consensus Flags ========================== **/
cmd.PersistentFlags().Uint32Var(&cfg.LayersPerEpoch, "layers-per-epoch",
cfg.LayersPerEpoch, "number of layers in epoch")
/**======================== PoET Flags ========================== **/
cmd.PersistentFlags().DurationVar(&cfg.POET.PhaseShift, "phase-shift",
cfg.POET.PhaseShift, "phase shift of poet server")
cmd.PersistentFlags().DurationVar(&cfg.POET.CycleGap, "cycle-gap",
cfg.POET.CycleGap, "cycle gap of poet server")
cmd.PersistentFlags().DurationVar(&cfg.POET.GracePeriod, "grace-period",
cfg.POET.GracePeriod, "propagation time for ATXs in the network")
/**======================== bootstrap data updater Flags ========================== **/
cmd.PersistentFlags().StringVar(&cfg.Bootstrap.URL, "bootstrap-url",
cfg.Bootstrap.URL, "the url to query bootstrap data update")
cmd.PersistentFlags().StringVar(&cfg.Bootstrap.Version, "bootstrap-version",
cfg.Bootstrap.Version, "the update version of the bootstrap data")
// Bind Flags to config
err := viper.BindPFlags(cmd.PersistentFlags())
if err != nil {
fmt.Println("an error has occurred while binding flags:", err)
}
}