Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Description

This PR implements ticket NOD-391 to rename misleading zkSync configuration variables that actually point to GenLayer chain endpoints, not zkSync endpoints. The changes improve clarity and prevent confusion by using more accurate naming throughout the codebase.

Link to Devin run: https://app.devin.ai/sessions/309d3e633b1447a88164d1745bf5dbfa
Requested by: @AgustinRamiroDiaz

⚠️ Breaking Change Notice

This is a breaking change that requires users to update their configuration files:

Before:

rollup:
  zksyncurl: "https://example.com/rpc"
  zksyncwebsocketurl: "wss://example.com/ws"

After:

rollup:
  genlayerchainrpcurl: "https://example.com/rpc" 
  genlayerchainwebsocketurl: "wss://example.com/ws"

Changes Made

Go Code Updates

  • Struct fields: Renamed ZkSyncURLGenlayerChainRpcURL and ZkSyncWebSocketURLGenlayerChainWebSocketURL in RollupConfig struct
  • YAML tags: Updated from yaml:"zksyncurl"yaml:"genlayerchainrpcurl" and yaml:"zksyncwebsocketurl"yaml:"genlayerchainwebsocketurl"
  • Field references: Updated all code that accesses these fields in connect.go and other files
  • Default values: Updated default configuration values in internal.go

Configuration Files

  • Updated configs/node/config.yaml.example with new variable names
  • Updated all test configuration files
  • Updated comments to reflect "GenLayer Chain" instead of "ZKSync"

CI/CD & Deployment

  • Updated .github/workflows/release-package.yml to use new variable names
  • Updated deployment scripts that reference these configurations
  • Updated environment variable name from GENLAYERNODE_ROLLUP_ZKSYNC_URLGENLAYERNODE_ROLLUP_GENLAYERCHAIN_RPC_URL

Documentation

  • Updated README.md configuration table
  • Updated deployment documentation

Files changed: 24 files with 87 insertions and 87 deletions

Human Review Checklist

Critical items to verify:

  • Compilation: Verify Go code compiles without errors (go build)
  • Field name casing: Confirm exact casing matches requirements (GenlayerChainRpcURL not GenlayerChainRPCURL)
  • Complete coverage: Search for any remaining references to old variable names:
    grep -r "ZkSyncURL\|ZkSyncWebSocketURL\|zksyncurl\|zksyncwebsocketurl" --exclude-dir=.git .
  • Configuration validation: Test that sample configurations actually work
  • Environment variables: Verify all environment variable references are updated consistently
  • Deployment scripts: Check that deployment scripts in taskfiles/ handle the new variable names correctly

Testing suggestions:

  • Test node startup with updated configuration
  • Verify zkSync connection functionality still works with new field names
  • Test configuration parsing and validation

Migration considerations:

  • Consider adding deprecation warnings for old variable names (if backward compatibility is desired)
  • Update any deployment documentation or runbooks
  • Notify users about the breaking change in release notes

Risk Assessment

⚠️ High Risk Areas:

  1. Breaking change impact: All users must update config files
  2. Comprehensive rename: 24 files changed - potential for missed references
  3. Critical infrastructure: Changes to CI workflows and deployment scripts
  4. Unable to test locally: Changes were not compiled/tested in development environment

The extensive scope of this rename requires careful verification to ensure no references were missed and that all systems continue to function correctly.

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@netlify
Copy link

netlify bot commented Aug 19, 2025

Deploy Preview for genlayer-docs ready!

Name Link
🔨 Latest commit 0c22145
🔍 Latest deploy log https://app.netlify.com/projects/genlayer-docs/deploys/68b03c14be0166000896d5f3
😎 Deploy Preview https://deploy-preview-280--genlayer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbit review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@AgustinRamiroDiaz AgustinRamiroDiaz left a comment

Choose a reason for hiding this comment

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

code looks good, we cannot merge until node v0.4 is released

Copy link
Contributor

@AgustinRamiroDiaz AgustinRamiroDiaz left a comment

Choose a reason for hiding this comment

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

please rebase this branch

…ables

Only update the sync workflow script to handle the new variable names.
Documentation files will be auto-updated when the release is created.

Co-Authored-By: Agustín Díaz <agustin.ramiro.diaz@gmail.com>
@devin-ai-integration devin-ai-integration bot force-pushed the devin/NOD-391-workflow-only-1755624272 branch from bbea6d6 to 0c22145 Compare August 28, 2025 11:22
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.

1 participant