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].Type != common.TxTypeCreateAccountDeposit &&
856 l1txs[i].Type != common.TxTypeCreateAccountDepositTransfer {
857 effectiveFromIdx = &l1txs[i].FromIdx
858 }
859 txs = append(txs, txWrite{
860 // Generic
861 IsL1: true,
862 TxID: l1txs[i].TxID,
863 Type: l1txs[i].Type,
864 Position: l1txs[i].Position,
865 FromIdx: &l1txs[i].FromIdx,
866 EffectiveFromIdx: effectiveFromIdx,
867 ToIdx: l1txs[i].ToIdx,
868 Amount: l1txs[i].Amount,
869 AmountFloat: amountFloat,
870 TokenID: l1txs[i].TokenID,
871 BatchNum: l1txs[i].BatchNum,
872 EthBlockNum: l1txs[i].EthBlockNum,
873 // L1
874 ToForgeL1TxsNum: l1txs[i].ToForgeL1TxsNum,
875 UserOrigin: &l1txs[i].UserOrigin,
876 FromEthAddr: &l1txs[i].FromEthAddr,
877 FromBJJ: &l1txs[i].FromBJJ,
878 DepositAmount: l1txs[i].DepositAmount,
879 DepositAmountFloat: &depositAmountFloat,
880 })
881 }
882 return tracerr.Wrap(hdb.addTxs(d, txs))
883}
884
885// AddL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
886func (hdb *HistoryDB) AddL2Txs(l2txs []common.L2Tx) error {
887 return tracerr.Wrap(hdb.addL2Txs(hdb.db, l2txs))
888}
889
890// addL2Txs inserts L2 txs to the DB. TokenID, USD and FeeUSD will be set automatically before storing the tx.
891func (hdb *HistoryDB) addL2Txs(d meddler.DB, l2txs []common.L2Tx) error {
892 txs := []txWrite{}
893 for i := 0; i < len(l2txs); i++ {
894 f := new(big.Float).SetInt(l2txs[i].Amount)
895 amountFloat, _ := f.Float64()
896 txs = append(txs, txWrite{
897 // Generic
898 IsL1: false,
899 TxID: l2txs[i].TxID,
900 Type: l2txs[i].Type,
901 Position: l2txs[i].Position,
902 FromIdx: &l2txs[i].FromIdx,
903 EffectiveFromIdx: &l2txs[i].FromIdx,
904 ToIdx: l2txs[i].ToIdx,
905 Amount: l2txs[i].Amount,
906 AmountFloat: amountFloat,
907 BatchNum: &l2txs[i].BatchNum,
908 EthBlockNum: l2txs[i].EthBlockNum,
909 // L2
910 Fee: &l2txs[i].Fee,
911 Nonce: &l2txs[i].Nonce,
912 })
913 }
914 return tracerr.Wrap(hdb.addTxs(d, txs))
915}
916
917func (hdb *HistoryDB) addTxs(d meddler.DB, txs []txWrite) error {
918 if len(txs) == 0 {
919 return nil
920 }
921 return tracerr.Wrap(db.BulkInsert(
922 d,
923 `INSERT INTO tx (
924 is_l1,
925 id,
926 type,
927 position,
928 from_idx,
929 effective_from_idx,
930 to_idx,
931 amount,
932 amount_f,
933 token_id,
934 batch_num,
935 eth_block_num,
936 to_forge_l1_txs_num,
937 user_origin,
938 from_eth_addr,
939 from_bjj,
940 deposit_amount,
941 deposit_amount_f,
942 fee,
943 nonce
944 ) VALUES %s;`,
945 txs[:],
946 ))
947}
948
949// GetHistoryTx returns a tx from the DB given a TxID
950func (hdb *HistoryDB) GetHistoryTx(txID common.TxID) (*TxAPI, error) {
951 // Warning: amount_success and deposit_amount_success have true as default for
952 // performance reasons. The expected default value is false (when txs are unforged)
953 // this case is handled at the function func (tx TxAPI) MarshalJSON() ([]byte, error)
954 tx := &TxAPI{}
955 err := meddler.QueryRow(
956 hdb.db, tx, `SELECT tx.item_id, tx.is_l1, tx.id, tx.type, tx.position,
957 hez_idx(tx.effective_from_idx, token.symbol) AS from_idx, tx.from_eth_addr, tx.from_bjj,
958 hez_idx(tx.to_idx, token.symbol) AS to_idx, tx.to_eth_addr, tx.to_bjj,
959 tx.amount, tx.amount_success, tx.token_id, tx.amount_usd,
960 tx.batch_num, tx.eth_block_num, tx.to_forge_l1_txs_num, tx.user_origin,
961 tx.deposit_amount, tx.deposit_amount_usd, tx.deposit_amount_success, tx.fee, tx.fee_usd, tx.nonce,
962 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
963 token.eth_addr, token.name, token.symbol, token.decimals, token.usd,
964 token.usd_update, block.timestamp
965 FROM tx INNER JOIN token ON tx.token_id = token.token_id
966 INNER JOIN block ON tx.eth_block_num = block.eth_block_num
967 WHERE tx.id = $1;`, txID,
968 )
969 return tx, tracerr.Wrap(err)
970}
971
972// GetHistoryTxs returns a list of txs from the DB using the HistoryTx struct
973// and pagination info
974func (hdb *HistoryDB) GetHistoryTxs(
975 ethAddr *ethCommon.Address, bjj *babyjub.PublicKeyComp,
976 tokenID *common.TokenID, idx *common.Idx, batchNum *uint, txType *common.TxType,
977 fromItem, limit *uint, order string,
978) ([]TxAPI, uint64, error) {
979 // Warning: amount_success and deposit_amount_success have true as default for
980 // performance reasons. The expected default value is false (when txs are unforged)
981 // this case is handled at the function func (tx TxAPI) MarshalJSON() ([]byte, error)
982 if ethAddr != nil && bjj != nil {
983 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
984 }
985 var query string
986 var args []interface{}
987 queryStr := `SELECT tx.item_id, tx.is_l1, tx.id, tx.type, tx.position,
988 hez_idx(tx.effective_from_idx, token.symbol) AS from_idx, tx.from_eth_addr, tx.from_bjj,
989 hez_idx(tx.to_idx, token.symbol) AS to_idx, tx.to_eth_addr, tx.to_bjj,
990 tx.amount, tx.amount_success, tx.token_id, tx.amount_usd,
991 tx.batch_num, tx.eth_block_num, tx.to_forge_l1_txs_num, tx.user_origin,
992 tx.deposit_amount, tx.deposit_amount_usd, tx.deposit_amount_success, tx.fee, tx.fee_usd, tx.nonce,
993 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
994 token.eth_addr, token.name, token.symbol, token.decimals, token.usd,
995 token.usd_update, block.timestamp, count(*) OVER() AS total_items
996 FROM tx INNER JOIN token ON tx.token_id = token.token_id
997 INNER JOIN block ON tx.eth_block_num = block.eth_block_num `
998 // Apply filters
999 nextIsAnd := false
1000 // ethAddr filter
1001 if ethAddr != nil {
1002 queryStr += "WHERE (tx.from_eth_addr = ? OR tx.to_eth_addr = ?) "
1003 nextIsAnd = true
1004 args = append(args, ethAddr, ethAddr)
1005 } else if bjj != nil { // bjj filter
1006 queryStr += "WHERE (tx.from_bjj = ? OR tx.to_bjj = ?) "
1007 nextIsAnd = true
1008 args = append(args, bjj, bjj)
1009 }
1010 // tokenID filter
1011 if tokenID != nil {
1012 if nextIsAnd {
1013 queryStr += "AND "
1014 } else {
1015 queryStr += "WHERE "
1016 }
1017 queryStr += "tx.token_id = ? "
1018 args = append(args, tokenID)
1019 nextIsAnd = true
1020 }
1021 // idx filter
1022 if idx != nil {
1023 if nextIsAnd {
1024 queryStr += "AND "
1025 } else {
1026 queryStr += "WHERE "
1027 }
1028 queryStr += "(tx.effective_from_idx = ? OR tx.to_idx = ?) "
1029 args = append(args, idx, idx)
1030 nextIsAnd = true
1031 }
1032 // batchNum filter
1033 if batchNum != nil {
1034 if nextIsAnd {
1035 queryStr += "AND "
1036 } else {
1037 queryStr += "WHERE "
1038 }
1039 queryStr += "tx.batch_num = ? "
1040 args = append(args, batchNum)
1041 nextIsAnd = true
1042 }
1043 // txType filter
1044 if txType != nil {
1045 if nextIsAnd {
1046 queryStr += "AND "
1047 } else {
1048 queryStr += "WHERE "
1049 }
1050 queryStr += "tx.type = ? "
1051 args = append(args, txType)
1052 nextIsAnd = true
1053 }
1054 if fromItem != nil {
1055 if nextIsAnd {
1056 queryStr += "AND "
1057 } else {
1058 queryStr += "WHERE "
1059 }
1060 if order == OrderAsc {
1061 queryStr += "tx.item_id >= ? "
1062 } else {
1063 queryStr += "tx.item_id <= ? "
1064 }
1065 args = append(args, fromItem)
1066 nextIsAnd = true
1067 }
1068 if nextIsAnd {
1069 queryStr += "AND "
1070 } else {
1071 queryStr += "WHERE "
1072 }
1073 queryStr += "tx.batch_num IS NOT NULL "
1074
1075 // pagination
1076 queryStr += "ORDER BY tx.item_id "
1077 if order == OrderAsc {
1078 queryStr += " ASC "
1079 } else {
1080 queryStr += " DESC "
1081 }
1082 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1083 query = hdb.db.Rebind(queryStr)
1084 // log.Debug(query)
1085 txsPtrs := []*TxAPI{}
1086 if err := meddler.QueryAll(hdb.db, &txsPtrs, query, args...); err != nil {
1087 return nil, 0, tracerr.Wrap(err)
1088 }
1089 txs := db.SlicePtrsToSlice(txsPtrs).([]TxAPI)
1090 if len(txs) == 0 {
1091 return txs, 0, nil
1092 }
1093 return txs, txs[0].TotalItems - uint64(len(txs)), nil
1094}
1095
1096// GetAllExits returns all exit from the DB
1097func (hdb *HistoryDB) GetAllExits() ([]common.ExitInfo, error) {
1098 var exits []*common.ExitInfo
1099 err := meddler.QueryAll(
1100 hdb.db, &exits,
1101 `SELECT exit_tree.batch_num, exit_tree.account_idx, exit_tree.merkle_proof,
1102 exit_tree.balance, exit_tree.instant_withdrawn, exit_tree.delayed_withdraw_request,
1103 exit_tree.delayed_withdrawn FROM exit_tree ORDER BY item_id;`,
1104 )
1105 return db.SlicePtrsToSlice(exits).([]common.ExitInfo), tracerr.Wrap(err)
1106}
1107
1108// GetExitAPI returns a exit from the DB
1109func (hdb *HistoryDB) GetExitAPI(batchNum *uint, idx *common.Idx) (*ExitAPI, error) {
1110 exit := &ExitAPI{}
1111 err := meddler.QueryRow(
1112 hdb.db, exit, `SELECT exit_tree.item_id, exit_tree.batch_num,
1113 hez_idx(exit_tree.account_idx, token.symbol) AS account_idx,
1114 account.bjj, account.eth_addr,
1115 exit_tree.merkle_proof, exit_tree.balance, exit_tree.instant_withdrawn,
1116 exit_tree.delayed_withdraw_request, exit_tree.delayed_withdrawn,
1117 token.token_id, token.item_id AS token_item_id,
1118 token.eth_block_num AS token_block, token.eth_addr AS token_eth_addr, token.name, token.symbol,
1119 token.decimals, token.usd, token.usd_update
1120 FROM exit_tree INNER JOIN account ON exit_tree.account_idx = account.idx
1121 INNER JOIN token ON account.token_id = token.token_id
1122 WHERE exit_tree.batch_num = $1 AND exit_tree.account_idx = $2;`, batchNum, idx,
1123 )
1124 return exit, tracerr.Wrap(err)
1125}
1126
1127// GetExitsAPI returns a list of exits from the DB and pagination info
1128func (hdb *HistoryDB) GetExitsAPI(
1129 ethAddr *ethCommon.Address, bjj *babyjub.PublicKeyComp, tokenID *common.TokenID,
1130 idx *common.Idx, batchNum *uint, onlyPendingWithdraws *bool,
1131 fromItem, limit *uint, order string,
1132) ([]ExitAPI, uint64, error) {
1133 if ethAddr != nil && bjj != nil {
1134 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
1135 }
1136 var query string
1137 var args []interface{}
1138 queryStr := `SELECT exit_tree.item_id, exit_tree.batch_num,
1139 hez_idx(exit_tree.account_idx, token.symbol) AS account_idx,
1140 account.bjj, account.eth_addr,
1141 exit_tree.merkle_proof, exit_tree.balance, exit_tree.instant_withdrawn,
1142 exit_tree.delayed_withdraw_request, exit_tree.delayed_withdrawn,
1143 token.token_id, token.item_id AS token_item_id,
1144 token.eth_block_num AS token_block, token.eth_addr AS token_eth_addr, token.name, token.symbol,
1145 token.decimals, token.usd, token.usd_update, COUNT(*) OVER() AS total_items
1146 FROM exit_tree INNER JOIN account ON exit_tree.account_idx = account.idx
1147 INNER JOIN token ON account.token_id = token.token_id `
1148 // Apply filters
1149 nextIsAnd := false
1150 // ethAddr filter
1151 if ethAddr != nil {
1152 queryStr += "WHERE account.eth_addr = ? "
1153 nextIsAnd = true
1154 args = append(args, ethAddr)
1155 } else if bjj != nil { // bjj filter
1156 queryStr += "WHERE account.bjj = ? "
1157 nextIsAnd = true
1158 args = append(args, bjj)
1159 }
1160 // tokenID filter
1161 if tokenID != nil {
1162 if nextIsAnd {
1163 queryStr += "AND "
1164 } else {
1165 queryStr += "WHERE "
1166 }
1167 queryStr += "account.token_id = ? "
1168 args = append(args, tokenID)
1169 nextIsAnd = true
1170 }
1171 // idx filter
1172 if idx != nil {
1173 if nextIsAnd {
1174 queryStr += "AND "
1175 } else {
1176 queryStr += "WHERE "
1177 }
1178 queryStr += "exit_tree.account_idx = ? "
1179 args = append(args, idx)
1180 nextIsAnd = true
1181 }
1182 // batchNum filter
1183 if batchNum != nil {
1184 if nextIsAnd {
1185 queryStr += "AND "
1186 } else {
1187 queryStr += "WHERE "
1188 }
1189 queryStr += "exit_tree.batch_num = ? "
1190 args = append(args, batchNum)
1191 nextIsAnd = true
1192 }
1193 // onlyPendingWithdraws
1194 if onlyPendingWithdraws != nil {
1195 if *onlyPendingWithdraws {
1196 if nextIsAnd {
1197 queryStr += "AND "
1198 } else {
1199 queryStr += "WHERE "
1200 }
1201 queryStr += "(exit_tree.instant_withdrawn IS NULL AND exit_tree.delayed_withdrawn IS NULL) "
1202 nextIsAnd = true
1203 }
1204 }
1205 if fromItem != nil {
1206 if nextIsAnd {
1207 queryStr += "AND "
1208 } else {
1209 queryStr += "WHERE "
1210 }
1211 if order == OrderAsc {
1212 queryStr += "exit_tree.item_id >= ? "
1213 } else {
1214 queryStr += "exit_tree.item_id <= ? "
1215 }
1216 args = append(args, fromItem)
1217 // nextIsAnd = true
1218 }
1219 // pagination
1220 queryStr += "ORDER BY exit_tree.item_id "
1221 if order == OrderAsc {
1222 queryStr += " ASC "
1223 } else {
1224 queryStr += " DESC "
1225 }
1226 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1227 query = hdb.db.Rebind(queryStr)
1228 // log.Debug(query)
1229 exits := []*ExitAPI{}
1230 if err := meddler.QueryAll(hdb.db, &exits, query, args...); err != nil {
1231 return nil, 0, tracerr.Wrap(err)
1232 }
1233 if len(exits) == 0 {
1234 return []ExitAPI{}, 0, nil
1235 }
1236 return db.SlicePtrsToSlice(exits).([]ExitAPI), exits[0].TotalItems - uint64(len(exits)), nil
1237}
1238
1239// GetAllL1UserTxs returns all L1UserTxs from the DB
1240func (hdb *HistoryDB) GetAllL1UserTxs() ([]common.L1Tx, error) {
1241 var txs []*common.L1Tx
1242 err := meddler.QueryAll(
1243 hdb.db, &txs, // Note that '\x' gets parsed as a big.Int with value = 0
1244 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1245 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1246 tx.amount, (CASE WHEN tx.batch_num IS NULL THEN NULL WHEN tx.amount_success THEN tx.amount ELSE '\x' END) AS effective_amount,
1247 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,
1248 tx.eth_block_num, tx.type, tx.batch_num
1249 FROM tx WHERE is_l1 = TRUE AND user_origin = TRUE ORDER BY item_id;`,
1250 )
1251 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1252}
1253
1254// GetAllL1CoordinatorTxs returns all L1CoordinatorTxs from the DB
1255func (hdb *HistoryDB) GetAllL1CoordinatorTxs() ([]common.L1Tx, error) {
1256 var txs []*common.L1Tx
1257 // Since the query specifies that only coordinator txs are returned, it's safe to assume
1258 // that returned txs will always have effective amounts
1259 err := meddler.QueryAll(
1260 hdb.db, &txs,
1261 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1262 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1263 tx.amount, tx.amount AS effective_amount,
1264 tx.deposit_amount, tx.deposit_amount AS effective_deposit_amount,
1265 tx.eth_block_num, tx.type, tx.batch_num
1266 FROM tx WHERE is_l1 = TRUE AND user_origin = FALSE ORDER BY item_id;`,
1267 )
1268 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1269}
1270
1271// GetAllL2Txs returns all L2Txs from the DB
1272func (hdb *HistoryDB) GetAllL2Txs() ([]common.L2Tx, error) {
1273 var txs []*common.L2Tx
1274 err := meddler.QueryAll(
1275 hdb.db, &txs,
1276 `SELECT tx.id, tx.batch_num, tx.position,
1277 tx.from_idx, tx.to_idx, tx.amount, tx.fee, tx.nonce,
1278 tx.type, tx.eth_block_num
1279 FROM tx WHERE is_l1 = FALSE ORDER BY item_id;`,
1280 )
1281 return db.SlicePtrsToSlice(txs).([]common.L2Tx), tracerr.Wrap(err)
1282}
1283
1284// GetUnforgedL1UserTxs gets L1 User Txs to be forged in the L1Batch with toForgeL1TxsNum.
1285func (hdb *HistoryDB) GetUnforgedL1UserTxs(toForgeL1TxsNum int64) ([]common.L1Tx, error) {
1286 var txs []*common.L1Tx
1287 err := meddler.QueryAll(
1288 hdb.db, &txs, // only L1 user txs can have batch_num set to null
1289 `SELECT tx.id, tx.to_forge_l1_txs_num, tx.position, tx.user_origin,
1290 tx.from_idx, tx.from_eth_addr, tx.from_bjj, tx.to_idx, tx.token_id,
1291 tx.amount, NULL AS effective_amount,
1292 tx.deposit_amount, NULL AS effective_deposit_amount,
1293 tx.eth_block_num, tx.type, tx.batch_num
1294 FROM tx WHERE batch_num IS NULL AND to_forge_l1_txs_num = $1
1295 ORDER BY position;`,
1296 toForgeL1TxsNum,
1297 )
1298 return db.SlicePtrsToSlice(txs).([]common.L1Tx), tracerr.Wrap(err)
1299}
1300
1301// TODO: Think about chaning all the queries that return a last value, to queries that return the next valid value.
1302
1303// GetLastTxsPosition for a given to_forge_l1_txs_num
1304func (hdb *HistoryDB) GetLastTxsPosition(toForgeL1TxsNum int64) (int, error) {
1305 row := hdb.db.QueryRow(
1306 "SELECT position FROM tx WHERE to_forge_l1_txs_num = $1 ORDER BY position DESC;",
1307 toForgeL1TxsNum,
1308 )
1309 var lastL1TxsPosition int
1310 return lastL1TxsPosition, tracerr.Wrap(row.Scan(&lastL1TxsPosition))
1311}
1312
1313// GetSCVars returns the rollup, auction and wdelayer smart contracts variables at their last update.
1314func (hdb *HistoryDB) GetSCVars() (*common.RollupVariables, *common.AuctionVariables,
1315 *common.WDelayerVariables, error) {
1316 var rollup common.RollupVariables
1317 var auction common.AuctionVariables
1318 var wDelayer common.WDelayerVariables
1319 if err := meddler.QueryRow(hdb.db, &rollup,
1320 "SELECT * FROM rollup_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1321 return nil, nil, nil, tracerr.Wrap(err)
1322 }
1323 if err := meddler.QueryRow(hdb.db, &auction,
1324 "SELECT * FROM auction_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1325 return nil, nil, nil, tracerr.Wrap(err)
1326 }
1327 if err := meddler.QueryRow(hdb.db, &wDelayer,
1328 "SELECT * FROM wdelayer_vars ORDER BY eth_block_num DESC LIMIT 1;"); err != nil {
1329 return nil, nil, nil, tracerr.Wrap(err)
1330 }
1331 return &rollup, &auction, &wDelayer, nil
1332}
1333
1334func (hdb *HistoryDB) setRollupVars(d meddler.DB, rollup *common.RollupVariables) error {
1335 return tracerr.Wrap(meddler.Insert(d, "rollup_vars", rollup))
1336}
1337
1338func (hdb *HistoryDB) setAuctionVars(d meddler.DB, auction *common.AuctionVariables) error {
1339 return tracerr.Wrap(meddler.Insert(d, "auction_vars", auction))
1340}
1341
1342func (hdb *HistoryDB) setWDelayerVars(d meddler.DB, wDelayer *common.WDelayerVariables) error {
1343 return tracerr.Wrap(meddler.Insert(d, "wdelayer_vars", wDelayer))
1344}
1345
1346func (hdb *HistoryDB) addBucketUpdates(d meddler.DB, bucketUpdates []common.BucketUpdate) error {
1347 if len(bucketUpdates) == 0 {
1348 return nil
1349 }
1350 return tracerr.Wrap(db.BulkInsert(
1351 d,
1352 `INSERT INTO bucket_update (
1353 eth_block_num,
1354 num_bucket,
1355 block_stamp,
1356 withdrawals
1357 ) VALUES %s;`,
1358 bucketUpdates[:],
1359 ))
1360}
1361
1362// AddBucketUpdatesTest allows call to unexported method
1363// only for internal testing purposes
1364func (hdb *HistoryDB) AddBucketUpdatesTest(d meddler.DB, bucketUpdates []common.BucketUpdate) error {
1365 return hdb.addBucketUpdates(d, bucketUpdates)
1366}
1367
1368// GetAllBucketUpdates retrieves all the bucket updates
1369func (hdb *HistoryDB) GetAllBucketUpdates() ([]common.BucketUpdate, error) {
1370 var bucketUpdates []*common.BucketUpdate
1371 err := meddler.QueryAll(
1372 hdb.db, &bucketUpdates,
1373 `SELECT eth_block_num, num_bucket, block_stamp, withdrawals
1374 FROM bucket_update ORDER BY item_id;`,
1375 )
1376 return db.SlicePtrsToSlice(bucketUpdates).([]common.BucketUpdate), tracerr.Wrap(err)
1377}
1378
1379// GetBucketUpdates retrieves latest values for each bucket
1380func (hdb *HistoryDB) GetBucketUpdates() ([]BucketUpdateAPI, error) {
1381 var bucketUpdates []*BucketUpdateAPI
1382 err := meddler.QueryAll(
1383 hdb.db, &bucketUpdates,
1384 `SELECT num_bucket, withdrawals FROM bucket_update
1385 WHERE item_id in(SELECT max(item_id) FROM bucket_update
1386 group by num_bucket)
1387 ORDER BY num_bucket ASC;`,
1388 )
1389 return db.SlicePtrsToSlice(bucketUpdates).([]BucketUpdateAPI), tracerr.Wrap(err)
1390}
1391
1392func (hdb *HistoryDB) addTokenExchanges(d meddler.DB, tokenExchanges []common.TokenExchange) error {
1393 if len(tokenExchanges) == 0 {
1394 return nil
1395 }
1396 return tracerr.Wrap(db.BulkInsert(
1397 d,
1398 `INSERT INTO token_exchange (
1399 eth_block_num,
1400 eth_addr,
1401 value_usd
1402 ) VALUES %s;`,
1403 tokenExchanges[:],
1404 ))
1405}
1406
1407// GetAllTokenExchanges retrieves all the token exchanges
1408func (hdb *HistoryDB) GetAllTokenExchanges() ([]common.TokenExchange, error) {
1409 var tokenExchanges []*common.TokenExchange
1410 err := meddler.QueryAll(
1411 hdb.db, &tokenExchanges,
1412 "SELECT eth_block_num, eth_addr, value_usd FROM token_exchange ORDER BY item_id;",
1413 )
1414 return db.SlicePtrsToSlice(tokenExchanges).([]common.TokenExchange), tracerr.Wrap(err)
1415}
1416
1417func (hdb *HistoryDB) addEscapeHatchWithdrawals(d meddler.DB,
1418 escapeHatchWithdrawals []common.WDelayerEscapeHatchWithdrawal) error {
1419 if len(escapeHatchWithdrawals) == 0 {
1420 return nil
1421 }
1422 return tracerr.Wrap(db.BulkInsert(
1423 d,
1424 `INSERT INTO escape_hatch_withdrawal (
1425 eth_block_num,
1426 who_addr,
1427 to_addr,
1428 token_addr,
1429 amount
1430 ) VALUES %s;`,
1431 escapeHatchWithdrawals[:],
1432 ))
1433}
1434
1435// GetAllEscapeHatchWithdrawals retrieves all the escape hatch withdrawals
1436func (hdb *HistoryDB) GetAllEscapeHatchWithdrawals() ([]common.WDelayerEscapeHatchWithdrawal, error) {
1437 var escapeHatchWithdrawals []*common.WDelayerEscapeHatchWithdrawal
1438 err := meddler.QueryAll(
1439 hdb.db, &escapeHatchWithdrawals,
1440 "SELECT eth_block_num, who_addr, to_addr, token_addr, amount FROM escape_hatch_withdrawal ORDER BY item_id;",
1441 )
1442 return db.SlicePtrsToSlice(escapeHatchWithdrawals).([]common.WDelayerEscapeHatchWithdrawal),
1443 tracerr.Wrap(err)
1444}
1445
1446// SetInitialSCVars sets the initial state of rollup, auction, wdelayer smart
1447// contract variables. This initial state is stored linked to block 0, which
1448// always exist in the DB and is used to store initialization data that always
1449// exist in the smart contracts.
1450func (hdb *HistoryDB) SetInitialSCVars(rollup *common.RollupVariables,
1451 auction *common.AuctionVariables, wDelayer *common.WDelayerVariables) error {
1452 txn, err := hdb.db.Beginx()
1453 if err != nil {
1454 return tracerr.Wrap(err)
1455 }
1456 defer func() {
1457 if err != nil {
1458 db.Rollback(txn)
1459 }
1460 }()
1461 // Force EthBlockNum to be 0 because it's the block used to link data
1462 // that belongs to the creation of the smart contracts
1463 rollup.EthBlockNum = 0
1464 auction.EthBlockNum = 0
1465 wDelayer.EthBlockNum = 0
1466 auction.DefaultSlotSetBidSlotNum = 0
1467 if err := hdb.setRollupVars(txn, rollup); err != nil {
1468 return tracerr.Wrap(err)
1469 }
1470 if err := hdb.setAuctionVars(txn, auction); err != nil {
1471 return tracerr.Wrap(err)
1472 }
1473 if err := hdb.setWDelayerVars(txn, wDelayer); err != nil {
1474 return tracerr.Wrap(err)
1475 }
1476
1477 return tracerr.Wrap(txn.Commit())
1478}
1479
1480// setExtraInfoForgedL1UserTxs sets the EffectiveAmount and EffectiveDepositAmount
1481// of the given l1UserTxs (with an UPDATE)
1482// TODO: Set effective_from_idx for txs that create accounts
1483func (hdb *HistoryDB) setExtraInfoForgedL1UserTxs(d sqlx.Ext, txs []common.L1Tx) error {
1484 if len(txs) == 0 {
1485 return nil
1486 }
1487 // Effective amounts are stored as success flags in the DB, with true value by default
1488 // to reduce the amount of updates. Therefore, only amounts that became uneffective should be
1489 // updated to become false
1490 type txUpdate struct {
1491 ID common.TxID `db:"id"`
1492 AmountSuccess bool `db:"amount_success"`
1493 DepositAmountSuccess bool `db:"deposit_amount_success"`
1494 }
1495 txUpdates := []txUpdate{}
1496 equal := func(a *big.Int, b *big.Int) bool {
1497 return a.Cmp(b) == 0
1498 }
1499 for i := range txs {
1500 amountSuccess := equal(txs[i].Amount, txs[i].EffectiveAmount)
1501 depositAmountSuccess := equal(txs[i].DepositAmount, txs[i].EffectiveDepositAmount)
1502 if !amountSuccess || !depositAmountSuccess {
1503 txUpdates = append(txUpdates, txUpdate{
1504 ID: txs[i].TxID,
1505 AmountSuccess: amountSuccess,
1506 DepositAmountSuccess: depositAmountSuccess,
1507 })
1508 }
1509 }
1510 const query string = `
1511 UPDATE tx SET
1512 amount_success = tx_update.amount_success,
1513 deposit_amount_success = tx_update.deposit_amount_success
1514 FROM (VALUES
1515 (NULL::::BYTEA, NULL::::BOOL, NULL::::BOOL),
1516 (:id, :amount_success, :deposit_amount_success)
1517 ) as tx_update (id, amount_success, deposit_amount_success)
1518 WHERE tx.id = tx_update.id;
1519 `
1520 if len(txUpdates) > 0 {
1521 if _, err := sqlx.NamedExec(d, query, txUpdates); err != nil {
1522 return tracerr.Wrap(err)
1523 }
1524 }
1525 return nil
1526}
1527
1528// AddBlockSCData stores all the information of a block retrieved by the
1529// Synchronizer. Blocks should be inserted in order, leaving no gaps because
1530// the pagination system of the API/DB depends on this. Within blocks, all
1531// items should also be in the correct order (Accounts, Tokens, Txs, etc.)
1532func (hdb *HistoryDB) AddBlockSCData(blockData *common.BlockData) (err error) {
1533 txn, err := hdb.db.Beginx()
1534 if err != nil {
1535 return tracerr.Wrap(err)
1536 }
1537 defer func() {
1538 if err != nil {
1539 db.Rollback(txn)
1540 }
1541 }()
1542
1543 // Add block
1544 if err := hdb.addBlock(txn, &blockData.Block); err != nil {
1545 return tracerr.Wrap(err)
1546 }
1547
1548 // Add Coordinators
1549 if err := hdb.addCoordinators(txn, blockData.Auction.Coordinators); err != nil {
1550 return tracerr.Wrap(err)
1551 }
1552
1553 // Add Bids
1554 if err := hdb.addBids(txn, blockData.Auction.Bids); err != nil {
1555 return tracerr.Wrap(err)
1556 }
1557
1558 // Add Tokens
1559 if err := hdb.addTokens(txn, blockData.Rollup.AddedTokens); err != nil {
1560 return tracerr.Wrap(err)
1561 }
1562
1563 // Prepare user L1 txs to be added.
1564 // They must be added before the batch that will forge them (which can be in the same block)
1565 // and after the account that will be sent to (also can be in the same block).
1566 // Note: insert order is not relevant since item_id will be updated by a DB trigger when
1567 // the batch that forges those txs is inserted
1568 userL1s := make(map[common.BatchNum][]common.L1Tx)
1569 for i := range blockData.Rollup.L1UserTxs {
1570 batchThatForgesIsInTheBlock := false
1571 for _, batch := range blockData.Rollup.Batches {
1572 if batch.Batch.ForgeL1TxsNum != nil &&
1573 *batch.Batch.ForgeL1TxsNum == *blockData.Rollup.L1UserTxs[i].ToForgeL1TxsNum {
1574 // Tx is forged in this block. It's guaranteed that:
1575 // * the first batch of the block won't forge user L1 txs that have been added in this block
1576 // * batch nums are sequential therefore it's safe to add the tx at batch.BatchNum -1
1577 batchThatForgesIsInTheBlock = true
1578 addAtBatchNum := batch.Batch.BatchNum - 1
1579 userL1s[addAtBatchNum] = append(userL1s[addAtBatchNum], blockData.Rollup.L1UserTxs[i])
1580 break
1581 }
1582 }
1583 if !batchThatForgesIsInTheBlock {
1584 // User artificial batchNum 0 to add txs that are not forge in this block
1585 // after all the accounts of the block have been added
1586 userL1s[0] = append(userL1s[0], blockData.Rollup.L1UserTxs[i])
1587 }
1588 }
1589
1590 // Add Batches
1591 for i := range blockData.Rollup.Batches {
1592 batch := &blockData.Rollup.Batches[i]
1593
1594 // Add Batch: this will trigger an update on the DB
1595 // that will set the batch num of forged L1 txs in this batch
1596 if err = hdb.addBatch(txn, &batch.Batch); err != nil {
1597 return tracerr.Wrap(err)
1598 }
1599
1600 // Add accounts
1601 if err := hdb.addAccounts(txn, batch.CreatedAccounts); err != nil {
1602 return tracerr.Wrap(err)
1603 }
1604
1605 // Set the EffectiveAmount and EffectiveDepositAmount of all the
1606 // L1UserTxs that have been forged in this batch
1607 // TODO: Set also effective_from_idx for txs that create accounts
1608 if err = hdb.setExtraInfoForgedL1UserTxs(txn, batch.L1UserTxs); err != nil {
1609 return tracerr.Wrap(err)
1610 }
1611
1612 // Add forged l1 coordinator Txs
1613 if err := hdb.addL1Txs(txn, batch.L1CoordinatorTxs); err != nil {
1614 return tracerr.Wrap(err)
1615 }
1616
1617 // Add l2 Txs
1618 if err := hdb.addL2Txs(txn, batch.L2Txs); err != nil {
1619 return tracerr.Wrap(err)
1620 }
1621
1622 // Add user L1 txs that will be forged in next batch
1623 if userlL1s, ok := userL1s[batch.Batch.BatchNum]; ok {
1624 if err := hdb.addL1Txs(txn, userlL1s); err != nil {
1625 return tracerr.Wrap(err)
1626 }
1627 }
1628
1629 // Add exit tree
1630 if err := hdb.addExitTree(txn, batch.ExitTree); err != nil {
1631 return tracerr.Wrap(err)
1632 }
1633 }
1634 // Add user L1 txs that won't be forged in this block
1635 if userL1sNotForgedInThisBlock, ok := userL1s[0]; ok {
1636 if err := hdb.addL1Txs(txn, userL1sNotForgedInThisBlock); err != nil {
1637 return tracerr.Wrap(err)
1638 }
1639 }
1640
1641 // Set SC Vars if there was an update
1642 if blockData.Rollup.Vars != nil {
1643 if err := hdb.setRollupVars(txn, blockData.Rollup.Vars); err != nil {
1644 return tracerr.Wrap(err)
1645 }
1646 }
1647 if blockData.Auction.Vars != nil {
1648 if err := hdb.setAuctionVars(txn, blockData.Auction.Vars); err != nil {
1649 return tracerr.Wrap(err)
1650 }
1651 }
1652 if blockData.WDelayer.Vars != nil {
1653 if err := hdb.setWDelayerVars(txn, blockData.WDelayer.Vars); err != nil {
1654 return tracerr.Wrap(err)
1655 }
1656 }
1657
1658 // Update withdrawals in exit tree table
1659 if err := hdb.updateExitTree(txn, blockData.Block.Num,
1660 blockData.Rollup.Withdrawals, blockData.WDelayer.Withdrawals); err != nil {
1661 return tracerr.Wrap(err)
1662 }
1663
1664 // Add Escape Hatch Withdrawals
1665 if err := hdb.addEscapeHatchWithdrawals(txn,
1666 blockData.WDelayer.EscapeHatchWithdrawals); err != nil {
1667 return tracerr.Wrap(err)
1668 }
1669
1670 // Add Buckets withdrawals updates
1671 if err := hdb.addBucketUpdates(txn, blockData.Rollup.UpdateBucketWithdraw); err != nil {
1672 return tracerr.Wrap(err)
1673 }
1674
1675 // Add Token exchange updates
1676 if err := hdb.addTokenExchanges(txn, blockData.Rollup.TokenExchanges); err != nil {
1677 return tracerr.Wrap(err)
1678 }
1679
1680 return tracerr.Wrap(txn.Commit())
1681}
1682
1683// GetCoordinatorAPI returns a coordinator by its bidderAddr
1684func (hdb *HistoryDB) GetCoordinatorAPI(bidderAddr ethCommon.Address) (*CoordinatorAPI, error) {
1685 coordinator := &CoordinatorAPI{}
1686 err := meddler.QueryRow(
1687 hdb.db, coordinator,
1688 "SELECT * FROM coordinator WHERE bidder_addr = $1 ORDER BY item_id DESC LIMIT 1;",
1689 bidderAddr,
1690 )
1691 return coordinator, tracerr.Wrap(err)
1692}
1693
1694// GetCoordinatorsAPI returns a list of coordinators from the DB and pagination info
1695func (hdb *HistoryDB) GetCoordinatorsAPI(
1696 bidderAddr, forgerAddr *ethCommon.Address,
1697 fromItem, limit *uint, order string,
1698) ([]CoordinatorAPI, uint64, error) {
1699 var query string
1700 var args []interface{}
1701 queryStr := `SELECT coordinator.*, COUNT(*) OVER() AS total_items
1702 FROM coordinator INNER JOIN (
1703 SELECT MAX(item_id) AS item_id FROM coordinator
1704 GROUP BY bidder_addr
1705 ) c ON coordinator.item_id = c.item_id `
1706 // Apply filters
1707 nextIsAnd := false
1708 if bidderAddr != nil {
1709 queryStr += "WHERE bidder_addr = ? "
1710 nextIsAnd = true
1711 args = append(args, bidderAddr)
1712 }
1713 if forgerAddr != nil {
1714 if nextIsAnd {
1715 queryStr += "AND "
1716 } else {
1717 queryStr += "WHERE "
1718 }
1719 queryStr += "forger_addr = ? "
1720 nextIsAnd = true
1721 args = append(args, forgerAddr)
1722 }
1723 if fromItem != nil {
1724 if nextIsAnd {
1725 queryStr += "AND "
1726 } else {
1727 queryStr += "WHERE "
1728 }
1729 if order == OrderAsc {
1730 queryStr += "coordinator.item_id >= ? "
1731 } else {
1732 queryStr += "coordinator.item_id <= ? "
1733 }
1734 args = append(args, fromItem)
1735 }
1736 // pagination
1737 queryStr += "ORDER BY coordinator.item_id "
1738 if order == OrderAsc {
1739 queryStr += " ASC "
1740 } else {
1741 queryStr += " DESC "
1742 }
1743 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1744 query = hdb.db.Rebind(queryStr)
1745
1746 coordinators := []*CoordinatorAPI{}
1747 if err := meddler.QueryAll(hdb.db, &coordinators, query, args...); err != nil {
1748 return nil, 0, tracerr.Wrap(err)
1749 }
1750 if len(coordinators) == 0 {
1751 return []CoordinatorAPI{}, 0, nil
1752 }
1753 return db.SlicePtrsToSlice(coordinators).([]CoordinatorAPI),
1754 coordinators[0].TotalItems - uint64(len(coordinators)), nil
1755}
1756
1757// AddAuctionVars insert auction vars into the DB
1758func (hdb *HistoryDB) AddAuctionVars(auctionVars *common.AuctionVariables) error {
1759 return tracerr.Wrap(meddler.Insert(hdb.db, "auction_vars", auctionVars))
1760}
1761
1762// GetAuctionVars returns auction variables
1763func (hdb *HistoryDB) GetAuctionVars() (*common.AuctionVariables, error) {
1764 auctionVars := &common.AuctionVariables{}
1765 err := meddler.QueryRow(
1766 hdb.db, auctionVars, `SELECT * FROM auction_vars;`,
1767 )
1768 return auctionVars, tracerr.Wrap(err)
1769}
1770
1771// GetAuctionVarsUntilSetSlotNum returns all the updates of the auction vars
1772// from the last entry in which DefaultSlotSetBidSlotNum <= slotNum
1773func (hdb *HistoryDB) GetAuctionVarsUntilSetSlotNum(slotNum int64, maxItems int) ([]MinBidInfo, error) {
1774 auctionVars := []*MinBidInfo{}
1775 query := `
1776 SELECT DISTINCT default_slot_set_bid, default_slot_set_bid_slot_num FROM auction_vars
1777 WHERE default_slot_set_bid_slot_num < $1
1778 ORDER BY default_slot_set_bid_slot_num DESC
1779 LIMIT $2;
1780 `
1781 err := meddler.QueryAll(hdb.db, &auctionVars, query, slotNum, maxItems)
1782 if err != nil {
1783 return nil, tracerr.Wrap(err)
1784 }
1785 return db.SlicePtrsToSlice(auctionVars).([]MinBidInfo), nil
1786}
1787
1788// GetAccountAPI returns an account by its index
1789func (hdb *HistoryDB) GetAccountAPI(idx common.Idx) (*AccountAPI, error) {
1790 account := &AccountAPI{}
1791 err := meddler.QueryRow(hdb.db, account, `SELECT account.item_id, hez_idx(account.idx,
1792 token.symbol) as idx, account.batch_num, account.bjj, account.eth_addr,
1793 token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
1794 token.eth_addr as token_eth_addr, token.name, token.symbol, token.decimals, token.usd, token.usd_update
1795 FROM account INNER JOIN token ON account.token_id = token.token_id WHERE idx = $1;`, idx)
1796
1797 if err != nil {
1798 return nil, tracerr.Wrap(err)
1799 }
1800
1801 return account, nil
1802}
1803
1804// GetAccountsAPI returns a list of accounts from the DB and pagination info
1805func (hdb *HistoryDB) GetAccountsAPI(
1806 tokenIDs []common.TokenID, ethAddr *ethCommon.Address,
1807 bjj *babyjub.PublicKeyComp, fromItem, limit *uint, order string,
1808) ([]AccountAPI, uint64, error) {
1809 if ethAddr != nil && bjj != nil {
1810 return nil, 0, tracerr.Wrap(errors.New("ethAddr and bjj are incompatible"))
1811 }
1812 var query string
1813 var args []interface{}
1814 queryStr := `SELECT account.item_id, hez_idx(account.idx, token.symbol) as idx, account.batch_num,
1815 account.bjj, account.eth_addr, token.token_id, token.item_id AS token_item_id, token.eth_block_num AS token_block,
1816 token.eth_addr as token_eth_addr, token.name, token.symbol, token.decimals, token.usd, token.usd_update,
1817 COUNT(*) OVER() AS total_items
1818 FROM account INNER JOIN token ON account.token_id = token.token_id `
1819 // Apply filters
1820 nextIsAnd := false
1821 // ethAddr filter
1822 if ethAddr != nil {
1823 queryStr += "WHERE account.eth_addr = ? "
1824 nextIsAnd = true
1825 args = append(args, ethAddr)
1826 } else if bjj != nil { // bjj filter
1827 queryStr += "WHERE account.bjj = ? "
1828 nextIsAnd = true
1829 args = append(args, bjj)
1830 }
1831 // tokenID filter
1832 if len(tokenIDs) > 0 {
1833 if nextIsAnd {
1834 queryStr += "AND "
1835 } else {
1836 queryStr += "WHERE "
1837 }
1838 queryStr += "account.token_id IN (?) "
1839 args = append(args, tokenIDs)
1840 nextIsAnd = true
1841 }
1842 if fromItem != nil {
1843 if nextIsAnd {
1844 queryStr += "AND "
1845 } else {
1846 queryStr += "WHERE "
1847 }
1848 if order == OrderAsc {
1849 queryStr += "account.item_id >= ? "
1850 } else {
1851 queryStr += "account.item_id <= ? "
1852 }
1853 args = append(args, fromItem)
1854 }
1855 // pagination
1856 queryStr += "ORDER BY account.item_id "
1857 if order == OrderAsc {
1858 queryStr += " ASC "
1859 } else {
1860 queryStr += " DESC "
1861 }
1862 queryStr += fmt.Sprintf("LIMIT %d;", *limit)
1863 query, argsQ, err := sqlx.In(queryStr, args...)
1864 if err != nil {
1865 return nil, 0, tracerr.Wrap(err)
1866 }
1867 query = hdb.db.Rebind(query)
1868
1869 accounts := []*AccountAPI{}
1870 if err := meddler.QueryAll(hdb.db, &accounts, query, argsQ...); err != nil {
1871 return nil, 0, tracerr.Wrap(err)
1872 }
1873 if len(accounts) == 0 {
1874 return []AccountAPI{}, 0, nil
1875 }
1876
1877 return db.SlicePtrsToSlice(accounts).([]AccountAPI),
1878 accounts[0].TotalItems - uint64(len(accounts)), nil
1879}
1880
1881// GetMetrics returns metrics
1882func (hdb *HistoryDB) GetMetrics(lastBatchNum common.BatchNum) (*Metrics, error) {
1883 metricsTotals := &MetricsTotals{}
1884 metrics := &Metrics{}
1885 err := meddler.QueryRow(
1886 hdb.db, metricsTotals, `SELECT COUNT(tx.*) as total_txs,
1887 COALESCE (MIN(tx.batch_num), 0) as batch_num, COALESCE (MIN(block.timestamp),
1888 NOW()) AS min_timestamp, COALESCE (MAX(block.timestamp), NOW()) AS max_timestamp
1889 FROM tx INNER JOIN block ON tx.eth_block_num = block.eth_block_num
1890 WHERE block.timestamp >= NOW() - INTERVAL '24 HOURS';`)
1891 if err != nil {
1892 return nil, tracerr.Wrap(err)
1893 }
1894
1895 seconds := metricsTotals.MaxTimestamp.Sub(metricsTotals.MinTimestamp).Seconds()
1896 // Avoid dividing by 0
1897 if seconds == 0 {
1898 seconds++
1899 }
1900
1901 metrics.TransactionsPerSecond = float64(metricsTotals.TotalTransactions) / seconds
1902
1903 if (lastBatchNum - metricsTotals.FirstBatchNum) > 0 {
1904 metrics.TransactionsPerBatch = float64(metricsTotals.TotalTransactions) /
1905 float64(lastBatchNum-metricsTotals.FirstBatchNum+1)
1906 } else {
1907 metrics.TransactionsPerBatch = float64(0)
1908 }
1909
1910 err = meddler.QueryRow(
1911 hdb.db, metricsTotals, `SELECT COUNT(*) AS total_batches,
1912 COALESCE (SUM(total_fees_usd), 0) AS total_fees FROM batch
1913 WHERE batch_num > $1;`, metricsTotals.FirstBatchNum)
1914 if err != nil {
1915 return nil, tracerr.Wrap(err)
1916 }
1917 if metricsTotals.TotalBatches > 0 {
1918 metrics.BatchFrequency = seconds / float64(metricsTotals.TotalBatches)
1919 } else {
1920 metrics.BatchFrequency = 0
1921 }
1922 if metricsTotals.TotalTransactions > 0 {
1923 metrics.AvgTransactionFee = metricsTotals.TotalFeesUSD / float64(metricsTotals.TotalTransactions)
1924 } else {
1925 metrics.AvgTransactionFee = 0
1926 }
1927 err = meddler.QueryRow(
1928 hdb.db, metrics,
1929 `SELECT COUNT(*) AS total_bjjs, COUNT(DISTINCT(bjj)) AS total_accounts FROM account;`)
1930 if err != nil {
1931 return nil, tracerr.Wrap(err)
1932 }
1933
1934 return metrics, nil
1935}
1936
1937// GetAvgTxFee returns average transaction fee of the last 1h
1938func (hdb *HistoryDB) GetAvgTxFee() (float64, error) {
1939 metricsTotals := &MetricsTotals{}
1940 err := meddler.QueryRow(
1941 hdb.db, metricsTotals, `SELECT COUNT(tx.*) as total_txs,
1942 COALESCE (MIN(tx.batch_num), 0) as batch_num
1943 FROM tx INNER JOIN block ON tx.eth_block_num = block.eth_block_num
1944 WHERE block.timestamp >= NOW() - INTERVAL '1 HOURS';`)
1945 if err != nil {
1946 return 0, tracerr.Wrap(err)
1947 }
1948 err = meddler.QueryRow(
1949 hdb.db, metricsTotals, `SELECT COUNT(*) AS total_batches,
1950 COALESCE (SUM(total_fees_usd), 0) AS total_fees FROM batch
1951 WHERE batch_num > $1;`, metricsTotals.FirstBatchNum)
1952 if err != nil {
1953 return 0, tracerr.Wrap(err)
1954 }
1955
1956 var avgTransactionFee float64
1957 if metricsTotals.TotalTransactions > 0 {
1958 avgTransactionFee = metricsTotals.TotalFeesUSD / float64(metricsTotals.TotalTransactions)
1959 } else {
1960 avgTransactionFee = 0
1961 }
1962
1963 return avgTransactionFee, nil
1964}