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