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