Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Info tree updater tests #1418

Open
wants to merge 15 commits into
base: zkevm
Choose a base branch
from
Open

Info tree updater tests #1418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
bae612d
test: add unit tests for L1InfoTree updater functionality
afa7789 Nov 5, 2024
a5bab22
test: changing one of the test functions
afa7789 Nov 6, 2024
6c7b35a
test: removing unneeded comments
afa7789 Nov 6, 2024
9ffc90c
test: putting underscore on not used variable
afa7789 Nov 6, 2024
9cc7c43
Merge branch 'zkevm' into info_tree_updater_tests
afa7789 Nov 7, 2024
e5e2e7d
fix(tests): correct function name casing in L1InfoTree initialisation
afa7789 Nov 7, 2024
3497b0a
chore: chunked logs update to check better the function
afa7789 Nov 25, 2024
454165d
Merge branch 'zkevm' into info_tree_updater_tests
V-Staykov Dec 3, 2024
fcb71ff
Merge branch 'zkevm' into info_tree_updater_tests
afa7789 Dec 19, 2024
44130e8
test: add cases for handling logs with insufficient topics and unmatc…
afa7789 Dec 19, 2024
04ca736
test: enhance L1 info tree update tests for topic validation and head…
afa7789 Dec 19, 2024
b112499
test: enhance L1 info tree update tests with some other cases
afa7789 Dec 19, 2024
d7ebe0f
test: enhance L1 mock in warmup test
afa7789 Dec 20, 2024
eb74de7
test: refactor database transaction handling in updater tests
afa7789 Jan 8, 2025
1b819e8
test: add assertion for currentRoot in initialiseL1InfoTree test
afa7789 Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions zk/l1infotree/updater_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
package l1infotree

import (
"context"
"math/big"
"testing"
"time"

"github.com/ledgerwatch/erigon-lib/common"
"github.com/ledgerwatch/erigon-lib/kv/memdb"
"github.com/ledgerwatch/erigon/core/types"
"github.com/ledgerwatch/erigon/zk/hermez_db"
"github.com/stretchr/testify/assert"
)

func TestUpdater_chunkLogs(t *testing.T) {
logs := []types.Log{
{
Address: common.Address{},
Topics: []common.Hash{common.HexToHash("0x01")},
Data: []byte{0x01},
},
{
Address: common.Address{},
Topics: []common.Hash{common.HexToHash("0x02")},
Data: []byte{0x02},
},
{
Address: common.Address{},
Topics: []common.Hash{common.HexToHash("0x03")},
Data: []byte{0x03},
},
{
Address: common.Address{},
Topics: []common.Hash{common.HexToHash("0x04")},
Data: []byte{0x04},
},
}

chunkedLogs := chunkLogs(logs, 2)
assert.Len(t, chunkedLogs, 2)
assert.Len(t, chunkedLogs[0], 2)
assert.Len(t, chunkedLogs[1], 2)
}

func TestUpdater_initialiseL1InfoTree(t *testing.T) {

_, db1 := context.Background(), memdb.NewTestDB(t)
tx := memdb.BeginRw(t, db1)
db := hermez_db.NewHermezDb(tx)
assert.NotNil(t, db)

// updater := NewUpdater(db)
// func initialiseL1InfoTree(hermezDb *hermez_db.HermezDb) (*L1InfoTree, error) {
l1infotree, err := InitialiseL1InfoTree(db)
assert.NoError(t, err)
assert.NotNil(t, l1infotree)

afa7789 marked this conversation as resolved.
Show resolved Hide resolved
assert.Equal(t, l1infotree.currentRoot, common.HexToHash("0x27AE5BA08D7291C96C8CBDDCC148BF48A6D68C7974B94356F53754EF6171D757"))

}

