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