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