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.

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

Feat/l1 msg queue #1055

Draft
wants to merge 5 commits into
base: feat/l1-state-tracker
Choose a base branch
from
Draft

Conversation

NazariiDenha
Copy link

1. Purpose or design rationale of this PR

Remove existing L1MessageQueue that stores all msgs in db with new one that

  1. able to get not only L1Msgs from Finalized L1 blocks, but also load most recent L1Msgs and handle reorgs, crucial for reducing bridge latency
  2. stores L1Msgs in memory and prunes old when not needed more

Design explanation and task page

2. 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

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

@0xmountaintop
Copy link

so we are using approach 2?

@NazariiDenha
Copy link
Author

NazariiDenha commented Oct 8, 2024

so we are using approach 2?

I think both are applicable here, becausePruneMessages can be called either by client or some internal logic


for {
select {
case <-ms.ctx.Done():
Copy link
Member

Choose a reason for hiding this comment

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

Why need to specifically handle <-ms.ctx.Done() and the subsequent select handle this again

rollup/l1/msg_storage.go Outdated Show resolved Hide resolved
EndBlockHeader *types.Header
}

type MsgStorage struct {
Copy link
Member

@georgehao georgehao Oct 9, 2024

Choose a reason for hiding this comment

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

add some metrics to MsgStorage eg:

  • whether the task is running
  • which head block is currently processed

}

// PruneMessages deletes all messages that are older or equal to provided index
func (ms *MsgStorage) PruneMessages(lastIndex uint64) {
Copy link
Member

Choose a reason for hiding this comment

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

Who call this function? if no, maybe this it's called by itself periodically

rollup/l1/msg_storage.go Outdated Show resolved Hide resolved
rollup/l1/msg_storage.go Outdated Show resolved Hide resolved
rollup/l1/msg_storage.go Outdated Show resolved Hide resolved
Comment on lines +154 to +174
var indexesToDelete []uint64
for _, msg := range msgs {
contains := false
for _, header := range old {
if header.Hash() == msg.headerHash {
contains = true
break
}
}
if contains {
indexesToDelete = append(indexesToDelete, msg.l1msg.QueueIndex)
}
}
if len(indexesToDelete) > 0 {
ms.msgsMu.Lock()
for _, index := range indexesToDelete {
ms.msgs.Delete(index)
}
ms.msgsMu.Unlock()
}
}

Choose a reason for hiding this comment

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

How about storing an additional map L1 blockNum -> L1 message indexes. then we just need to iterate once and delete. this should be rare but it could be quite costly depending on how big msgs and old are

Copy link

coderabbitai bot commented Nov 4, 2024

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.

ms.newChainNotifications <- newChainNotification{old, new}
return true
} else {
ms.latestFinalized = new[0]

Choose a reason for hiding this comment

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

Instead of having the distinction of online subscriber I think it would be better to let the Tracker always send its updates. It's the job of the receiver to handle these correctly AND not block.

In this case I think what would be sufficient is something like this:

select {
  case ms.newChainNotifications <- newChainNotification{old, new}:
  default:
}

This would try to add the update to the channel but if it is full, the update is dropped. I think this is fine since eventually there will be a new update (with a newer block) which can be queued once there is space in the channel (the long running fetching from before is then probably done).

return false
})
go func() {
fetchTicker := time.NewTicker(defaultFetchInterval)

Choose a reason for hiding this comment

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

We should remove the ticker here and simply wait for the channel to be filled and the context done in the select below

case <-ms.ctx.Done():
return
case <-fetchTicker.C:
if ms.state.EndBlockHeader.Number.Uint64() < ms.latestFinalized.Number.Uint64() {

Choose a reason for hiding this comment

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

here we should just use whatever we read from the channel. if it is far away we might need to have a special way of handling it. if it is close, then we can simply request all of the L1 messages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants