hermez-node/db/historydb/historydb.go
db/historydb/historydb.goRaw
1package historydb
2
3import (
4 "errors"
5 "fmt"
6 "math"
7 "math/big"
8
9 ethCommon "github.com/ethereum/go-ethereum/common"
10 "github.com/hermeznetwork/hermez-node/common"
11 "github.com/hermeznetwork/hermez-node/db"
12 "github.com/hermeznetwork/tracerr"
13 "github.com/iden3/go-iden3-crypto/babyjub"
14 "github.com/jmoiron/sqlx"
15
16 //nolint:errcheck // driver for postgres DB
17 _ "github.com/lib/pq"
18 "github.com/russross/meddler"
19)
20
21const (
22 // OrderAsc indicates ascending order when using pagination
23 OrderAsc = "ASC"
24 // OrderDesc indicates descending order when using pagination
25 OrderDesc = "DESC"
26)
27
28// TODO(Edu): Document here how HistoryDB is kept consistent
29
30// HistoryDB persist the historic of the rollup
31type HistoryDB struct {
32 db *sqlx.DB
33}
34
35// NewHistoryDB initialize the DB
36func NewHistoryDB(db *sqlx.DB) *HistoryDB {
37 return &HistoryDB{db: db}
38}
39
40// DB returns a pointer to the L2DB.db. This method should be used only for
41// internal testing purposes.
42func (hdb *HistoryDB) DB() *sqlx.DB {
43 return hdb.db
44}
45
46// AddBlock insert a block into the DB
47func (hdb *HistoryDB) AddBlock(block *common.Block) error { return hdb.addBlock(hdb.db, block) }
48func (hdb *HistoryDB) addBlock(d meddler.DB, block *common.Block) error {
49 return tracerr.Wrap(meddler.Insert(d, "block", block))
50}
51
52// AddBlocks inserts blocks into the DB
53func (hdb *HistoryDB) AddBlocks(blocks []common.Block) error {
54 return tracerr.Wrap(hdb.addBlocks(hdb.db, blocks))
55}
56
57func (hdb *HistoryDB) addBlocks(d meddler.DB, blocks []common.Block) error {
58 return tracerr.Wrap(db.BulkInsert(
59 d,
60 `INSERT INTO block (
61 eth_block_num,
62 timestamp,
63 hash
64 ) VALUES %s;`,
65 blocks[:],
66 ))
67}
68
69// GetBlock retrieve a block from the DB, given a block number
70func (hdb *HistoryDB) GetBlock(blockNum int64) (*common.Block, error) {
71 block := &common.Block{}
72 err := meddler.QueryRow(
73 hdb.db, block,
74 "SELECT * FROM block WHERE eth_block_num = $1;", blockNum,
75 )
76 return block, tracerr.Wrap(err)
77}
78
79// GetAllBlocks retrieve all blocks from the DB
80func (hdb *HistoryDB) GetAllBlocks() ([]common.Block, error) {
81 var blocks []*common.Block
82 err := meddler.QueryAll(
83 hdb.db, &blocks,
84 "SELECT * FROM block ORDER BY eth_block_num;",
85 )
86 return db.SlicePtrsToSlice(blocks).([]common.Block), tracerr.Wrap(err)
87}
88
89// GetBlocks retrieve blocks from the DB, given a range of block numbers defined by from and to
90func (hdb *HistoryDB) GetBlocks(from, to int64) ([]common.Block, error) {
91 var blocks []*common.Block
92 err := meddler.QueryAll(
93 hdb.db, &blocks,
94 "SELECT * FROM block WHERE $1 <= eth_block_num AND eth_block_num < $2 ORDER BY eth_block_num;",
95 from, to,
96 )
97 return db.SlicePtrsToSlice(blocks).([]common.Block), tracerr.Wrap(err)
98}
99
100// GetLastBlock retrieve the block with the highest block number from the DB
101func (hdb *HistoryDB) GetLastBlock() (*common.Block, error) {
102 block := &common.Block{}
103 err := meddler.QueryRow(
104 hdb.db, block, "SELECT * FROM block ORDER BY eth_block_num DESC LIMIT 1;",
105 )
106 return block, tracerr.Wrap(err)
107}
108
109// AddBatch insert a Batch into the DB
110func (hdb *HistoryDB) AddBatch(batch *common.Batch) error { return hdb.addBatch(hdb.db, batch) }
111func (hdb *HistoryDB) addBatch(d meddler.DB, batch *common.Batch) error {
112 // Calculate total collected fees in USD
113 // Get IDs of collected tokens for fees
114 tokenIDs := []common.TokenID{}
115 for id := range batch.CollectedFees {
116 tokenIDs = append(tokenIDs, id)
117 }
118 // Get USD value of the tokens
119 type tokenPrice struct {
120 ID common.TokenID `meddler:"token_id"`
121 USD *float64 `meddler:"usd"`
122 Decimals int `meddler:"decimals"`
123 }
124 var tokenPrices []*tokenPrice
125 if len(tokenIDs) > 0 {
126 query, args, err := sqlx.In(
127 "SELECT token_id, usd, decimals FROM token WHERE token_id IN (?);",
128 tokenIDs,
129 )
130 if err != nil {
131 return tracerr.Wrap(err)
132 }
133 query = hdb.db.Rebind(query)
134 if err := meddler.QueryAll(
135 hdb.db, &tokenPrices, query, args...,
136 ); err != nil {
137 return tracerr.Wrap(err)
138 }
139 }
140 // Calculate total collected
141 var total float64
142 for _, tokenPrice := range tokenPrices {
143 if tokenPrice.USD == nil {
144 continue
145 }
146 f := new(big.Float).SetInt(batch.CollectedFees[tokenPrice.ID])
147 amount, _ := f.Float64()
148 total += *tokenPrice.USD * (amount / math.Pow(10, float64(tokenPrice.Decimals))) //nolint decimals have to be ^10
149 }
150 batch.TotalFeesUSD = &total
151 // Insert to DB
152 return tracerr.Wrap(meddler.Insert(d, "batch", batch))
153}
154
155// AddBatches insert Bids into the DB
156func (hdb *HistoryDB) AddBatches(batches []common.Batch) error {
157 return tracerr.Wrap(hdb.addBatches(hdb.db, batches))
158}
159func (hdb *HistoryDB) addBatches(d meddler.DB, batches []common.Batch) error {
160 for i := 0; i < len(batches); i++ {
161 if err := hdb.addBatch(d, &batches[i]); err != nil {
162 return tracerr.Wrap(err)
163 }
164 }
165 return nil
166}
167
168// GetBatchAPI return the batch with the given batchNum
169func (hdb *HistoryDB) GetBatchAPI(batchNum common.BatchNum) (*BatchAPI, error) {
170 batch := &BatchAPI{}
171 return batch, tracerr.Wrap(meddler.QueryRow(
172 hdb.db, batch,
173 `SELECT batch.item_id, batch.batch_num, batch.eth_block_num,
174 batch.forger_addr, batch.fees_collected, batch.total_fees_usd, batch.state_root,
175 batch.num_accounts, batch.exit_root, batch.forge_l1_txs_num, batch.slot_num,
176 block.timestamp, block.hash,
177 COALESCE ((SELECT COUNT(*) FROM tx WHERE batch_num = batch.batch_num), 0) AS forged_txs
178 FROM batch INNER JOIN block ON batch.eth_block_num = block.eth_block_num
179 WHERE batch_num = $1;`, batchNum,
180 ))
181}
182
183// GetBatchesAPI return the batches applying the given filters
184func (hdb *HistoryDB) GetBatchesAPI(
185 minBatchNum, maxBatchNum, slotNum *uint,
186 forgerAddr *ethCommon.Address,
187 fromItem, limit *uint, order string,
188) ([]BatchAPI, uint64, error) {
189 var query string
190 var args []interface{}
191 queryStr := `SELECT batch.item_id, batch.batch_num, batch.eth_block_num,
192 batch.forger_addr, batch.fees_collected, batch.total_fees_usd, batch.state_root,
193 batch.num_accounts, batch.exit_root, batch.forge_l1_txs_num, batch.slot_num,
194 block.timestamp, block.hash,
195 COALESCE ((SELECT COUNT(*) FROM tx WHERE batch_num = batch.batch_num), 0) AS forged_txs,
196 count(*) OVER() AS total_items
197 FROM batch INNER JOIN block ON batch.eth_block_num = block.eth_block_num `
198 // Apply filters
199 nextIsAnd := false
200 // minBatchNum filter
201 if minBatchNum != nil {
202 if nextIsAnd {
203 queryStr += "AND "
204 } else {
205 queryStr += "WHERE "
206 }
207 queryStr += "batch.batch_num > ? "
208 args = append(args, minBatchNum)
209 nextIsAnd = true
210 }
211 // maxBatchNum filter
212 if maxBatchNum != nil {
213 if nextIsAnd {
214 queryStr += "AND "
215 } else {
216 queryStr += "WHERE "
217 }
218 queryStr += "batch.batch_num < ? "
219 args = append(args, maxBatchNum)
220 nextIsAnd = true
221 }
222 // slotNum filter
223 if slotNum != nil {
224 if nextIsAnd {
225 queryStr += "AND "
226 } else {
227 queryStr += "WHERE "
228 }
229 queryStr += "batch.slot_num = ? "
230 args = append(args, slotNum)
231 nextIsAnd = true
232 }
233 // forgerAddr filter
234 if forgerAddr != nil {
235 if nextIsAnd {
236 queryStr += "AND "
237 } else {
238 queryStr += "WHERE "
239 }
240 queryStr += "batch.forger_addr = ? "
241 args = append(args, forgerAddr)
242 nextIsAnd = true
243 }
244 // pagination
245 if fromItem != nil {
246 if nextIsAnd {
247 queryStr += "AND "
248 } else {
249 queryStr += "WHERE "
250 }
251 if order == OrderAsc {
252 queryStr += "batch.item_id >= ? "
253 } else {
254 queryStr += "batch.item_id <= ? "
255 }
256 args = append(args, fromItem)
257 }
258 queryStr += "ORDER BY batch.item_id "
259 if order == OrderAsc {
260 queryStr += " ASC "
261 } else {
262 queryStr += " DESC "
263 }
264 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
265 query = hdb.db.Rebind(queryStr)
266 // log.Debug(query)
267 batchPtrs := []*BatchAPI{}
268 if err := meddler.QueryAll(hdb.db, &batchPtrs, query, args...); err != nil {
269 return nil, 0, tracerr.Wrap(err)
270 }
271 batches := db.SlicePtrsToSlice(batchPtrs).([]BatchAPI)
272 if len(batches) == 0 {
273 return batches, 0, nil
274 }
275 return batches, batches[0].TotalItems - uint64(len(batches)), nil
276}
277
278// GetAllBatches retrieve all batches from the DB
279func (hdb *HistoryDB) GetAllBatches() ([]common.Batch, error) {
280 var batches []*common.Batch
281 err := meddler.QueryAll(
282 hdb.db, &batches,
283 `SELECT batch.batch_num, batch.eth_block_num, batch.forger_addr, batch.fees_collected,
284 batch.fee_idxs_coordinator, batch.state_root, batch.num_accounts, batch.last_idx, batch.exit_root,
285 batch.forge_l1_txs_num, batch.slot_num, batch.total_fees_usd FROM batch
286 ORDER BY item_id;`,
287 )
288 return db.SlicePtrsToSlice(batches).([]common.Batch), tracerr.Wrap(err)
289}
290
291// GetBatches retrieve batches from the DB, given a range of batch numbers defined by from and to
292func (hdb *HistoryDB) GetBatches(from, to common.BatchNum) ([]common.Batch, error) {
293 var batches []*common.Batch
294 err := meddler.QueryAll(
295 hdb.db, &batches,
296 `SELECT batch_num, eth_block_num, forger_addr, fees_collected, fee_idxs_coordinator,
297 state_root, num_accounts, last_idx, exit_root, forge_l1_txs_num, slot_num, total_fees_usd
298 FROM batch WHERE $1 <= batch_num AND batch_num < $2 ORDER BY batch_num;`,
299 from, to,
300 )
301 return db.SlicePtrsToSlice(batches).([]common.Batch), tracerr.Wrap(err)
302}
303
304// GetFirstBatchBlockNumBySlot returns the ethereum block number of the first
305// batch within a slot
306func (hdb *HistoryDB) GetFirstBatchBlockNumBySlot(slotNum int64) (int64, error) {
307 row := hdb.db.QueryRow(
308 `SELECT eth_block_num FROM batch
309 WHERE slot_num = $1 ORDER BY batch_num ASC LIMIT 1;`, slotNum,
310 )
311 var blockNum int64
312 return blockNum, tracerr.Wrap(row.Scan(&blockNum))
313}
314
315// GetLastBatchNum returns the BatchNum of the latest forged batch
316func (hdb *HistoryDB) GetLastBatchNum() (common.BatchNum, error) {
317 row := hdb.db.QueryRow("SELECT batch_num FROM batch ORDER BY batch_num DESC LIMIT 1;")
318 var batchNum common.BatchNum
319 return batchNum, tracerr.Wrap(row.Scan(&batchNum))
320}
321
322// GetLastL1BatchBlockNum returns the blockNum of the latest forged l1Batch
323func (hdb *HistoryDB) GetLastL1BatchBlockNum() (int64, error) {
324 row := hdb.db.QueryRow(`SELECT eth_block_num FROM batch
325 WHERE forge_l1_txs_num IS NOT NULL
326 ORDER BY batch_num DESC LIMIT 1;`)
327 var blockNum int64
328 return blockNum, tracerr.Wrap(row.Scan(&blockNum))
329}
330
331// GetLastL1TxsNum returns the greatest ForgeL1TxsNum in the DB from forged
332// batches. If there's no batch in the DB (nil, nil) is returned.
333func (hdb *HistoryDB) GetLastL1TxsNum() (*int64, error) {
334 row := hdb.db.QueryRow("SELECT MAX(forge_l1_txs_num) FROM batch;")
335 lastL1TxsNum := new(int64)
336 return lastL1TxsNum, tracerr.Wrap(row.Scan(&lastL1TxsNum))
337}
338
339// Reorg deletes all the information that was added into the DB after the
340// lastValidBlock. If lastValidBlock is negative, all block information is
341// deleted.
342func (hdb *HistoryDB) Reorg(lastValidBlock int64) error {
343 var err error
344 if lastValidBlock < 0 {
345 _, err = hdb.db.Exec("DELETE FROM block;")
346 } else {
347 _, err = hdb.db.Exec("DELETE FROM block WHERE eth_block_num > $1;", lastValidBlock)
348 }
349 return tracerr.Wrap(err)
350}
351
352// AddBids insert Bids into the DB
353func (hdb *HistoryDB) AddBids(bids []common.Bid) error { return hdb.addBids(hdb.db, bids) }
354func (hdb *HistoryDB) addBids(d meddler.DB, bids []common.Bid) error {
355 if len(bids) == 0 {
356 return nil
357 }
358 // TODO: check the coordinator info
359 return tracerr.Wrap(db.BulkInsert(
360 d,
361 "INSERT INTO bid (slot_num, bid_value, eth_block_num, bidder_addr) VALUES %s;",
362 bids[:],
363 ))
364}
365
366// GetAllBids retrieve all bids from the DB
367func (hdb *HistoryDB) GetAllBids() ([]common.Bid, error) {
368 var bids []*common.Bid
369 err := meddler.QueryAll(
370 hdb.db, &bids,
371 `SELECT bid.slot_num, bid.bid_value, bid.eth_block_num, bid.bidder_addr FROM bid
372 ORDER BY item_id;`,
373 )
374 return db.SlicePtrsToSlice(bids).([]common.Bid), tracerr.Wrap(err)
375}
376
377// GetBestBidAPI returns the best bid in specific slot by slotNum
378func (hdb *HistoryDB) GetBestBidAPI(slotNum *int64) (BidAPI, error) {
379 bid := &BidAPI{}
380 err := meddler.QueryRow(
381 hdb.db, bid, `SELECT bid.*, block.timestamp, coordinator.forger_addr, coordinator.url
382 FROM bid INNER JOIN block ON bid.eth_block_num = block.eth_block_num
383 INNER JOIN (
384 SELECT bidder_addr, MAX(item_id) AS item_id FROM coordinator
385 GROUP BY bidder_addr
386 ) c ON bid.bidder_addr = c.bidder_addr
387 INNER JOIN coordinator ON c.item_id = coordinator.item_id
388 WHERE slot_num = $1 ORDER BY item_id DESC LIMIT 1;`, slotNum,
389 )
390 return *bid, tracerr.Wrap(err)
391}
392
393// GetBestBidCoordinator returns the forger address of the highest bidder in a slot by slotNum
394func (hdb *HistoryDB) GetBestBidCoordinator(slotNum int64) (*common.BidCoordinator, error) {
395 bidCoord := &common.BidCoordinator{}
396 err := meddler.QueryRow(
397 hdb.db, bidCoord,
398 `SELECT (
399 SELECT default_slot_set_bid
400 FROM auction_vars
401 WHERE default_slot_set_bid_slot_num <= $1
402 ORDER BY eth_block_num DESC LIMIT 1
403 ),
404 bid.slot_num, bid.bid_value, bid.bidder_addr,
405 coordinator.forger_addr, coordinator.url
406 FROM bid
407 INNER JOIN (
408 SELECT bidder_addr, MAX(item_id) AS item_id FROM coordinator
409 GROUP BY bidder_addr
410 ) c ON bid.bidder_addr = c.bidder_addr
411 INNER JOIN coordinator ON c.item_id = coordinator.item_id
412 WHERE bid.slot_num = $1 ORDER BY bid.item_id DESC LIMIT 1;`,
413 slotNum)
414
415 return bidCoord, tracerr.Wrap(err)
416}
417
418// GetBestBidsAPI returns the best bid in specific slot by slotNum
419func (hdb *HistoryDB) GetBestBidsAPI(
420 minSlotNum, maxSlotNum *int64,
421 bidderAddr *ethCommon.Address,
422 limit *uint, order string,
423) ([]BidAPI, uint64, error) {
424 var query string
425 var args []interface{}
426 // JOIN the best bid of each slot with the latest update of each coordinator
427 queryStr := `SELECT b.*, block.timestamp, coordinator.forger_addr, coordinator.url,
428 COUNT(*) OVER() AS total_items FROM (
429 SELECT slot_num, MAX(item_id) as maxitem
430 FROM bid GROUP BY slot_num
431 )
432 AS x INNER JOIN bid AS b ON b.item_id = x.maxitem
433 INNER JOIN block ON b.eth_block_num = block.eth_block_num
434 INNER JOIN (
435 SELECT bidder_addr, MAX(item_id) AS item_id FROM coordinator
436 GROUP BY bidder_addr
437 ) c ON b.bidder_addr = c.bidder_addr
438 INNER JOIN coordinator ON c.item_id = coordinator.item_id
439 WHERE (b.slot_num >= ? AND b.slot_num <= ?)`
440 args = append(args, minSlotNum)
441 args = append(args, maxSlotNum)
442 // Apply filters
443 if bidderAddr != nil {
444 queryStr += " AND b.bidder_addr = ? "
445 args = append(args, bidderAddr)
446 }
447 queryStr += " ORDER BY b.slot_num "
448 if order == OrderAsc {
449 queryStr += "ASC "
450 } else {
451 queryStr += "DESC "
452 }
453 if limit != nil {
454 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
455 }
456 query = hdb.db.Rebind(queryStr)
457 bidPtrs := []*BidAPI{}
458 if err := meddler.QueryAll(hdb.db, &bidPtrs, query, args...); err != nil {
459 return nil, 0, tracerr.Wrap(err)
460 }
461 // log.Debug(query)
462 bids := db.SlicePtrsToSlice(bidPtrs).([]BidAPI)
463 if len(bids) == 0 {
464 return bids, 0, nil
465 }
466 return bids, bids[0].TotalItems - uint64(len(bids)), nil
467}
468
469// GetBidsAPI return the bids applying the given filters
470func (hdb *HistoryDB) GetBidsAPI(
471 slotNum *int64, bidderAddr *ethCommon.Address,
472 fromItem, limit *uint, order string,
473) ([]BidAPI, uint64, error) {
474 var query string
475 var args []interface{}
476 // JOIN each bid with the latest update of each coordinator
477 queryStr := `SELECT bid.*, block.timestamp, coord.forger_addr, coord.url,
478 COUNT(*) OVER() AS total_items
479 FROM bid INNER JOIN block ON bid.eth_block_num = block.eth_block_num
480 INNER JOIN (
481 SELECT bidder_addr, MAX(item_id) AS item_id FROM coordinator
482 GROUP BY bidder_addr
483 ) c ON bid.bidder_addr = c.bidder_addr
484 INNER JOIN coordinator coord ON c.item_id = coord.item_id `
485 // Apply filters
486 nextIsAnd := false
487 // slotNum filter
488 if slotNum != nil {
489 if nextIsAnd {
490 queryStr += "AND "
491 } else {
492 queryStr += "WHERE "
493 }
494 queryStr += "bid.slot_num = ? "
495 args = append(args, slotNum)
496 nextIsAnd = true
497 }
498 // bidder filter
499 if bidderAddr != nil {
500 if nextIsAnd {
501 queryStr += "AND "
502 } else {
503 queryStr += "WHERE "
504 }
505 queryStr += "bid.bidder_addr = ? "
506 args = append(args, bidderAddr)
507 nextIsAnd = true
508 }
509 if fromItem != nil {
510 if nextIsAnd {
511 queryStr += "AND "
512 } else {
513 queryStr += "WHERE "
514 }
515 if order == OrderAsc {
516 queryStr += "bid.item_id >= ? "
517 } else {
518 queryStr += "bid.item_id <= ? "
519 }
520 args = append(args, fromItem)
521 }
522 // pagination
523 queryStr += "ORDER BY bid.item_id "
524 if order == OrderAsc {
525 queryStr += "ASC "
526 } else {
527 queryStr += "DESC "
528 }
529 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
530 query, argsQ, err := sqlx.In(queryStr, args...)
531 if err != nil {
532 return nil, 0, tracerr.Wrap(err)
533 }
534 query = hdb.db.Rebind(query)
535 bids := []*BidAPI{}
536 if err := meddler.QueryAll(hdb.db, &bids, query, argsQ...); err != nil {
537 return nil, 0, tracerr.Wrap(err)
538 }
539 if len(bids) == 0 {
540 return []BidAPI{}, 0, nil
541 }
542 return db.SlicePtrsToSlice(bids).([]BidAPI), bids[0].TotalItems - uint64(len(bids)), nil
543}
544
545// AddCoordinators insert Coordinators into the DB
546func (hdb *HistoryDB) AddCoordinators(coordinators []common.Coordinator) error {
547 return tracerr.Wrap(hdb.addCoordinators(hdb.db, coordinators))
548}
549func (hdb *HistoryDB) addCoordinators(d meddler.DB, coordinators []common.Coordinator) error {
550 if len(coordinators) == 0 {
551 return nil
552 }
553 return tracerr.Wrap(db.BulkInsert(
554 d,
555 "INSERT INTO coordinator (bidder_addr, forger_addr, eth_block_num, url) VALUES %s;",
556 coordinators[:],
557 ))
558}
559
560// AddExitTree insert Exit tree into the DB
561func (hdb *HistoryDB) AddExitTree(exitTree []common.ExitInfo) error {
562 return tracerr.Wrap(hdb.addExitTree(hdb.db, exitTree))
563}
564func (hdb *HistoryDB) addExitTree(d meddler.DB, exitTree []common.ExitInfo) error {
565 if len(exitTree) == 0 {
566 return nil
567 }
568 return tracerr.Wrap(db.BulkInsert(
569 d,
570 "INSERT INTO exit_tree (batch_num, account_idx, merkle_proof, balance, "+
571 "instant_withdrawn, delayed_withdraw_request, delayed_withdrawn) VALUES %s;",
572 exitTree[:],
573 ))
574}
575
576func (hdb *HistoryDB) updateExitTree(d sqlx.Ext, blockNum int64,
577 rollupWithdrawals []common.WithdrawInfo, wDelayerWithdrawals []common.WDelayerTransfer) error {
578 if len(rollupWithdrawals) == 0 && len(wDelayerWithdrawals) == 0 {
579 return nil
580 }
581 type withdrawal struct {
582 BatchNum int64 `db:"batch_num"`
583 AccountIdx int64 `db:"account_idx"`
584 InstantWithdrawn *int64 `db:"instant_withdrawn"`
585 DelayedWithdrawRequest *int64 `db:"delayed_withdraw_request"`
586 DelayedWithdrawn *int64 `db:"delayed_withdrawn"`
587 Owner *ethCommon.Address `db:"owner"`
588 Token *ethCommon.Address `db:"token"`
589 }
590 withdrawals := make([]withdrawal, len(rollupWithdrawals)+len(wDelayerWithdrawals))
591 for i := range rollupWithdrawals {
592 info := &rollupWithdrawals[i]
593 withdrawals[i] = withdrawal{
594 BatchNum: int64(info.NumExitRoot),
595 AccountIdx: int64(info.Idx),
596 }
597 if info.InstantWithdraw {
598 withdrawals[i].InstantWithdrawn = &blockNum
599 } else {
600 withdrawals[i].DelayedWithdrawRequest = &blockNum
601 withdrawals[i].Owner = &info.Owner
602 withdrawals[i].Token = &info.Token
603 }
604 }
605 for i := range wDelayerWithdrawals {
606 info := &wDelayerWithdrawals[i]
607 withdrawals[len(rollupWithdrawals)+i] = withdrawal{
608 DelayedWithdrawn: &blockNum,
609 Owner: &info.Owner,
610 Token: &info.Token,
611 }
612 }
613 // In VALUES we set an initial row of NULLs to set the types of each
614 // variable passed as argument
615 const query string = `
616 UPDATE exit_tree e SET
617 instant_withdrawn = d.instant_withdrawn,
618 delayed_withdraw_request = CASE
619 WHEN e.delayed_withdraw_request IS NOT NULL THEN e.delayed_withdraw_request
620 ELSE d.delayed_withdraw_request
621 END,
622 delayed_withdrawn = d.delayed_withdrawn,
623 owner = d.owner,
624 token = d.token
625 FROM (VALUES
626 (NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BIGINT, NULL::::BYTEA, NULL::::BYTEA),
627 (:batch_num,
628 :account_idx,
629 :instant_withdrawn,
630 :delayed_withdraw_request,
631 :delayed_withdrawn,
632 :owner,
633 :token)
634 ) as d (batch_num, account_idx, instant_withdrawn, delayed_withdraw_request, delayed_withdrawn, owner, token)
635 WHERE
636 (d.batch_num IS NOT NULL AND e.batch_num = d.batch_num AND e.account_idx = d.account_idx) OR
637 (d.delayed_withdrawn IS NOT NULL AND e.delayed_withdrawn IS NULL AND e.owner = d.owner AND e.token = d.token);
638 `
639 if len(withdrawals) > 0 {
640 if _, err := sqlx.NamedExec(d, query, withdrawals); err != nil {
641 return tracerr.Wrap(err)
642 }
643 }
644
645 return nil
646}
647
648// AddToken insert a token into the DB
649func (hdb *HistoryDB) AddToken(token *common.Token) error {
650 return tracerr.Wrap(meddler.Insert(hdb.db, "token", token))
651}
652
653// AddTokens insert tokens into the DB
654func (hdb *HistoryDB) AddTokens(tokens []common.Token) error { return hdb.addTokens(hdb.db, tokens) }
655func (hdb *HistoryDB) addTokens(d meddler.DB, tokens []common.Token) error {
656 if len(tokens) == 0 {
657 return nil
658 }
659 return tracerr.Wrap(db.BulkInsert(
660 d,
661 `INSERT INTO token (
662 token_id,
663 eth_block_num,
664 eth_addr,
665 name,
666 symbol,
667 decimals
668 ) VALUES %s;`,
669 tokens[:],
670 ))
671}
672
673// UpdateTokenValue updates the USD value of a token
674func (hdb *HistoryDB) UpdateTokenValue(tokenSymbol string, value float64) error {
675 _, err := hdb.db.Exec(
676 "UPDATE token SET usd = $1 WHERE symbol = $2;",
677 value, tokenSymbol,
678 )
679 return tracerr.Wrap(err)
680}
681
682// GetToken returns a token from the DB given a TokenID
683func (hdb *HistoryDB) GetToken(tokenID common.TokenID) (*TokenWithUSD, error) {
684 token := &TokenWithUSD{}
685 err := meddler.QueryRow(
686 hdb.db, token, `SELECT * FROM token WHERE token_id = $1;`, tokenID,
687 )
688 return token, tracerr.Wrap(err)
689}
690
691// GetAllTokens returns all tokens from the DB
692func (hdb *HistoryDB) GetAllTokens() ([]TokenWithUSD, error) {
693 var tokens []*TokenWithUSD
694 err := meddler.QueryAll(
695 hdb.db, &tokens,
696 "SELECT * FROM token ORDER BY token_id;",
697 )
698 return db.SlicePtrsToSlice(tokens).([]TokenWithUSD), tracerr.Wrap(err)
699}
700
701// GetTokens returns a list of tokens from the DB
702func (hdb *HistoryDB) GetTokens(
703 ids []common.TokenID, symbols []string, name string, fromItem,
704 limit *uint, order string,
705) ([]TokenWithUSD, uint64, error) {
706 var query string
707 var args []interface{}
708 queryStr := `SELECT * , COUNT(*) OVER() AS total_items FROM token `
709 // Apply filters
710 nextIsAnd := false
711 if len(ids) > 0 {
712 queryStr += "WHERE token_id IN (?) "
713 nextIsAnd = true
714 args = append(args, ids)
715 }
716 if len(symbols) > 0 {
717 if nextIsAnd {
718 queryStr += "AND "
719 } else {
720 queryStr += "WHERE "
721 }
722 queryStr += "symbol IN (?) "
723 args = append(args, symbols)
724 nextIsAnd = true
725 }
726 if name != "" {
727 if nextIsAnd {
728 queryStr += "AND "
729 } else {
730 queryStr += "WHERE "
731 }
732 queryStr += "name ~ ? "
733 args = append(args, name)
734 nextIsAnd = true
735 }
736 if fromItem != nil {
737 if nextIsAnd {
738 queryStr += "AND "
739 } else {
740 queryStr += "WHERE "
741 }
742 if order == OrderAsc {
743 queryStr += "item_id >= ? "
744 } else {
745 queryStr += "item_id <= ? "
746 }
747 args = append(args, fromItem)
748 }
749 // pagination
750 queryStr += "ORDER BY item_id "
751 if order == OrderAsc {
752 queryStr += "ASC "
753 } else {
754 queryStr += "DESC "
755 }
756 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
757 query, argsQ, err := sqlx.In(queryStr, args...)
758 if err != nil {
759 return nil, 0, tracerr.Wrap(err)
760 }
761 query = hdb.db.Rebind(query)
762 tokens := []*TokenWithUSD{}
763 if err := meddler.QueryAll(hdb.db, &tokens, query, argsQ...); err != nil {
764 return nil, 0, tracerr.Wrap(err)
765 }
766 if len(tokens) == 0 {
767 return []TokenWithUSD{}, 0, nil
768 }
769 return db.SlicePtrsToSlice(tokens).([]TokenWithUSD), uint64(len(tokens)) - tokens[0].TotalItems, nil
770}
771
772// GetTokenSymbols returns all the token symbols from the DB
773func (hdb *HistoryDB) GetTokenSymbols() ([]string, error) {
774 var tokenSymbols []string
775 rows, err := hdb.db.Query("SELECT symbol FROM token;")
776 if err != nil {
777 return nil, tracerr.Wrap(err)
778 }
779 defer db.RowsClose(rows)
780 sym := new(string)
781 for rows.Next() {
782 err = rows.Scan(sym)
783 if err != nil {
784 return nil, tracerr.Wrap(err)
785 }
786 tokenSymbols = append(tokenSymbols, *sym)
787 }
788 return tokenSymbols, nil
789}
790
791// AddAccounts insert accounts into the DB
792func (hdb *HistoryDB) AddAccounts(accounts []common.Account) error {
793 return tracerr.Wrap(hdb.addAccounts(hdb.db, accounts))
794}
795func (hdb *HistoryDB) addAccounts(d meddler.DB, accounts []common.Account) error {
796 if len(accounts) == 0 {
797 return nil
798 }
799 return tracerr.Wrap(db.BulkInsert(
800 d,
801 `INSERT INTO account (
802 idx,
803 token_id,
804 batch_num,
805 bjj,
806 eth_addr
807 ) VALUES %s;`,
808 accounts[:],
809 ))
810}
811
812// GetAllAccounts returns a list of accounts from the DB
813func (hdb *HistoryDB) GetAllAccounts() ([]common.Account, error) {
814 var accs []*common.Account
815 err := meddler.QueryAll(
816 hdb.db, &accs,
817 "SELECT idx, token_id, batch_num, bjj, eth_addr FROM account ORDER BY idx;",
818 )
819 return db.SlicePtrsToSlice(accs).([]common.Account), tracerr.Wrap(err)
820}
821
822// AddL1Txs inserts L1 txs to the DB. USD and DepositAmountUSD will be set automatically before storing the tx.
823// If the tx is originated by a coordinator, BatchNum must be provided. If it's originated by a user,
824// BatchNum should be null, and the value will be setted by a trigger when a batch forges the tx.
825// EffectiveAmount and EffectiveDepositAmount are seted with default values by the DB.
826func (hdb *HistoryDB) AddL1Txs(l1txs []common.L1Tx) error {
827 return tracerr.Wrap(hdb.addL1Txs(hdb.db, l1txs))
828}
829
830// addL1Txs inserts L1 txs to the DB. USD and DepositAmountUSD will be set automatically before storing the tx.
831// If the tx is originated by a coordinator, BatchNum must be provided. If it's originated by a user,
832// BatchNum should be null, and the value will be setted by a trigger when a batch forges the tx.
833// EffectiveAmount and EffectiveDepositAmount are seted with default values by the DB.
834func (hdb *HistoryDB) addL1Txs(d meddler.DB, l1txs []common.L1Tx) error {
835 if len(l1txs) == 0 {
836 return nil
837 }
838 txs := []txWrite{}
839 for i := 0; i < len(l1txs); i++ {
840 af := new(big.Float).SetInt(l1txs[i].Amount)
841 amountFloat, _ := af.Float64()
842 laf := new(big.Float).SetInt(l1txs[i].DepositAmount)
843 depositAmountFloat, _ := laf.Float64()
844 txs = append(txs, txWrite{
845 // Generic
846 IsL1: true,
847 TxID: l1txs[i].TxID,
848 Type: l1txs[i].Type,
849 Position: l1txs[i].Position,
850 FromIdx: &l1txs[i].FromIdx,
851 ToIdx: l1txs[i].ToIdx,
852 Amount: l1txs[i].Amount,
853 AmountFloat: amountFloat,
854 TokenID: l1txs[i].TokenID,
855 BatchNum: l1txs[i].BatchNum,
856 EthBlockNum: l1txs[i].EthBlockNum,
857 // L1
858 ToForgeL1TxsNum: l1txs[i].ToForgeL1TxsNum,
859 UserOrigin: &l1txs[i].UserOrigin,
860 FromEthAddr: &l1txs[i].FromEthAddr,
861 FromBJJ: &l1txs[i].FromBJJ,
862 DepositAmount: l1txs[i].DepositAmount,
863 DepositAmountFloat: &depositAmountFloat,
864 })
865 }
866 return tracerr.Wrap(hdb.addTxs(d, txs))
867}
868
869// AddL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
870func (hdb *HistoryDB) AddL2Txs(l2txs []common.L2Tx) error {
871 return tracerr.Wrap(hdb.addL2Txs(hdb.db, l2txs))
872}
873
874// addL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
875func (hdb *HistoryDB) addL2Txs(d meddler.DB, l2txs []common.L2Tx) error {
876 txs := []txWrite{}
877 for i := 0; i < len(l2txs); i++ {
878 f := new(big.Float).SetInt(l2txs[i].Amount)
879 amountFloat, _ := f.Float64()
880 txs = append(txs, txWrite{
881 // Generic
882 IsL1: false,
883 TxID: l2txs[i].TxID,
884 Type: l2txs[i].Type,
885 Position: l2txs[i].Position,
886 FromIdx: &l2txs[i].FromIdx,
887 ToIdx: l2txs[i].ToIdx,
888 Amount: l2txs[i].Amount,
889 AmountFloat: amountFloat,
890 BatchNum: &l2txs[i].BatchNum,
891 EthBlockNum: l2txs[i].EthBlockNum,
892 // L2
893 Fee: &l2txs[i].Fee,
894 Nonce: &l2txs[i].Nonce,
895 })
896 }
897 return tracerr.Wrap(hdb.addTxs(d, txs))
898}
899
900func (hdb *HistoryDB) addTxs(d meddler.DB, txs []txWrite) error {
901 if len(txs) == 0 {
902 return nil
903 }
904 return tracerr.Wrap(db.BulkInsert(
905 d,
906 `INSERT INTO tx (
907 is_l1,
908 id,
909 type,
910 position,
911 from_idx,
912 to_idx,
913 amount,
914 amount_f,
915 token_id,
916 batch_num,
917 eth_block_num,
918 to_forge_l1_txs_num,
919 user_origin,
920 from_eth_addr,
921 from_bjj,
922 deposit_amount,
923 deposit_amount_f,
924 fee,
925 nonce
926 ) VALUES %s;`,
927 txs[:],
928 ))
929}
930
931// // GetTxs returns a list of txs from the DB
932// func (hdb *HistoryDB) GetTxs() ([]common.Tx, error) {
933// var txs []*common.Tx
934// err := meddler.QueryAll(
935// hdb.db, &txs,
936// `SELECT * FROM tx
937// ORDER BY (batch_num, position) ASC`,
938// )
939// return db.SlicePtrsToSlice(txs).([]common.Tx), err
940// }
941
942// GetHistoryTx returns a tx from the DB given a TxID
943func (hdb *HistoryDB) GetHistoryTx(txID common.TxID) (*TxAPI, error) {
944 // Warning: amount_success and deposit_amount_success have true as default for
945 // performance reasons. The expected default value is false (when txs are unforged)
946 // this case is handled at the function func (tx TxAPI) MarshalJSON() ([]byte, error)
947 tx := &TxAPI{}
948 err := meddler.QueryRow(
949 hdb.db, tx, `SELECT tx.item_id, tx.is_l1, tx.id, tx.type, tx.position,
950 hez_idx(tx.from_idx, token.symbol) AS from_idx, tx.from_eth_addr, tx.from_bjj,
951 hez_idx(tx.to_idx, token.symbol) AS to_idx, tx.to_eth_addr, tx.to_bjj,
952 tx.amount, tx.amount_success, tx.token_id, tx.amount_usd,
953 tx.batch_num, tx.eth_block_num, tx.to_forge_l1_txs_num, tx.user_origin,
954 tx.deposit_amount, tx.deposit_amount_usd, tx.deposit_amount_success, tx.fee, tx.fee_usd, tx.nonce,
955 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
956 token.eth_addr, token.name, token.symbol, token.decimals, token.usd,
957 token.usd_update, block.timestamp
958 FROM tx INNER JOIN token ON tx.token_id = token.token_id
959 INNER JOIN block ON tx.eth_block_num = block.eth_block_num
960 WHERE tx.id = $1;`, txID,
961 )
962 return tx, tracerr.Wrap(err)
963}
964
965// GetHistoryTxs returns a list of txs from the DB using the HistoryTx struct
966// and pagination info
967func (hdb *HistoryDB) GetHistoryTxs(
968 ethAddr *ethCommon.Address, bjj *babyjub.PublicKeyComp,
969 tokenID *common.TokenID, idx *common.Idx, batchNum *uint, txType *common.TxType,
970 fromItem, limit *uint, order string,
971) ([]TxAPI, uint64, error) {
972 // Warning: amount_success and deposit_amount_success have true as default for
973 // performance reasons. The expected default value is false (when txs are unforged)
974 // this case is handled at the function func (tx TxAPI) MarshalJSON() ([]byte, error)
975 if ethAddr != nil && bjj != nil {
976 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
977 }
978 var query string
979 var args []interface{}
980 queryStr := `SELECT tx.item_id, tx.is_l1, tx.id, tx.type, tx.position,
981 hez_idx(tx.from_idx, token.symbol) AS from_idx, tx.from_eth_addr, tx.from_bjj,
982 hez_idx(tx.to_idx, token.symbol) AS to_idx, tx.to_eth_addr, tx.to_bjj,
983 tx.amount, tx.amount_success, tx.token_id, tx.amount_usd,
984 tx.batch_num, tx.eth_block_num, tx.to_forge_l1_txs_num, tx.user_origin,
985 tx.deposit_amount, tx.deposit_amount_usd, tx.deposit_amount_success, tx.fee, tx.fee_usd, tx.nonce,
986 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
987 token.eth_addr, token.name, token.symbol, token.decimals, token.usd,
988 token.usd_update, block.timestamp, count(*) OVER() AS total_items
989 FROM tx INNER JOIN token ON tx.token_id = token.token_id
990 INNER JOIN block ON tx.eth_block_num = block.eth_block_num `
991 // Apply filters
992 nextIsAnd := false
993 // ethAddr filter
994 if ethAddr != nil {
995 queryStr += "WHERE (tx.from_eth_addr = ? OR tx.to_eth_addr = ?) "
996 nextIsAnd = true
997 args = append(args, ethAddr, ethAddr)
998 } else if bjj != nil { // bjj filter
999 queryStr += "WHERE (tx.from_bjj = ? OR tx.to_bjj = ?) "
1000 nextIsAnd = true
1001 args = append(args, bjj, bjj)
1002 }
1003 // tokenID filter
1004 if tokenID != nil {
1005 if nextIsAnd {
1006 queryStr += "AND "
1007 } else {
1008 queryStr += "WHERE "
1009 }
1010 queryStr += "tx.token_id = ? "
1011 args = append(args, tokenID)
1012 nextIsAnd = true
1013 }
1014 // idx filter
1015 if idx != nil {
1016 if nextIsAnd {
1017 queryStr += "AND "
1018 } else {
1019 queryStr += "WHERE "
1020 }
1021 queryStr += "(tx.from_idx = ? OR tx.to_idx = ?) "
1022 args = append(args, idx, idx)
1023 nextIsAnd = true
1024 }
1025 // batchNum filter
1026 if batchNum != nil {
1027 if nextIsAnd {
1028 queryStr += "AND "
1029 } else {
1030 queryStr += "WHERE "
1031 }
1032 queryStr += "tx.batch_num = ? "
1033 args = append(args, batchNum)
1034 nextIsAnd = true
1035 }
1036 // txType filter
1037 if txType != nil {
1038 if nextIsAnd {
1039 queryStr += "AND "
1040 } else {
1041 queryStr += "WHERE "
1042 }
1043 queryStr += "tx.type = ? "
1044 args = append(args, txType)
1045 nextIsAnd = true
1046 }
1047 if fromItem != nil {
1048 if nextIsAnd {
1049 queryStr += "AND "
1050 } else {
1051 queryStr += "WHERE "
1052 }
1053 if order == OrderAsc {
1054 queryStr += "tx.item_id >= ? "
1055 } else {
1056 queryStr += "tx.item_id <= ? "
1057 }
1058 args = append(args, fromItem)
1059 nextIsAnd = true
1060 }
1061 if nextIsAnd {
1062 queryStr += "AND "
1063 } else {
1064 queryStr += "WHERE "
1065 }
1066 queryStr += "tx.batch_num IS NOT NULL "
1067
1068 // pagination
1069 queryStr += "ORDER BY tx.item_id "
1070 if order == OrderAsc {
1071 queryStr += " ASC "
1072 } else {
1073 queryStr += " DESC "
1074 }
1075 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1076 query = hdb.db.Rebind(queryStr)
1077 // log.Debug(query)
1078 txsPtrs := []*TxAPI{}
1079 if err := meddler.QueryAll(hdb.db, &txsPtrs, query, args...); err != nil {
1080 return nil, 0, tracerr.Wrap(err)
1081 }
1082 txs := db.SlicePtrsToSlice(txsPtrs).([]TxAPI)
1083 if len(txs) == 0 {
1084 return txs, 0, nil
1085 }
1086 return txs, txs[0].TotalItems - uint64(len(txs)), nil
1087}
1088
1089// GetAllExits returns all exit from the DB
1090func (hdb *HistoryDB) GetAllExits() ([]common.ExitInfo, error) {
1091 var exits []*common.ExitInfo
1092 err := meddler.QueryAll(
1093 hdb.db, &exits,
1094 `SELECT exit_tree.batch_num, exit_tree.account_idx, exit_tree.merkle_proof,
1095 exit_tree.balance, exit_tree.instant_withdrawn, exit_tree.delayed_withdraw_request,
1096 exit_tree.delayed_withdrawn FROM exit_tree ORDER BY item_id;`,
1097 )
1098 return db.SlicePtrsToSlice(exits).([]common.ExitInfo), tracerr.Wrap(err)
1099}
1100
1101// GetExitAPI returns a exit from the DB
1102func (hdb *HistoryDB) GetExitAPI(batchNum *uint, idx *common.Idx) (*ExitAPI, error) {
1103 exit := &ExitAPI{}
1104 err := meddler.QueryRow(
1105 hdb.db, exit, `SELECT exit_tree.item_id, exit_tree.batch_num,
1106 hez_idx(exit_tree.account_idx, token.symbol) AS account_idx,
1107 account.bjj, account.eth_addr,
1108 exit_tree.merkle_proof, exit_tree.balance, exit_tree.instant_withdrawn,
1109 exit_tree.delayed_withdraw_request, exit_tree.delayed_withdrawn,
1110 token.token_id, token.item_id AS token_item_id,
1111 token.eth_block_num AS token_block, token.eth_addr AS token_eth_addr, token.name, token.symbol,
1112 token.decimals, token.usd, token.usd_update
1113 FROM exit_tree INNER JOIN account ON exit_tree.account_idx = account.idx
1114 INNER JOIN token ON account.token_id = token.token_id
1115 WHERE exit_tree.batch_num = $1 AND exit_tree.account_idx = $2;`, batchNum, idx,
1116 )
1117 return exit, tracerr.Wrap(err)
1118}
1119
1120// GetExitsAPI returns a list of exits from the DB and pagination info
1121func (hdb *HistoryDB) GetExitsAPI(
1122 ethAddr *ethCommon.Address, bjj *babyjub.PublicKeyComp, tokenID *common.TokenID,
1123 idx *common.Idx, batchNum *uint, onlyPendingWithdraws *bool,
1124 fromItem, limit *uint, order string,
1125) ([]ExitAPI, uint64, error) {
1126 if ethAddr != nil && bjj != nil {
1127 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
1128 }
1129 var query string
1130 var args []interface{}
1131 queryStr := `SELECT exit_tree.item_id, exit_tree.batch_num,
1132 hez_idx(exit_tree.account_idx, token.symbol) AS account_idx,
1133 account.bjj, account.eth_addr,
1134 exit_tree.merkle_proof, exit_tree.balance, exit_tree.instant_withdrawn,
1135 exit_tree.delayed_withdraw_request, exit_tree.delayed_withdrawn,
1136 token.token_id, token.item_id AS token_item_id,
1137 token.eth_block_num AS token_block, token.eth_addr AS token_eth_addr, token.name, token.symbol,
1138 token.decimals, token.usd, token.usd_update, COUNT(*) OVER() AS total_items
1139 FROM exit_tree INNER JOIN account ON exit_tree.account_idx = account.idx
1140 INNER JOIN token ON account.token_id = token.token_id `
1141 // Apply filters
1142 nextIsAnd := false
1143 // ethAddr filter
1144 if ethAddr != nil {
1145 queryStr += "WHERE account.eth_addr = ? "
1146 nextIsAnd = true
1147 args = append(args, ethAddr)
1148 } else if bjj != nil { // bjj filter
1149 queryStr += "WHERE account.bjj = ? "
1150 nextIsAnd = true
1151 args = append(args, bjj)
1152 }
1153 // tokenID filter
1154 if tokenID != nil {
1155 if nextIsAnd {
1156 queryStr += "AND "
1157 } else {
1158 queryStr += "WHERE "
1159 }
1160 queryStr += "account.token_id = ? "
1161 args = append(args, tokenID)
1162 nextIsAnd = true
1163 }
1164 // idx filter
1165 if idx != nil {
1166 if nextIsAnd {
1167 queryStr += "AND "
1168 } else {
1169 queryStr += "WHERE "
1170 }
1171 queryStr += "exit_tree.account_idx = ? "
1172 args = append(args, idx)
1173 nextIsAnd = true
1174 }
1175 // batchNum filter
1176 if batchNum != nil {
1177 if nextIsAnd {
1178 queryStr += "AND "
1179 } else {
1180 queryStr += "WHERE "
1181 }
1182 queryStr += "exit_tree.batch_num = ? "
1183 args = append(args, batchNum)
1184 nextIsAnd = true
1185 }
1186 // onlyPendingWithdraws
1187 if onlyPendingWithdraws != nil {
1188 if *onlyPendingWithdraws {
1189 if nextIsAnd {
1190 queryStr += "AND "
1191 } else {
1192 queryStr += "WHERE "
1193 }
1194 queryStr += "(exit_tree.instant_withdrawn IS NULL AND exit_tree.delayed_withdrawn IS NULL) "
1195 nextIsAnd = true
1196 }
1197 }
1198 if fromItem != nil {
1199 if nextIsAnd {
1200 queryStr += "AND "
1201 } else {
1202 queryStr += "WHERE "
1203 }
1204 if order == OrderAsc {
1205 queryStr += "exit_tree.item_id >= ? "
1206 } else {
1207 queryStr += "exit_tree.item_id <= ? "
1208 }
1209 args = append(args, fromItem)
1210 // nextIsAnd = true
1211 }
1212 // pagination
1213 queryStr += "ORDER BY exit_tree.item_id "
1214 if order == OrderAsc {
1215 queryStr += " ASC "
1216 } else {
1217 queryStr += " DESC "
1218 }
1219 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1220 query = hdb.db.Rebind(queryStr)
1221 // log.Debug(query)
1222 exits := []*ExitAPI{}
1223 if err := meddler.QueryAll(hdb.db, &exits, query, args...); err != nil {
1224 return nil, 0, tracerr.Wrap(err)
1225 }
1226 if len(exits) == 0 {
1227 return []ExitAPI{}, 0, nil
1228 }
1229 return db.SlicePtrsToSlice(exits).([]ExitAPI), exits[0].TotalItems - uint64(len(exits)), nil
1230}
1231
1232// GetAllL1UserTxs returns all L1UserTxs from the DB
1233func (hdb *HistoryDB) GetAllL1UserTxs() ([]common.L1Tx, error) {
1234 var txs []*common.L1Tx
1235 err := meddler.QueryAll(
1236 hdb.db, &txs, // Note that '\x' gets parsed as a big.Int with value = 0
1237 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1238 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1239 tx.amount, (CASE WHEN tx.batch_num IS NULL THEN NULL WHEN tx.amount_success THEN tx.amount ELSE '\x' END) AS effective_amount,
1240 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,
1241 tx.eth_block_num, tx.type, tx.batch_num
1242 FROM tx WHERE is_l1 = TRUE AND user_origin = TRUE ORDER BY item_id;`,
1243 )
1244 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1245}
1246
1247// GetAllL1CoordinatorTxs returns all L1CoordinatorTxs from the DB
1248func (hdb *HistoryDB) GetAllL1CoordinatorTxs() ([]common.L1Tx, error) {
1249 var txs []*common.L1Tx
1250 // Since the query specifies that only coordinator txs are returned, it's safe to assume
1251 // that returned txs will always have effective amounts
1252 err := meddler.QueryAll(
1253 hdb.db, &txs,
1254 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1255 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1256 tx.amount, tx.amount AS effective_amount,
1257 tx.deposit_amount, tx.deposit_amount AS effective_deposit_amount,
1258 tx.eth_block_num, tx.type, tx.batch_num
1259 FROM tx WHERE is_l1 = TRUE AND user_origin = FALSE ORDER BY item_id;`,
1260 )
1261 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1262}
1263
1264// GetAllL2Txs returns all L2Txs from the DB
1265func (hdb *HistoryDB) GetAllL2Txs() ([]common.L2Tx, error) {
1266 var txs []*common.L2Tx
1267 err := meddler.QueryAll(
1268 hdb.db, &txs,
1269 `SELECT tx.id, tx.batch_num, tx.position,
1270 tx.from_idx, tx.to_idx, tx.amount, tx.fee, tx.nonce,
1271 tx.type, tx.eth_block_num
1272 FROM tx WHERE is_l1 = FALSE ORDER BY item_id;`,
1273 )
1274 return db.SlicePtrsToSlice(txs).([]common.L2Tx), tracerr.Wrap(err)
1275}
1276
1277// GetUnforgedL1UserTxs gets L1 User Txs to be forged in the L1Batch with toForgeL1TxsNum.
1278func (hdb *HistoryDB) GetUnforgedL1UserTxs(toForgeL1TxsNum int64) ([]common.L1Tx, error) {
1279 var txs []*common.L1Tx
1280 err := meddler.QueryAll(
1281 hdb.db, &txs, // only L1 user txs can have batch_num set to null
1282 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1283 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1284 tx.amount, NULL AS effective_amount,
1285 tx.deposit_amount, NULL AS effective_deposit_amount,
1286 tx.eth_block_num, tx.type, tx.batch_num
1287 FROM tx WHERE batch_num IS NULL AND to_forge_l1_txs_num = $1
1288 ORDER BY position;`,
1289 toForgeL1TxsNum,
1290 )
1291 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1292}
1293
1294// TODO: Think about chaning all the queries that return a last value, to queries that return the next valid value.
1295
1296// GetLastTxsPosition for a given to_forge_l1_txs_num
1297func (hdb *HistoryDB) GetLastTxsPosition(toForgeL1TxsNum int64) (int, error) {
1298 row := hdb.db.QueryRow(
1299 "SELECT position FROM tx WHERE to_forge_l1_txs_num = $1 ORDER BY position DESC;",
1300 toForgeL1TxsNum,
1301 )
1302 var lastL1TxsPosition int
1303 return lastL1TxsPosition, tracerr.Wrap(row.Scan(&lastL1TxsPosition))
1304}
1305
1306// GetSCVars returns the rollup, auction and wdelayer smart contracts variables at their last update.
1307func (hdb *HistoryDB) GetSCVars() (*common.RollupVariables, *common.AuctionVariables,
1308 *common.WDelayerVariables, error) {
1309 var rollup common.RollupVariables
1310 var auction common.AuctionVariables
1311 var wDelayer common.WDelayerVariables
1312 if err := meddler.QueryRow(hdb.db, &rollup,
1313 "SELECT * FROM rollup_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1314 return nil, nil, nil, tracerr.Wrap(err)
1315 }
1316 if err := meddler.QueryRow(hdb.db, &auction,
1317 "SELECT * FROM auction_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1318 return nil, nil, nil, tracerr.Wrap(err)
1319 }
1320 if err := meddler.QueryRow(hdb.db, &wDelayer,
1321 "SELECT * FROM wdelayer_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1322 return nil, nil, nil, tracerr.Wrap(err)
1323 }
1324 return &rollup, &auction, &wDelayer, nil
1325}
1326
1327func (hdb *HistoryDB) setRollupVars(d meddler.DB, rollup *common.RollupVariables) error {
1328 return tracerr.Wrap(meddler.Insert(d, "rollup_vars", rollup))
1329}
1330
1331func (hdb *HistoryDB) setAuctionVars(d meddler.DB, auction *common.AuctionVariables) error {
1332 return tracerr.Wrap(meddler.Insert(d, "auction_vars", auction))
1333}
1334
1335func (hdb *HistoryDB) setWDelayerVars(d meddler.DB, wDelayer *common.WDelayerVariables) error {
1336 return tracerr.Wrap(meddler.Insert(d, "wdelayer_vars", wDelayer))
1337}
1338
1339func (hdb *HistoryDB) addBucketUpdates(d meddler.DB, bucketUpdates []common.BucketUpdate) error {
1340 if len(bucketUpdates) == 0 {
1341 return nil
1342 }
1343 return tracerr.Wrap(db.BulkInsert(
1344 d,
1345 `INSERT INTO bucket_update (
1346 eth_block_num,
1347 num_bucket,
1348 block_stamp,
1349 withdrawals
1350 ) VALUES %s;`,
1351 bucketUpdates[:],
1352 ))
1353}
1354
1355// GetAllBucketUpdates retrieves all the bucket updates
1356func (hdb *HistoryDB) GetAllBucketUpdates() ([]common.BucketUpdate, error) {
1357 var bucketUpdates []*common.BucketUpdate
1358 err := meddler.QueryAll(
1359 hdb.db, &bucketUpdates,
1360 `SELECT eth_block_num, num_bucket, block_stamp, withdrawals
1361 FROM bucket_update ORDER BY item_id;`,
1362 )
1363 return db.SlicePtrsToSlice(bucketUpdates).([]common.BucketUpdate), tracerr.Wrap(err)
1364}
1365
1366func (hdb *HistoryDB) addTokenExchanges(d meddler.DB, tokenExchanges []common.TokenExchange) error {
1367 if len(tokenExchanges) == 0 {
1368 return nil
1369 }
1370 return tracerr.Wrap(db.BulkInsert(
1371 d,
1372 `INSERT INTO token_exchange (
1373 eth_block_num,
1374 eth_addr,
1375 value_usd
1376 ) VALUES %s;`,
1377 tokenExchanges[:],
1378 ))
1379}
1380
1381// GetAllTokenExchanges retrieves all the token exchanges
1382func (hdb *HistoryDB) GetAllTokenExchanges() ([]common.TokenExchange, error) {
1383 var tokenExchanges []*common.TokenExchange
1384 err := meddler.QueryAll(
1385 hdb.db, &tokenExchanges,
1386 "SELECT eth_block_num, eth_addr, value_usd FROM token_exchange ORDER BY item_id;",
1387 )
1388 return db.SlicePtrsToSlice(tokenExchanges).([]common.TokenExchange), tracerr.Wrap(err)
1389}
1390
1391func (hdb *HistoryDB) addEscapeHatchWithdrawals(d meddler.DB,
1392 escapeHatchWithdrawals []common.WDelayerEscapeHatchWithdrawal) error {
1393 if len(escapeHatchWithdrawals) == 0 {
1394 return nil
1395 }
1396 return tracerr.Wrap(db.BulkInsert(
1397 d,
1398 `INSERT INTO escape_hatch_withdrawal (
1399 eth_block_num,
1400 who_addr,
1401 to_addr,
1402 token_addr,
1403 amount
1404 ) VALUES %s;`,
1405 escapeHatchWithdrawals[:],
1406 ))
1407}
1408
1409// GetAllEscapeHatchWithdrawals retrieves all the escape hatch withdrawals
1410func (hdb *HistoryDB) GetAllEscapeHatchWithdrawals() ([]common.WDelayerEscapeHatchWithdrawal, error) {
1411 var escapeHatchWithdrawals []*common.WDelayerEscapeHatchWithdrawal
1412 err := meddler.QueryAll(
1413 hdb.db, &escapeHatchWithdrawals,
1414 "SELECT eth_block_num, who_addr, to_addr, token_addr, amount FROM escape_hatch_withdrawal ORDER BY item_id;",
1415 )
1416 return db.SlicePtrsToSlice(escapeHatchWithdrawals).([]common.WDelayerEscapeHatchWithdrawal),
1417 tracerr.Wrap(err)
1418}
1419
1420// SetInitialSCVars sets the initial state of rollup, auction, wdelayer smart
1421// contract variables. This initial state is stored linked to block 0, which
1422// always exist in the DB and is used to store initialization data that always
1423// exist in the smart contracts.
1424func (hdb *HistoryDB) SetInitialSCVars(rollup *common.RollupVariables,
1425 auction *common.AuctionVariables, wDelayer *common.WDelayerVariables) error {
1426 txn, err := hdb.db.Beginx()
1427 if err != nil {
1428 return tracerr.Wrap(err)
1429 }
1430 defer func() {
1431 if err != nil {
1432 db.Rollback(txn)
1433 }
1434 }()
1435 // Force EthBlockNum to be 0 because it's the block used to link data
1436 // that belongs to the creation of the smart contracts
1437 rollup.EthBlockNum = 0
1438 auction.EthBlockNum = 0
1439 wDelayer.EthBlockNum = 0
1440 auction.DefaultSlotSetBidSlotNum = 0
1441 if err := hdb.setRollupVars(txn, rollup); err != nil {
1442 return tracerr.Wrap(err)
1443 }
1444 if err := hdb.setAuctionVars(txn, auction); err != nil {
1445 return tracerr.Wrap(err)
1446 }
1447 if err := hdb.setWDelayerVars(txn, wDelayer); err != nil {
1448 return tracerr.Wrap(err)
1449 }
1450
1451 return tracerr.Wrap(txn.Commit())
1452}
1453
1454// setL1UserTxEffectiveAmounts sets the EffectiveAmount and EffectiveDepositAmount
1455// of the given l1UserTxs (with an UPDATE)
1456func (hdb *HistoryDB) setL1UserTxEffectiveAmounts(d sqlx.Ext, txs []common.L1Tx) error {
1457 if len(txs) == 0 {
1458 return nil
1459 }
1460 // Effective amounts are stored as success flags in the DB, with true value by default
1461 // to reduce the amount of updates. Therefore, only amounts that became uneffective should be
1462 // updated to become false
1463 type txUpdate struct {
1464 ID common.TxID `db:"id"`
1465 AmountSuccess bool `db:"amount_success"`
1466 DepositAmountSuccess bool `db:"deposit_amount_success"`
1467 }
1468 txUpdates := []txUpdate{}
1469 equal := func(a *big.Int, b *big.Int) bool {
1470 return a.Cmp(b) == 0
1471 }
1472 for i := range txs {
1473 amountSuccess := equal(txs[i].Amount, txs[i].EffectiveAmount)
1474 depositAmountSuccess := equal(txs[i].DepositAmount, txs[i].EffectiveDepositAmount)
1475 if !amountSuccess || !depositAmountSuccess {
1476 txUpdates = append(txUpdates, txUpdate{
1477 ID: txs[i].TxID,
1478 AmountSuccess: amountSuccess,
1479 DepositAmountSuccess: depositAmountSuccess,
1480 })
1481 }
1482 }
1483 const query string = `
1484 UPDATE tx SET
1485 amount_success = tx_update.amount_success,
1486 deposit_amount_success = tx_update.deposit_amount_success
1487 FROM (VALUES
1488 (NULL::::BYTEA, NULL::::BOOL, NULL::::BOOL),
1489 (:id, :amount_success, :deposit_amount_success)
1490 ) as tx_update (id, amount_success, deposit_amount_success)
1491 WHERE tx.id = tx_update.id;
1492 `
1493 if len(txUpdates) > 0 {
1494 if _, err := sqlx.NamedExec(d, query, txUpdates); err != nil {
1495 return tracerr.Wrap(err)
1496 }
1497 }
1498 return nil
1499}
1500
1501// AddBlockSCData stores all the information of a block retrieved by the
1502// Synchronizer. Blocks should be inserted in order, leaving no gaps because
1503// the pagination system of the API/DB depends on this. Within blocks, all
1504// items should also be in the correct order (Accounts, Tokens, Txs, etc.)
1505func (hdb *HistoryDB) AddBlockSCData(blockData *common.BlockData) (err error) {
1506 txn, err := hdb.db.Beginx()
1507 if err != nil {
1508 return tracerr.Wrap(err)
1509 }
1510 defer func() {
1511 if err != nil {
1512 db.Rollback(txn)
1513 }
1514 }()
1515
1516 // Add block
1517 if err := hdb.addBlock(txn, &blockData.Block); err != nil {
1518 return tracerr.Wrap(err)
1519 }
1520
1521 // Add Coordinators
1522 if err := hdb.addCoordinators(txn, blockData.Auction.Coordinators); err != nil {
1523 return tracerr.Wrap(err)
1524 }
1525
1526 // Add Bids
1527 if err := hdb.addBids(txn, blockData.Auction.Bids); err != nil {
1528 return tracerr.Wrap(err)
1529 }
1530
1531 // Add Tokens
1532 if err := hdb.addTokens(txn, blockData.Rollup.AddedTokens); err != nil {
1533 return tracerr.Wrap(err)
1534 }
1535
1536 // Prepare user L1 txs to be added.
1537 // They must be added before the batch that will forge them (which can be in the same block)
1538 // and after the account that will be sent to (also can be in the same block).
1539 // Note: insert order is not relevant since item_id will be updated by a DB trigger when
1540 // the batch that forges those txs is inserted
1541 userL1s := make(map[common.BatchNum][]common.L1Tx)
1542 for i := range blockData.Rollup.L1UserTxs {
1543 batchThatForgesIsInTheBlock := false
1544 for _, batch := range blockData.Rollup.Batches {
1545 if batch.Batch.ForgeL1TxsNum != nil &&
1546 *batch.Batch.ForgeL1TxsNum == *blockData.Rollup.L1UserTxs[i].ToForgeL1TxsNum {
1547 // Tx is forged in this block. It's guaranteed that:
1548 // * the first batch of the block won't forge user L1 txs that have been added in this block
1549 // * batch nums are sequential therefore it's safe to add the tx at batch.BatchNum -1
1550 batchThatForgesIsInTheBlock = true
1551 addAtBatchNum := batch.Batch.BatchNum - 1
1552 userL1s[addAtBatchNum] = append(userL1s[addAtBatchNum], blockData.Rollup.L1UserTxs[i])
1553 break
1554 }
1555 }
1556 if !batchThatForgesIsInTheBlock {
1557 // User artificial batchNum 0 to add txs that are not forge in this block
1558 // after all the accounts of the block have been added
1559 userL1s[0] = append(userL1s[0], blockData.Rollup.L1UserTxs[i])
1560 }
1561 }
1562
1563 // Add Batches
1564 for i := range blockData.Rollup.Batches {
1565 batch := &blockData.Rollup.Batches[i]
1566
1567 // Add Batch: this will trigger an update on the DB
1568 // that will set the batch num of forged L1 txs in this batch
1569 if err = hdb.addBatch(txn, &batch.Batch); err != nil {
1570 return tracerr.Wrap(err)
1571 }
1572
1573 // Set the EffectiveAmount and EffectiveDepositAmount of all the
1574 // L1UserTxs that have been forged in this batch
1575 if err = hdb.setL1UserTxEffectiveAmounts(txn, batch.L1UserTxs); err != nil {
1576 return tracerr.Wrap(err)
1577 }
1578
1579 // Add accounts
1580 if err := hdb.addAccounts(txn, batch.CreatedAccounts); err != nil {
1581 return tracerr.Wrap(err)
1582 }
1583
1584 // Add forged l1 coordinator Txs
1585 if err := hdb.addL1Txs(txn, batch.L1CoordinatorTxs); err != nil {
1586 return tracerr.Wrap(err)
1587 }
1588
1589 // Add l2 Txs
1590 if err := hdb.addL2Txs(txn, batch.L2Txs); err != nil {
1591 return tracerr.Wrap(err)
1592 }
1593
1594 // Add user L1 txs that will be forged in next batch
1595 if userlL1s, ok := userL1s[batch.Batch.BatchNum]; ok {
1596 if err := hdb.addL1Txs(txn, userlL1s); err != nil {
1597 return tracerr.Wrap(err)
1598 }
1599 }
1600
1601 // Add exit tree
1602 if err := hdb.addExitTree(txn, batch.ExitTree); err != nil {
1603 return tracerr.Wrap(err)
1604 }
1605 }
1606 // Add user L1 txs that won't be forged in this block
1607 if userL1sNotForgedInThisBlock, ok := userL1s[0]; ok {
1608 if err := hdb.addL1Txs(txn, userL1sNotForgedInThisBlock); err != nil {
1609 return tracerr.Wrap(err)
1610 }
1611 }
1612
1613 // Set SC Vars if there was an update
1614 if blockData.Rollup.Vars != nil {
1615 if err := hdb.setRollupVars(txn, blockData.Rollup.Vars); err != nil {
1616 return tracerr.Wrap(err)
1617 }
1618 }
1619 if blockData.Auction.Vars != nil {
1620 if err := hdb.setAuctionVars(txn, blockData.Auction.Vars); err != nil {
1621 return tracerr.Wrap(err)
1622 }
1623 }
1624 if blockData.WDelayer.Vars != nil {
1625 if err := hdb.setWDelayerVars(txn, blockData.WDelayer.Vars); err != nil {
1626 return tracerr.Wrap(err)
1627 }
1628 }
1629
1630 // Update withdrawals in exit tree table
1631 if err := hdb.updateExitTree(txn, blockData.Block.Num,
1632 blockData.Rollup.Withdrawals, blockData.WDelayer.Withdrawals); err != nil {
1633 return tracerr.Wrap(err)
1634 }
1635
1636 // Add Escape Hatch Withdrawals
1637 if err := hdb.addEscapeHatchWithdrawals(txn,
1638 blockData.WDelayer.EscapeHatchWithdrawals); err != nil {
1639 return tracerr.Wrap(err)
1640 }
1641
1642 // Add Buckets withdrawals updates
1643 if err := hdb.addBucketUpdates(txn, blockData.Rollup.UpdateBucketWithdraw); err != nil {
1644 return tracerr.Wrap(err)
1645 }
1646
1647 // Add Token exchange updates
1648 if err := hdb.addTokenExchanges(txn, blockData.Rollup.TokenExchanges); err != nil {
1649 return tracerr.Wrap(err)
1650 }
1651
1652 return tracerr.Wrap(txn.Commit())
1653}
1654
1655// GetCoordinatorAPI returns a coordinator by its bidderAddr
1656func (hdb *HistoryDB) GetCoordinatorAPI(bidderAddr ethCommon.Address) (*CoordinatorAPI, error) {
1657 coordinator := &CoordinatorAPI{}
1658 err := meddler.QueryRow(
1659 hdb.db, coordinator,
1660 "SELECT * FROM coordinator WHERE bidder_addr = $1 ORDER BY item_id DESC LIMIT 1;",
1661 bidderAddr,
1662 )
1663 return coordinator, tracerr.Wrap(err)
1664}
1665
1666// GetCoordinatorsAPI returns a list of coordinators from the DB and pagination info
1667func (hdb *HistoryDB) GetCoordinatorsAPI(
1668 bidderAddr, forgerAddr *ethCommon.Address,
1669 fromItem, limit *uint, order string,
1670) ([]CoordinatorAPI, uint64, error) {
1671 var query string
1672 var args []interface{}
1673 queryStr := `SELECT coordinator.*, COUNT(*) OVER() AS total_items
1674 FROM coordinator INNER JOIN (
1675 SELECT MAX(item_id) AS item_id FROM coordinator
1676 GROUP BY bidder_addr
1677 ) c ON coordinator.item_id = c.item_id `
1678 // Apply filters
1679 nextIsAnd := false
1680 if bidderAddr != nil {
1681 queryStr += "WHERE bidder_addr = ? "
1682 nextIsAnd = true
1683 args = append(args, bidderAddr)
1684 }
1685 if forgerAddr != nil {
1686 if nextIsAnd {
1687 queryStr += "AND "
1688 } else {
1689 queryStr += "WHERE "
1690 }
1691 queryStr += "forger_addr = ? "
1692 nextIsAnd = true
1693 args = append(args, forgerAddr)
1694 }
1695 if fromItem != nil {
1696 if nextIsAnd {
1697 queryStr += "AND "
1698 } else {
1699 queryStr += "WHERE "
1700 }
1701 if order == OrderAsc {
1702 queryStr += "coordinator.item_id >= ? "
1703 } else {
1704 queryStr += "coordinator.item_id <= ? "
1705 }
1706 args = append(args, fromItem)
1707 }
1708 // pagination
1709 queryStr += "ORDER BY coordinator.item_id "
1710 if order == OrderAsc {
1711 queryStr += " ASC "
1712 } else {
1713 queryStr += " DESC "
1714 }
1715 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1716 query = hdb.db.Rebind(queryStr)
1717
1718 coordinators := []*CoordinatorAPI{}
1719 if err := meddler.QueryAll(hdb.db, &coordinators, query, args...); err != nil {
1720 return nil, 0, tracerr.Wrap(err)
1721 }
1722 if len(coordinators) == 0 {
1723 return []CoordinatorAPI{}, 0, nil
1724 }
1725 return db.SlicePtrsToSlice(coordinators).([]CoordinatorAPI),
1726 coordinators[0].TotalItems - uint64(len(coordinators)), nil
1727}
1728
1729// AddAuctionVars insert auction vars into the DB
1730func (hdb *HistoryDB) AddAuctionVars(auctionVars *common.AuctionVariables) error {
1731 return tracerr.Wrap(meddler.Insert(hdb.db, "auction_vars", auctionVars))
1732}
1733
1734// GetAuctionVars returns auction variables
1735func (hdb *HistoryDB) GetAuctionVars() (*common.AuctionVariables, error) {
1736 auctionVars := &common.AuctionVariables{}
1737 err := meddler.QueryRow(
1738 hdb.db, auctionVars, `SELECT * FROM auction_vars;`,
1739 )
1740 return auctionVars, tracerr.Wrap(err)
1741}
1742
1743// GetAuctionVarsUntilSetSlotNum returns all the updates of the auction vars
1744// from the last entry in which DefaultSlotSetBidSlotNum <= slotNum
1745func (hdb *HistoryDB) GetAuctionVarsUntilSetSlotNum(slotNum int64, maxItems int) ([]MinBidInfo, error) {
1746 auctionVars := []*MinBidInfo{}
1747 query := `
1748 SELECT DISTINCT default_slot_set_bid, default_slot_set_bid_slot_num FROM auction_vars
1749 WHERE default_slot_set_bid_slot_num < $1
1750 ORDER BY default_slot_set_bid_slot_num DESC
1751 LIMIT $2;
1752 `
1753 err := meddler.QueryAll(hdb.db, &auctionVars, query, slotNum, maxItems)
1754 if err != nil {
1755 return nil, tracerr.Wrap(err)
1756 }
1757 return db.SlicePtrsToSlice(auctionVars).([]MinBidInfo), nil
1758}
1759
1760// GetAccountAPI returns an account by its index
1761func (hdb *HistoryDB) GetAccountAPI(idx common.Idx) (*AccountAPI, error) {
1762 account := &AccountAPI{}
1763 err := meddler.QueryRow(hdb.db, account, `SELECT account.item_id, hez_idx(account.idx,
1764 token.symbol) as idx, account.batch_num, account.bjj, account.eth_addr,
1765 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
1766 token.eth_addr as token_eth_addr, token.name, token.symbol, token.decimals, token.usd, token.usd_update
1767 FROM account INNER JOIN token ON account.token_id = token.token_id WHERE idx = $1;`, idx)
1768
1769 if err != nil {
1770 return nil, tracerr.Wrap(err)
1771 }
1772
1773 return account, nil
1774}
1775
1776// GetAccountsAPI returns a list of accounts from the DB and pagination info
1777func (hdb *HistoryDB) GetAccountsAPI(
1778 tokenIDs []common.TokenID, ethAddr *ethCommon.Address,
1779 bjj *babyjub.PublicKeyComp, fromItem, limit *uint, order string,
1780) ([]AccountAPI, uint64, error) {
1781 if ethAddr != nil && bjj != nil {
1782 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
1783 }
1784 var query string
1785 var args []interface{}
1786 queryStr := `SELECT account.item_id, hez_idx(account.idx, token.symbol) as idx, account.batch_num,
1787 account.bjj, account.eth_addr, token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
1788 token.eth_addr as token_eth_addr, token.name, token.symbol, token.decimals, token.usd, token.usd_update,
1789 COUNT(*) OVER() AS total_items
1790 FROM account INNER JOIN token ON account.token_id = token.token_id `
1791 // Apply filters
1792 nextIsAnd := false
1793 // ethAddr filter
1794 if ethAddr != nil {
1795 queryStr += "WHERE account.eth_addr = ? "
1796 nextIsAnd = true
1797 args = append(args, ethAddr)
1798 } else if bjj != nil { // bjj filter
1799 queryStr += "WHERE account.bjj = ? "
1800 nextIsAnd = true
1801 args = append(args, bjj)
1802 }
1803 // tokenID filter
1804 if len(tokenIDs) > 0 {
1805 if nextIsAnd {
1806 queryStr += "AND "
1807 } else {
1808 queryStr += "WHERE "
1809 }
1810 queryStr += "account.token_id IN (?) "
1811 args = append(args, tokenIDs)
1812 nextIsAnd = true
1813 }
1814 if fromItem != nil {
1815 if nextIsAnd {
1816 queryStr += "AND "
1817 } else {
1818 queryStr += "WHERE "
1819 }
1820 if order == OrderAsc {
1821 queryStr += "account.item_id >= ? "
1822 } else {
1823 queryStr += "account.item_id <= ? "
1824 }
1825 args = append(args, fromItem)
1826 }
1827 // pagination
1828 queryStr += "ORDER BY account.item_id "
1829 if order == OrderAsc {
1830 queryStr += " ASC "
1831 } else {
1832 queryStr += " DESC "
1833 }
1834 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1835 query, argsQ, err := sqlx.In(queryStr, args...)
1836 if err != nil {
1837 return nil, 0, tracerr.Wrap(err)
1838 }
1839 query = hdb.db.Rebind(query)
1840
1841 accounts := []*AccountAPI{}
1842 if err := meddler.QueryAll(hdb.db, &accounts, query, argsQ...); err != nil {
1843 return nil, 0, tracerr.Wrap(err)
1844 }
1845 if len(accounts) == 0 {
1846 return []AccountAPI{}, 0, nil
1847 }
1848
1849 return db.SlicePtrsToSlice(accounts).([]AccountAPI),
1850 accounts[0].TotalItems - uint64(len(accounts)), nil
1851}
1852
1853// GetMetrics returns metrics
1854func (hdb *HistoryDB) GetMetrics(lastBatchNum common.BatchNum) (*Metrics, error) {
1855 metricsTotals := &MetricsTotals{}
1856 metrics := &Metrics{}
1857 err := meddler.QueryRow(
1858 hdb.db, metricsTotals, `SELECT COUNT(tx.*) as total_txs,
1859 COALESCE (MIN(tx.batch_num), 0) as batch_num, COALESCE (MIN(block.timestamp),
1860 NOW()) AS min_timestamp, COALESCE (MAX(block.timestamp), NOW()) AS max_timestamp
1861 FROM tx INNER JOIN block ON tx.eth_block_num = block.eth_block_num
1862 WHERE block.timestamp >= NOW() - INTERVAL '24 HOURS';`)
1863 if err != nil {
1864 return nil, tracerr.Wrap(err)
1865 }
1866
1867 seconds := metricsTotals.MaxTimestamp.Sub(metricsTotals.MinTimestamp).Seconds()
1868 // Avoid dividing by 0
1869 if seconds == 0 {
1870 seconds++
1871 }
1872
1873 metrics.TransactionsPerSecond = float64(metricsTotals.TotalTransactions) / seconds
1874
1875 if (lastBatchNum - metricsTotals.FirstBatchNum) > 0 {
1876 metrics.TransactionsPerBatch = float64(metricsTotals.TotalTransactions) /
1877 float64(lastBatchNum-metricsTotals.FirstBatchNum+1)
1878 } else {
1879 metrics.TransactionsPerBatch = float64(0)
1880 }
1881
1882 err = meddler.QueryRow(
1883 hdb.db, metricsTotals, `SELECT COUNT(*) AS total_batches,
1884 COALESCE (SUM(total_fees_usd), 0) AS total_fees FROM batch
1885 WHERE batch_num > $1;`, metricsTotals.FirstBatchNum)
1886 if err != nil {
1887 return nil, tracerr.Wrap(err)
1888 }
1889 if metricsTotals.TotalBatches > 0 {
1890 metrics.BatchFrequency = seconds / float64(metricsTotals.TotalBatches)
1891 } else {
1892 metrics.BatchFrequency = 0
1893 }
1894 if metricsTotals.TotalTransactions > 0 {
1895 metrics.AvgTransactionFee = metricsTotals.TotalFeesUSD / float64(metricsTotals.TotalTransactions)
1896 } else {
1897 metrics.AvgTransactionFee = 0
1898 }
1899 err = meddler.QueryRow(
1900 hdb.db, metrics,
1901 `SELECT COUNT(*) AS total_bjjs, COUNT(DISTINCT(bjj)) AS total_accounts FROM account;`)
1902 if err != nil {
1903 return nil, tracerr.Wrap(err)
1904 }
1905
1906 return metrics, nil
1907}
1908
1909// GetAvgTxFee returns average transaction fee of the last 1h
1910func (hdb *HistoryDB) GetAvgTxFee() (float64, error) {
1911 metricsTotals := &MetricsTotals{}
1912 err := meddler.QueryRow(
1913 hdb.db, metricsTotals, `SELECT COUNT(tx.*) as total_txs,
1914 COALESCE (MIN(tx.batch_num), 0) as batch_num
1915 FROM tx INNER JOIN block ON tx.eth_block_num = block.eth_block_num
1916 WHERE block.timestamp >= NOW() - INTERVAL '1 HOURS';`)
1917 if err != nil {
1918 return 0, tracerr.Wrap(err)
1919 }
1920 err = meddler.QueryRow(
1921 hdb.db, metricsTotals, `SELECT COUNT(*) AS total_batches,
1922 COALESCE (SUM(total_fees_usd), 0) AS total_fees FROM batch
1923 WHERE batch_num > $1;`, metricsTotals.FirstBatchNum)
1924 if err != nil {
1925 return 0, tracerr.Wrap(err)
1926 }
1927
1928 var avgTransactionFee float64
1929 if metricsTotals.TotalTransactions > 0 {
1930 avgTransactionFee = metricsTotals.TotalFeesUSD / float64(metricsTotals.TotalTransactions)
1931 } else {
1932 avgTransactionFee = 0
1933 }
1934
1935 return avgTransactionFee, nil
1936}