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