package l2db import ( "math/big" "time" ethCommon "github.com/ethereum/go-ethereum/common" "github.com/hermeznetwork/hermez-node/common" "github.com/hermeznetwork/hermez-node/db" "github.com/hermeznetwork/tracerr" "github.com/jmoiron/sqlx" //nolint:errcheck // driver for postgres DB _ "github.com/lib/pq" "github.com/russross/meddler" ) // TODO(Edu): Check DB consistency while there's concurrent use from Coordinator/TxSelector & API // L2DB stores L2 txs and authorization registers received by the coordinator and keeps them until they are no longer relevant // due to them being forged or invalid after a safety period type L2DB struct { db *sqlx.DB safetyPeriod common.BatchNum ttl time.Duration maxTxs uint32 } // NewL2DB creates a L2DB. // To create it, it's needed db connection, safety period expressed in batches, // maxTxs that the DB should have and TTL (time to live) for pending txs. func NewL2DB(db *sqlx.DB, safetyPeriod common.BatchNum, maxTxs uint32, TTL time.Duration) *L2DB { return &L2DB{ db: db, safetyPeriod: safetyPeriod, ttl: TTL, maxTxs: maxTxs, } } // DB returns a pointer to the L2DB.db. This method should be used only for // internal testing purposes. func (l2db *L2DB) DB() *sqlx.DB { return l2db.db } // AddAccountCreationAuth inserts an account creation authorization into the DB func (l2db *L2DB) AddAccountCreationAuth(auth *common.AccountCreationAuth) error { // return meddler.Insert(l2db.db, "account_creation_auth", auth) _, err := l2db.db.Exec( `INSERT INTO account_creation_auth (eth_addr, bjj, signature) VALUES ($1, $2, $3);`, auth.EthAddr, auth.BJJ, auth.Signature, ) return tracerr.Wrap(err) } // GetAccountCreationAuth returns an account creation authorization from the DB func (l2db *L2DB) GetAccountCreationAuth(addr ethCommon.Address) (*common.AccountCreationAuth, error) { auth := new(common.AccountCreationAuth) return auth, meddler.QueryRow( l2db.db, auth, "SELECT * FROM account_creation_auth WHERE eth_addr = $1;", addr, ) } // GetAccountCreationAuthAPI returns an account creation authorization from the DB func (l2db *L2DB) GetAccountCreationAuthAPI(addr ethCommon.Address) (*AccountCreationAuthAPI, error) { auth := new(AccountCreationAuthAPI) return auth, meddler.QueryRow( l2db.db, auth, "SELECT * FROM account_creation_auth WHERE eth_addr = $1;", addr, ) } // AddTx inserts a tx to the pool func (l2db *L2DB) AddTx(tx *PoolL2TxWrite) error { return meddler.Insert(l2db.db, "tx_pool", tx) } // AddTxTest inserts a tx into the L2DB. This is useful for test purposes, // but in production txs will only be inserted through the API func (l2db *L2DB) AddTxTest(tx *common.PoolL2Tx) error { // transform tx from *common.PoolL2Tx to PoolL2TxWrite insertTx := &PoolL2TxWrite{ TxID: tx.TxID, FromIdx: tx.FromIdx, ToBJJ: tx.ToBJJ, TokenID: tx.TokenID, Amount: tx.Amount, Fee: tx.Fee, Nonce: tx.Nonce, State: common.PoolL2TxStatePending, Signature: tx.Signature, RqToBJJ: tx.RqToBJJ, RqAmount: tx.RqAmount, Type: tx.Type, } if tx.ToIdx != 0 { insertTx.ToIdx = &tx.ToIdx } nilAddr := ethCommon.BigToAddress(big.NewInt(0)) if tx.ToEthAddr != nilAddr { insertTx.ToEthAddr = &tx.ToEthAddr } if tx.RqFromIdx != 0 { insertTx.RqFromIdx = &tx.RqFromIdx } if tx.RqToIdx != 0 { // if true, all Rq... fields must be different to nil insertTx.RqToIdx = &tx.RqToIdx insertTx.RqTokenID = &tx.RqTokenID insertTx.RqFee = &tx.RqFee insertTx.RqNonce = &tx.RqNonce } if tx.RqToEthAddr != nilAddr { insertTx.RqToEthAddr = &tx.RqToEthAddr } f := new(big.Float).SetInt(tx.Amount) amountF, _ := f.Float64() insertTx.AmountFloat = amountF // insert tx return meddler.Insert(l2db.db, "tx_pool", insertTx) } // selectPoolTxAPI select part of queries to get PoolL2TxRead const selectPoolTxAPI = `SELECT tx_pool.tx_id, hez_idx(tx_pool.from_idx, token.symbol) AS from_idx, tx_pool.from_eth_addr, tx_pool.from_bjj, hez_idx(tx_pool.to_idx, token.symbol) AS to_idx, tx_pool.to_eth_addr, tx_pool.to_bjj, tx_pool.token_id, tx_pool.amount, tx_pool.fee, tx_pool.nonce, tx_pool.state, tx_pool.signature, tx_pool.timestamp, tx_pool.batch_num, hez_idx(tx_pool.rq_from_idx, token.symbol) AS rq_from_idx, hez_idx(tx_pool.rq_to_idx, token.symbol) AS rq_to_idx, tx_pool.rq_to_eth_addr, tx_pool.rq_to_bjj, tx_pool.rq_token_id, tx_pool.rq_amount, tx_pool.rq_fee, tx_pool.rq_nonce, tx_pool.tx_type, token.item_id AS token_item_id, token.eth_block_num, token.eth_addr, token.name, token.symbol, token.decimals, token.usd, token.usd_update FROM tx_pool INNER JOIN token ON tx_pool.token_id = token.token_id ` // selectPoolTxCommon select part of queries to get common.PoolL2Tx const selectPoolTxCommon = `SELECT tx_pool.tx_id, from_idx, to_idx, tx_pool.to_eth_addr, tx_pool.to_bjj, tx_pool.token_id, tx_pool.amount, tx_pool.fee, tx_pool.nonce, tx_pool.state, tx_pool.signature, tx_pool.timestamp, rq_from_idx, rq_to_idx, tx_pool.rq_to_eth_addr, tx_pool.rq_to_bjj, tx_pool.rq_token_id, tx_pool.rq_amount, tx_pool.rq_fee, tx_pool.rq_nonce, tx_pool.tx_type, fee_percentage(tx_pool.fee::NUMERIC) * token.usd * tx_pool.amount_f AS fee_usd, token.usd_update FROM tx_pool INNER JOIN token ON tx_pool.token_id = token.token_id ` // GetTx return the specified Tx in common.PoolL2Tx format func (l2db *L2DB) GetTx(txID common.TxID) (*common.PoolL2Tx, error) { tx := new(common.PoolL2Tx) return tx, meddler.QueryRow( l2db.db, tx, selectPoolTxCommon+"WHERE tx_id = $1;", txID, ) } // GetTxAPI return the specified Tx in PoolTxAPI format func (l2db *L2DB) GetTxAPI(txID common.TxID) (*PoolTxAPI, error) { tx := new(PoolTxAPI) return tx, meddler.QueryRow( l2db.db, tx, selectPoolTxAPI+"WHERE tx_id = $1;", txID, ) } // GetPendingTxs return all the pending txs of the L2DB, that have a non NULL AbsoluteFee func (l2db *L2DB) GetPendingTxs() ([]common.PoolL2Tx, error) { var txs []*common.PoolL2Tx err := meddler.QueryAll( l2db.db, &txs, selectPoolTxCommon+"WHERE state = $1", common.PoolL2TxStatePending, ) return db.SlicePtrsToSlice(txs).([]common.PoolL2Tx), tracerr.Wrap(err) } // StartForging updates the state of the transactions that will begin the forging process. // The state of the txs referenced by txIDs will be changed from Pending -> Forging func (l2db *L2DB) StartForging(txIDs []common.TxID, batchNum common.BatchNum) error { query, args, err := sqlx.In( `UPDATE tx_pool SET state = ?, batch_num = ? WHERE state = ? AND tx_id IN (?);`, common.PoolL2TxStateForging, batchNum, common.PoolL2TxStatePending, txIDs, ) if err != nil { return tracerr.Wrap(err) } query = l2db.db.Rebind(query) _, err = l2db.db.Exec(query, args...) return tracerr.Wrap(err) } // DoneForging updates the state of the transactions that have been forged // so the state of the txs referenced by txIDs will be changed from Forging -> Forged func (l2db *L2DB) DoneForging(txIDs []common.TxID, batchNum common.BatchNum) error { query, args, err := sqlx.In( `UPDATE tx_pool SET state = ?, batch_num = ? WHERE state = ? AND tx_id IN (?);`, common.PoolL2TxStateForged, batchNum, common.PoolL2TxStateForging, txIDs, ) if err != nil { return tracerr.Wrap(err) } query = l2db.db.Rebind(query) _, err = l2db.db.Exec(query, args...) return tracerr.Wrap(err) } // InvalidateTxs updates the state of the transactions that are invalid. // The state of the txs referenced by txIDs will be changed from * -> Invalid func (l2db *L2DB) InvalidateTxs(txIDs []common.TxID, batchNum common.BatchNum) error { query, args, err := sqlx.In( `UPDATE tx_pool SET state = ?, batch_num = ? WHERE tx_id IN (?);`, common.PoolL2TxStateInvalid, batchNum, txIDs, ) if err != nil { return tracerr.Wrap(err) } query = l2db.db.Rebind(query) _, err = l2db.db.Exec(query, args...) return tracerr.Wrap(err) } // CheckNonces invalidate txs with nonces that are smaller or equal than their respective accounts nonces. // The state of the affected txs will be changed from Pending -> Invalid func (l2db *L2DB) CheckNonces(updatedAccounts []common.Account, batchNum common.BatchNum) (err error) { txn, err := l2db.db.Beginx() if err != nil { return tracerr.Wrap(err) } defer func() { // Rollback the transaction if there was an error. if err != nil { db.Rollback(txn) } }() for i := 0; i < len(updatedAccounts); i++ { _, err = txn.Exec( `UPDATE tx_pool SET state = $1, batch_num = $2 WHERE state = $3 AND from_idx = $4 AND nonce <= $5;`, common.PoolL2TxStateInvalid, batchNum, common.PoolL2TxStatePending, updatedAccounts[i].Idx, updatedAccounts[i].Nonce, ) if err != nil { return tracerr.Wrap(err) } } return txn.Commit() } // Reorg updates the state of txs that were updated in a batch that has been discarted due to a blockchain reorg. // The state of the affected txs can change form Forged -> Pending or from Invalid -> Pending func (l2db *L2DB) Reorg(lastValidBatch common.BatchNum) error { _, err := l2db.db.Exec( `UPDATE tx_pool SET batch_num = NULL, state = $1 WHERE (state = $2 OR state = $3) AND batch_num > $4`, common.PoolL2TxStatePending, common.PoolL2TxStateForged, common.PoolL2TxStateInvalid, lastValidBatch, ) return tracerr.Wrap(err) } // Purge deletes transactions that have been forged or marked as invalid for longer than the safety period // it also deletes txs that has been in the L2DB for longer than the ttl if maxTxs has been exceeded func (l2db *L2DB) Purge(currentBatchNum common.BatchNum) (err error) { txn, err := l2db.db.Beginx() if err != nil { return tracerr.Wrap(err) } defer func() { // Rollback the transaction if there was an error. if err != nil { db.Rollback(txn) } }() // Delete pending txs that have been in the pool after the TTL if maxTxs is reached now := time.Now().UTC().Unix() _, err = txn.Exec( `DELETE FROM tx_pool WHERE (SELECT count(*) FROM tx_pool) > $1 AND timestamp < $2`, l2db.maxTxs, time.Unix(now-int64(l2db.ttl.Seconds()), 0), ) if err != nil { return tracerr.Wrap(err) } // Delete txs that have been marked as forged / invalid after the safety period _, err = txn.Exec( `DELETE FROM tx_pool WHERE batch_num < $1 AND (state = $2 OR state = $3)`, currentBatchNum-l2db.safetyPeriod, common.PoolL2TxStateForged, common.PoolL2TxStateInvalid, ) if err != nil { return tracerr.Wrap(err) } return txn.Commit() }