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