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