hermez-node/db/historydb/historydb.go
db/historydb/historydb.goRaw
1package historydb
2
3import (
4 "math"
5 "math/big"
6 "strings"
7
8 ethCommon "github.com/ethereum/go-ethereum/common"
9 "github.com/hermeznetwork/hermez-node/common"
10 "github.com/hermeznetwork/hermez-node/db"
11 "github.com/hermeznetwork/tracerr"
12 "github.com/jmoiron/sqlx"
13
14 //nolint:errcheck // driver for postgres DB
15 _ "github.com/lib/pq"
16 "github.com/russross/meddler"
17)
18
19const (
20 // OrderAsc indicates ascending order when using pagination
21 OrderAsc = "ASC"
22 // OrderDesc indicates descending order when using pagination
23 OrderDesc = "DESC"
24)
25
26// TODO(Edu): Document here how HistoryDB is kept consistent
27
28// HistoryDB persist the historic of the rollup
29type HistoryDB struct {
30 db *sqlx.DB
31 apiConnCon *db.APIConnectionController
32}
33
34// NewHistoryDB initialize the DB
35func NewHistoryDB(db *sqlx.DB, apiConnCon *db.APIConnectionController) *HistoryDB {
36 return &HistoryDB{db: db, apiConnCon: apiConnCon}
37}
38
39// DB returns a pointer to the L2DB.db. This method should be used only for
40// internal testing purposes.
41func (hdb *HistoryDB) DB() *sqlx.DB {
42 return hdb.db
43}
44
45// AddBlock insert a block into the DB
46func (hdb *HistoryDB) AddBlock(block *common.Block) error { return hdb.addBlock(hdb.db, block) }
47func (hdb *HistoryDB) addBlock(d meddler.DB, block *common.Block) error {
48 return tracerr.Wrap(meddler.Insert(d, "block", block))
49}
50
51// AddBlocks inserts blocks into the DB
52func (hdb *HistoryDB) AddBlocks(blocks []common.Block) error {
53 return tracerr.Wrap(hdb.addBlocks(hdb.db, blocks))
54}
55
56func (hdb *HistoryDB) addBlocks(d meddler.DB, blocks []common.Block) error {
57 return tracerr.Wrap(db.BulkInsert(
58 d,
59 `INSERT INTO block (
60 eth_block_num,
61 timestamp,
62 hash
63 ) VALUES %s;`,
64 blocks[:],
65 ))
66}
67
68// GetBlock retrieve a block from the DB, given a block number
69func (hdb *HistoryDB) GetBlock(blockNum int64) (*common.Block, error) {
70 block := &common.Block{}
71 err := meddler.QueryRow(
72 hdb.db, block,
73 "SELECT * FROM block WHERE eth_block_num = $1;", blockNum,
74 )
75 return block, tracerr.Wrap(err)
76}
77
78// GetAllBlocks retrieve all blocks from the DB
79func (hdb *HistoryDB) GetAllBlocks() ([]common.Block, error) {
80 var blocks []*common.Block
81 err := meddler.QueryAll(
82 hdb.db, &blocks,
83 "SELECT * FROM block ORDER BY eth_block_num;",
84 )
85 return db.SlicePtrsToSlice(blocks).([]common.Block), tracerr.Wrap(err)
86}
87
88// getBlocks retrieve blocks from the DB, given a range of block numbers defined by from and to
89func (hdb *HistoryDB) getBlocks(from, to int64) ([]common.Block, error) {
90 var blocks []*common.Block
91 err := meddler.QueryAll(
92 hdb.db, &blocks,
93 "SELECT * FROM block WHERE $1 <= eth_block_num AND eth_block_num < $2 ORDER BY eth_block_num;",
94 from, to,
95 )
96 return db.SlicePtrsToSlice(blocks).([]common.Block), tracerr.Wrap(err)
97}
98
99// GetLastBlock retrieve the block with the highest block number from the DB
100func (hdb *HistoryDB) GetLastBlock() (*common.Block, error) {
101 block := &common.Block{}
102 err := meddler.QueryRow(
103 hdb.db, block, "SELECT * FROM block ORDER BY eth_block_num DESC LIMIT 1;",
104 )
105 return block, tracerr.Wrap(err)
106}
107
108// AddBatch insert a Batch into the DB
109func (hdb *HistoryDB) AddBatch(batch *common.Batch) error { return hdb.addBatch(hdb.db, batch) }
110func (hdb *HistoryDB) addBatch(d meddler.DB, batch *common.Batch) error {
111 // Calculate total collected fees in USD
112 // Get IDs of collected tokens for fees
113 tokenIDs := []common.TokenID{}
114 for id := range batch.CollectedFees {
115 tokenIDs = append(tokenIDs, id)
116 }
117 // Get USD value of the tokens
118 type tokenPrice struct {
119 ID common.TokenID `meddler:"token_id"`
120 USD *float64 `meddler:"usd"`
121 Decimals int `meddler:"decimals"`
122 }
123 var tokenPrices []*tokenPrice
124 if len(tokenIDs) > 0 {
125 query, args, err := sqlx.In(
126 "SELECT token_id, usd, decimals FROM token WHERE token_id IN (?);",
127 tokenIDs,
128 )
129 if err != nil {
130 return tracerr.Wrap(err)
131 }
132 query = hdb.db.Rebind(query)
133 if err := meddler.QueryAll(
134 hdb.db, &tokenPrices, query, args...,
135 ); err != nil {
136 return tracerr.Wrap(err)
137 }
138 }
139 // Calculate total collected
140 var total float64
141 for _, tokenPrice := range tokenPrices {
142 if tokenPrice.USD == nil {
143 continue
144 }
145 f := new(big.Float).SetInt(batch.CollectedFees[tokenPrice.ID])
146 amount, _ := f.Float64()
147 total += *tokenPrice.USD * (amount / math.Pow(10, float64(tokenPrice.Decimals))) //nolint decimals have to be ^10
148 }
149 batch.TotalFeesUSD = &total
150 // Insert to DB
151 return tracerr.Wrap(meddler.Insert(d, "batch", batch))
152}
153
154// AddBatches insert Bids into the DB
155func (hdb *HistoryDB) AddBatches(batches []common.Batch) error {
156 return tracerr.Wrap(hdb.addBatches(hdb.db, batches))
157}
158func (hdb *HistoryDB) addBatches(d meddler.DB, batches []common.Batch) error {
159 for i := 0; i < len(batches); i++ {
160 if err := hdb.addBatch(d, &batches[i]); err != nil {
161 return tracerr.Wrap(err)
162 }
163 }
164 return nil
165}
166
167// GetBatch returns the batch with the given batchNum
168func (hdb *HistoryDB) GetBatch(batchNum common.BatchNum) (*common.Batch, error) {
169 var batch common.Batch
170 err := meddler.QueryRow(
171 hdb.db, &batch, `SELECT batch.batch_num, batch.eth_block_num, batch.forger_addr,
172 batch.fees_collected, batch.fee_idxs_coordinator, batch.state_root,
173 batch.num_accounts, batch.last_idx, batch.exit_root, batch.forge_l1_txs_num,
174 batch.slot_num, batch.total_fees_usd FROM batch WHERE batch_num = $1;`,
175 batchNum,
176 )
177 return &batch, err
178}
179
180// GetAllBatches retrieve all batches from the DB
181func (hdb *HistoryDB) GetAllBatches() ([]common.Batch, error) {
182 var batches []*common.Batch
183 err := meddler.QueryAll(
184 hdb.db, &batches,
185 `SELECT batch.batch_num, batch.eth_block_num, batch.forger_addr, batch.fees_collected,
186 batch.fee_idxs_coordinator, batch.state_root, batch.num_accounts, batch.last_idx, batch.exit_root,
187 batch.forge_l1_txs_num, batch.slot_num, batch.total_fees_usd FROM batch
188 ORDER BY item_id;`,
189 )
190 return db.SlicePtrsToSlice(batches).([]common.Batch), tracerr.Wrap(err)
191}
192
193// GetBatches retrieve batches from the DB, given a range of batch numbers defined by from and to
194func (hdb *HistoryDB) GetBatches(from, to common.BatchNum) ([]common.Batch, error) {
195 var batches []*common.Batch
196 err := meddler.QueryAll(
197 hdb.db, &batches,
198 `SELECT batch_num, eth_block_num, forger_addr, fees_collected, fee_idxs_coordinator,
199 state_root, num_accounts, last_idx, exit_root, forge_l1_txs_num, slot_num, total_fees_usd
200 FROM batch WHERE $1 <= batch_num AND batch_num < $2 ORDER BY batch_num;`,
201 from, to,
202 )
203 return db.SlicePtrsToSlice(batches).([]common.Batch), tracerr.Wrap(err)
204}
205
206// GetFirstBatchBlockNumBySlot returns the ethereum block number of the first
207// batch within a slot
208func (hdb *HistoryDB) GetFirstBatchBlockNumBySlot(slotNum int64) (int64, error) {
209 row := hdb.db.QueryRow(
210 `SELECT eth_block_num FROM batch
211 WHERE slot_num = $1 ORDER BY batch_num ASC LIMIT 1;`, slotNum,
212 )
213 var blockNum int64
214 return blockNum, tracerr.Wrap(row.Scan(&blockNum))
215}
216
217// GetLastBatchNum returns the BatchNum of the latest forged batch
218func (hdb *HistoryDB) GetLastBatchNum() (common.BatchNum, error) {
219 row := hdb.db.QueryRow("SELECT batch_num FROM batch ORDER BY batch_num DESC LIMIT 1;")
220 var batchNum common.BatchNum
221 return batchNum, tracerr.Wrap(row.Scan(&batchNum))
222}
223
224// GetLastBatch returns the last forged batch
225func (hdb *HistoryDB) GetLastBatch() (*common.Batch, error) {
226 var batch common.Batch
227 err := meddler.QueryRow(
228 hdb.db, &batch, `SELECT batch.batch_num, batch.eth_block_num, batch.forger_addr,
229 batch.fees_collected, batch.fee_idxs_coordinator, batch.state_root,
230 batch.num_accounts, batch.last_idx, batch.exit_root, batch.forge_l1_txs_num,
231 batch.slot_num, batch.total_fees_usd FROM batch ORDER BY batch_num DESC LIMIT 1;`,
232 )
233 return &batch, err
234}
235
236// GetLastL1BatchBlockNum returns the blockNum of the latest forged l1Batch
237func (hdb *HistoryDB) GetLastL1BatchBlockNum() (int64, error) {
238 row := hdb.db.QueryRow(`SELECT eth_block_num FROM batch
239 WHERE forge_l1_txs_num IS NOT NULL
240 ORDER BY batch_num DESC LIMIT 1;`)
241 var blockNum int64
242 return blockNum, tracerr.Wrap(row.Scan(&blockNum))
243}
244
245// GetLastL1TxsNum returns the greatest ForgeL1TxsNum in the DB from forged
246// batches. If there's no batch in the DB (nil, nil) is returned.
247func (hdb *HistoryDB) GetLastL1TxsNum() (*int64, error) {
248 row := hdb.db.QueryRow("SELECT MAX(forge_l1_txs_num) FROM batch;")
249 lastL1TxsNum := new(int64)
250 return lastL1TxsNum, tracerr.Wrap(row.Scan(&lastL1TxsNum))
251}
252
253// Reorg deletes all the information that was added into the DB after the
254// lastValidBlock. If lastValidBlock is negative, all block information is
255// deleted.
256func (hdb *HistoryDB) Reorg(lastValidBlock int64) error {
257 var err error
258 if lastValidBlock < 0 {
259 _, err = hdb.db.Exec("DELETE FROM block;")
260 } else {
261 _, err = hdb.db.Exec("DELETE FROM block WHERE eth_block_num > $1;", lastValidBlock)
262 }
263 return tracerr.Wrap(err)
264}
265
266// AddBids insert Bids into the DB
267func (hdb *HistoryDB) AddBids(bids []common.Bid) error { return hdb.addBids(hdb.db, bids) }
268func (hdb *HistoryDB) addBids(d meddler.DB, bids []common.Bid) error {
269 if len(bids) == 0 {
270 return nil
271 }
272 // TODO: check the coordinator info
273 return tracerr.Wrap(db.BulkInsert(
274 d,
275 "INSERT INTO bid (slot_num, bid_value, eth_block_num, bidder_addr) VALUES %s;",
276 bids[:],
277 ))
278}
279
280// GetAllBids retrieve all bids from the DB
281func (hdb *HistoryDB) GetAllBids() ([]common.Bid, error) {
282 var bids []*common.Bid
283 err := meddler.QueryAll(
284 hdb.db, &bids,
285 `SELECT bid.slot_num, bid.bid_value, bid.eth_block_num, bid.bidder_addr FROM bid
286 ORDER BY item_id;`,
287 )
288 return db.SlicePtrsToSlice(bids).([]common.Bid), tracerr.Wrap(err)
289}
290
291// GetBestBidCoordinator returns the forger address of the highest bidder in a slot by slotNum
292func (hdb *HistoryDB) GetBestBidCoordinator(slotNum int64) (*common.BidCoordinator, error) {
293 bidCoord := &common.BidCoordinator{}
294 err := meddler.QueryRow(
295 hdb.db, bidCoord,
296 `SELECT (
297 SELECT default_slot_set_bid
298 FROM auction_vars
299 WHERE default_slot_set_bid_slot_num <= $1
300 ORDER BY eth_block_num DESC LIMIT 1
301 ),
302 bid.slot_num, bid.bid_value, bid.bidder_addr,
303 coordinator.forger_addr, coordinator.url
304 FROM bid
305 INNER JOIN (
306 SELECT bidder_addr, MAX(item_id) AS item_id FROM coordinator
307 GROUP BY bidder_addr
308 ) c ON bid.bidder_addr = c.bidder_addr
309 INNER JOIN coordinator ON c.item_id = coordinator.item_id
310 WHERE bid.slot_num = $1 ORDER BY bid.item_id DESC LIMIT 1;`,
311 slotNum)
312
313 return bidCoord, tracerr.Wrap(err)
314}
315
316// AddCoordinators insert Coordinators into the DB
317func (hdb *HistoryDB) AddCoordinators(coordinators []common.Coordinator) error {
318 return tracerr.Wrap(hdb.addCoordinators(hdb.db, coordinators))
319}
320func (hdb *HistoryDB) addCoordinators(d meddler.DB, coordinators []common.Coordinator) error {
321 if len(coordinators) == 0 {
322 return nil
323 }
324 return tracerr.Wrap(db.BulkInsert(
325 d,
326 "INSERT INTO coordinator (bidder_addr, forger_addr, eth_block_num, url) VALUES %s;",
327 coordinators[:],
328 ))
329}
330
331// AddExitTree insert Exit tree into the DB
332func (hdb *HistoryDB) AddExitTree(exitTree []common.ExitInfo) error {
333 return tracerr.Wrap(hdb.addExitTree(hdb.db, exitTree))
334}
335func (hdb *HistoryDB) addExitTree(d meddler.DB, exitTree []common.ExitInfo) error {
336 if len(exitTree) == 0 {
337 return nil
338 }
339 return tracerr.Wrap(db.BulkInsert(
340 d,
341 "INSERT INTO exit_tree (batch_num, account_idx, merkle_proof, balance, "+
342 "instant_withdrawn, delayed_withdraw_request, delayed_withdrawn) VALUES %s;",
343 exitTree[:],
344 ))
345}
346
347func (hdb *HistoryDB) updateExitTree(d sqlx.Ext, blockNum int64,
348 rollupWithdrawals []common.WithdrawInfo, wDelayerWithdrawals []common.WDelayerTransfer) error {
349 if len(rollupWithdrawals) == 0 && len(wDelayerWithdrawals) == 0 {
350 return nil
351 }
352 type withdrawal struct {
353 BatchNum int64 `db:"batch_num"`
354 AccountIdx int64 `db:"account_idx"`
355 InstantWithdrawn *int64 `db:"instant_withdrawn"`
356 DelayedWithdrawRequest *int64 `db:"delayed_withdraw_request"`
357 DelayedWithdrawn *int64 `db:"delayed_withdrawn"`
358 Owner *ethCommon.Address `db:"owner"`
359 Token *ethCommon.Address `db:"token"`
360 }
361 withdrawals := make([]withdrawal, len(rollupWithdrawals)+len(wDelayerWithdrawals))
362 for i := range rollupWithdrawals {
363 info := &rollupWithdrawals[i]
364 withdrawals[i] = withdrawal{
365 BatchNum: int64(info.NumExitRoot),
366 AccountIdx: int64(info.Idx),
367 }
368 if info.InstantWithdraw {
369 withdrawals[i].InstantWithdrawn = &blockNum
370 } else {
371 withdrawals[i].DelayedWithdrawRequest = &blockNum
372 withdrawals[i].Owner = &info.Owner
373 withdrawals[i].Token = &info.Token
374 }
375 }
376 for i := range wDelayerWithdrawals {
377 info := &wDelayerWithdrawals[i]
378 withdrawals[len(rollupWithdrawals)+i] = withdrawal{
379 DelayedWithdrawn: &blockNum,
380 Owner: &info.Owner,
381 Token: &info.Token,
382 }
383 }
384 // In VALUES we set an initial row of NULLs to set the types of each
385 // variable passed as argument
386 const query string = `
387 UPDATE exit_tree e SET
388 instant_withdrawn = d.instant_withdrawn,
389 delayed_withdraw_request = CASE
390 WHEN e.delayed_withdraw_request IS NOT NULL THEN e.delayed_withdraw_request
391 ELSE d.delayed_withdraw_request
392 END,
393 delayed_withdrawn = d.delayed_withdrawn,
394 owner = d.owner,
395 token = d.token
396 FROM (VALUES
397 (NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BYTEA, NULL::::BYTEA),
398 (:batch_num,
399 :account_idx,
400 :instant_withdrawn,
401 :delayed_withdraw_request,
402 :delayed_withdrawn,
403 :owner,
404 :token)
405 ) as d (batch_num, account_idx, instant_withdrawn, delayed_withdraw_request, delayed_withdrawn, owner, token)
406 WHERE
407 (d.batch_num IS NOT NULL AND e.batch_num = d.batch_num AND e.account_idx = d.account_idx) OR
408 (d.delayed_withdrawn IS NOT NULL AND e.delayed_withdrawn IS NULL AND e.owner = d.owner AND e.token = d.token);
409 `
410 if len(withdrawals) > 0 {
411 if _, err := sqlx.NamedExec(d, query, withdrawals); err != nil {
412 return tracerr.Wrap(err)
413 }
414 }
415
416 return nil
417}
418
419// AddToken insert a token into the DB
420func (hdb *HistoryDB) AddToken(token *common.Token) error {
421 return tracerr.Wrap(meddler.Insert(hdb.db, "token", token))
422}
423
424// AddTokens insert tokens into the DB
425func (hdb *HistoryDB) AddTokens(tokens []common.Token) error { return hdb.addTokens(hdb.db, tokens) }
426func (hdb *HistoryDB) addTokens(d meddler.DB, tokens []common.Token) error {
427 if len(tokens) == 0 {
428 return nil
429 }
430 // Sanitize name and symbol
431 for i, token := range tokens {
432 token.Name = strings.ToValidUTF8(token.Name, " ")
433 token.Symbol = strings.ToValidUTF8(token.Symbol, " ")
434 tokens[i] = token
435 }
436 return tracerr.Wrap(db.BulkInsert(
437 d,
438 `INSERT INTO token (
439 token_id,
440 eth_block_num,
441 eth_addr,
442 name,
443 symbol,
444 decimals
445 ) VALUES %s;`,
446 tokens[:],
447 ))
448}
449
450// UpdateTokenValue updates the USD value of a token
451func (hdb *HistoryDB) UpdateTokenValue(tokenSymbol string, value float64) error {
452 // Sanitize symbol
453 tokenSymbol = strings.ToValidUTF8(tokenSymbol, " ")
454
455 _, err := hdb.db.Exec(
456 "UPDATE token SET usd = $1 WHERE symbol = $2;",
457 value, tokenSymbol,
458 )
459 return tracerr.Wrap(err)
460}
461
462// GetToken returns a token from the DB given a TokenID
463func (hdb *HistoryDB) GetToken(tokenID common.TokenID) (*TokenWithUSD, error) {
464 token := &TokenWithUSD{}
465 err := meddler.QueryRow(
466 hdb.db, token, `SELECT * FROM token WHERE token_id = $1;`, tokenID,
467 )
468 return token, tracerr.Wrap(err)
469}
470
471// GetAllTokens returns all tokens from the DB
472func (hdb *HistoryDB) GetAllTokens() ([]TokenWithUSD, error) {
473 var tokens []*TokenWithUSD
474 err := meddler.QueryAll(
475 hdb.db, &tokens,
476 "SELECT * FROM token ORDER BY token_id;",
477 )
478 return db.SlicePtrsToSlice(tokens).([]TokenWithUSD), tracerr.Wrap(err)
479}
480
481// GetTokenSymbols returns all the token symbols from the DB
482func (hdb *HistoryDB) GetTokenSymbols() ([]string, error) {
483 var tokenSymbols []string
484 rows, err := hdb.db.Query("SELECT symbol FROM token;")
485 if err != nil {
486 return nil, tracerr.Wrap(err)
487 }
488 defer db.RowsClose(rows)
489 sym := new(string)
490 for rows.Next() {
491 err = rows.Scan(sym)
492 if err != nil {
493 return nil, tracerr.Wrap(err)
494 }
495 tokenSymbols = append(tokenSymbols, *sym)
496 }
497 return tokenSymbols, nil
498}
499
500// AddAccounts insert accounts into the DB
501func (hdb *HistoryDB) AddAccounts(accounts []common.Account) error {
502 return tracerr.Wrap(hdb.addAccounts(hdb.db, accounts))
503}
504func (hdb *HistoryDB) addAccounts(d meddler.DB, accounts []common.Account) error {
505 if len(accounts) == 0 {
506 return nil
507 }
508 return tracerr.Wrap(db.BulkInsert(
509 d,
510 `INSERT INTO account (
511 idx,
512 token_id,
513 batch_num,
514 bjj,
515 eth_addr
516 ) VALUES %s;`,
517 accounts[:],
518 ))
519}
520
521// GetAllAccounts returns a list of accounts from the DB
522func (hdb *HistoryDB) GetAllAccounts() ([]common.Account, error) {
523 var accs []*common.Account
524 err := meddler.QueryAll(
525 hdb.db, &accs,
526 "SELECT idx, token_id, batch_num, bjj, eth_addr FROM account ORDER BY idx;",
527 )
528 return db.SlicePtrsToSlice(accs).([]common.Account), tracerr.Wrap(err)
529}
530
531// AddL1Txs inserts L1 txs to the DB. USD and DepositAmountUSD will be set automatically before storing the tx.
532// If the tx is originated by a coordinator, BatchNum must be provided. If it's originated by a user,
533// BatchNum should be null, and the value will be setted by a trigger when a batch forges the tx.
534// EffectiveAmount and EffectiveDepositAmount are seted with default values by the DB.
535func (hdb *HistoryDB) AddL1Txs(l1txs []common.L1Tx) error {
536 return tracerr.Wrap(hdb.addL1Txs(hdb.db, l1txs))
537}
538
539// addL1Txs inserts L1 txs to the DB. USD and DepositAmountUSD will be set automatically before storing the tx.
540// If the tx is originated by a coordinator, BatchNum must be provided. If it's originated by a user,
541// BatchNum should be null, and the value will be setted by a trigger when a batch forges the tx.
542// EffectiveAmount and EffectiveDepositAmount are seted with default values by the DB.
543func (hdb *HistoryDB) addL1Txs(d meddler.DB, l1txs []common.L1Tx) error {
544 if len(l1txs) == 0 {
545 return nil
546 }
547 txs := []txWrite{}
548 for i := 0; i < len(l1txs); i++ {
549 af := new(big.Float).SetInt(l1txs[i].Amount)
550 amountFloat, _ := af.Float64()
551 laf := new(big.Float).SetInt(l1txs[i].DepositAmount)
552 depositAmountFloat, _ := laf.Float64()
553 var effectiveFromIdx *common.Idx
554 if l1txs[i].UserOrigin {
555 if l1txs[i].Type != common.TxTypeCreateAccountDeposit &&
556 l1txs[i].Type != common.TxTypeCreateAccountDepositTransfer {
557 effectiveFromIdx = &l1txs[i].FromIdx
558 }
559 } else {
560 effectiveFromIdx = &l1txs[i].EffectiveFromIdx
561 }
562 txs = append(txs, txWrite{
563 // Generic
564 IsL1: true,
565 TxID: l1txs[i].TxID,
566 Type: l1txs[i].Type,
567 Position: l1txs[i].Position,
568 FromIdx: &l1txs[i].FromIdx,
569 EffectiveFromIdx: effectiveFromIdx,
570 ToIdx: l1txs[i].ToIdx,
571 Amount: l1txs[i].Amount,
572 AmountFloat: amountFloat,
573 TokenID: l1txs[i].TokenID,
574 BatchNum: l1txs[i].BatchNum,
575 EthBlockNum: l1txs[i].EthBlockNum,
576 // L1
577 ToForgeL1TxsNum: l1txs[i].ToForgeL1TxsNum,
578 UserOrigin: &l1txs[i].UserOrigin,
579 FromEthAddr: &l1txs[i].FromEthAddr,
580 FromBJJ: &l1txs[i].FromBJJ,
581 DepositAmount: l1txs[i].DepositAmount,
582 DepositAmountFloat: &depositAmountFloat,
583 })
584 }
585 return tracerr.Wrap(hdb.addTxs(d, txs))
586}
587
588// AddL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
589func (hdb *HistoryDB) AddL2Txs(l2txs []common.L2Tx) error {
590 return tracerr.Wrap(hdb.addL2Txs(hdb.db, l2txs))
591}
592
593// addL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
594func (hdb *HistoryDB) addL2Txs(d meddler.DB, l2txs []common.L2Tx) error {
595 txs := []txWrite{}
596 for i := 0; i < len(l2txs); i++ {
597 f := new(big.Float).SetInt(l2txs[i].Amount)
598 amountFloat, _ := f.Float64()
599 txs = append(txs, txWrite{
600 // Generic
601 IsL1: false,
602 TxID: l2txs[i].TxID,
603 Type: l2txs[i].Type,
604 Position: l2txs[i].Position,
605 FromIdx: &l2txs[i].FromIdx,
606 EffectiveFromIdx: &l2txs[i].FromIdx,
607 ToIdx: l2txs[i].ToIdx,
608 TokenID: l2txs[i].TokenID,
609 Amount: l2txs[i].Amount,
610 AmountFloat: amountFloat,
611 BatchNum: &l2txs[i].BatchNum,
612 EthBlockNum: l2txs[i].EthBlockNum,
613 // L2
614 Fee: &l2txs[i].Fee,
615 Nonce: &l2txs[i].Nonce,
616 })
617 }
618 return tracerr.Wrap(hdb.addTxs(d, txs))
619}
620
621func (hdb *HistoryDB) addTxs(d meddler.DB, txs []txWrite) error {
622 if len(txs) == 0 {
623 return nil
624 }
625 return tracerr.Wrap(db.BulkInsert(
626 d,
627 `INSERT INTO tx (
628 is_l1,
629 id,
630 type,
631 position,
632 from_idx,
633 effective_from_idx,
634 to_idx,
635 amount,
636 amount_f,
637 token_id,
638 batch_num,
639 eth_block_num,
640 to_forge_l1_txs_num,
641 user_origin,
642 from_eth_addr,
643 from_bjj,
644 deposit_amount,
645 deposit_amount_f,
646 fee,
647 nonce
648 ) VALUES %s;`,
649 txs[:],
650 ))
651}
652
653// GetAllExits returns all exit from the DB
654func (hdb *HistoryDB) GetAllExits() ([]common.ExitInfo, error) {
655 var exits []*common.ExitInfo
656 err := meddler.QueryAll(
657 hdb.db, &exits,
658 `SELECT exit_tree.batch_num, exit_tree.account_idx, exit_tree.merkle_proof,
659 exit_tree.balance, exit_tree.instant_withdrawn, exit_tree.delayed_withdraw_request,
660 exit_tree.delayed_withdrawn FROM exit_tree ORDER BY item_id;`,
661 )
662 return db.SlicePtrsToSlice(exits).([]common.ExitInfo), tracerr.Wrap(err)
663}
664
665// GetAllL1UserTxs returns all L1UserTxs from the DB
666func (hdb *HistoryDB) GetAllL1UserTxs() ([]common.L1Tx, error) {
667 var txs []*common.L1Tx
668 err := meddler.QueryAll(
669 hdb.db, &txs, // Note that '\x' gets parsed as a big.Int with value = 0
670 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
671 tx.from_idx, tx.effective_from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
672 tx.amount, (CASE WHEN tx.batch_num IS NULL THEN NULL WHEN tx.amount_success THEN tx.amount ELSE '\x' END) AS effective_amount,
673 tx.deposit_amount, (CASE WHEN tx.batch_num IS NULL THEN NULL WHEN tx.deposit_amount_success THEN tx.deposit_amount ELSE '\x' END) AS effective_deposit_amount,
674 tx.eth_block_num, tx.type, tx.batch_num
675 FROM tx WHERE is_l1 = TRUE AND user_origin = TRUE ORDER BY item_id;`,
676 )
677 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
678}
679
680// GetAllL1CoordinatorTxs returns all L1CoordinatorTxs from the DB
681func (hdb *HistoryDB) GetAllL1CoordinatorTxs() ([]common.L1Tx, error) {
682 var txs []*common.L1Tx
683 // Since the query specifies that only coordinator txs are returned, it's safe to assume
684 // that returned txs will always have effective amounts
685 err := meddler.QueryAll(
686 hdb.db, &txs,
687 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
688 tx.from_idx, tx.effective_from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
689 tx.amount, tx.amount AS effective_amount,
690 tx.deposit_amount, tx.deposit_amount AS effective_deposit_amount,
691 tx.eth_block_num, tx.type, tx.batch_num
692 FROM tx WHERE is_l1 = TRUE AND user_origin = FALSE ORDER BY item_id;`,
693 )
694 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
695}
696
697// GetAllL2Txs returns all L2Txs from the DB
698func (hdb *HistoryDB) GetAllL2Txs() ([]common.L2Tx, error) {
699 var txs []*common.L2Tx
700 err := meddler.QueryAll(
701 hdb.db, &txs,
702 `SELECT tx.id, tx.batch_num, tx.position,
703 tx.from_idx, tx.to_idx, tx.amount, tx.token_id,
704 tx.fee, tx.nonce, tx.type, tx.eth_block_num
705 FROM tx WHERE is_l1 = FALSE ORDER BY item_id;`,
706 )
707 return db.SlicePtrsToSlice(txs).([]common.L2Tx), tracerr.Wrap(err)
708}
709
710// GetUnforgedL1UserTxs gets L1 User Txs to be forged in the L1Batch with toForgeL1TxsNum.
711func (hdb *HistoryDB) GetUnforgedL1UserTxs(toForgeL1TxsNum int64) ([]common.L1Tx, error) {
712 var txs []*common.L1Tx
713 err := meddler.QueryAll(
714 hdb.db, &txs, // only L1 user txs can have batch_num set to null
715 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
716 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
717 tx.amount, NULL AS effective_amount,
718 tx.deposit_amount, NULL AS effective_deposit_amount,
719 tx.eth_block_num, tx.type, tx.batch_num
720 FROM tx WHERE batch_num IS NULL AND to_forge_l1_txs_num = $1
721 ORDER BY position;`,
722 toForgeL1TxsNum,
723 )
724 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
725}
726
727// TODO: Think about chaning all the queries that return a last value, to queries that return the next valid value.
728
729// GetLastTxsPosition for a given to_forge_l1_txs_num
730func (hdb *HistoryDB) GetLastTxsPosition(toForgeL1TxsNum int64) (int, error) {
731 row := hdb.db.QueryRow(
732 "SELECT position FROM tx WHERE to_forge_l1_txs_num = $1 ORDER BY position DESC;",
733 toForgeL1TxsNum,
734 )
735 var lastL1TxsPosition int
736 return lastL1TxsPosition, tracerr.Wrap(row.Scan(&lastL1TxsPosition))
737}
738
739// GetSCVars returns the rollup, auction and wdelayer smart contracts variables at their last update.
740func (hdb *HistoryDB) GetSCVars() (*common.RollupVariables, *common.AuctionVariables,
741 *common.WDelayerVariables, error) {
742 var rollup common.RollupVariables
743 var auction common.AuctionVariables
744 var wDelayer common.WDelayerVariables
745 if err := meddler.QueryRow(hdb.db, &rollup,
746 "SELECT * FROM rollup_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
747 return nil, nil, nil, tracerr.Wrap(err)
748 }
749 if err := meddler.QueryRow(hdb.db, &auction,
750 "SELECT * FROM auction_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
751 return nil, nil, nil, tracerr.Wrap(err)
752 }
753 if err := meddler.QueryRow(hdb.db, &wDelayer,
754 "SELECT * FROM wdelayer_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
755 return nil, nil, nil, tracerr.Wrap(err)
756 }
757 return &rollup, &auction, &wDelayer, nil
758}
759
760func (hdb *HistoryDB) setRollupVars(d meddler.DB, rollup *common.RollupVariables) error {
761 return tracerr.Wrap(meddler.Insert(d, "rollup_vars", rollup))
762}
763
764func (hdb *HistoryDB) setAuctionVars(d meddler.DB, auction *common.AuctionVariables) error {
765 return tracerr.Wrap(meddler.Insert(d, "auction_vars", auction))
766}
767
768func (hdb *HistoryDB) setWDelayerVars(d meddler.DB, wDelayer *common.WDelayerVariables) error {
769 return tracerr.Wrap(meddler.Insert(d, "wdelayer_vars", wDelayer))
770}
771
772func (hdb *HistoryDB) addBucketUpdates(d meddler.DB, bucketUpdates []common.BucketUpdate) error {
773 if len(bucketUpdates) == 0 {
774 return nil
775 }
776 return tracerr.Wrap(db.BulkInsert(
777 d,
778 `INSERT INTO bucket_update (
779 eth_block_num,
780 num_bucket,
781 block_stamp,
782 withdrawals
783 ) VALUES %s;`,
784 bucketUpdates[:],
785 ))
786}
787
788// AddBucketUpdatesTest allows call to unexported method
789// only for internal testing purposes
790func (hdb *HistoryDB) AddBucketUpdatesTest(d meddler.DB, bucketUpdates []common.BucketUpdate) error {
791 return hdb.addBucketUpdates(d, bucketUpdates)
792}
793
794// GetAllBucketUpdates retrieves all the bucket updates
795func (hdb *HistoryDB) GetAllBucketUpdates() ([]common.BucketUpdate, error) {
796 var bucketUpdates []*common.BucketUpdate
797 err := meddler.QueryAll(
798 hdb.db, &bucketUpdates,
799 `SELECT eth_block_num, num_bucket, block_stamp, withdrawals
800 FROM bucket_update ORDER BY item_id;`,
801 )
802 return db.SlicePtrsToSlice(bucketUpdates).([]common.BucketUpdate), tracerr.Wrap(err)
803}
804
805func (hdb *HistoryDB) addTokenExchanges(d meddler.DB, tokenExchanges []common.TokenExchange) error {
806 if len(tokenExchanges) == 0 {
807 return nil
808 }
809 return tracerr.Wrap(db.BulkInsert(
810 d,
811 `INSERT INTO token_exchange (
812 eth_block_num,
813 eth_addr,
814 value_usd
815 ) VALUES %s;`,
816 tokenExchanges[:],
817 ))
818}
819
820// GetAllTokenExchanges retrieves all the token exchanges
821func (hdb *HistoryDB) GetAllTokenExchanges() ([]common.TokenExchange, error) {
822 var tokenExchanges []*common.TokenExchange
823 err := meddler.QueryAll(
824 hdb.db, &tokenExchanges,
825 "SELECT eth_block_num, eth_addr, value_usd FROM token_exchange ORDER BY item_id;",
826 )
827 return db.SlicePtrsToSlice(tokenExchanges).([]common.TokenExchange), tracerr.Wrap(err)
828}
829
830func (hdb *HistoryDB) addEscapeHatchWithdrawals(d meddler.DB,
831 escapeHatchWithdrawals []common.WDelayerEscapeHatchWithdrawal) error {
832 if len(escapeHatchWithdrawals) == 0 {
833 return nil
834 }
835 return tracerr.Wrap(db.BulkInsert(
836 d,
837 `INSERT INTO escape_hatch_withdrawal (
838 eth_block_num,
839 who_addr,
840 to_addr,
841 token_addr,
842 amount
843 ) VALUES %s;`,
844 escapeHatchWithdrawals[:],
845 ))
846}
847
848// GetAllEscapeHatchWithdrawals retrieves all the escape hatch withdrawals
849func (hdb *HistoryDB) GetAllEscapeHatchWithdrawals() ([]common.WDelayerEscapeHatchWithdrawal, error) {
850 var escapeHatchWithdrawals []*common.WDelayerEscapeHatchWithdrawal
851 err := meddler.QueryAll(
852 hdb.db, &escapeHatchWithdrawals,
853 "SELECT eth_block_num, who_addr, to_addr, token_addr, amount FROM escape_hatch_withdrawal ORDER BY item_id;",
854 )
855 return db.SlicePtrsToSlice(escapeHatchWithdrawals).([]common.WDelayerEscapeHatchWithdrawal),
856 tracerr.Wrap(err)
857}
858
859// SetInitialSCVars sets the initial state of rollup, auction, wdelayer smart
860// contract variables. This initial state is stored linked to block 0, which
861// always exist in the DB and is used to store initialization data that always
862// exist in the smart contracts.
863func (hdb *HistoryDB) SetInitialSCVars(rollup *common.RollupVariables,
864 auction *common.AuctionVariables, wDelayer *common.WDelayerVariables) error {
865 txn, err := hdb.db.Beginx()
866 if err != nil {
867 return tracerr.Wrap(err)
868 }
869 defer func() {
870 if err != nil {
871 db.Rollback(txn)
872 }
873 }()
874 // Force EthBlockNum to be 0 because it's the block used to link data
875 // that belongs to the creation of the smart contracts
876 rollup.EthBlockNum = 0
877 auction.EthBlockNum = 0
878 wDelayer.EthBlockNum = 0
879 auction.DefaultSlotSetBidSlotNum = 0
880 if err := hdb.setRollupVars(txn, rollup); err != nil {
881 return tracerr.Wrap(err)
882 }
883 if err := hdb.setAuctionVars(txn, auction); err != nil {
884 return tracerr.Wrap(err)
885 }
886 if err := hdb.setWDelayerVars(txn, wDelayer); err != nil {
887 return tracerr.Wrap(err)
888 }
889
890 return tracerr.Wrap(txn.Commit())
891}
892
893// setExtraInfoForgedL1UserTxs sets the EffectiveAmount, EffectiveDepositAmount
894// and EffectiveFromIdx of the given l1UserTxs (with an UPDATE)
895func (hdb *HistoryDB) setExtraInfoForgedL1UserTxs(d sqlx.Ext, txs []common.L1Tx) error {
896 if len(txs) == 0 {
897 return nil
898 }
899 // Effective amounts are stored as success flags in the DB, with true value by default
900 // to reduce the amount of updates. Therefore, only amounts that became uneffective should be
901 // updated to become false. At the same time, all the txs that contain
902 // accounts (FromIdx == 0) are updated to set the EffectiveFromIdx.
903 type txUpdate struct {
904 ID common.TxID `db:"id"`
905 AmountSuccess bool `db:"amount_success"`
906 DepositAmountSuccess bool `db:"deposit_amount_success"`
907 EffectiveFromIdx common.Idx `db:"effective_from_idx"`
908 }
909 txUpdates := []txUpdate{}
910 equal := func(a *big.Int, b *big.Int) bool {
911 return a.Cmp(b) == 0
912 }
913 for i := range txs {
914 amountSuccess := equal(txs[i].Amount, txs[i].EffectiveAmount)
915 depositAmountSuccess := equal(txs[i].DepositAmount, txs[i].EffectiveDepositAmount)
916 if !amountSuccess || !depositAmountSuccess || txs[i].FromIdx == 0 {
917 txUpdates = append(txUpdates, txUpdate{
918 ID: txs[i].TxID,
919 AmountSuccess: amountSuccess,
920 DepositAmountSuccess: depositAmountSuccess,
921 EffectiveFromIdx: txs[i].EffectiveFromIdx,
922 })
923 }
924 }
925 const query string = `
926 UPDATE tx SET
927 amount_success = tx_update.amount_success,
928 deposit_amount_success = tx_update.deposit_amount_success,
929 effective_from_idx = tx_update.effective_from_idx
930 FROM (VALUES
931 (NULL::::BYTEA, NULL::::BOOL, NULL::::BOOL, NULL::::BIGINT),
932 (:id, :amount_success, :deposit_amount_success, :effective_from_idx)
933 ) as tx_update (id, amount_success, deposit_amount_success, effective_from_idx)
934 WHERE tx.id = tx_update.id;
935 `
936 if len(txUpdates) > 0 {
937 if _, err := sqlx.NamedExec(d, query, txUpdates); err != nil {
938 return tracerr.Wrap(err)
939 }
940 }
941 return nil
942}
943
944// AddBlockSCData stores all the information of a block retrieved by the
945// Synchronizer. Blocks should be inserted in order, leaving no gaps because
946// the pagination system of the API/DB depends on this. Within blocks, all
947// items should also be in the correct order (Accounts, Tokens, Txs, etc.)
948func (hdb *HistoryDB) AddBlockSCData(blockData *common.BlockData) (err error) {
949 txn, err := hdb.db.Beginx()
950 if err != nil {
951 return tracerr.Wrap(err)
952 }
953 defer func() {
954 if err != nil {
955 db.Rollback(txn)
956 }
957 }()
958
959 // Add block
960 if err := hdb.addBlock(txn, &blockData.Block); err != nil {
961 return tracerr.Wrap(err)
962 }
963
964 // Add Coordinators
965 if err := hdb.addCoordinators(txn, blockData.Auction.Coordinators); err != nil {
966 return tracerr.Wrap(err)
967 }
968
969 // Add Bids
970 if err := hdb.addBids(txn, blockData.Auction.Bids); err != nil {
971 return tracerr.Wrap(err)
972 }
973
974 // Add Tokens
975 if err := hdb.addTokens(txn, blockData.Rollup.AddedTokens); err != nil {
976 return tracerr.Wrap(err)
977 }
978
979 // Prepare user L1 txs to be added.
980 // They must be added before the batch that will forge them (which can be in the same block)
981 // and after the account that will be sent to (also can be in the same block).
982 // Note: insert order is not relevant since item_id will be updated by a DB trigger when
983 // the batch that forges those txs is inserted
984 userL1s := make(map[common.BatchNum][]common.L1Tx)
985 for i := range blockData.Rollup.L1UserTxs {
986 batchThatForgesIsInTheBlock := false
987 for _, batch := range blockData.Rollup.Batches {
988 if batch.Batch.ForgeL1TxsNum != nil &&
989 *batch.Batch.ForgeL1TxsNum == *blockData.Rollup.L1UserTxs[i].ToForgeL1TxsNum {
990 // Tx is forged in this block. It's guaranteed that:
991 // * the first batch of the block won't forge user L1 txs that have been added in this block
992 // * batch nums are sequential therefore it's safe to add the tx at batch.BatchNum -1
993 batchThatForgesIsInTheBlock = true
994 addAtBatchNum := batch.Batch.BatchNum - 1
995 userL1s[addAtBatchNum] = append(userL1s[addAtBatchNum], blockData.Rollup.L1UserTxs[i])
996 break
997 }
998 }
999 if !batchThatForgesIsInTheBlock {
1000 // User artificial batchNum 0 to add txs that are not forge in this block
1001 // after all the accounts of the block have been added
1002 userL1s[0] = append(userL1s[0], blockData.Rollup.L1UserTxs[i])
1003 }
1004 }
1005
1006 // Add Batches
1007 for i := range blockData.Rollup.Batches {
1008 batch := &blockData.Rollup.Batches[i]
1009
1010 // Add Batch: this will trigger an update on the DB
1011 // that will set the batch num of forged L1 txs in this batch
1012 if err = hdb.addBatch(txn, &batch.Batch); err != nil {
1013 return tracerr.Wrap(err)
1014 }
1015
1016 // Add accounts
1017 if err := hdb.addAccounts(txn, batch.CreatedAccounts); err != nil {
1018 return tracerr.Wrap(err)
1019 }
1020
1021 // Set the EffectiveAmount and EffectiveDepositAmount of all the
1022 // L1UserTxs that have been forged in this batch
1023 if err = hdb.setExtraInfoForgedL1UserTxs(txn, batch.L1UserTxs); err != nil {
1024 return tracerr.Wrap(err)
1025 }
1026
1027 // Add forged l1 coordinator Txs
1028 if err := hdb.addL1Txs(txn, batch.L1CoordinatorTxs); err != nil {
1029 return tracerr.Wrap(err)
1030 }
1031
1032 // Add l2 Txs
1033 if err := hdb.addL2Txs(txn, batch.L2Txs); err != nil {
1034 return tracerr.Wrap(err)
1035 }
1036
1037 // Add user L1 txs that will be forged in next batch
1038 if userlL1s, ok := userL1s[batch.Batch.BatchNum]; ok {
1039 if err := hdb.addL1Txs(txn, userlL1s); err != nil {
1040 return tracerr.Wrap(err)
1041 }
1042 }
1043
1044 // Add exit tree
1045 if err := hdb.addExitTree(txn, batch.ExitTree); err != nil {
1046 return tracerr.Wrap(err)
1047 }
1048 }
1049 // Add user L1 txs that won't be forged in this block
1050 if userL1sNotForgedInThisBlock, ok := userL1s[0]; ok {
1051 if err := hdb.addL1Txs(txn, userL1sNotForgedInThisBlock); err != nil {
1052 return tracerr.Wrap(err)
1053 }
1054 }
1055
1056 // Set SC Vars if there was an update
1057 if blockData.Rollup.Vars != nil {
1058 if err := hdb.setRollupVars(txn, blockData.Rollup.Vars); err != nil {
1059 return tracerr.Wrap(err)
1060 }
1061 }
1062 if blockData.Auction.Vars != nil {
1063 if err := hdb.setAuctionVars(txn, blockData.Auction.Vars); err != nil {
1064 return tracerr.Wrap(err)
1065 }
1066 }
1067 if blockData.WDelayer.Vars != nil {
1068 if err := hdb.setWDelayerVars(txn, blockData.WDelayer.Vars); err != nil {
1069 return tracerr.Wrap(err)
1070 }
1071 }
1072
1073 // Update withdrawals in exit tree table
1074 if err := hdb.updateExitTree(txn, blockData.Block.Num,
1075 blockData.Rollup.Withdrawals, blockData.WDelayer.Withdrawals); err != nil {
1076 return tracerr.Wrap(err)
1077 }
1078
1079 // Add Escape Hatch Withdrawals
1080 if err := hdb.addEscapeHatchWithdrawals(txn,
1081 blockData.WDelayer.EscapeHatchWithdrawals); err != nil {
1082 return tracerr.Wrap(err)
1083 }
1084
1085 // Add Buckets withdrawals updates
1086 if err := hdb.addBucketUpdates(txn, blockData.Rollup.UpdateBucketWithdraw); err != nil {
1087 return tracerr.Wrap(err)
1088 }
1089
1090 // Add Token exchange updates
1091 if err := hdb.addTokenExchanges(txn, blockData.Rollup.TokenExchanges); err != nil {
1092 return tracerr.Wrap(err)
1093 }
1094
1095 return tracerr.Wrap(txn.Commit())
1096}
1097
1098// GetCoordinatorAPI returns a coordinator by its bidderAddr
1099func (hdb *HistoryDB) GetCoordinatorAPI(bidderAddr ethCommon.Address) (*CoordinatorAPI, error) {
1100 coordinator := &CoordinatorAPI{}
1101 err := meddler.QueryRow(
1102 hdb.db, coordinator,
1103 "SELECT * FROM coordinator WHERE bidder_addr = $1 ORDER BY item_id DESC LIMIT 1;",
1104 bidderAddr,
1105 )
1106 return coordinator, tracerr.Wrap(err)
1107}
1108
1109// AddAuctionVars insert auction vars into the DB
1110func (hdb *HistoryDB) AddAuctionVars(auctionVars *common.AuctionVariables) error {
1111 return tracerr.Wrap(meddler.Insert(hdb.db, "auction_vars", auctionVars))
1112}
1113
1114// GetTokensTest used to get tokens in a testing context
1115func (hdb *HistoryDB) GetTokensTest() ([]TokenWithUSD, error) {
1116 tokens := []*TokenWithUSD{}
1117 if err := meddler.QueryAll(
1118 hdb.db, &tokens,
1119 "SELECT * FROM TOKEN",
1120 ); err != nil {
1121 return nil, tracerr.Wrap(err)
1122 }
1123 if len(tokens) == 0 {
1124 return []TokenWithUSD{}, nil
1125 }
1126 return db.SlicePtrsToSlice(tokens).([]TokenWithUSD), nil
1127}