hermez-node/config/config.go
config/config.goRaw
1package config
2
3import (
4 "fmt"
5 "io/ioutil"
6 "math/big"
7 "time"
8
9 "github.com/BurntSushi/toml"
10 ethCommon "github.com/ethereum/go-ethereum/common"
11 "github.com/hermeznetwork/hermez-node/common"
12 "github.com/hermeznetwork/hermez-node/priceupdater"
13 "github.com/hermeznetwork/tracerr"
14 "github.com/iden3/go-iden3-crypto/babyjub"
15 "gopkg.in/go-playground/validator.v9"
16)
17
18// Duration is a wrapper type that parses time duration from text.
19type Duration struct {
20 time.Duration `validate:"required"`
21}
22
23// UnmarshalText unmarshalls time duration from text.
24func (d *Duration) UnmarshalText(data []byte) error {
25 duration, err := time.ParseDuration(string(data))
26 if err != nil {
27 return tracerr.Wrap(err)
28 }
29 d.Duration = duration
30 return nil
31}
32
33// ServerProof is the server proof configuration data.
34type ServerProof struct {
35 // URL is the server proof API URL
36 URL string `validate:"required"`
37}
38
39// ForgeBatchGasCost is the costs associated to a ForgeBatch transaction, split
40// into different parts to be used in a formula.
41type ForgeBatchGasCost struct {
42 Fixed uint64 `validate:"required"`
43 L1UserTx uint64 `validate:"required"`
44 L1CoordTx uint64 `validate:"required"`
45 L2Tx uint64 `validate:"required"`
46}
47
48// CoordinatorAPI specifies the configuration parameters of the API in mode
49// coordinator
50type CoordinatorAPI struct {
51 // Coordinator enables the coordinator API endpoints
52 Coordinator bool
53}
54
55// Coordinator is the coordinator specific configuration.
56type Coordinator struct {
57 // ForgerAddress is the address under which this coordinator is forging
58 ForgerAddress ethCommon.Address `validate:"required"`
59 // MinimumForgeAddressBalance is the minimum balance the forger address
60 // needs to start the coordinator in wei. Of set to 0, the coordinator
61 // will not check the balance before starting.
62 MinimumForgeAddressBalance *big.Int
63 // FeeAccount is the Hermez account that the coordinator uses to receive fees
64 FeeAccount struct {
65 // Address is the ethereum address of the account to receive fees
66 Address ethCommon.Address `validate:"required"`
67 // BJJ is the baby jub jub public key of the account to receive fees
68 BJJ babyjub.PublicKeyComp `validate:"required"`
69 } `validate:"required"`
70 // ConfirmBlocks is the number of confirmation blocks to wait for sent
71 // ethereum transactions before forgetting about them
72 ConfirmBlocks int64 `validate:"required"`
73 // L1BatchTimeoutPerc is the portion of the range before the L1Batch
74 // timeout that will trigger a schedule to forge an L1Batch
75 L1BatchTimeoutPerc float64 `validate:"required"`
76 // StartSlotBlocksDelay is the number of blocks of delay to wait before
77 // starting the pipeline when we reach a slot in which we can forge.
78 StartSlotBlocksDelay int64
79 // ScheduleBatchBlocksAheadCheck is the number of blocks ahead in which
80 // the forger address is checked to be allowed to forge (apart from
81 // checking the next block), used to decide when to stop scheduling new
82 // batches (by stopping the pipeline).
83 // For example, if we are at block 10 and ScheduleBatchBlocksAheadCheck
84 // is 5, even though at block 11 we canForge, the pipeline will be
85 // stopped if we can't forge at block 15.
86 // This value should be the expected number of blocks it takes between
87 // scheduling a batch and having it mined.
88 ScheduleBatchBlocksAheadCheck int64
89 // SendBatchBlocksMarginCheck is the number of margin blocks ahead in
90 // which the coordinator is also checked to be allowed to forge, apart
91 // from the next block; used to decide when to stop sending batches to
92 // the smart contract.
93 // For example, if we are at block 10 and SendBatchBlocksMarginCheck is
94 // 5, even though at block 11 we canForge, the batch will be discarded
95 // if we can't forge at block 15.
96 SendBatchBlocksMarginCheck int64
97 // ProofServerPollInterval is the waiting interval between polling the
98 // ProofServer while waiting for a particular status
99 ProofServerPollInterval Duration `validate:"required"`
100 // ForgeRetryInterval is the waiting interval between calls forge a
101 // batch after an error
102 ForgeRetryInterval Duration `validate:"required"`
103 // ForgeDelay is the delay after which a batch is forged if the slot is
104 // already committed. If set to 0s, the coordinator will continuously
105 // forge at the maximum rate.
106 ForgeDelay Duration `validate:"-"`
107 // ForgeNoTxsDelay is the delay after which a batch is forged even if
108 // there are no txs to forge if the slot is already committed. If set
109 // to 0s, the coordinator will continuously forge even if the batches
110 // are empty.
111 ForgeNoTxsDelay Duration `validate:"-"`
112 // MustForgeAtSlotDeadline enables the coordinator to forge slots if
113 // the empty slots reach the slot deadline.
114 MustForgeAtSlotDeadline bool
115 // IgnoreSlotCommitment IgnoreSlotCommitment disables forcing the
116 // coordinator to forge a slot immediately when the slot is not
117 // committed. If set to false, the coordinator will immediately forge
118 // a batch at the beginning of a slot if it's the slot winner.
119 IgnoreSlotCommitment bool
120 // SyncRetryInterval is the waiting interval between calls to the main
121 // handler of a synced block after an error
122 SyncRetryInterval Duration `validate:"required"`
123 // PurgeByExtDelInterval is the waiting interval between calls
124 // to the PurgeByExternalDelete function of the l2db which deletes
125 // pending txs externally marked by the column `external_delete`
126 PurgeByExtDelInterval Duration `validate:"required"`
127 // L2DB is the DB that holds the pool of L2Txs
128 L2DB struct {
129 // SafetyPeriod is the number of batches after which
130 // non-pending L2Txs are deleted from the pool
131 SafetyPeriod common.BatchNum `validate:"required"`
132 // MaxTxs is the maximum number of pending L2Txs that can be
133 // stored in the pool. Once this number of pending L2Txs is
134 // reached, inserts to the pool will be denied until some of
135 // the pending txs are forged.
136 MaxTxs uint32 `validate:"required"`
137 // MinFeeUSD is the minimum fee in USD that a tx must pay in
138 // order to be accepted into the pool. Txs with lower than
139 // minimum fee will be rejected at the API level.
140 MinFeeUSD float64
141 // TTL is the Time To Live for L2Txs in the pool. Once MaxTxs
142 // L2Txs is reached, L2Txs older than TTL will be deleted.
143 TTL Duration `validate:"required"`
144 // PurgeBatchDelay is the delay between batches to purge
145 // outdated transactions. Outdated L2Txs are those that have
146 // been forged or marked as invalid for longer than the
147 // SafetyPeriod and pending L2Txs that have been in the pool
148 // for longer than TTL once there are MaxTxs.
149 PurgeBatchDelay int64 `validate:"required"`
150 // InvalidateBatchDelay is the delay between batches to mark
151 // invalid transactions due to nonce lower than the account
152 // nonce.
153 InvalidateBatchDelay int64 `validate:"required"`
154 // PurgeBlockDelay is the delay between blocks to purge
155 // outdated transactions. Outdated L2Txs are those that have
156 // been forged or marked as invalid for longer than the
157 // SafetyPeriod and pending L2Txs that have been in the pool
158 // for longer than TTL once there are MaxTxs.
159 PurgeBlockDelay int64 `validate:"required"`
160 // InvalidateBlockDelay is the delay between blocks to mark
161 // invalid transactions due to nonce lower than the account
162 // nonce.
163 InvalidateBlockDelay int64 `validate:"required"`
164 } `validate:"required"`
165 TxSelector struct {
166 // Path where the TxSelector StateDB is stored
167 Path string `validate:"required"`
168 } `validate:"required"`
169 BatchBuilder struct {
170 // Path where the BatchBuilder StateDB is stored
171 Path string `validate:"required"`
172 } `validate:"required"`
173 ServerProofs []ServerProof `validate:"required"`
174 Circuit struct {
175 // MaxTx is the maximum number of txs supported by the circuit
176 MaxTx int64 `validate:"required"`
177 // NLevels is the maximum number of merkle tree levels
178 // supported by the circuit
179 NLevels int64 `validate:"required"`
180 } `validate:"required"`
181 EthClient struct {
182 // MaxGasPrice is the maximum gas price allowed for ethereum
183 // transactions
184 MaxGasPrice *big.Int `validate:"required"`
185 // GasPriceIncPerc is the percentage increase of gas price set
186 // in an ethereum transaction from the suggested gas price by
187 // the ethereum node
188 GasPriceIncPerc int64
189 // CheckLoopInterval is the waiting interval between receipt
190 // checks of ethereum transactions in the TxManager
191 CheckLoopInterval Duration `validate:"required"`
192 // Attempts is the number of attempts to do an eth client RPC
193 // call before giving up
194 Attempts int `validate:"required"`
195 // AttemptsDelay is delay between attempts do do an eth client
196 // RPC call
197 AttemptsDelay Duration `validate:"required"`
198 // TxResendTimeout is the timeout after which a non-mined
199 // ethereum transaction will be resent (reusing the nonce) with
200 // a newly calculated gas price
201 TxResendTimeout Duration `validate:"required"`
202 // NoReuseNonce disables reusing nonces of pending transactions for
203 // new replacement transactions
204 NoReuseNonce bool
205 // Keystore is the ethereum keystore where private keys are kept
206 Keystore struct {
207 // Path to the keystore
208 Path string `validate:"required"`
209 // Password used to decrypt the keys in the keystore
210 Password string `validate:"required"`
211 } `validate:"required"`
212 // ForgeBatchGasCost contains the cost of each action in the
213 // ForgeBatch transaction.
214 ForgeBatchGasCost ForgeBatchGasCost `validate:"required"`
215 } `validate:"required"`
216 API CoordinatorAPI `validate:"required"`
217 Debug struct {
218 // BatchPath if set, specifies the path where batchInfo is stored
219 // in JSON in every step/update of the pipeline
220 BatchPath string
221 // LightScrypt if set, uses light parameters for the ethereum
222 // keystore encryption algorithm.
223 LightScrypt bool
224 // RollupVerifierIndex is the index of the verifier to use in
225 // the Rollup smart contract. The verifier chosen by index
226 // must match with the Circuit parameters.
227 RollupVerifierIndex *int
228 }
229}
230
231// PostgreSQL is the postgreSQL configuration parameters. It's possible to use
232// diferentiated SQL connections for read/write. If the read configuration is
233// not provided, the write one it's going to be used for both reads and writes
234type PostgreSQL struct {
235 // Port of the PostgreSQL write server
236 PortWrite int `validate:"required"`
237 // Host of the PostgreSQL write server
238 HostWrite string `validate:"required"`
239 // User of the PostgreSQL write server
240 UserWrite string `validate:"required"`
241 // Password of the PostgreSQL write server
242 PasswordWrite string `validate:"required"`
243 // Name of the PostgreSQL write server database
244 NameWrite string `validate:"required"`
245 // Port of the PostgreSQL read server
246 PortRead int
247 // Host of the PostgreSQL read server
248 HostRead string
249 // User of the PostgreSQL read server
250 UserRead string
251 // Password of the PostgreSQL read server
252 PasswordRead string
253 // Name of the PostgreSQL read server database
254 NameRead string
255}
256
257// NodeDebug specifies debug configuration parameters
258type NodeDebug struct {
259 // APIAddress is the address where the debugAPI will listen if
260 // set
261 APIAddress string
262 // MeddlerLogs enables meddler debug mode, where unused columns and struct
263 // fields will be logged
264 MeddlerLogs bool
265 // GinDebugMode sets Gin-Gonic (the web framework) to run in
266 // debug mode
267 GinDebugMode bool
268}
269
270// Node is the hermez node configuration.
271type Node struct {
272 PriceUpdater struct {
273 // Interval between price updater calls
274 Interval Duration `validate:"required"`
275 // URLBitfinexV2 is the URL of bitfinex V2 API
276 URLBitfinexV2 string `validate:"required"`
277 // URLCoinGeckoV3 is the URL of coingecko V3 API
278 URLCoinGeckoV3 string `validate:"required"`
279 // DefaultUpdateMethod to get token prices
280 DefaultUpdateMethod priceupdater.UpdateMethodType `validate:"required"`
281 // TokensConfig to specify how each token get it's price updated
282 TokensConfig []priceupdater.TokenConfig
283 } `validate:"required"`
284 StateDB struct {
285 // Path where the synchronizer StateDB is stored
286 Path string `validate:"required"`
287 // Keep is the number of checkpoints to keep
288 Keep int `validate:"required"`
289 } `validate:"required"`
290 PostgreSQL PostgreSQL `validate:"required"`
291 Web3 struct {
292 // URL is the URL of the web3 ethereum-node RPC server
293 URL string `validate:"required"`
294 } `validate:"required"`
295 Synchronizer struct {
296 // SyncLoopInterval is the interval between attempts to
297 // synchronize a new block from an ethereum node
298 SyncLoopInterval Duration `validate:"required"`
299 // StatsRefreshPeriod is the interval between updates of the
300 // synchronizer state Eth parameters (`Eth.LastBlock` and
301 // `Eth.LastBatch`). This value only affects the reported % of
302 // synchronization of blocks and batches, nothing else.
303 StatsRefreshPeriod Duration `validate:"required"`
304 } `validate:"required"`
305 SmartContracts struct {
306 // Rollup is the address of the Hermez.sol smart contract
307 Rollup ethCommon.Address `validate:"required"`
308 // Rollup is the address of the HermezAuctionProtocol.sol smart
309 // contract
310 Auction ethCommon.Address `validate:"required"`
311 // WDelayer is the address of the WithdrawalDelayer.sol smart
312 // contract
313 WDelayer ethCommon.Address `validate:"required"`
314 // TokenHEZ is the address of the HEZTokenFull.sol smart
315 // contract
316 TokenHEZ ethCommon.Address `validate:"required"`
317 // TokenHEZName is the name of the HEZ token deployed at
318 // TokenHEZ address
319 TokenHEZName string `validate:"required"`
320 } `validate:"required"`
321 // API specifies the configuration parameters of the API
322 API struct {
323 // Address where the API will listen if set
324 Address string
325 // Explorer enables the Explorer API endpoints
326 Explorer bool
327 // UpdateMetricsInterval is the interval between updates of the
328 // API metrics
329 UpdateMetricsInterval Duration
330 // UpdateRecommendedFeeInterval is the interval between updates of the
331 // recommended fees
332 UpdateRecommendedFeeInterval Duration
333 // Maximum concurrent connections allowed between API and SQL
334 MaxSQLConnections int `validate:"required"`
335 // SQLConnectionTimeout is the maximum amount of time that an API request
336 // can wait to stablish a SQL connection
337 SQLConnectionTimeout Duration
338 } `validate:"required"`
339 Debug NodeDebug `validate:"required"`
340 Coordinator Coordinator `validate:"-"`
341}
342
343// APIServer is the api server configuration parameters
344type APIServer struct {
345 // NodeAPI specifies the configuration parameters of the API
346 API struct {
347 // Address where the API will listen if set
348 Address string `validate:"required"`
349 // Explorer enables the Explorer API endpoints
350 Explorer bool
351 // Maximum concurrent connections allowed between API and SQL
352 MaxSQLConnections int `validate:"required"`
353 // SQLConnectionTimeout is the maximum amount of time that an API request
354 // can wait to stablish a SQL connection
355 SQLConnectionTimeout Duration
356 } `validate:"required"`
357 PostgreSQL PostgreSQL `validate:"required"`
358 Coordinator struct {
359 API struct {
360 // Coordinator enables the coordinator API endpoints
361 Coordinator bool
362 } `validate:"required"`
363 L2DB struct {
364 // MaxTxs is the maximum number of pending L2Txs that can be
365 // stored in the pool. Once this number of pending L2Txs is
366 // reached, inserts to the pool will be denied until some of
367 // the pending txs are forged.
368 MaxTxs uint32 `validate:"required"`
369 // MinFeeUSD is the minimum fee in USD that a tx must pay in
370 // order to be accepted into the pool. Txs with lower than
371 // minimum fee will be rejected at the API level.
372 MinFeeUSD float64
373 } `validate:"required"`
374 }
375 Debug NodeDebug `validate:"required"`
376}
377
378// Load loads a generic config.
379func Load(path string, cfg interface{}) error {
380 bs, err := ioutil.ReadFile(path) //nolint:gosec
381 if err != nil {
382 return tracerr.Wrap(err)
383 }
384 cfgToml := string(bs)
385 if _, err := toml.Decode(cfgToml, cfg); err != nil {
386 return tracerr.Wrap(err)
387 }
388 return nil
389}
390
391// LoadNode loads the Node configuration from path.
392func LoadNode(path string, coordinator bool) (*Node, error) {
393 var cfg Node
394 if err := Load(path, &cfg); err != nil {
395 return nil, tracerr.Wrap(fmt.Errorf("error loading node configuration file: %w", err))
396 }
397 validate := validator.New()
398 if err := validate.Struct(cfg); err != nil {
399 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
400 }
401 if coordinator {
402 if err := validate.Struct(cfg.Coordinator); err != nil {
403 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
404 }
405 }
406 return &cfg, nil
407}
408
409// LoadAPIServer loads the APIServer configuration from path.
410func LoadAPIServer(path string, coordinator bool) (*APIServer, error) {
411 var cfg APIServer
412 if err := Load(path, &cfg); err != nil {
413 return nil, tracerr.Wrap(fmt.Errorf("error loading apiServer configuration file: %w", err))
414 }
415 validate := validator.New()
416 if err := validate.Struct(cfg); err != nil {
417 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
418 }
419 if coordinator {
420 if err := validate.Struct(cfg.Coordinator); err != nil {
421 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
422 }
423 }
424 return &cfg, nil
425}