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

docs: add postmortem of tx receipts validation skip fork #289

Merged
merged 4 commits into from
Apr 8, 2024

Conversation

0xHansLee
Copy link
Contributor

@0xHansLee 0xHansLee commented Apr 5, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the incident summary header text casing for better readability.
    • Added detailed documentation for the chain halt incident on 2024-04-01, covering causes, impact, recovery steps, and future improvement plans.

@0xHansLee 0xHansLee requested a review from a team April 5, 2024 04:54
@0xHansLee 0xHansLee self-assigned this Apr 5, 2024
Copy link
Contributor

coderabbitai bot commented Apr 5, 2024

Walkthrough

The recent updates involve two primary changes. Firstly, a minor modification to text casing in the incident summary header within the postmortem documentation. Secondly, a detailed incident report addressing a chain halt caused by a validation issue, leading to improvements in validation processes and monitoring systems to prevent similar incidents.

Changes

File Path Change Summary
.../2024-03-12-zktrie-fork.md
.../2024-03-12-zktrie-incident.md
Adjusted incident summary header text casing and corrected details of a block-related incident in KromaZKTrie.
.../2024-04-01-tx-receipts-validation-skip-fork.md
.../2024-04-01-tx-receipts-validation-skip-incident.md
Documented a chain halt incident due to transaction validation skip, with recovery involving process enhancements for validation and monitoring systems to improve incident response.

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 7

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 05d5e24 and e49ed98.
Files selected for processing (2)
  • postmortems/2024-03-12-zktrie-fork.md (1 hunks)
  • postmortems/2024-04-01-tx-receipts-validation-skip-fork.md (1 hunks)

postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-04-01-tx-receipts-validation-skip-fork.md Outdated Show resolved Hide resolved
postmortems/2024-03-12-zktrie-fork.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 9

Actionable comments outside the diff hunks (2)
postmortems/2024-03-12-zktrie-incident.md (2)

Line range hint 19-22: Ensure the description of the upgrade process is clear and concise.

- On Thu, Mar 07, 2024, at 05:00:00 UTC, an upgrade to kroma [`v1.3.2`](https://github.com/kroma-network/kroma/releases/tag/v1.3.2) and kroma-geth `v0.4.4` was conducted to enhance ZKTrie, which is to store the state of accounts and storage.
+ On March 7, 2024, at 05:00:00 UTC, we upgraded to kroma [`v1.3.2`](https://github.com/kroma-network/kroma/releases/tag/v1.3.2) and kroma-geth `v0.4.4` to enhance ZKTrie, our state storage solution.

Line range hint 82-85: Clarify the testing and deployment process for the bug fix.

- The bug will be fixed in this [PR](https://github.com/kroma-network/go-ethereum/pull/81), and once merged, it will undergo sufficient test on the internal devnet and Kroma sepolia.
+ The bug fix, available in this [PR](https://github.com/kroma-network/go-ethereum/pull/81), will undergo extensive testing on the internal devnet and Kroma Sepolia upon merging.
Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e49ed98 and 38827c5.
Files selected for processing (2)
  • postmortems/2024-03-12-zktrie-incident.md (3 hunks)
  • postmortems/2024-04-01-tx-receipts-validation-skip-incident.md (1 hunks)

Copy link
Contributor

@kangsorang kangsorang left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@seolaoh seolaoh left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 38827c5 and 47009b1.
Files selected for processing (1)
  • postmortems/2024-04-01-tx-receipts-validation-skip-incident.md (1 hunks)
Additional comments not posted (6)
postmortems/2024-04-01-tx-receipts-validation-skip-incident.md (6)

1-1: The title accurately reflects the incident date and content.


3-10: The incident summary is clear and provides a concise overview of the issue.


12-17: The background section effectively sets the context for the incident.


32-35: The recovery process is clearly outlined.


37-46: The timeline section is detailed and informative, providing a clear sequence of events.


52-62: The future works section clearly outlines steps to prevent similar incidents.

Comment on lines +19 to +28
# Causes

Block head of our L1 RPC began to fall behind the canonical chain, triggering a switch to the fallback L1 RPC once it
deviated beyond a certain threshold. During the switch, sequencer attempted to retrieve transaction receipts from the L1
RPC node that fell behind it had not yet synced, resulting in empty transaction receipt responses.

Actually, the block in question did contain [deposited transaction](https://kromascan.com/tx/0xf76e4f34645bc3e172909fb03311cd1770f9c574ce46bd1da3644f9cea82c0e3)
on L1, yet the sequencer proceeded to generate the block without processing this transaction, having received empty
transaction receipts from the trusted L1 RPC. As a consequence, starting from block 9029744, a different block was
generated, leading to a generation of wrong block.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding an article for grammatical correctness.

- Block head of our L1 RPC began to fall behind
+ The block head of our L1 RPC began to fall behind

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
# Causes
Block head of our L1 RPC began to fall behind the canonical chain, triggering a switch to the fallback L1 RPC once it
deviated beyond a certain threshold. During the switch, sequencer attempted to retrieve transaction receipts from the L1
RPC node that fell behind it had not yet synced, resulting in empty transaction receipt responses.
Actually, the block in question did contain [deposited transaction](https://kromascan.com/tx/0xf76e4f34645bc3e172909fb03311cd1770f9c574ce46bd1da3644f9cea82c0e3)
on L1, yet the sequencer proceeded to generate the block without processing this transaction, having received empty
transaction receipts from the trusted L1 RPC. As a consequence, starting from block 9029744, a different block was
generated, leading to a generation of wrong block.
# Causes
The block head of our L1 RPC began to fall behind the canonical chain, triggering a switch to the fallback L1 RPC once it
deviated beyond a certain threshold. During the switch, sequencer attempted to retrieve transaction receipts from the L1
RPC node that fell behind it had not yet synced, resulting in empty transaction receipt responses.
Actually, the block in question did contain [deposited transaction](https://kromascan.com/tx/0xf76e4f34645bc3e172909fb03311cd1770f9c574ce46bd1da3644f9cea82c0e3)
on L1, yet the sequencer proceeded to generate the block without processing this transaction, having received empty
transaction receipts from the trusted L1 RPC. As a consequence, starting from block 9029744, a different block was
generated, leading to a generation of wrong block.

@0xHansLee 0xHansLee merged commit 071c797 into dev Apr 8, 2024
2 checks passed
@0xHansLee 0xHansLee deleted the docs/add-tx-receipts-validation-skip-fork branch April 8, 2024 10:41
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.

5 participants