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