feat(permissionless batches): batch production toolkit and operator recovery #1555

jonastheis · 2024-10-24T08:37:16Z

Purpose or design rationale of this PR

This PR is part of the permissionless batches (aka enforced batches) feature. It implements the permissionless batch production, operator recovery and provides instructions how to run these in the readme.

permissionless batch production: rollup/cmd/permissionless_batches/app/app.go the main tool in conjunction with permissionless-batches/docker-compose.yml (usage will be explained in readme later) to create batches in a permissionless way and submit them to L1. It requires the recovery and potentially block production without signature in l2geth before.

operator recovery: rollup/cmd/rollup_relayer/app/app.go with cfg.RecoveryConfig.Enable == true. Will
restore all batches between the latest finalized batch in the DB and the latest finalized batch on L1 based on L1 data. It requires the recovery of l2geth before.

Other parts of this feature are implemented in following PRs:

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
docs: Documentation-only changes
feat: A new feature
fix: A bug fix
perf: A code change that improves performance
refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

No, this PR doesn't involve a new deployment, git tag, docker image tag
Yes

Breaking change label

Does this PR have the breaking-change label?

No, this PR is not a breaking change
Yes

…e batches

…batches-recovery

…locks

coderabbitai · 2024-10-24T08:37:27Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

georgehao · 2024-10-28T08:25:10Z

can you add more description about this pr

jonastheis · 2024-10-29T05:01:43Z

can you add more description about this pr

Will do so once it's in a better shape. This is still a draft PR and and such many things are still changing. Once ready, I'll provide a high-level description + how it relates to the changes made in this PR :)

rollup/internal/orm/chunk.go

rollup/internal/orm/bundle.go

rollup/cmd/permissionless_batches/app/app.go

rollup/cmd/rollup_relayer/app/app.go

colinlyguo · 2024-10-29T15:55:42Z

rollup/cmd/permissionless_batches/app/app.go

+	// 2. Make sure that the specified batch is indeed finalized on the L1 rollup contract and is the latest finalized batch.
+	// TODO: enable check
+	//latestFinalizedBatch, err := reader.LatestFinalizedBatch(latestFinalizedL1Block)
+	//if cfg.RecoveryConfig.LatestFinalizedBatch != latestFinalizedBatch {


curious about why setting cfg.RecoveryConfig.LatestFinalizedBatch instead of using reader.LatestFinalizedBatch as the start point.

