Skip to content

debug system config #1179

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

Closed
wants to merge 2 commits into from
Closed

debug system config #1179

wants to merge 2 commits into from

Conversation

yiweichi
Copy link
Member

@yiweichi yiweichi commented Apr 30, 2025

1. Purpose or design rationale of this PR

...

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

Summary by CodeRabbit

  • Bug Fixes

    • Updated address retrieval logic to use a fixed Ethereum address instead of fetching from the L1 system contract.
  • Chores

    • Disabled the broadcasting of newly mined blocks to peers.

Copy link

coderabbitai bot commented Apr 30, 2025

Walkthrough

This update introduces two main changes. First, in the consensus system contract logic, the method responsible for fetching an address from L1 storage now disregards the actual storage value and assigns a fixed, hardcoded Ethereum address instead. Second, in the Ethereum handler, the broadcasting of newly mined blocks is disabled by commenting out the relevant loop, stopping the propagation and announcement of mined blocks to peers via this mechanism.

Changes

File(s) Change Summary
consensus/system_contract/system_contract.go Modified fetchAddressFromL1 to ignore storage value and use a hardcoded Ethereum address.
eth/handler.go Commented out the loop in minedBroadcastLoop, disabling mined block broadcasting to peers.

Possibly related PRs

Suggested reviewers

  • omerfirmak
  • colinlyguo

Poem

A bunny hopped through lines of code,
Where hardcoded paths now softly strode.
No blocks announced, the network sleeps,
While storage secrets it no longer keeps.
With paws on keys and whiskers twitching,
The code is calm, no longer switching.
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link

@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: 2

🧹 Nitpick comments (1)
consensus/system_contract/system_contract.go (1)

96-98: Remove commented-out code alternatives

These commented-out address alternatives are adding noise to the codebase without providing value.

-	// bAddress := common.HexToAddress("0x756ea06bdee36de11f22dcca45a31d8a178ef3c6")
-	// bAddress := common.HexToAddress("0xD9E635beA2Ed2813eD1c550429FB965dEE58109B")
-	// bAddress := common.Address{}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4109fd and 85ef933.

📒 Files selected for processing (2)
  • consensus/system_contract/system_contract.go (1 hunks)
  • eth/handler.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
consensus/system_contract/system_contract.go (1)
common/types.go (1)
  • HexToAddress (218-218)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Analyze (go)

Comment on lines +92 to +99
_, err := s.client.StorageAt(s.ctx, s.config.SystemContractAddress, s.config.SystemContractSlot, nil)
if err != nil {
return fmt.Errorf("failed to get signer address from L1 System Contract: %w", err)
}
bAddress := common.BytesToAddress(address)

// bAddress := common.HexToAddress("0x756ea06bdee36de11f22dcca45a31d8a178ef3c6")
// bAddress := common.HexToAddress("0xD9E635beA2Ed2813eD1c550429FB965dEE58109B")
// bAddress := common.Address{}
bAddress := common.HexToAddress("0xfe3Ba6Fac4Fdd5C975A61089AF2a3508a86D6a8B")
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Hardcoded address bypasses dynamic L1 storage resolution

This change fundamentally alters the system's behavior - the function still retrieves L1 storage data but then ignores it, instead assigning a hardcoded Ethereum address. This approach bypasses the dynamic address resolution mechanism that appears to be the original design intent.

Consider either:

  1. Properly using the retrieved storage value:
-	_, err := s.client.StorageAt(s.ctx, s.config.SystemContractAddress, s.config.SystemContractSlot, nil)
+	storage, err := s.client.StorageAt(s.ctx, s.config.SystemContractAddress, s.config.SystemContractSlot, nil)
 	if err != nil {
 		return fmt.Errorf("failed to get signer address from L1 System Contract: %w", err)
 	}
-	// bAddress := common.HexToAddress("0x756ea06bdee36de11f22dcca45a31d8a178ef3c6")
-	// bAddress := common.HexToAddress("0xD9E635beA2Ed2813eD1c550429FB965dEE58109B")
-	// bAddress := common.Address{}
-	bAddress := common.HexToAddress("0xfe3Ba6Fac4Fdd5C975A61089AF2a3508a86D6a8B")
+	bAddress := common.BytesToAddress(storage)
  1. If this change is intentional, modify the function to skip making the unnecessary L1 call entirely.
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
_, err := s.client.StorageAt(s.ctx, s.config.SystemContractAddress, s.config.SystemContractSlot, nil)
if err != nil {
return fmt.Errorf("failed to get signer address from L1 System Contract: %w", err)
}
bAddress := common.BytesToAddress(address)
// bAddress := common.HexToAddress("0x756ea06bdee36de11f22dcca45a31d8a178ef3c6")
// bAddress := common.HexToAddress("0xD9E635beA2Ed2813eD1c550429FB965dEE58109B")
// bAddress := common.Address{}
bAddress := common.HexToAddress("0xfe3Ba6Fac4Fdd5C975A61089AF2a3508a86D6a8B")
storage, err := s.client.StorageAt(s.ctx, s.config.SystemContractAddress, s.config.SystemContractSlot, nil)
if err != nil {
return fmt.Errorf("failed to get signer address from L1 System Contract: %w", err)
}
bAddress := common.BytesToAddress(storage)

Comment on lines +545 to +550
// for obj := range h.minedBlockSub.Chan() {
// if ev, ok := obj.Data.(core.NewMinedBlockEvent); ok {
// h.BroadcastBlock(ev.Block, true) // First propagate block to peers
// h.BroadcastBlock(ev.Block, false) // Only then announce to the rest
// }
// }
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Block broadcasting is completely disabled

This change completely disables the broadcasting of newly mined blocks to network peers. This will prevent nodes running this code from contributing to block propagation in the network, which could significantly impact network health and performance.

If this is temporary debugging code, please add a prominent comment explaining why it's disabled and when it should be re-enabled. If this is intended to be a permanent change, consider:

  1. Either removing the minedBroadcastLoop function entirely.
  2. Or explaining the rationale for disabling block broadcasting with clear comments.
func (h *handler) minedBroadcastLoop() {
	defer h.wg.Done()

+	// Block broadcasting disabled intentionally because:
+	// [EXPLANATION HERE]
	// for obj := range h.minedBlockSub.Chan() {
	// 	if ev, ok := obj.Data.(core.NewMinedBlockEvent); ok {
	// 		h.BroadcastBlock(ev.Block, true)  // First propagate block to peers
	// 		h.BroadcastBlock(ev.Block, false) // Only then announce to the rest
	// 	}
	// }
}
📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// for obj := range h.minedBlockSub.Chan() {
// if ev, ok := obj.Data.(core.NewMinedBlockEvent); ok {
// h.BroadcastBlock(ev.Block, true) // First propagate block to peers
// h.BroadcastBlock(ev.Block, false) // Only then announce to the rest
// }
// }
func (h *handler) minedBroadcastLoop() {
defer h.wg.Done()
// Block broadcasting disabled intentionally because:
// [EXPLANATION HERE]
// for obj := range h.minedBlockSub.Chan() {
// if ev, ok := obj.Data.(core.NewMinedBlockEvent); ok {
// h.BroadcastBlock(ev.Block, true) // First propagate block to peers
// h.BroadcastBlock(ev.Block, false) // Only then announce to the rest
// }
// }
}

@Thegaram Thegaram closed this Apr 30, 2025
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