-
Notifications
You must be signed in to change notification settings - Fork 199
/
config.go
641 lines (564 loc) · 20.8 KB
/
config.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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
package config
import p2pConfig "github.com/multiversx/mx-chain-go/p2p/config"
// CacheConfig will map the cache configuration
type CacheConfig struct {
Name string
Type string
Capacity uint32
SizePerSender uint32
SizeInBytes uint64
SizeInBytesPerSender uint32
Shards uint32
}
// HeadersPoolConfig will map the headers cache configuration
type HeadersPoolConfig struct {
MaxHeadersPerShard int
NumElementsToRemoveOnEviction int
}
// DBConfig will map the database configuration
type DBConfig struct {
FilePath string
Type string
BatchDelaySeconds int
MaxBatchSize int
MaxOpenFiles int
UseTmpAsFilePath bool
ShardIDProviderType string
NumShards int32
}
// StorageConfig will map the storage unit configuration
type StorageConfig struct {
Cache CacheConfig
DB DBConfig
}
// TrieSyncStorageConfig will map trie sync storage configuration
type TrieSyncStorageConfig struct {
Capacity uint32
SizeInBytes uint64
EnableDB bool
DB DBConfig
}
// PubkeyConfig will map the public key configuration
type PubkeyConfig struct {
Length int
Type string
SignatureLength int
Hrp string
}
// TypeConfig will map the string type configuration
type TypeConfig struct {
Type string
}
// MarshalizerConfig holds the marshalizer related configuration
type MarshalizerConfig struct {
Type string
// TODO check if we still need this
SizeCheckDelta uint32
}
// ConsensusConfig holds the consensus configuration parameters
type ConsensusConfig struct {
Type string
}
// NTPConfig will hold the configuration for NTP queries
type NTPConfig struct {
Hosts []string
Port int
TimeoutMilliseconds int
SyncPeriodSeconds int
Version int
}
// EvictionWaitingListConfig will hold the configuration for the EvictionWaitingList
type EvictionWaitingListConfig struct {
RootHashesSize uint
HashesSize uint
DB DBConfig
}
// EpochStartConfig will hold the configuration of EpochStart settings
type EpochStartConfig struct {
MinRoundsBetweenEpochs int64
RoundsPerEpoch int64
MinShuffledOutRestartThreshold float64
MaxShuffledOutRestartThreshold float64
MinNumConnectedPeersToStart int
MinNumOfPeersToConsiderBlockValid int
ExtraDelayForRequestBlockInfoInMilliseconds int
GenesisEpoch uint32
}
// BlockSizeThrottleConfig will hold the configuration for adaptive block size throttle
type BlockSizeThrottleConfig struct {
MinSizeInBytes uint32
MaxSizeInBytes uint32
}
// SoftwareVersionConfig will hold the configuration for software version checker
type SoftwareVersionConfig struct {
StableTagLocation string
PollingIntervalInMinutes int
}
// GatewayMetricsConfig will hold the configuration for gateway endpoint configuration
type GatewayMetricsConfig struct {
URL string
}
// HeartbeatV2Config will hold the configuration for heartbeat v2
type HeartbeatV2Config struct {
PeerAuthenticationTimeBetweenSendsInSec int64
PeerAuthenticationTimeBetweenSendsWhenErrorInSec int64
PeerAuthenticationTimeThresholdBetweenSends float64
HeartbeatTimeBetweenSendsInSec int64
HeartbeatTimeBetweenSendsDuringBootstrapInSec int64
HeartbeatTimeBetweenSendsWhenErrorInSec int64
HeartbeatTimeThresholdBetweenSends float64
HeartbeatExpiryTimespanInSec int64
MinPeersThreshold float32
DelayBetweenPeerAuthenticationRequestsInSec int64
PeerAuthenticationMaxTimeoutForRequestsInSec int64
PeerShardTimeBetweenSendsInSec int64
PeerShardTimeThresholdBetweenSends float64
MaxMissingKeysInRequest uint32
MaxDurationPeerUnresponsiveInSec int64
HideInactiveValidatorIntervalInSec int64
HeartbeatPool CacheConfig
HardforkTimeBetweenSendsInSec int64
TimeBetweenConnectionsMetricsUpdateInSec int64
TimeToReadDirectConnectionsInSec int64
PeerAuthenticationTimeBetweenChecksInSec int64
}
// Config will hold the entire application configuration parameters
type Config struct {
MiniBlocksStorage StorageConfig
PeerBlockBodyStorage StorageConfig
BlockHeaderStorage StorageConfig
TxStorage StorageConfig
UnsignedTransactionStorage StorageConfig
RewardTxStorage StorageConfig
ShardHdrNonceHashStorage StorageConfig
MetaHdrNonceHashStorage StorageConfig
StatusMetricsStorage StorageConfig
ReceiptsStorage StorageConfig
ScheduledSCRsStorage StorageConfig
SmartContractsStorage StorageConfig
SmartContractsStorageForSCQuery StorageConfig
TrieEpochRootHashStorage StorageConfig
SmartContractsStorageSimulate StorageConfig
BootstrapStorage StorageConfig
MetaBlockStorage StorageConfig
AccountsTrieStorage StorageConfig
PeerAccountsTrieStorage StorageConfig
EvictionWaitingList EvictionWaitingListConfig
StateTriesConfig StateTriesConfig
TrieStorageManagerConfig TrieStorageManagerConfig
BadBlocksCache CacheConfig
TxBlockBodyDataPool CacheConfig
PeerBlockBodyDataPool CacheConfig
TxDataPool CacheConfig
UnsignedTransactionDataPool CacheConfig
RewardTransactionDataPool CacheConfig
TrieNodesChunksDataPool CacheConfig
WhiteListPool CacheConfig
WhiteListerVerifiedTxs CacheConfig
SmartContractDataPool CacheConfig
ValidatorInfoPool CacheConfig
TrieSyncStorage TrieSyncStorageConfig
EpochStartConfig EpochStartConfig
AddressPubkeyConverter PubkeyConfig
ValidatorPubkeyConverter PubkeyConfig
Hasher TypeConfig
MultisigHasher TypeConfig
Marshalizer MarshalizerConfig
VmMarshalizer TypeConfig
TxSignMarshalizer TypeConfig
TxSignHasher TypeConfig
PublicKeyShardId CacheConfig
PublicKeyPeerId CacheConfig
PeerIdShardId CacheConfig
PublicKeyPIDSignature CacheConfig
PeerHonesty CacheConfig
Antiflood AntifloodConfig
WebServerAntiflood WebServerAntifloodConfig
ResourceStats ResourceStatsConfig
HeartbeatV2 HeartbeatV2Config
ValidatorStatistics ValidatorStatisticsConfig
GeneralSettings GeneralSettingsConfig
Consensus ConsensusConfig
StoragePruning StoragePruningConfig
LogsAndEvents LogsAndEventsConfig
HardwareRequirements HardwareRequirementsConfig
NTPConfig NTPConfig
HeadersPoolConfig HeadersPoolConfig
BlockSizeThrottleConfig BlockSizeThrottleConfig
VirtualMachine VirtualMachineServicesConfig
BuiltInFunctions BuiltInFunctionsConfig
Hardfork HardforkConfig
Debug DebugConfig
Health HealthServiceConfig
SoftwareVersionConfig SoftwareVersionConfig
GatewayMetricsConfig GatewayMetricsConfig
DbLookupExtensions DbLookupExtensionsConfig
Versions VersionsConfig
Logs LogsConfig
TrieSync TrieSyncConfig
Requesters RequesterConfig
VMOutputCacher CacheConfig
PeersRatingConfig PeersRatingConfig
PoolsCleanersConfig PoolsCleanersConfig
Redundancy RedundancyConfig
}
// PeersRatingConfig will hold settings related to peers rating
type PeersRatingConfig struct {
TopRatedCacheCapacity int
BadRatedCacheCapacity int
}
// LogsConfig will hold settings related to the logging sub-system
type LogsConfig struct {
LogFileLifeSpanInSec int
LogFileLifeSpanInMB int
}
// StoragePruningConfig will hold settings related to storage pruning
type StoragePruningConfig struct {
Enabled bool
ValidatorCleanOldEpochsData bool
ObserverCleanOldEpochsData bool
AccountsTrieCleanOldEpochsData bool
AccountsTrieSkipRemovalCustomPattern string
NumEpochsToKeep uint64
NumActivePersisters uint64
FullArchiveNumActivePersisters uint32
}
// ResourceStatsConfig will hold all resource stats settings
type ResourceStatsConfig struct {
Enabled bool
RefreshIntervalInSec int
}
// ValidatorStatisticsConfig will hold validator statistics specific settings
type ValidatorStatisticsConfig struct {
CacheRefreshIntervalInSec uint32
}
// MaxNodesChangeConfig defines a config change tuple, with a maximum number enabled in a certain epoch number
type MaxNodesChangeConfig struct {
EpochEnable uint32
MaxNumNodes uint32
NodesToShufflePerShard uint32
}
// MultiSignerConfig defines a config tuple for a BLS multi-signer that activates in a certain epoch
type MultiSignerConfig struct {
EnableEpoch uint32
Type string
}
// GeneralSettingsConfig will hold the general settings for a node
type GeneralSettingsConfig struct {
StatusPollingIntervalSec int
MaxComputableRounds uint64
MaxConsecutiveRoundsOfRatingDecrease uint64
StartInEpochEnabled bool
ChainID string
MinTransactionVersion uint32
GenesisString string
GenesisMaxNumberOfShards uint32
SyncProcessTimeInMillis uint32
SetGuardianEpochsDelay uint32
}
// HardwareRequirementsConfig will hold the hardware requirements config
type HardwareRequirementsConfig struct {
CPUFlags []string
}
// FacadeConfig will hold different configuration option that will be passed to the node facade
type FacadeConfig struct {
RestApiInterface string
PprofEnabled bool
P2PPrometheusMetricsEnabled bool
}
// StateTriesConfig will hold information about state tries
type StateTriesConfig struct {
SnapshotsEnabled bool
AccountsStatePruningEnabled bool
PeerStatePruningEnabled bool
MaxStateTrieLevelInMemory uint
MaxPeerTrieLevelInMemory uint
StateStatisticsEnabled bool
}
// TrieStorageManagerConfig will hold config information about trie storage manager
type TrieStorageManagerConfig struct {
PruningBufferLen uint32
SnapshotsBufferLen uint32
SnapshotsGoroutineNum uint32
}
// EndpointsThrottlersConfig holds a pair of an endpoint and its maximum number of simultaneous go routines
type EndpointsThrottlersConfig struct {
Endpoint string
MaxNumGoRoutines int32
}
// WebServerAntifloodConfig will hold the anti-flooding parameters for the web server
type WebServerAntifloodConfig struct {
WebServerAntifloodEnabled bool
SimultaneousRequests uint32
SameSourceRequests uint32
SameSourceResetIntervalInSec uint32
TrieOperationsDeadlineMilliseconds uint32
GetAddressesBulkMaxSize uint32
VmQueryDelayAfterStartInSec uint32
EndpointsThrottlers []EndpointsThrottlersConfig
}
// BlackListConfig will hold the p2p peer black list threshold values
type BlackListConfig struct {
ThresholdNumMessagesPerInterval uint32
ThresholdSizePerInterval uint64
NumFloodingRounds uint32
PeerBanDurationInSeconds uint32
}
// TopicMaxMessagesConfig will hold the maximum number of messages/sec per topic value
type TopicMaxMessagesConfig struct {
Topic string
NumMessagesPerSec uint32
}
// TopicAntifloodConfig will hold the maximum values per second to be used in certain topics
type TopicAntifloodConfig struct {
DefaultMaxMessagesPerSec uint32
MaxMessages []TopicMaxMessagesConfig
}
// TxAccumulatorConfig will hold the tx accumulator config values
type TxAccumulatorConfig struct {
MaxAllowedTimeInMilliseconds uint32
MaxDeviationTimeInMilliseconds uint32
}
// AntifloodConfig will hold all p2p antiflood parameters
type AntifloodConfig struct {
Enabled bool
NumConcurrentResolverJobs int32
NumConcurrentResolvingTrieNodesJobs int32
OutOfSpecs FloodPreventerConfig
FastReacting FloodPreventerConfig
SlowReacting FloodPreventerConfig
PeerMaxOutput AntifloodLimitsConfig
Cache CacheConfig
Topic TopicAntifloodConfig
TxAccumulator TxAccumulatorConfig
}
// FloodPreventerConfig will hold all flood preventer parameters
type FloodPreventerConfig struct {
IntervalInSeconds uint32
ReservedPercent float32
PeerMaxInput AntifloodLimitsConfig
BlackList BlackListConfig
}
// AntifloodLimitsConfig will hold the maximum antiflood limits in both number of messages and total
// size of the messages
type AntifloodLimitsConfig struct {
BaseMessagesPerInterval uint32
TotalSizePerInterval uint64
IncreaseFactor IncreaseFactorConfig
}
// IncreaseFactorConfig defines the configurations used to increase the set values of a flood preventer
type IncreaseFactorConfig struct {
Threshold uint32
Factor float32
}
// VirtualMachineServicesConfig holds configuration for the Virtual Machine(s): both querying and execution services.
type VirtualMachineServicesConfig struct {
Execution VirtualMachineConfig
Querying QueryVirtualMachineConfig
GasConfig VirtualMachineGasConfig
}
// VirtualMachineConfig holds configuration for a Virtual Machine service
type VirtualMachineConfig struct {
WasmVMVersions []WasmVMVersionByEpoch
TimeOutForSCExecutionInMilliseconds uint32
WasmerSIGSEGVPassthrough bool
}
// WasmVMVersionByEpoch represents the Wasm VM version to be used starting with an epoch
type WasmVMVersionByEpoch struct {
StartEpoch uint32
Version string
}
// QueryVirtualMachineConfig holds the configuration for the virtual machine(s) used in query process
type QueryVirtualMachineConfig struct {
VirtualMachineConfig
NumConcurrentVMs int
}
// VirtualMachineGasConfig holds the configuration for the virtual machine(s) gas operations
type VirtualMachineGasConfig struct {
ShardMaxGasPerVmQuery uint64
MetaMaxGasPerVmQuery uint64
}
// BuiltInFunctionsConfig holds the configuration for the built-in functions
type BuiltInFunctionsConfig struct {
AutomaticCrawlerAddresses []string
MaxNumAddressesInTransferRole uint32
DNSV2Addresses []string
}
// HardforkConfig holds the configuration for the hardfork trigger
type HardforkConfig struct {
ExportStateStorageConfig StorageConfig
ExportKeysStorageConfig StorageConfig
ExportTriesStorageConfig StorageConfig
ImportStateStorageConfig StorageConfig
ImportKeysStorageConfig StorageConfig
PublicKeyToListenFrom string
ImportFolder string
GenesisTime int64
StartRound uint64
StartNonce uint64
CloseAfterExportInMinutes uint32
StartEpoch uint32
ValidatorGracePeriodInEpochs uint32
EnableTrigger bool
EnableTriggerFromP2P bool
MustImport bool
AfterHardFork bool
}
// LogsAndEventsConfig hold the configuration for the logs and events
type LogsAndEventsConfig struct {
SaveInStorageEnabled bool
TxLogsStorage StorageConfig
}
// DbLookupExtensionsConfig holds the configuration for the db lookup extensions
type DbLookupExtensionsConfig struct {
Enabled bool
DbLookupMaxActivePersisters uint32
MiniblocksMetadataStorageConfig StorageConfig
MiniblockHashByTxHashStorageConfig StorageConfig
EpochByHashStorageConfig StorageConfig
ResultsHashesByTxHashStorageConfig StorageConfig
ESDTSuppliesStorageConfig StorageConfig
RoundHashStorageConfig StorageConfig
}
// DebugConfig will hold debugging configuration
type DebugConfig struct {
InterceptorResolver InterceptorResolverDebugConfig
Antiflood AntifloodDebugConfig
ShuffleOut ShuffleOutDebugConfig
EpochStart EpochStartDebugConfig
Process ProcessDebugConfig
}
// HealthServiceConfig will hold health service (monitoring) configuration
type HealthServiceConfig struct {
IntervalVerifyMemoryInSeconds int
IntervalDiagnoseComponentsInSeconds int
IntervalDiagnoseComponentsDeeplyInSeconds int
MemoryUsageToCreateProfiles int
NumMemoryUsageRecordsToKeep int
FolderPath string
}
// InterceptorResolverDebugConfig will hold the interceptor-resolver debug configuration
type InterceptorResolverDebugConfig struct {
Enabled bool
EnablePrint bool
CacheSize int
IntervalAutoPrintInSeconds int
NumRequestsThreshold int
NumResolveFailureThreshold int
DebugLineExpiration int
}
// AntifloodDebugConfig will hold the antiflood debug configuration
type AntifloodDebugConfig struct {
Enabled bool
CacheSize int
IntervalAutoPrintInSeconds int
}
// ShuffleOutDebugConfig will hold the shuffle out debug configuration
type ShuffleOutDebugConfig struct {
CallGCWhenShuffleOut bool
ExtraPrintsOnShuffleOut bool
DoProfileOnShuffleOut bool
}
// EpochStartDebugConfig will hold the epoch debug configuration
type EpochStartDebugConfig struct {
GoRoutineAnalyserEnabled bool
ProcessDataTrieOnCommitEpoch bool
}
// ProcessDebugConfig will hold the process debug configuration
type ProcessDebugConfig struct {
Enabled bool
GoRoutinesDump bool
DebuggingLogLevel string
PollingTimeInSeconds int
RevertLogLevelTimeInSeconds int
}
// ApiRoutesConfig holds the configuration related to Rest API routes
type ApiRoutesConfig struct {
Logging ApiLoggingConfig
APIPackages map[string]APIPackageConfig
}
// ApiLoggingConfig holds the configuration related to API requests logging
type ApiLoggingConfig struct {
LoggingEnabled bool
ThresholdInMicroSeconds int
}
// APIPackageConfig holds the configuration for the routes of each package
type APIPackageConfig struct {
Routes []RouteConfig
}
// RouteConfig holds the configuration for a single route
type RouteConfig struct {
Name string
Open bool
}
// VersionByEpochs represents a version entry that will be applied between the provided epochs
type VersionByEpochs struct {
StartEpoch uint32
Version string
}
// VersionsConfig represents the versioning config area
type VersionsConfig struct {
DefaultVersion string
VersionsByEpochs []VersionByEpochs
Cache CacheConfig
}
// Configs is a holder for the node configuration parameters
type Configs struct {
GeneralConfig *Config
ApiRoutesConfig *ApiRoutesConfig
EconomicsConfig *EconomicsConfig
SystemSCConfig *SystemSmartContractsConfig
RatingsConfig *RatingsConfig
PreferencesConfig *Preferences
ExternalConfig *ExternalConfig
MainP2pConfig *p2pConfig.P2PConfig
FullArchiveP2pConfig *p2pConfig.P2PConfig
FlagsConfig *ContextFlagsConfig
ImportDbConfig *ImportDbConfig
ConfigurationPathsHolder *ConfigurationPathsHolder
EpochConfig *EpochConfig
RoundConfig *RoundConfig
}
// ConfigurationPathsHolder holds all configuration filenames and configuration paths used to start the node
type ConfigurationPathsHolder struct {
MainConfig string
ApiRoutes string
Economics string
SystemSC string
Ratings string
Preferences string
External string
MainP2p string
FullArchiveP2p string
GasScheduleDirectoryName string
Nodes string
Genesis string
SmartContracts string
ValidatorKey string
AllValidatorKeys string
Epoch string
RoundActivation string
P2pKey string
}
// TrieSyncConfig represents the trie synchronization configuration area
type TrieSyncConfig struct {
NumConcurrentTrieSyncers int
MaxHardCapForMissingNodes int
TrieSyncerVersion int
CheckNodesOnDisk bool
}
// RequesterConfig represents the config options to be used when setting up the requester instances
type RequesterConfig struct {
NumCrossShardPeers uint32
NumTotalPeers uint32
NumFullHistoryPeers uint32
}
// PoolsCleanersConfig represents the config options to be used by the pools cleaners
type PoolsCleanersConfig struct {
MaxRoundsToKeepUnprocessedMiniBlocks int64
MaxRoundsToKeepUnprocessedTransactions int64
}
// RedundancyConfig represents the config options to be used when setting the redundancy configuration
type RedundancyConfig struct {
MaxRoundsOfInactivityAccepted int
}