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

Improve prepare-node-config for Orbit Rollup Deployment #228

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dindonero
Copy link

Improve prepare-node-config for Orbit Rollup Deployment

Overview

This PR improves the prepare-node-config functionality to ensure smoother deployments of an Orbit rollup using the SDK examples. These updates enhance configuration clarity, usability, and compatibility across the Orbit ecosystem.

Key Improvements

  1. Configurable Chain Name in .env

    • Enables customization of the chain name at the environment configuration level for better flexibility in deployments.
  2. Generation of orbitSetupScriptConfig.json

    • This file is a critical component for integrating Orbit chains across various tools:
      • Used by the setup.js script during deployment.
      • Required in the bridge UI for adding custom Orbit chains.
      • Simplifies arbitrum-sdk integration via example configurations. Registering a new custom network from the orbitSetupScriptConfig.json example can be found in the bridge UI repo.
  3. RPC Endpoint Handling

    • PARENT_CHAIN_RPC is now stored in nodeConfig.json and orbitSetupScriptConfig.json.
    • This ensures that user-provided RPC endpoints are prioritized over defaults, avoiding timeouts or connection issues.
  4. Consistent Naming

    • Renamed node-config.json to nodeConfig.json for uniformity with other file naming conventions.

Reasoning

These changes address challenges in the deployment process, such as:

  • Timeout issues with default RPC endpoints.
  • Improved usability and cross-compatibility by aligning configurations across tools.
  • Enhanced developer experience with more predictable and standardized file naming.

Relevant Links

Summary of Changes

  • Added configurable chain name in .env
  • Generates orbitSetupScriptConfig.json for deployment use
  • Fixed: PARENT_CHAIN_RPC now stored in nodeConfig.json and orbitSetupScriptConfig.json
  • Renamed node-config.json to nodeConfig.json for consistency

Improve prepare-node-config for Orbit rollup deployment through the sdk

- Added configurable chain name in `.env`
- Generates `orbitSetupScriptConfig.json` for deployment use
- Fixed: `PARENT_CHAIN_RPC` now stored in `nodeConfig.json` and `orbitSetupScriptConfig.json`
- Renamed `node-config.json` to `nodeConfig.json` for consistency
chainOwner: chainConfig.arbitrum.InitialChainOwner,
chainId: chainConfig.chainId,
chainName,
minL2BaseFee: 100000000, // todo: check default?
Copy link
Author

Choose a reason for hiding this comment

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

Please review lines 97 and 100. Verify if the outputs for minL2BaseFee and utils are correct.

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