add new endpoint zkevm_getLatestGlobalExitRoot

db/migrations/state/0014.sql

@@ -0,0 +1,6 @@
+-- +migrate Up
+CREATE INDEX IF NOT EXISTS idx_batch_global_exit_root ON state.batch (global_exit_root);
+
+-- +migrate Down
+DROP INDEX IF EXISTS state.idx_batch_global_exit_root;
+

db/migrations/state/0014_test.go

@@ -0,0 +1,63 @@
+package migrations_test
+
+import (
+	"database/sql"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// this migration changes length of the token name
+type migrationTest0014 struct{}
+
+func (m migrationTest0014) InsertData(db *sql.DB) error {
+	return nil
+}
+
+func (m migrationTest0014) RunAssertsAfterMigrationUp(t *testing.T, db *sql.DB) {
+	indexes := []string{
+		"idx_l2block_ger",
+	}
+	// Check indexes adding
+	for _, idx := range indexes {
+		// getIndex
+		const getIndex = `SELECT count(*) FROM pg_indexes WHERE indexname = $1;`
+		row := db.QueryRow(getIndex, idx)
+		var result int
+		assert.NoError(t, row.Scan(&result))
+		assert.Equal(t, 1, result)
+	}
+
+	// Check added column
+	const getFinalDeviationColumn = `SELECT count(*) FROM information_schema.columns WHERE table_name='l2block' and column_name='ger'`
+	row := db.QueryRow(getFinalDeviationColumn)
+	var result int
+	assert.NoError(t, row.Scan(&result))
+	assert.Equal(t, 1, result)
+}
+
+func (m migrationTest0014) RunAssertsAfterMigrationDown(t *testing.T, db *sql.DB) {
+	indexes := []string{
+		"idx_l2block_ger",
+	}
+	// Check indexes removing
+	for _, idx := range indexes {
+		// getIndex
+		const getIndex = `SELECT count(*) FROM pg_indexes WHERE indexname = $1;`
+		row := db.QueryRow(getIndex, idx)
+		var result int
+		assert.NoError(t, row.Scan(&result))
+		assert.Equal(t, 0, result)
+	}
+
+	// Check removed column
+	const getFinalDeviationColumn = `SELECT count(*) FROM information_schema.columns WHERE table_name='l2block' and column_name='ger'`
+	row := db.QueryRow(getFinalDeviationColumn)
+	var result int
+	assert.NoError(t, row.Scan(&result))
+	assert.Equal(t, 0, result)
+}
+
+func TestMigration0014(t *testing.T) {
+	runMigrationTest(t, 14, migrationTest0014{})
+}

jsonrpc/client/zkevm.go

@@ -77,3 +77,23 @@ func (c *Client) ExitRootsByGER(ctx context.Context, globalExitRoot common.Hash)
 
 	return result, nil
 }
+
+// GetLatestGlobalExitRoot returns the latest global exit root
+func (c *Client) GetLatestGlobalExitRoot(ctx context.Context) (common.Hash, error) {
+	response, err := JSONRPCCall(c.url, "zkevm_getLatestGlobalExitRoot")
+	if err != nil {
+		return common.Hash{}, err
+	}
+
+	if response.Error != nil {
+		return common.Hash{}, response.Error.RPCError()
+	}
+
+	var result string
+	err = json.Unmarshal(response.Result, &result)
+	if err != nil {
+		return common.Hash{}, err
+	}
+
+	return common.HexToHash(result), nil
+}

jsonrpc/endpoints_zkevm.go

@@ -535,3 +535,17 @@ func (z *ZKEVMEndpoints) getBlockByArg(ctx context.Context, blockArg *types.Bloc
 
 	return block, nil
 }
+
+// GetLatestGlobalExitRoot returns the last global exit root used by l2
+func (z *ZKEVMEndpoints) GetLatestGlobalExitRoot() (interface{}, types.Error) {
+	return z.txMan.NewDbTxScope(z.state, func(ctx context.Context, dbTx pgx.Tx) (interface{}, types.Error) {
+		var err error
+
+		ger, err := z.state.GetLatestBatchGlobalExitRoot(ctx, dbTx)
+		if err != nil {
+			return RPCErrorResponse(types.DefaultErrorCode, "couldn't load the last global exit root", err, true)
+		}
+
+		return ger.String(), nil
+	})
+}

jsonrpc/endpoints_zkevm.openrpc.json

@@ -411,6 +411,18 @@
           }
         }
       ]
+    },
+    {
+      "name": "zkevm_getLatestGlobalExitRoot",
+      "summary": "Returns the latest global exit root.",
+      "params": [
+      ],
+      "result": {
+        "name": "GER",
+          "schema": {
+            "$ref": "#/components/schemas/Keccak"
+          }
+      }
     }
   ],
   "components": {

jsonrpc/endpoints_zkevm_test.go

@@ -2586,3 +2586,81 @@ func TestGetExitRootsByGER(t *testing.T) {
 		})
 	}
 }