func TestUpdater_createL1InfoTreeUpdate(t *testing.T) {
_, db1 := context.Background(), memdb.NewTestDB(t)
tx := memdb.BeginRw(t, db1)
db := hermez_db.NewHermezDb(tx)
assert.NotNil(t, db)

// func createL1InfoTreeUpdate(hermezDb *hermez_db.HermezDb, l1InfoTree *L1InfoTree) (*zkTypes.L1InfoTreeUpdate, error) {
l1infotree, err := InitialiseL1InfoTree(db)
assert.NoError(t, err)
assert.NotNil(t, l1infotree)

// Prepare a valid log with 3 topics
log := types.Log{
BlockNumber: 1,
Topics: []common.Hash{common.HexToHash("0x01"), common.HexToHash("0x02"), common.HexToHash("0x03")},
}
header := &types.Header{Number: big.NewInt(1), Time: uint64(time.Now().Unix()), ParentHash: common.HexToHash("0x0")}

// func createL1InfoTreeUpdate(l types.Log, header *types.Header) (*zkTypes.L1InfoTreeUpdate, error) {
l1infotreeupdate, err := createL1InfoTreeUpdate(log, header)
assert.NoError(t, err)
assert.NotNil(t, l1infotreeupdate)
afa7789 marked this conversation as resolved.
Show resolved Hide resolved
assert.Equal(t, log.Topics[1], l1infotreeupdate.MainnetExitRoot)
assert.Equal(t, log.Topics[2], l1infotreeupdate.RollupExitRoot)
assert.Equal(t, log.BlockNumber, l1infotreeupdate.BlockNumber)
assert.Equal(t, header.Time, l1infotreeupdate.Timestamp)
assert.Equal(t, header.ParentHash, l1infotreeupdate.ParentHash)

// Prepare a valid log with less than 3 topics
lessThen3Topics := types.Log{
BlockNumber: 1,
Topics: []common.Hash{},
}

// func createL1InfoTreeUpdate(l types.Log, header *types.Header) (*zkTypes.L1InfoTreeUpdate, error) {
l1infotreeupdate2, err2 := createL1InfoTreeUpdate(lessThen3Topics, header)
assert.Error(t, err2)
assert.Nil(t, l1infotreeupdate2)

unmatchingHeader := &types.Header{Number: big.NewInt(2), Time: uint64(time.Now().Unix()), ParentHash: common.HexToHash("0x0")}

// func createL1InfoTreeUpdate(l types.Log, header *types.Header) (*zkTypes.L1InfoTreeUpdate, error) {
l1infotreeupdate3, err3 := createL1InfoTreeUpdate(lessThen3Topics, unmatchingHeader)
assert.Error(t, err3)
assert.Nil(t, l1infotreeupdate3)
}

func TestUpdater_handleL1InfoTreeUpdate(t *testing.T) {
_, db1 := context.Background(), memdb.NewTestDB(t)
tx := memdb.BeginRw(t, db1)
db := hermez_db.NewHermezDb(tx)
assert.NotNil(t, db)

// Prepare a valid log with 3 topics
log := types.Log{
BlockNumber: 1,
Topics: []common.Hash{common.HexToHash("0x01"), common.HexToHash("0x02"), common.HexToHash("0x03")},
}
header := &types.Header{Number: big.NewInt(1), Time: uint64(time.Now().Unix()), ParentHash: common.HexToHash("0x0")}

// func createL1InfoTreeUpdate(l types.Log, header *types.Header) (*zkTypes.L1InfoTreeUpdate, error) {
l1infotreeupdate, err := createL1InfoTreeUpdate(log, header)
assert.NoError(t, err)

// func handleL1InfoTreeUpdate(hermezDb *hermez_db.HermezDb, update *zkTypes.L1InfoTreeUpdate) error {
err = handleL1InfoTreeUpdate(db, l1infotreeupdate)
assert.Nil(t, err)
assert.NoError(t, err)
afa7789 marked this conversation as resolved.
Show resolved Hide resolved

// Fetch and assert data from the DB
// Verify WriteL1InfoTreeUpdate
retrievedUpdate, err := db.GetL1InfoTreeUpdate(l1infotreeupdate.Index)
assert.NoError(t, err)
assert.NotNil(t, retrievedUpdate)

// Verify WriteL1InfoTreeUpdateToGer
retrievedUpdateGer, err := db.GetL1InfoTreeUpdateByGer(l1infotreeupdate.GER)
assert.NoError(t, err)
assert.NotNil(t, retrievedUpdateGer)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for checking the handler updating the info tree we should check the new tree info root hash. We could use a network like Bali or integration network 8 where have known L1 info roots already that we know are valid. We can just replicate those updates with mock logs etc. to ensure the tree comes back with the same root as we're expecting. We don't need to go crazy, just a couple of updates would be enough.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an extra test for this case then.

to check with real networks.
instead of changing the current one would be good.

( TODO )

}
155 changes: 155 additions & 0 deletions zk/l1infotree/updater_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
package l1infotree_test

