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

op-batcher: fix "handle receipt" log message to properly log id #9918

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

sebastianst
Copy link
Member

@sebastianst sebastianst commented Mar 19, 2024

Description

Fixes "handle receipt" log message to properly log id. It used to log the full transaction frames.

While fixing this, decided to attach only the txID to the transaction candidate, instead of the full txData. We only need the attached id as an identifier, not the full data. This made me remove the data_len field from one log, but that's fine because we already log the channel and tx length in multiple places before. We don't need to log it when confirming a receipt.

Note that the bug was in line 266 and is now implicitly solved by changing the type of the ID field of the receipt.

Tests

n/a

it used to log the full transaction frames
@sebastianst sebastianst requested a review from a team as a code owner March 19, 2024 20:01
Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

Walkthrough

The modification primarily revolves around the alteration of data types in channel declarations and function parameters, transitioning from txData to txID within the context of the BatchSubmitter structure and its related functions. This change directly impacts the manner in which transaction information is managed and processed, streamlining the workflow by focusing on transaction identifiers rather than the full transaction data.

Changes

File(s) Change Summary
op-batcher/.../driver.go Updated types in channel declarations and function parameters from txData to txID in the BatchSubmitter struct and related methods, impacting transaction data handling and processing.

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

semgrep-app bot commented Mar 19, 2024

Semgrep found 1 todos_require_linear finding:

  • packages/sdk/src/cross-chain-messenger.ts

Please create a GitHub ticket for this TODO.

Ignore this finding from todos_require_linear.

Copy link
Contributor

@axelKingsley axelKingsley left a comment

Choose a reason for hiding this comment

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

Love how this reduces complexity in the batcher. I actually didn't realize we never needed more than just the ID!

@sebastianst sebastianst enabled auto-merge March 19, 2024 21:30
@sebastianst sebastianst added this pull request to the merge queue Mar 19, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 19, 2024
@tynes tynes added this pull request to the merge queue Mar 19, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 19, 2024
@sebastianst sebastianst added this pull request to the merge queue Mar 20, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Mar 20, 2024
@sebastianst sebastianst added this pull request to the merge queue Mar 20, 2024
Merged via the queue into develop with commit 99a5338 Mar 20, 2024
70 checks passed
@sebastianst sebastianst deleted the seb/fix-batcher-log-handle-rec branch March 20, 2024 11:45
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.

2 participants