you're right, can probably remove it and make the configuration a bit easier. initially, I wanted the user to specify L1 block and the latest finalized batch so that the user knows where the (minimal) recovery process is starting from and there's no "magic" happening (e.g. if there's another batch committed in the meantime).

I introduced another config parameter for testing purposes to override this check force_latest_finalized_batch. The user now still needs to specify the L1 block height and latest finalized batch to not have any surprises/magic.

… message amount. this is mainly for testing purposes

georgehao · 2024-11-19T08:50:31Z

rollup/internal/controller/watcher/batch_proposer.go

@@ -149,6 +149,10 @@ func NewBatchProposer(ctx context.Context, cfg *config.BatchProposerConfig, chai
 	return p
 }

+func (p *BatchProposer) BatchORM() *orm.Batch {


as our layout purpose, the orm instance should be exposed to app layer.

done in 5ff6fd0

georgehao · 2024-11-19T08:53:59Z

rollup/cmd/permissionless_batches/app/app.go

+	return db, nil
+}
+
+func fetchL2Blocks(ctx context.Context, cfg *config.Config, genesis *core.Genesis, db *gorm.DB, registry prometheus.Registerer, fromBlock uint64, l2BlockHeightLimit uint64) (uint64, error) {


I suggest that move these logics to controller layer

done in 5ff6fd0

georgehao · 2024-11-19T09:33:16Z

rollup/cmd/permissionless_batches/app/app.go

+
+	// TODO: make these parameters -> part of genesis config?
+	scrollChainAddress := common.HexToAddress("0x2D567EcE699Eabe5afCd141eDB7A4f2D0D6ce8a0")
+	l1MessageQueueAddress := common.HexToAddress("0xF0B2293F5D834eAe920c6974D50957A1732de763")


read from config

done in 5ff6fd0

…erriding and instead switching to batch submission mode

rollup/internal/orm/batch.go

rollup/internal/controller/permissionless_batches/minimal_recovery.go

georgehao · 2024-11-25T02:30:52Z

rollup/internal/controller/permissionless_batches/minimal_recovery.go

+	if err != nil {
+		return true
+	}
+	if chunk.Index <= defaultRestoredChunkIndex {


Why don't get the defaultRestoredChunkIndex, defaultRestoredBundleIndex from config like RecoveryConfig.LatestFinalizedBatch

// defaultFakeRestoredChunkIndex is the default index of the last restored fake chunk. It is used to be able to generate new chunks pretending that we have already processed some chunks.

I renamed them now to include fake in the name. It is not a config parameter but just an arbitrary constant value as we need to pretend we have chunks and bundles in the DB (even though in reality we don't)

georgehao · 2024-11-25T02:35:28Z

rollup/internal/controller/permissionless_batches/minimal_recovery.go

+	return toBlock, nil
+}
+
+func (r *MinimalRecovery) resetDB() error {


I prefer the user use database component to do it.

cd scroll/database

make db_cli

./build/bin/db_cli migrate --config ./config.json

Yeah I was thinking about this as well. But the user doesn't even really know there's a database (it's automatically started with executing the Docker Compose profiles). For the minimal recovery the DB is just a crutch to make the batch creating with existing logic, coordinator and proving working without changing the logic in the components respectively.

If we add it like this then we'll need to add these additional steps to the README.md which makes the entire thing even more complicated.

rollup/internal/controller/permissionless_batches/minimal_recovery.go

georgehao · 2024-11-25T03:07:13Z

rollup/internal/orm/batch.go

@@ -324,6 +326,53 @@ func (o *Batch) InsertBatch(ctx context.Context, batch *encoding.Batch, codecVer
 	return &newBatch, nil
 }

+func (o *Batch) InsertBatchRaw(ctx context.Context, batchIndex *big.Int, batchHash common.Hash, codecVersion encoding.CodecVersion, chunk *Chunk) (*Batch, error) {


Suggested change

func (o *Batch) InsertBatchRaw(ctx context.Context, batchIndex *big.Int, batchHash common.Hash, codecVersion encoding.CodecVersion, chunk *Chunk) (*Batch, error) {

func (o *Batch) InsertPermissionlessBatch(ctx context.Context, batchIndex *big.Int, batchHash common.Hash, codecVersion encoding.CodecVersion, chunk *Chunk) (*Batch, error) {

done in 6ef4775

georgehao · 2024-11-25T03:08:44Z

rollup/internal/orm/batch.go

+		StartChunkHash:            chunk.Hash,
+		EndChunkIndex:             chunk.Index,
+		EndChunkHash:              chunk.Hash,
+		StateRoot:                 "",


If the field doesn't have a value, don't need to assign a empty value to it, the gorm will set automatically.

done in 6ef4775

georgehao · 2024-11-25T09:08:42Z

rollup/cmd/permissionless_batches/app/app.go

+		log.Info("Success! You're ready to generate proofs!")
+	} else {
+		// TODO: implement batch submission if proofs are available
+		log.Info("TODO: Batch submission")


you mean the finalizeBundle?

no, I mean a new function on the contracts for permissionless mode (commitAndFinalizeBatch) to submit the batch and finalize in one go. However, the implementation is not yet done and changing as we won't have SGX for now: https://github.com/scroll-tech/scroll-contracts/pull/61/files#diff-569c04365d5a05d8c3084fec1c23fa7d12607340e012df710d3c5963bd1684beR511

georgehao · 2024-11-25T09:16:43Z

rollup/internal/orm/chunk.go

@@ -254,6 +256,52 @@ func (o *Chunk) InsertChunk(ctx context.Context, chunk *encoding.Chunk, codecVer
 	return &newChunk, nil
 }

+func (o *Chunk) InsertChunkRaw(ctx context.Context, index uint64, codecVersion encoding.CodecVersion, chunk *encoding.DAChunkRawTx, totalL1MessagePoppedBefore uint64) (*Chunk, error) {


done in 6ef4775

…oduction toolkit

georgehao · 2024-11-25T10:59:12Z

rollup/internal/controller/permissionless_batches/minimal_recovery.go

+}
+
+func (r *MinimalRecovery) RecoveryNeeded() bool {
+	chunk, err := r.chunkORM.GetLatestChunk(r.ctx)


If users run, here seems weird.
for users, I think they don't have any data locally.

within the Docker Compose they have a DB but users don't really know about it as it is all part of the automatic script.

georgehao · 2024-11-25T11:14:28Z

rollup/internal/controller/relayer/full_recovery.go

+// RestoreFullPreviousState restores the full state from L1.
+// The DB state should be clean: the latest batch in the DB should be finalized on L1. This function will
+// restore all batches between the latest finalized batch in the DB and the latest finalized batch on L1.
+func (f *FullRecovery) RestoreFullPreviousState() error {


Why I feel we can combine the RestoreMinimalPreviousState and RestoreFullPreviousState to same logic. WDYT？

I agree, there is some overlap but if you look at it side by side, the functionality diverges already at 1.5 steps. As such, I think it would make it more complicated to combine them.

jonastheis added 5 commits October 23, 2024 16:52

implement first steps for minimal recovery to permissionlessly produc…

dca69ce

…e batches

Merge remote-tracking branch 'origin/develop' into jt/permissionless-…

2e09118

…batches-recovery

add config for recovery mode

496314f

structure code and implement restoreMinimalPreviousState and fetchL2B…

c12d380

…locks

produce chunks from specified L2 blocks and batch from chunks

c329959

jonastheis added 2 commits October 25, 2024 15:51

start implementation of restoring full previous state for relayer

71f240b

implement processFinalizedBatch

acc7083

handle batches

59ea991

colinlyguo self-requested a review October 29, 2024 05:05

colinlyguo reviewed Oct 29, 2024

View reviewed changes

rollup/internal/orm/chunk.go Outdated Show resolved Hide resolved

rollup/internal/orm/bundle.go Show resolved Hide resolved

colinlyguo reviewed Oct 29, 2024

View reviewed changes

jonastheis added 3 commits November 6, 2024 15:53

introduce ForceL1MessageCount to config to be able to set a custom L1…

2df07a9

… message amount. this is mainly for testing purposes

add Dockerfile for relayer in permissionless batches mode

0f5ebf3

add docker compose file to spin up all necessary services together

f96af8e

jonastheis mentioned this pull request Nov 18, 2024

feat(permissionless batches): block production without signature scroll-tech/go-ethereum#1087

Draft

13 tasks

georgehao reviewed Nov 19, 2024

View reviewed changes

jonastheis added 6 commits November 19, 2024 17:55

move docker file to build/dockerfiles

16a471d

add coordinator-cron and proving-service-bundle

d25094b

add bundle creation

603feed

add permissionless-batches/conf/ to dockerignore files

5ddd6d6

refactor cmd/permissionless_batches/app

5ff6fd0

implement RecoveryNeeded functionality to allow re-running without ov…

0108873

…erriding and instead switching to batch submission mode

colinlyguo reviewed Nov 20, 2024

View reviewed changes

rollup/internal/orm/batch.go Outdated Show resolved Hide resolved

refactor cmd/rollup_relayer/app and split into FullRecovery struct

a6f914a

clean up

0123502

jonastheis changed the title ~~Permissionless batches recovery~~ feat(permissionless batches): batch production toolkit and operator recovery Nov 21, 2024

jonastheis added 2 commits November 21, 2024 16:54

introduce profiles to docker-compose.yml

596d9fe

initial instructions in README.md

d85bdf5

colinlyguo reviewed Nov 21, 2024

View reviewed changes

rollup/internal/controller/permissionless_batches/minimal_recovery.go Show resolved Hide resolved

colinlyguo reviewed Nov 21, 2024

View reviewed changes

rollup/internal/controller/permissionless_batches/minimal_recovery.go Show resolved Hide resolved

colinlyguo reviewed Nov 21, 2024

View reviewed changes

rollup/internal/controller/permissionless_batches/minimal_recovery.go Outdated Show resolved Hide resolved

address review comments

a9eac08

georgehao reviewed Nov 25, 2024

View reviewed changes

rollup/internal/controller/permissionless_batches/minimal_recovery.go Show resolved Hide resolved

georgehao reviewed Nov 25, 2024

View reviewed changes

jonastheis added 2 commits November 25, 2024 18:20

add dummy configuration and documentation for permissionless batch pr…

606162e

…oduction toolkit

ignore /conf folder from git

30c0201

georgehao reviewed Nov 25, 2024

View reviewed changes

jonastheis added 2 commits November 26, 2024 08:53

add documentation for operator recovery

ec9d862

address review comments

6ef4775

	func (o Batch) InsertBatchRaw(ctx context.Context, batchIndex big.Int, batchHash common.Hash, codecVersion encoding.CodecVersion, chunk Chunk) (Batch, error) {
	func (o Batch) InsertPermissionlessBatch(ctx context.Context, batchIndex big.Int, batchHash common.Hash, codecVersion encoding.CodecVersion, chunk Chunk) (Batch, error) {

feat(permissionless batches): batch production toolkit and operator recovery #1555

Are you sure you want to change the base?

feat(permissionless batches): batch production toolkit and operator recovery #1555

Conversation

jonastheis commented Oct 24, 2024 • edited Loading

Purpose or design rationale of this PR

PR title

Deployment tag versioning

Breaking change label

coderabbitai bot commented Oct 24, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

georgehao commented Oct 28, 2024

jonastheis commented Oct 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

georgehao Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

jonastheis Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

georgehao Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonastheis commented Oct 24, 2024 •

edited

Loading

coderabbitai bot commented Oct 24, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

georgehao Nov 25, 2024 •

edited

Loading

jonastheis Nov 26, 2024 •

edited

Loading

georgehao Nov 25, 2024 •

edited

Loading