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 disables forcing the coordinator to forge a
116 // slot immediately when the slot is not committed. If set to false,
117 // the coordinator will immediately forge a batch at the beginning of a
118 // slot if it's the slot winner.
119 IgnoreSlotCommitment bool
120 // ForgeOncePerSlotIfTxs will make the coordinator forge at most one
121 // batch per slot, only if there are included txs in that batch, or
122 // pending l1UserTxs in the smart contract. Setting this parameter
123 // overrides `ForgeDelay`, `ForgeNoTxsDelay`, `MustForgeAtSlotDeadline`
124 // and `IgnoreSlotCommitment`.
125 ForgeOncePerSlotIfTxs bool
126 // SyncRetryInterval is the waiting interval between calls to the main
127 // handler of a synced block after an error
128 SyncRetryInterval Duration `validate:"required"`
129 // PurgeByExtDelInterval is the waiting interval between calls
130 // to the PurgeByExternalDelete function of the l2db which deletes
131 // pending txs externally marked by the column `external_delete`
132 PurgeByExtDelInterval Duration `validate:"required"`
133 // L2DB is the DB that holds the pool of L2Txs
134 L2DB struct {
135 // SafetyPeriod is the number of batches after which
136 // non-pending L2Txs are deleted from the pool
137 SafetyPeriod common.BatchNum `validate:"required"`
138 // MaxTxs is the maximum number of pending L2Txs that can be
139 // stored in the pool. Once this number of pending L2Txs is
140 // reached, inserts to the pool will be denied until some of
141 // the pending txs are forged.
142 MaxTxs uint32 `validate:"required"`
143 // MinFeeUSD is the minimum fee in USD that a tx must pay in
144 // order to be accepted into the pool. Txs with lower than
145 // minimum fee will be rejected at the API level.
146 MinFeeUSD float64
147 // TTL is the Time To Live for L2Txs in the pool. Once MaxTxs
148 // L2Txs is reached, L2Txs older than TTL will be deleted.
149 TTL Duration `validate:"required"`
150 // PurgeBatchDelay is the delay between batches to purge
151 // outdated transactions. Outdated L2Txs are those that have
152 // been forged or marked as invalid for longer than the
153 // SafetyPeriod and pending L2Txs that have been in the pool
154 // for longer than TTL once there are MaxTxs.
155 PurgeBatchDelay int64 `validate:"required"`
156 // InvalidateBatchDelay is the delay between batches to mark
157 // invalid transactions due to nonce lower than the account
158 // nonce.
159 InvalidateBatchDelay int64 `validate:"required"`
160 // PurgeBlockDelay is the delay between blocks to purge
161 // outdated transactions. Outdated L2Txs are those that have
162 // been forged or marked as invalid for longer than the
163 // SafetyPeriod and pending L2Txs that have been in the pool
164 // for longer than TTL once there are MaxTxs.
165 PurgeBlockDelay int64 `validate:"required"`
166 // InvalidateBlockDelay is the delay between blocks to mark
167 // invalid transactions due to nonce lower than the account
168 // nonce.
169 InvalidateBlockDelay int64 `validate:"required"`
170 } `validate:"required"`
171 TxSelector struct {
172 // Path where the TxSelector StateDB is stored
173 Path string `validate:"required"`
174 } `validate:"required"`
175 BatchBuilder struct {
176 // Path where the BatchBuilder StateDB is stored
177 Path string `validate:"required"`
178 } `validate:"required"`
179 ServerProofs []ServerProof `validate:"required"`
180 Circuit struct {
181 // MaxTx is the maximum number of txs supported by the circuit
182 MaxTx int64 `validate:"required"`
183 // NLevels is the maximum number of merkle tree levels
184 // supported by the circuit
185 NLevels int64 `validate:"required"`
186 } `validate:"required"`
187 EthClient struct {
188 // MaxGasPrice is the maximum gas price allowed for ethereum
189 // transactions
190 MaxGasPrice *big.Int `validate:"required"`
191 // GasPriceIncPerc is the percentage increase of gas price set
192 // in an ethereum transaction from the suggested gas price by
193 // the ethereum node
194 GasPriceIncPerc int64
195 // CheckLoopInterval is the waiting interval between receipt
196 // checks of ethereum transactions in the TxManager
197 CheckLoopInterval Duration `validate:"required"`
198 // Attempts is the number of attempts to do an eth client RPC
199 // call before giving up
200 Attempts int `validate:"required"`
201 // AttemptsDelay is delay between attempts do do an eth client
202 // RPC call
203 AttemptsDelay Duration `validate:"required"`
204 // TxResendTimeout is the timeout after which a non-mined
205 // ethereum transaction will be resent (reusing the nonce) with
206 // a newly calculated gas price
207 TxResendTimeout Duration `validate:"required"`
208 // NoReuseNonce disables reusing nonces of pending transactions for
209 // new replacement transactions
210 NoReuseNonce bool
211 // Keystore is the ethereum keystore where private keys are kept
212 Keystore struct {
213 // Path to the keystore
214 Path string `validate:"required"`
215 // Password used to decrypt the keys in the keystore
216 Password string `validate:"required"`
217 } `validate:"required"`
218 // ForgeBatchGasCost contains the cost of each action in the
219 // ForgeBatch transaction.
220 ForgeBatchGasCost ForgeBatchGasCost `validate:"required"`
221 } `validate:"required"`
222 API CoordinatorAPI `validate:"required"`
223 Debug struct {
224 // BatchPath if set, specifies the path where batchInfo is stored
225 // in JSON in every step/update of the pipeline
226 BatchPath string
227 // LightScrypt if set, uses light parameters for the ethereum
228 // keystore encryption algorithm.
229 LightScrypt bool
230 // RollupVerifierIndex is the index of the verifier to use in
231 // the Rollup smart contract. The verifier chosen by index
232 // must match with the Circuit parameters.
233 RollupVerifierIndex *int
234 }
235}
236
237// PostgreSQL is the postgreSQL configuration parameters. It's possible to use
238// diferentiated SQL connections for read/write. If the read configuration is
239// not provided, the write one it's going to be used for both reads and writes
240type PostgreSQL struct {
241 // Port of the PostgreSQL write server
242 PortWrite int `validate:"required"`
243 // Host of the PostgreSQL write server
244 HostWrite string `validate:"required"`
245 // User of the PostgreSQL write server
246 UserWrite string `validate:"required"`
247 // Password of the PostgreSQL write server
248 PasswordWrite string `validate:"required"`
249 // Name of the PostgreSQL write server database
250 NameWrite string `validate:"required"`
251 // Port of the PostgreSQL read server
252 PortRead int
253 // Host of the PostgreSQL read server
254 HostRead string
255 // User of the PostgreSQL read server
256 UserRead string
257 // Password of the PostgreSQL read server
258 PasswordRead string
259 // Name of the PostgreSQL read server database
260 NameRead string
261}
262
263// NodeDebug specifies debug configuration parameters
264type NodeDebug struct {
265 // APIAddress is the address where the debugAPI will listen if
266 // set
267 APIAddress string
268 // MeddlerLogs enables meddler debug mode, where unused columns and struct
269 // fields will be logged
270 MeddlerLogs bool
271 // GinDebugMode sets Gin-Gonic (the web framework) to run in
272 // debug mode
273 GinDebugMode bool
274}
275
276// Node is the hermez node configuration.
277type Node struct {
278 PriceUpdater struct {
279 // Interval between price updater calls
280 Interval Duration `validate:"required"`
281 // URLBitfinexV2 is the URL of bitfinex V2 API
282 URLBitfinexV2 string `validate:"required"`
283 // URLCoinGeckoV3 is the URL of coingecko V3 API
284 URLCoinGeckoV3 string `validate:"required"`
285 // DefaultUpdateMethod to get token prices
286 DefaultUpdateMethod priceupdater.UpdateMethodType `validate:"required"`
287 // TokensConfig to specify how each token get it's price updated
288 TokensConfig []priceupdater.TokenConfig
289 } `validate:"required"`
290 StateDB struct {
291 // Path where the synchronizer StateDB is stored
292 Path string `validate:"required"`
293 // Keep is the number of checkpoints to keep
294 Keep int `validate:"required"`
295 } `validate:"required"`
296 PostgreSQL PostgreSQL `validate:"required"`
297 Web3 struct {
298 // URL is the URL of the web3 ethereum-node RPC server
299 URL string `validate:"required"`
300 } `validate:"required"`
301 Synchronizer struct {
302 // SyncLoopInterval is the interval between attempts to
303 // synchronize a new block from an ethereum node
304 SyncLoopInterval Duration `validate:"required"`
305 // StatsRefreshPeriod is the interval between updates of the
306 // synchronizer state Eth parameters (`Eth.LastBlock` and
307 // `Eth.LastBatch`). This value only affects the reported % of
308 // synchronization of blocks and batches, nothing else.
309 StatsRefreshPeriod Duration `validate:"required"`
310 } `validate:"required"`
311 SmartContracts struct {
312 // Rollup is the address of the Hermez.sol smart contract
313 Rollup ethCommon.Address `validate:"required"`
314 // Rollup is the address of the HermezAuctionProtocol.sol smart
315 // contract
316 Auction ethCommon.Address `validate:"required"`
317 // WDelayer is the address of the WithdrawalDelayer.sol smart
318 // contract
319 WDelayer ethCommon.Address `validate:"required"`
320 // TokenHEZ is the address of the HEZTokenFull.sol smart
321 // contract
322 TokenHEZ ethCommon.Address `validate:"required"`
323 // TokenHEZName is the name of the HEZ token deployed at
324 // TokenHEZ address
325 TokenHEZName string `validate:"required"`
326 } `validate:"required"`
327 // API specifies the configuration parameters of the API
328 API struct {
329 // Address where the API will listen if set
330 Address string
331 // Explorer enables the Explorer API endpoints
332 Explorer bool
333 // UpdateMetricsInterval is the interval between updates of the
334 // API metrics
335 UpdateMetricsInterval Duration
336 // UpdateRecommendedFeeInterval is the interval between updates of the
337 // recommended fees
338 UpdateRecommendedFeeInterval Duration
339 // Maximum concurrent connections allowed between API and SQL
340 MaxSQLConnections int `validate:"required"`
341 // SQLConnectionTimeout is the maximum amount of time that an API request
342 // can wait to stablish a SQL connection
343 SQLConnectionTimeout Duration
344 } `validate:"required"`
345 Debug NodeDebug `validate:"required"`
346 Coordinator Coordinator `validate:"-"`
347}
348
349// APIServer is the api server configuration parameters
350type APIServer struct {
351 // NodeAPI specifies the configuration parameters of the API
352 API struct {
353 // Address where the API will listen if set
354 Address string `validate:"required"`
355 // Explorer enables the Explorer API endpoints
356 Explorer bool
357 // Maximum concurrent connections allowed between API and SQL
358 MaxSQLConnections int `validate:"required"`
359 // SQLConnectionTimeout is the maximum amount of time that an API request
360 // can wait to stablish a SQL connection
361 SQLConnectionTimeout Duration
362 } `validate:"required"`
363 PostgreSQL PostgreSQL `validate:"required"`
364 Coordinator struct {
365 API struct {
366 // Coordinator enables the coordinator API endpoints
367 Coordinator bool
368 } `validate:"required"`
369 L2DB struct {
370 // MaxTxs is the maximum number of pending L2Txs that can be
371 // stored in the pool. Once this number of pending L2Txs is
372 // reached, inserts to the pool will be denied until some of
373 // the pending txs are forged.
374 MaxTxs uint32 `validate:"required"`
375 // MinFeeUSD is the minimum fee in USD that a tx must pay in
376 // order to be accepted into the pool. Txs with lower than
377 // minimum fee will be rejected at the API level.
378 MinFeeUSD float64
379 } `validate:"required"`
380 }
381 Debug NodeDebug `validate:"required"`
382}
383
384// Load loads a generic config.
385func Load(path string, cfg interface{}) error {
386 bs, err := ioutil.ReadFile(path) //nolint:gosec
387 if err != nil {
388 return tracerr.Wrap(err)
389 }
390 cfgToml := string(bs)
391 if _, err := toml.Decode(cfgToml, cfg); err != nil {
392 return tracerr.Wrap(err)
393 }
394 return nil
395}
396
397// LoadNode loads the Node configuration from path.
398func LoadNode(path string, coordinator bool) (*Node, error) {
399 var cfg Node
400 if err := Load(path, &cfg); err != nil {
401 return nil, tracerr.Wrap(fmt.Errorf("error loading node configuration file: %w", err))
402 }
403 validate := validator.New()
404 if err := validate.Struct(cfg); err != nil {
405 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
406 }
407 if coordinator {
408 if err := validate.Struct(cfg.Coordinator); err != nil {
409 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
410 }
411 }
412 return &cfg, nil
413}
414
415// LoadAPIServer loads the APIServer configuration from path.
416func LoadAPIServer(path string, coordinator bool) (*APIServer, error) {
417 var cfg APIServer
418 if err := Load(path, &cfg); err != nil {
419 return nil, tracerr.Wrap(fmt.Errorf("error loading apiServer configuration file: %w", err))
420 }
421 validate := validator.New()
422 if err := validate.Struct(cfg); err != nil {
423 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
424 }
425 if coordinator {
426 if err := validate.Struct(cfg.Coordinator); err != nil {
427 return nil, tracerr.Wrap(fmt.Errorf("error validating configuration file: %w", err))
428 }
429 }
430 return &cfg, nil
431}