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