feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 #33

jonastheis · 2024-12-27T04:15:14Z

Purpose or design rationale of this PR

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

Breaking change label

Does this PR have the breaking-change label?

No, this PR is not a breaking change
Yes

coderabbitai · 2024-12-27T04:15:21Z

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

colinlyguo · 2024-12-30T15:15:29Z

encoding/codecv6.go

+
+// TODO: add DecodeBlob to interface to decode the blob and transactions or reuse DecodeTxsFromBlob but only have a single "chunk" for all transactions in the batch?
+
+// TODO: which of the Estimate* functions are needed?


It's used to give proof witnesses (from coordinator to provers in distributing tasks).
namely here: https://github.com/scroll-tech/scroll/blob/v4.4.83/coordinator/internal/logic/provertask/batch_prover_task.go#L255

previously it's used here: https://github.com/scroll-tech/scroll/blob/v4.4.83/common/types/message/message.go#L56.
now it is not used and may be removed.

Thegaram · 2025-01-15T16:36:37Z

encoding/codecv6.go

+
+// MaxNumChunksPerBatch returns the maximum number of chunks per batch.
+func (d *DACodecV6) MaxNumChunksPerBatch() int {
+	return 1


Why 1? Just a placeholder?

Since Chunks are not exposed to DA, there should be no details about chunks here. However, to keep compatibility and the way we build chunks in the relayer we could still keep using it

In that case, rollup-relayer should not use MaxNumChunksPerBatch, right? Otherwise we'll keep producing batches with a single chunk.

encoding/codecv6.go

encoding/codecv6_types.go

Thegaram · 2025-01-24T12:20:04Z

encoding/codecv7_types.go

+	"github.com/scroll-tech/go-ethereum/core/types"
+	"github.com/scroll-tech/go-ethereum/crypto"
+	"github.com/scroll-tech/go-ethereum/crypto/kzg4844"
+)


Suggested change

)

)

// Below is the encoding for `BatchHeader` V7, total 73 bytes.

// * Field Bytes Type Index Comments

// * version 1 uint8 0 The batch version

// * batchIndex 8 uint64 1 The index of the batch

// * blobVersionedHash 32 bytes32 9 The versioned hash of the blob with this batch’s data

// * parentBatchHash 32 bytes32 41 The parent batch hash

I suggest you add this at the top for an easy reference.

Thegaram · 2025-01-24T12:31:55Z

encoding/codecv7_types.go

