a_bennassar
12 changed files with 418 additions and 108 deletions
Unified View
Diff Options
-
+5 -5batchbuilder/batchbuilder.go
-
+15 -11common/l1tx.go
-
+15 -2common/l2tx.go
-
+38 -29common/pooll2tx.go
-
+0 -13common/tx.go
-
+9 -11db/historydb/migrations/001_init.sql
-
+72 -17db/l2db/l2db.go
-
+181 -0db/l2db/l2db_test.go
-
+37 -0db/l2db/migrations/001_init.sql
-
+40 -0db/utils.go
-
+1 -0go.mod
-
+5 -20go.sum
@ -1,7 +1,20 @@ |
|||||
package common |
package common |
||||
|
|
||||
|
import ( |
||||
|
"math/big" |
||||
|
) |
||||
|
|
||||
// L2Tx is a struct that represents an already forged L2 tx
|
// L2Tx is a struct that represents an already forged L2 tx
|
||||
type L2Tx struct { |
type L2Tx struct { |
||||
Tx |
|
||||
Position int // Position among all the L1Txs in that batch
|
|
||||
|
// Stored in DB: mandatory fileds
|
||||
|
TxID TxID `meddler:"tx_id"` |
||||
|
BatchNum BatchNum `meddler:"batch_num"` // batchNum in which this tx was forged.
|
||||
|
Position int `meddler:"position"` |
||||
|
FromIdx Idx `meddler:"from_idx"` |
||||
|
ToIdx Idx `meddler:"to_idx"` |
||||
|
Amount *big.Int `meddler:"amount,bigint"` |
||||
|
Fee FeeSelector `meddler:"fee"` |
||||
|
Nonce uint64 `meddler:"nonce"` |
||||
|
// Extra metadata, may be uninitialized
|
||||
|
Type TxType `meddler:"-"` // optional, descrives which kind of tx it's
|
||||
} |
} |
||||
@ -0,0 +1,181 @@ |
|||||
|
package l2db |
||||
|
|
||||
|
import ( |
||||
|
"fmt" |
||||
|
"math/big" |
||||
|
"os" |
||||
|
"strconv" |
||||
|
"testing" |
||||
|
"time" |
||||
|
|
||||
|
eth "github.com/ethereum/go-ethereum/common" |
||||
|
"github.com/hermeznetwork/hermez-node/common" |
||||
|
"github.com/iden3/go-iden3-crypto/babyjub" |
||||
|
"github.com/stretchr/testify/assert" |
||||
|
) |
||||
|
|
||||
|
var l2DB *L2DB |
||||
|
|
||||
|
// In order to run the test you need to run a Posgres DB with
|
||||
|
// a database named "l2" that is accessible by
|
||||
|
// user: "hermez"
|
||||
|
// pass: set it using the env var POSTGRES_PASS
|
||||
|
// This can be achieved by running: POSTGRES_PASS=your_strong_pass && sudo docker run --rm --name hermez-db-test -p 5432:5432 -e POSTGRES_DB=history -e POSTGRES_USER=hermez -e POSTGRES_PASSWORD=$POSTGRES_PASS -d postgres && sleep 2s && sudo docker exec -it hermez-db-test psql -a history -U hermez -c "CREATE DATABASE l2;"
|
||||
|
// After running the test you can stop the container by running: sudo docker kill hermez-ydb-test
|
||||
|
// If you already did that for the HistoryDB you don't have to do it again
|
||||
|
func TestMain(m *testing.M) { |
||||
|
// init DB
|
||||
|
var err error |
||||
|
pass := os.Getenv("POSTGRES_PASS") |
||||
|
l2DB, err = NewL2DB(5432, "localhost", "hermez", pass, "l2", 10, 512, 24*time.Hour) |
||||
|
if err != nil { |
||||
|
panic(err) |
||||
|
} |
||||
|
// Run tests
|
||||
|
result := m.Run() |
||||
|
// Close DB
|
||||
|
if err := l2DB.Close(); err != nil { |
||||
|
fmt.Println("Error closing the history DB:", err) |
||||
|
} |
||||
|
os.Exit(result) |
||||
|
} |
||||
|
|
||||
|
func TestAddTx(t *testing.T) { |
||||
|
const nInserts = 20 |
||||
|
cleanDB() |
||||
|
txs := genTxs(nInserts) |
||||
|
for _, tx := range txs { |
||||
|
err := l2DB.AddTx(tx) |
||||
|
assert.NoError(t, err) |
||||
|
fetchedTx, err := l2DB.GetTx(tx.TxID) |
||||
|
assert.NoError(t, err) |
||||
|
assert.Equal(t, tx.Timestamp.Unix(), fetchedTx.Timestamp.Unix()) |
||||
|
tx.Timestamp = fetchedTx.Timestamp |
||||
|
assert.Equal(t, tx.AbsoluteFeeUpdate.Unix(), fetchedTx.AbsoluteFeeUpdate.Unix()) |
||||
|
tx.Timestamp = fetchedTx.Timestamp |
||||
|
tx.AbsoluteFeeUpdate = fetchedTx.AbsoluteFeeUpdate |
||||
|
assert.Equal(t, tx, fetchedTx) |
||||
|
} |
||||
|
} |
||||
|
|
||||
|
func BenchmarkAddTx(b *testing.B) { |
||||
|
const nInserts = 20 |
||||
|
cleanDB() |
||||
|
txs := genTxs(nInserts) |
||||
|
now := time.Now() |
||||
|
for _, tx := range txs { |
||||
|
l2DB.AddTx(tx) |
||||
|
} |
||||
|
elapsedTime := time.Since(now) |
||||
|
fmt.Println("Time to insert 2048 txs:", elapsedTime) |
||||
|
} |
||||
|
|
||||
|
func TestGetPending(t *testing.T) { |
||||
|
const nInserts = 20 |
||||
|
cleanDB() |
||||
|
txs := genTxs(nInserts) |
||||
|
var pendingTxs []*common.PoolL2Tx |
||||
|
for _, tx := range txs { |
||||
|
err := l2DB.AddTx(tx) |
||||
|
assert.NoError(t, err) |
||||
|
if tx.State == common.PoolL2TxStatePending { |
||||
|
pendingTxs = append(pendingTxs, tx) |
||||
|
} |
||||
|
} |
||||
|
fetchedTxs, err := l2DB.GetPendingTxs() |
||||
|
assert.NoError(t, err) |
||||
|
assert.Equal(t, len(pendingTxs), len(fetchedTxs)) |
||||
|
for i, fetchedTx := range fetchedTxs { |
||||
|
assert.Equal(t, pendingTxs[i].Timestamp.Unix(), fetchedTx.Timestamp.Unix()) |
||||
|
pendingTxs[i].Timestamp = fetchedTx.Timestamp |
||||
|
assert.Equal(t, pendingTxs[i].AbsoluteFeeUpdate.Unix(), fetchedTx.AbsoluteFeeUpdate.Unix()) |
||||
|
pendingTxs[i].AbsoluteFeeUpdate = fetchedTx.AbsoluteFeeUpdate |
||||
|
assert.Equal(t, pendingTxs[i], fetchedTx) |
||||
|
} |
||||
|
} |
||||
|
|
||||
|
func TestStartForging(t *testing.T) { |
||||
|
const nInserts = 24 |
||||
|
const fakeBlockNum = 33 |
||||
|
cleanDB() |
||||
|
txs := genTxs(nInserts) |
||||
|
var startForgingTxs []*common.PoolL2Tx |
||||
|
var startForgingTxIDs []common.TxID |
||||
|
randomizer := 0 |
||||
|
for _, tx := range txs { |
||||
|
err := l2DB.AddTx(tx) |
||||
|
assert.NoError(t, err) |
||||
|
if tx.State == common.PoolL2TxStatePending && randomizer%2 == 0 { |
||||
|
randomizer++ |
||||
|
startForgingTxs = append(startForgingTxs, tx) |
||||
|
startForgingTxIDs = append(startForgingTxIDs, tx.TxID) |
||||
|
} |
||||
|
if tx.State == common.PoolL2TxStateForging { |
||||
|
startForgingTxs = append(startForgingTxs, tx) |
||||
|
} |
||||
|
} |
||||
|
err := l2DB.StartForging(startForgingTxIDs, fakeBlockNum) |
||||
|
assert.NoError(t, err) |
||||
|
// TODO: Fetch txs and check that they've been updated correctly
|
||||
|
} |
||||
|
|
||||
|
func genTxs(n int) []*common.PoolL2Tx { |
||||
|
// WARNING: This tx doesn't follow the protocol (signature, txID, ...)
|
||||
|
// it's just to test geting/seting from/to the DB.
|
||||
|
// Type and RqTxCompressedData: not initialized because it's not stored
|
||||
|
// on the DB and add noise when checking results.
|
||||
|
txs := make([]*common.PoolL2Tx, 0, n) |
||||
|
privK := babyjub.NewRandPrivKey() |
||||
|
for i := 0; i < n; i++ { |
||||
|
var state common.PoolL2TxState |
||||
|
if i%4 == 0 { |
||||
|
state = common.PoolL2TxStatePending |
||||
|
} else if i%4 == 1 { |
||||
|
state = common.PoolL2TxStateInvalid |
||||
|
} else if i%4 == 2 { |
||||
|
state = common.PoolL2TxStateForging |
||||
|
} else if i%4 == 3 { |
||||
|
state = common.PoolL2TxStateForged |
||||
|
} |
||||
|
tx := &common.PoolL2Tx{ |
||||
|
TxID: common.TxID(common.Hash([]byte(strconv.Itoa(i)))), |
||||
|
FromIdx: 47, |
||||
|
ToIdx: 96, |
||||
|
ToEthAddr: eth.BigToAddress(big.NewInt(234523534)), |
||||
|
ToBJJ: privK.Public(), |
||||
|
TokenID: 73, |
||||
|
Amount: big.NewInt(3487762374627846747), |
||||
|
Fee: 99, |
||||
|
Nonce: 28, |
||||
|
State: state, |
||||
|
Signature: *privK.SignPoseidon(big.NewInt(674238462)), |
||||
|
Timestamp: time.Now().UTC(), |
||||
|
} |
||||
|
if i%2 == 0 { // Optional parameters: rq
|
||||
|
tx.RqFromIdx = 893 |
||||
|
tx.RqToIdx = 334 |
||||
|
tx.RqToEthAddr = eth.BigToAddress(big.NewInt(239457111187)) |
||||
|
tx.RqToBJJ = privK.Public() |
||||
|
tx.RqTokenID = 222 |
||||
|
tx.RqAmount = big.NewInt(3487762374627846747) |
||||
|
tx.RqFee = 11 |
||||
|
tx.RqNonce = 78 |
||||
|
} |
||||
|
if i%3 == 0 { // Optional parameters: things that get updated "a posteriori"
|
||||
|
tx.BatchNum = 489 |
||||
|
tx.AbsoluteFee = 39.12345 |
||||
|
tx.AbsoluteFeeUpdate = time.Now().UTC() |
||||
|
} |
||||
|
txs = append(txs, tx) |
||||
|
} |
||||
|
return txs |
||||
|
} |
||||
|
|
||||
|
func cleanDB() { |
||||
|
if _, err := l2DB.db.Exec("DELETE FROM tx_pool"); err != nil { |
||||
|
panic(err) |
||||
|
} |
||||
|
if _, err := l2DB.db.Exec("DELETE FROM account_creation_auth"); err != nil { |
||||
|
panic(err) |
||||
|
} |
||||
|
} |
||||
@ -0,0 +1,37 @@ |
|||||
|
-- +migrate Up |
||||
|
CREATE TABLE tx_pool ( |
||||
|
tx_id BYTEA PRIMARY KEY, |
||||
|
from_idx BIGINT NOT NULL, |
||||
|
to_idx BIGINT NOT NULL, |
||||
|
to_eth_addr BYTEA NOT NULL, |
||||
|
to_bjj BYTEA NOT NULL, |
||||
|
token_id INT NOT NULL, |
||||
|
amount BYTEA NOT NULL, |
||||
|
fee SMALLINT NOT NULL, |
||||
|
nonce BIGINT NOT NULL, |
||||
|
state CHAR(4) NOT NULL, |
||||
|
batch_num BIGINT, |
||||
|
rq_from_idx BIGINT, |
||||
|
rq_to_idx BIGINT, |
||||
|
rq_to_eth_addr BYTEA, |
||||
|
rq_to_bjj BYTEA, |
||||
|
rq_token_id INT, |
||||
|
rq_amount BYTEA, |
||||
|
rq_fee SMALLINT, |
||||
|
rq_nonce BIGINT, |
||||
|
signature BYTEA NOT NULL, |
||||
|
timestamp TIMESTAMP WITHOUT TIME ZONE NOT NULL, |
||||
|
absolute_fee NUMERIC, |
||||
|
absolute_fee_update TIMESTAMP WITHOUT TIME ZONE |
||||
|
); |
||||
|
|
||||
|
CREATE TABLE account_creation_auth ( |
||||
|
eth_addr BYTEA PRIMARY KEY, |
||||
|
bjj BYTEA NOT NULL, |
||||
|
account_creation_auth_sig BYTEA NOT NULL, |
||||
|
timestamp TIMESTAMP WITHOUT TIME ZONE NOT NULL |
||||
|
); |
||||
|
|
||||
|
-- +migrate Down |
||||
|
DROP TABLE account_creation_auth; |
||||
|
DROP TABLE tx_pool; |
||||