Add deploy arbitrum chain with genesis json docs #2712
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
anegg0
requested changes
Sep 26, 2025
There was a problem hiding this comment.
I added front matter and made some editorial changes, primarily regarding sentence casing.
Should this be added to the sidebar and marked as open, @Jason-W123?
| @@ -0,0 +1,214 @@ | |||
| # Deploying Arbitrum Chains Using Genesis Configuration | |||
There was a problem hiding this comment.
Suggested change
| # Deploying Arbitrum Chains Using Genesis Configuration | |
| --- | |
| title: 'Deploy your Arbitrum chain with genesis configuration' | |
| sidebar_label: 'Deploy chain with genesis' | |
| description: 'Learn how to deploy your Arbitrum chain using a custom genesis.json configuration file to pre-configure accounts, balances, and smart contracts' | |
| user_story: 'As a chain operator, I want to deploy an Arbitrum chain with pre-configured accounts and contracts in the genesis block' | |
| content_type: 'how-to' | |
| author: 'Jason-W123' | |
| sme: 'Jason-W123' | |
| --- | |
| # Deploying Arbitrum Chains Using Genesis Configuration |
|
|
||
| ## Overview | ||
|
|
||
| This guide demonstrates how to deploy an Arbitrum Orbit chain using a custom genesis.json configuration with the orbit-cli-tool and nitro's genesis generator. This approach allows you to deploy chains with pre-configured accounts, balances, and smart contracts in the genesis block. |
There was a problem hiding this comment.
Suggested change
| This guide demonstrates how to deploy an Arbitrum Orbit chain using a custom genesis.json configuration with the orbit-cli-tool and nitro's genesis generator. This approach allows you to deploy chains with pre-configured accounts, balances, and smart contracts in the genesis block. | |
| This guide shows you how to deploy your Arbitrum chain using a custom `genesis.json` configuration with the orbit-cli-tool and Nitro's genesis generator. This approach lets you deploy chains with pre-configured accounts, balances, and smart contracts in the genesis block. | |
Comment on lines
+15
to
+19
| - Node.js and npm/yarn installed | ||
| - orbit-cli-tool repository cloned and configured | ||
| - nitro repository with genesis-generator compiled (If compiling locally, follow the [official nitro build documentation](/run-arbitrum-node/nitro/build-nitro-locally)) | ||
| - Docker installed (If not compiling locally) | ||
| - Custom genesis configuration requirements (accounts, balances, contracts) |
There was a problem hiding this comment.
Suggested change
| - Node.js and npm/yarn installed | |
| - orbit-cli-tool repository cloned and configured | |
| - nitro repository with genesis-generator compiled (If compiling locally, follow the [official nitro build documentation](/run-arbitrum-node/nitro/build-nitro-locally)) | |
| - Docker installed (If not compiling locally) | |
| - Custom genesis configuration requirements (accounts, balances, contracts) | |
| Before you begin, you'll need: | |
| - Node.js and npm/yarn installed | |
| - orbit-cli-tool repository cloned and configured | |
| - Nitro repository with genesis-generator compiled (if compiling locally, follow the [official Nitro build documentation](/run-arbitrum-node/nitro/build-nitro-locally)) | |
| - Docker installed (if not compiling locally) | |
| - Custom genesis configuration requirements (accounts, balances, contracts) |
Comment on lines
+21
to
+23
| ## Step 1: Generate Genesis Configuration | ||
|
|
||
| This step creates a custom genesis.json file that includes your specific chain parameters, account allocations, and any pre-deployed contracts needed for your Orbit chain. |
There was a problem hiding this comment.
Suggested change
| ## Step 1: Generate Genesis Configuration | |
| This step creates a custom genesis.json file that includes your specific chain parameters, account allocations, and any pre-deployed contracts needed for your Orbit chain. | |
| ## Step 1: Generate genesis configuration | |
| This step creates a custom `genesis.json` file that includes your specific chain parameters, account allocations, and any pre-deployed contracts needed for your Arbitrum chain. |
Comment on lines
+25
to
+31
| ### Setup | ||
|
|
||
| Navigate to your orbit-cli-tool directory and install dependencies: | ||
|
|
||
| ```bash | ||
| cd orbit-cli-tool | ||
| npm install |
There was a problem hiding this comment.
Suggested change
| ### Setup | |
| Navigate to your orbit-cli-tool directory and install dependencies: | |
| ```bash | |
| cd orbit-cli-tool | |
| npm install | |
| ### Set up your environment | |
| Navigate to your orbit-cli-tool directory and install dependencies: | |
| ```shell | |
|
|
||
| **The L1 gas price used in `--initial-l1-base-fee` MUST be exactly identical to the actual gas price when deploying the rollup contracts.** Any difference will cause deployment failure. | ||
|
|
||
| **Important Steps**: |
There was a problem hiding this comment.
Suggested change
| **Important Steps**: | |
| **Important steps**: |
Comment on lines
+149
to
+153
| ### Deploy Rollup | ||
|
|
||
| Execute the rollup creation command with your genesis block hash: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Suggested change
| ### Deploy Rollup | |
| Execute the rollup creation command with your genesis block hash: | |
| ```bash | |
| ## Step 3: Deploy rollup contracts | |
| The final step involves deploying the actual rollup contracts to Arbitrum Sepolia using the calculated genesis block hash. | |
| ### Deploy rollup | |
| Execute the rollup creation command with your genesis block hash: | |
| ```shell |
|
|
||
| **⚠️ Critical Requirement**: The gas price used for the rollup deployment transaction MUST be exactly identical to the `--initial-l1-base-fee` value used when generating the genesis block hash. Any difference will cause deployment failure. If gas prices have changed at all, regenerate the genesis block hash first. | ||
|
|
||
| ### Deployment Process |
There was a problem hiding this comment.
Suggested change
| ### Deployment Process | |
| ### Deployment process |
| - Extract chain configuration and chain ID | ||
| - Deploy rollup contracts to Arbitrum Sepolia testnet | ||
|
|
||
| ## Configuration Reference |
There was a problem hiding this comment.
Suggested change
| ## Configuration Reference | |
| ## Configuration reference |
|
|
||
| ## Configuration Reference | ||
|
|
||
| ### Genesis Configuration Structure |
There was a problem hiding this comment.
Suggested change
| ### Genesis Configuration Structure | |
| ### Genesis configuration structure |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.