import (
"context"
"math/big"
"testing"
"time"

"github.com/ledgerwatch/erigon-lib/common"
"github.com/ledgerwatch/erigon-lib/kv/memdb"
"github.com/ledgerwatch/erigon/core/types"
"github.com/ledgerwatch/erigon/eth/ethconfig"
"github.com/ledgerwatch/erigon/zk/hermez_db"
"github.com/ledgerwatch/erigon/zk/l1infotree"
"github.com/ledgerwatch/erigon/zk/syncer"
"github.com/ledgerwatch/erigon/zk/syncer/mocks"
zktypes "github.com/ledgerwatch/erigon/zk/types"
"github.com/stretchr/testify/assert"
"go.uber.org/mock/gomock"
)

func TestNewUpdater(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

cfg := &ethconfig.Zk{}

l1InfoTreeSyncer := syncer.NewL1Syncer(
ctx,
nil, nil, nil,
cfg.L1BlockRange,
cfg.L1QueryDelay,
cfg.L1HighestBlockType,
)

updater := l1infotree.NewUpdater(cfg, l1InfoTreeSyncer)
assert.NotNil(t, updater)
}

func TestUpdater_WarmUp_GetProgress_GetLatestUpdate(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
EthermanMock := mocks.NewMockIEtherman(mockCtrl)

cfg := &ethconfig.Zk{
L1FirstBlock: 1,
}

finalizedHeader := &types.Header{Number: big.NewInt(10), Difficulty: big.NewInt(100)}
finalizedBlock := types.NewBlockWithHeader(finalizedHeader)

// this will be last block answer
EthermanMock.EXPECT().
BlockByNumber(gomock.Any(), (*big.Int)(nil)).
Return(finalizedBlock, nil).AnyTimes()

// // filterLogs
EthermanMock.EXPECT().
FilterLogs(gomock.Any(), gomock.Any()).Return(
[]types.Log{
{},
{},
}, nil).AnyTimes()

l1InfoTreeSyncer := syncer.NewL1Syncer(
ctx,
[]syncer.IEtherman{EthermanMock},
[]common.Address{},
[][]common.Hash{},
cfg.L1BlockRange,
cfg.L1QueryDelay,
cfg.L1HighestBlockType,
)

updater := l1infotree.NewUpdater(cfg, l1InfoTreeSyncer)

_, db1 := context.Background(), memdb.NewTestDB(t)
tx := memdb.BeginRw(t, db1)
db := hermez_db.NewHermezDb(tx)

tree := &zktypes.L1InfoTreeUpdate{
BlockNumber: 1,
}
db.WriteL1InfoTreeUpdate(tree)

err := updater.WarmUp(tx)

progress := updater.GetProgress()
assert.Equal(t, uint64(0), progress)
afa7789 marked this conversation as resolved.
Show resolved Hide resolved

latestUpdate := updater.GetLatestUpdate()
// log.Println(latestUpdate)
assert.Equal(t, tree, latestUpdate)
assert.NoError(t, err)
}

func TestUpdater_CheckForInfoTreeUpdates(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
EthermanMock := mocks.NewMockIEtherman(mockCtrl)

mockHeader := &types.Header{
Number: big.NewInt(1),
Time: uint64(time.Now().Unix()),
ParentHash: common.HexToHash("0x0"),
}

expectedBlock := types.NewBlockWithHeader(mockHeader)

EthermanMock.EXPECT().
BlockByNumber(gomock.Any(), (*big.Int)(nil)).
Return(expectedBlock, nil).
AnyTimes()

EthermanMock.EXPECT().
HeaderByNumber(gomock.Any(), gomock.Any()).
Return(mockHeader, nil).
AnyTimes()

cfg := &ethconfig.Zk{
L1BlockRange: 2,
}

l1InfoTreeSyncer := syncer.NewL1Syncer(
ctx,
[]syncer.IEtherman{EthermanMock},
[]common.Address{},
[][]common.Hash{},
cfg.L1BlockRange,
cfg.L1QueryDelay,
cfg.L1HighestBlockType,
)

updater := l1infotree.NewUpdater(cfg, l1InfoTreeSyncer)

ctx, db1 := context.Background(), memdb.NewTestDB(t)
tx := memdb.BeginRw(t, db1)

err := updater.WarmUp(tx)
assert.NoError(t, err)

_, err = updater.CheckForInfoTreeUpdates(
"TestUpdater_CheckForInfoTreeUpdates",
tx,
)
assert.NoError(t, err)
// TODO: add more setup on mock/syncer to get a certain number of logs here.
// assert.NotNil(t, allLogs)
}
Loading