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