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