+)
+
+const (
+	blobPayloadV7EncodedLength               = 8 + 2*common.HashLength + 8 + 2


Suggested change

blobPayloadV7EncodedLength = 8 + 2*common.HashLength + 8 + 2

blobPayloadV7MinimumLength = 8 + 2*common.HashLength + 8 + 2

Thegaram · 2025-01-24T12:33:24Z

encoding/codecv7_types.go

+
+const (
+	daBatchV7EncodedLength           = 73
+	daBatchV7OffsetBlobVersionedHash = 9


Suggested change

daBatchV7OffsetBlobVersionedHash = 9

daBatchV7BlobVersionedHashOffset = 9

Suggest making this consistent with the others (e.g. blobEnvelopeV7VersionOffset)

Thegaram · 2025-01-24T12:33:47Z

encoding/codecv7_types.go

+
+const (
+	blobPayloadV7EncodedLength               = 8 + 2*common.HashLength + 8 + 2
+	blobPayloadV7OffsetInitialL1MessageIndex = 0


Suggested change

blobPayloadV7OffsetInitialL1MessageIndex = 0

blobPayloadV7InitialL1MessageIndexOffset = 0

Thegaram · 2025-01-24T12:34:34Z

encoding/codecv7_types.go

+const (
+	blobPayloadV7EncodedLength               = 8 + 2*common.HashLength + 8 + 2
+	blobPayloadV7OffsetInitialL1MessageIndex = 0
+	blobPayloadV7OffsetInitialL1MessageQueue = blobPayloadV7OffsetInitialL1MessageIndex + 8


Above you use absolute indices, and here relative indices. Again, I think consistency is desirable, but not a big deal, can also leave it as it is

Thegaram · 2025-01-24T12:55:18Z

encoding/codecv7_types.go

+}
+
+func encodeSize3Bytes(data uint32) []byte {
+	return []byte{byte(data), byte(data >> 8), byte(data >> 16)}


Isn't this little-endian? We use big-endian everywhere else

Thegaram · 2025-01-24T12:56:42Z

encoding/da.go

@@ -131,6 +137,19 @@ func (b *Block) NumL1Messages(totalL1MessagePoppedBefore uint64) uint64 {
 	return *lastQueueIndex - totalL1MessagePoppedBefore + 1
 }

+// NumL1MessagesNoSkipping returns the number of L1 messages in this block.
+// This method assumes that L1 messages can't be skipped.
+func (b *Block) NumL1MessagesNoSkipping() uint16 {


Could add a QueueIndex continuity check here, just to be defensive

Thegaram · 2025-01-24T12:57:42Z

encoding/codecv7.go

+		return nil, errors.New("block number is not uint64")
+	}
+
+	// note: numL1Messages includes skipped messages


there are no skipped messages

Thegaram · 2025-01-24T12:58:04Z

encoding/codecv7.go

+		return nil, errors.New("number of L1 messages exceeds max uint16")
+	}
+
+	// note: numTransactions includes skipped messages


Thegaram · 2025-01-24T12:59:00Z

encoding/codecv7.go

+
+// NewDAChunk creates a new DAChunk from the given Chunk and the total number of L1 messages popped before.
+// Note: For DACodecV7, this function is not implemented since there is no notion of DAChunk in this version. Blobs
+// contain the entire batch data, and it is up to a prover to decide the chunk sizes.


it is up to a prover to decide the chunk sizes.

This is not accurate, this will still be decided by rollup-relayer.

colinlyguo · 2025-01-25T13:50:38Z

encoding/codecv7.go

+}
+
+// JSONFromBytes converts the bytes to a DABatch and then marshals it to JSON.
+func (d *DACodecV7) JSONFromBytes(data []byte) ([]byte, error) {


Is this unused anymore? previously in coordinator, while currently only utilizing NewDABatchFromBytes, worth double-checking it.

colinlyguo · 2025-01-25T13:59:13Z

encoding/codecv7.go

+	return d.checkCompressedDataCompatibility(b)
+}
+
+// TODO: which of the Estimate* functions are needed?


based on a previous discussion, gas limit (irrelevant to the number of L1 messages) and calldata length (constant length) will not exceed in v7. while (uncompressed) batch size and blob size are still needed.

batch size has a limit of 5 * blob size, could ask @noel2004 or @roynalnaruto to check if v7 still has this limit.

colinlyguo · 2025-01-25T14:03:56Z

encoding/codecv7_types.go

+	return b.blobBytes
+}
+
+// MarshalJSON implements the custom JSON serialization for daBatchV3.


Suggested change

// MarshalJSON implements the custom JSON serialization for daBatchV3.

// MarshalJSON implements the custom JSON serialization for daBatchV7.

add initial CodecV6 and daBatchV6

286f209

colinlyguo reviewed Dec 30, 2024

View reviewed changes

jonastheis mentioned this pull request Jan 2, 2025

feat: CodecV7 scroll-tech/scroll#1583

Draft

13 tasks

Thegaram reviewed Jan 15, 2025

View reviewed changes

jonastheis added 2 commits January 21, 2025 09:45

implement blob encoding and decoding according to new blob layout

cc9561b

rename to CodecV7

8c2a5cc

jonastheis changed the title ~~feat(CodecV6): add CodecV6 to support upgrade 6~~ feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 Jan 21, 2025

jonastheis added 2 commits January 22, 2025 08:34

add NewDABatchFromParams

9117170

add DecodeBlob to Codec

4ef7bfc

Thegaram reviewed Jan 24, 2025

View reviewed changes

colinlyguo approved these changes Jan 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 #33

feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 #33

jonastheis commented Dec 27, 2024

coderabbitai bot commented Dec 27, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

colinlyguo Dec 30, 2024 •

edited

Loading

colinlyguo Dec 31, 2024

Thegaram Jan 15, 2025

jonastheis Jan 17, 2025 •

edited

Loading

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

Thegaram Jan 24, 2025

colinlyguo Jan 25, 2025

colinlyguo Jan 25, 2025

colinlyguo Jan 25, 2025


		// TODO: add DecodeBlob to interface to decode the blob and transactions or reuse DecodeTxsFromBlob but only have a single "chunk" for all transactions in the batch?

		// TODO: which of the Estimate* functions are needed?

-)
+)
+// Below is the encoding for `BatchHeader` V7, total 73 bytes.
+//   * Field                   Bytes       Type        Index   Comments
+//   * version                 1           uint8       0       The batch version
+//   * batchIndex              8           uint64      1       The index of the batch
+//   * blobVersionedHash       32          bytes32     9       The versioned hash of the blob with this batch’s data
+//   * parentBatchHash         32          bytes32     41      The parent batch hash

	blobPayloadV7EncodedLength = 8 + 2*common.HashLength + 8 + 2
	blobPayloadV7MinimumLength = 8 + 2*common.HashLength + 8 + 2

	daBatchV7OffsetBlobVersionedHash = 9
	daBatchV7BlobVersionedHashOffset = 9

	blobPayloadV7OffsetInitialL1MessageIndex = 0
	blobPayloadV7InitialL1MessageIndexOffset = 0

	// MarshalJSON implements the custom JSON serialization for daBatchV3.
	// MarshalJSON implements the custom JSON serialization for daBatchV7.

feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 #33

Are you sure you want to change the base?

feat(CodecV7): add CodecV7 to support upgrade 5.2 Euclid phase2 #33

Conversation

jonastheis commented Dec 27, 2024

Purpose or design rationale of this PR

PR title

Breaking change label

coderabbitai bot commented Dec 27, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

colinlyguo Dec 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonastheis Jan 17, 2025 • 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

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

CodeRabbit Configuration File (`.coderabbit.yaml`)

colinlyguo Dec 30, 2024 •

edited

Loading

jonastheis Jan 17, 2025 •

edited

Loading