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