+
+func TestGetLatestGlobalExitRoot(t *testing.T) {
+	type testCase struct {
+		Name           string
+		ExpectedResult *common.Hash
+		ExpectedError  types.Error
+		SetupMocks     func(*mocksWrapper, *testCase)
+	}
+
+	testCases := []testCase{
+		{
+			Name:           "failed to load GER from state",
+			ExpectedResult: nil,
+			ExpectedError:  types.NewRPCError(types.DefaultErrorCode, "couldn't load the last global exit root"),
+			SetupMocks: func(m *mocksWrapper, tc *testCase) {
+				m.DbTx.
+					On("Rollback", context.Background()).
+					Return(nil).
+					Once()
+
+				m.State.
+					On("BeginStateTransaction", context.Background()).
+					Return(m.DbTx, nil).
+					Once()
+
+				m.State.
+					On("GetLatestBatchGlobalExitRoot", context.Background(), m.DbTx).
+					Return(nil, fmt.Errorf("failed to load GER from state")).
+					Once()
+			},
+		},
+		{
+			Name:           "Get latest GER successfully",
+			ExpectedResult: state.Ptr(common.HexToHash("0x1")),
+			ExpectedError:  nil,
+			SetupMocks: func(m *mocksWrapper, tc *testCase) {
+				m.DbTx.
+					On("Commit", context.Background()).
+					Return(nil).
+					Once()
+
+				m.State.
+					On("BeginStateTransaction", context.Background()).
+					Return(m.DbTx, nil).
+					Once()
+
+				m.State.
+					On("GetLatestBatchGlobalExitRoot", context.Background(), m.DbTx).
+					Return(common.HexToHash("0x1"), nil).
+					Once()
+			},
+		},
+	}
+
+	s, m, _ := newSequencerMockedServer(t)
+	defer s.Stop()
+
+	zkEVMClient := client.NewClient(s.ServerURL)
+
+	for _, testCase := range testCases {
+		t.Run(testCase.Name, func(t *testing.T) {
+			tc := testCase
+			testCase.SetupMocks(m, &tc)
+
+			ger, err := zkEVMClient.GetLatestGlobalExitRoot(context.Background())
+
+			if tc.ExpectedResult != nil {
+				assert.Equal(t, tc.ExpectedResult.String(), ger.String())
+			}
+
+			if err != nil || tc.ExpectedError != nil {
+				rpcErr := err.(types.RPCError)
+				assert.Equal(t, tc.ExpectedError.ErrorCode(), rpcErr.ErrorCode())
+				assert.Equal(t, tc.ExpectedError.Error(), rpcErr.Error())
+			}
+		})
+	}
+}

jsonrpc/types/interfaces.go

@@ -74,6 +74,7 @@ type StateInterface interface {
 	GetLastVerifiedL2BlockNumberUntilL1Block(ctx context.Context, l1FinalizedBlockNumber uint64, dbTx pgx.Tx) (uint64, error)
 	GetLastVerifiedBatchNumberUntilL1Block(ctx context.Context, l1BlockNumber uint64, dbTx pgx.Tx) (uint64, error)
 	GetBatchTimestamp(ctx context.Context, batchNumber uint64, forcedForkId *uint64, dbTx pgx.Tx) (*time.Time, error)
+	GetLatestBatchGlobalExitRoot(ctx context.Context, dbTx pgx.Tx) (common.Hash, error)
 }
 
 // EthermanInterface provides integration with L1

state/interfaces.go

@@ -148,4 +148,5 @@ type storage interface {
 	GetBlockByNumber(ctx context.Context, blockNumber uint64, dbTx pgx.Tx) (*Block, error)
 	GetVirtualBatchParentHash(ctx context.Context, batchNumber uint64, dbTx pgx.Tx) (common.Hash, error)
 	GetForcedBatchParentHash(ctx context.Context, forcedBatchNumber uint64, dbTx pgx.Tx) (common.Hash, error)
+	GetLatestBatchGlobalExitRoot(ctx context.Context, dbTx pgx.Tx) (common.Hash, error)
 }

state/pgstatestorage/batch.go

@@ -1008,3 +1008,20 @@ func (p *PostgresStorage) GetForcedBatchParentHash(ctx context.Context, forcedBa
 	}
 	return common.HexToHash(parentHash), nil
 }
+
+// GetLatestBatchGlobalExitRoot gets the last GER that is not zero from batches
+func (p *PostgresStorage) GetLatestBatchGlobalExitRoot(ctx context.Context, dbTx pgx.Tx) (common.Hash, error) {
+	var lastGER string
+	const query = "SELECT global_exit_root FROM state.batch where global_exit_root != $1 ORDER BY batch_num DESC LIMIT 1"
+
+	q := p.getExecQuerier(dbTx)
+	err := q.QueryRow(ctx, query, state.ZeroHash.String()).Scan(&lastGER)
+
+	if errors.Is(err, pgx.ErrNoRows) {
+		return state.ZeroHash, nil
+	} else if err != nil {
+		return state.ZeroHash, err
+	}
+
+	return common.HexToHash(lastGER), nil
+}

state/pgstatestorage/l2block.go

@@ -154,8 +154,8 @@ func (p *PostgresStorage) AddL2Block(ctx context.Context, batchNumber uint64, l2
 	e := p.getExecQuerier(dbTx)
 
 	const addL2BlockSQL = `
-        INSERT INTO state.l2block (block_num, block_hash, header, uncles, parent_hash, state_root, received_at, batch_num, created_at)
-                           VALUES (       $1,         $2,     $3,     $4,          $5,         $6,          $7,        $8,         $9)`
+        INSERT INTO state.l2block (block_num, block_hash, header, uncles, parent_hash, state_root, received_at, batch_num, created_at, ger)
+                           VALUES (       $1,         $2,     $3,     $4,          $5,         $6,          $7,        $8,         $9, $10)`
 
 	var header = "{}"
 	if l2Block.Header() != nil {
@@ -178,7 +178,7 @@ func (p *PostgresStorage) AddL2Block(ctx context.Context, batchNumber uint64, l2
 	if _, err := e.Exec(ctx, addL2BlockSQL,
 		l2Block.Number().Uint64(), l2Block.Hash().String(), header, uncles,
 		l2Block.ParentHash().String(), l2Block.Root().String(),
-		l2Block.ReceivedAt, batchNumber, time.Now().UTC()); err != nil {
+		l2Block.ReceivedAt, batchNumber, time.Now().UTC(), l2Block.GlobalExitRoot().String()); err != nil {
 		return err
 	}