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

Orbit V3 #1815

Draft
wants to merge 30 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
30ad8e6
feat: tmp structure
anegg0 Nov 13, 2024
27722ee
fix: sidebar adjustments
anegg0 Nov 13, 2024
ab04a24
fix: readjust sidebar categories
anegg0 Nov 13, 2024
a8282ba
Merge branch 'master' into Orbit-V3
anegg0 Nov 14, 2024
ceb318c
feat: add stub article "start your journey"
anegg0 Nov 14, 2024
cd0ef1f
Merge branch 'master' into Orbit-V3
anegg0 Nov 15, 2024
8e7d038
feat: add Supported parent chains and configurations
anegg0 Nov 14, 2024
5d57a4f
Add supported parent chain page
mahsamoosavi Nov 15, 2024
8d0b256
feat: readjust sidebar
anegg0 Nov 17, 2024
9753160
fix: remove malformed stub-article
anegg0 Nov 17, 2024
3c02f31
fix: add orbit license stub article
anegg0 Nov 17, 2024
0ae3f6d
feat: add "how to configure your chain"
anegg0 Nov 17, 2024
493e09f
feat: add "additional configuration parameters"
anegg0 Nov 17, 2024
4dfc3a8
feat: rename config parameters
anegg0 Nov 17, 2024
c59a130
fix: format + rename configuration parameters
anegg0 Nov 17, 2024
ebd6d19
feat: rename orbit configuration parameters
anegg0 Nov 17, 2024
3addd0d
feat: add fast block times stub article
anegg0 Nov 17, 2024
30580d6
fix: add smart contract size limit
anegg0 Nov 18, 2024
b5864b3
Merge branch 'master' into Orbit-V3
anegg0 Nov 18, 2024
ed48cd2
feat: add orbit-smart-contract-size-limits
anegg0 Nov 18, 2024
b15dc40
fix: fix link
anegg0 Nov 18, 2024
40d9f0f
Merge branch 'master' into Orbit-V3
anegg0 Nov 18, 2024
3930c0c
feat: add batch post stub article
anegg0 Nov 22, 2024
66a4373
feat: add orbit sequencer config stub
anegg0 Nov 22, 2024
b10c1d5
feat: add stubs to sidebar
anegg0 Nov 22, 2024
3051705
structure & organizational changes, gitignore (vercel, DS_Store)
pete-vielhaber Dec 11, 2024
47c60f3
finished structure/organization based on outline
pete-vielhaber Dec 11, 2024
8304c95
structure and outline draft ready
pete-vielhaber Dec 11, 2024
2d29fdc
fixing escape issue
pete-vielhaber Dec 12, 2024
2b947d0
yarn format fixes
pete-vielhaber Dec 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.vscode
arbitrum-docs/sdk
arbitrum-docs/stylus-by-example
.vercel
.DS_Store
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Layer leap'
description: 'Learn how to configure Layer Leap on your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Fast withdrawals'
description: 'Learn how to configure fast withdrawals on your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'AEP fee router'
description: 'Learn how to configure your Orbit chain AEP fee router.'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Customizable Challenge Period'
description: 'Learn how to customize your Orbit chain's challenge period'
author:
sme:
content_type: how-to
---

- **Challenge Period Blocks**: Time until assertions are confirmed, allowing challenges.
- **Extra Challenge Period Blocks**: Additional waiting time before a challenge period expires.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Stake and validator configurations'
description: 'Learn how to configure your Orbit chain with a custom stake and validator configurations'
author:
sme:
content_type: how-to
---

- **Base Stake**: Minimum stake required for validators.
- **Stake Token**: Token used for staking.
- **Loser Stake Escrow**: Address for escrowed funds from losing validators.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'ArbOS configuration'
description: 'Learn how to configure ArbOS on your Orbit chain'
author: jose-franco
sme: jose-franco
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Gas Optimization Tools'
description: 'Learn how to configure gas optimization tools for your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Fee Management'
description: 'Learn how to configure fee management for your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Batch Posting and Assertion Control'
description: 'Learn how to configure batch posting and assertion control for your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Sequencer Timing Adjustments'
description: 'Learn how to configure sequencer timing adjustments for your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Per batch gas cost'
description: 'Learn how to configure per batch gas cost for your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Smart contract size limit'
description: 'Learn how to configure smart contract size limits on your Orbit chain'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Customizing AnyTrust'
description: 'Learn how to customize AnyTrust on your Orbit chain'
author:
sme:
content_type: how-to
---
10 changes: 10 additions & 0 deletions arbitrum-docs/launch-orbit-chain/02-start-your-journey.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Start your journey into Orbit'
sidebar_label: 'Orbit: get started'
description: 'Learn how to get started with Orbit'
sidebar_position: '2'
author: 'anegg0'
sme: 'mahsamoosavi'
editor: 'anegg0'
target_audience: 'Prospective chain owners, and operators'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Canonical Factory Contracts'
description: 'Learn how to deploy Canonical factory contracts on your Orbit chain'
author:
sme:
content_type: how-to
---
10 changes: 10 additions & 0 deletions arbitrum-docs/launch-orbit-chain/03-orbit-license.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'The Orbit license'
sidebar_label: 'Orbit license'
description: ''
sidebar_position: 2
author:
sme:
editor: anegg0
target_audience:
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Bridging'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Monitoring'
description: 'Learn how to configure your Orbit chain with a custom stake and validator configurations'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Ownership Structure and Access Control'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Decentralization and Security'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Guidance on AltDA'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Integrations'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---

## Compatible third-party integrations

## LayerZero OFT

## xERC20 Gateway
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Orbit Node Providers'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Orbit Portal'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Get listed on Orbit platforms'
description: 'PLACEHOLDER'
author:
sme:
content_type: how-to
---
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ When deploying your Orbit chain, this address must be a standard Ethereum wallet

## Additional configuration parameters

There are a number of [additional parameters](/launch-orbit-chain/reference/additional-configuration-parameters) that are not presented in the deployment UI, but are still configurable for more advanced chain deployers.
There are a number of [additional parameters](/launch-orbit-chain/reference/orbit-configuration-parameters) that are not presented in the deployment UI, but are still configurable for more advanced chain deployers.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Guidance on how to configure your Orbit chain'
sidebar_label: 'Configure your Orbit chain'
description: 'Learn how to configure your Orbit chain'
author: 'anegg0'
sme: 'anegg0'
target_audience: 'Developers deploying and maintaining Orbit chains.'
sidebar_position: '6'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand how to configure my chain to satisfy my requirements'
content_type: 'how-to'
---
63 changes: 63 additions & 0 deletions arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: 'Supported parent chains'
sidebar_label: 'Supported parent chains'
description: 'List of chains officially supported in Orbit'
sidebar_position: '2'
author: 'mahsamoosavi'
sme: 'mahsamoosavi'
editor: 'anegg0'
target_audience: 'Orbit chains owners and operators'
---

This page lists the parent chains that are officially supported in Orbit, including mainnets, testnets, and options for local development. While the Orbit SDK provides functionality to enable custom parent chains, support is limited to the chains explicitly listed on this page. Developers are welcome to use the Orbit SDK to configure and deploy custom parent chains; however, such setups, including deploying the required creator and template contracts, are beyond the scope of our official support.

:::caution Supported Chains Only

Please note that we cannot guarantee compatibility or offer assistance for custom configurations outside of the supported chains detailed below.

:::

#### Supported chains

<div class="chain-cards">

- **Ethereum Mainnet**
**Chain ID:** `1`

- **Arbitrum One**
**Chain ID:** `42161`

- **Arbitrum Nova**
**Chain ID:** `42170`

- **Base**
**Chain ID:** `8453`

- **Sepolia**
**Chain ID:** `11155111`

- **Holesky**
**Chain ID:** `17000`

- **Arbitrum Sepolia**
**Chain ID:** `421613`

- **Base Sepolia**
**Chain ID:** `84531`

- **Nitro Testnode L1**
**Chain ID:** `1337`

- **Nitro Testnode L2**
**Chain ID:** `412346`

- **Nitro Testnode L3**
**Chain ID:** `333333`

</div>

### Adding custom parent chains

Although Orbit primarily supports a predefined set of chains, it provides developers with the flexibility to add custom parent chains through [the `registerCustomParentChain` function of the Orbit SDK](https://github.com/OffchainLabs/arbitrum-orbit-sdk/blob/729facd4d50156d7a84cf1204552c900eb86655c/src/chains.ts#L102). This capability enables integration with chains beyond the officially supported list, offering opportunities for customization and expanding the Orbit ecosystem.

However, adding a custom chain requires deploying essential contracts, such as the creator contract and template contract, on the target chain. These contracts are fundamental for ensuring the proper functioning of the Orbit framework on the custom chain.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Orbit chains: batch poster configuration parameters'
sidebar_label: 'sequencer orbit batch poster configuration'
description: 'Learn how to configure a sequencer on your Orbit chain'
author: 'anegg0'
sme: 'anegg0'
target_audience: 'Prospective chain owners, and operators'
sidebar_position: '6'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand how to configure my batch poster'
content_type: 'reference'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Configuration parameters: Orbit chains'
sidebar_label: 'Configuration parameters'
description: 'Learn about Orbit configuration parameters'
author: 'anegg0'
sme: 'anegg0'
target_audience: 'Prospective chain owners, and operators'
sidebar_position: '6'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand how to configure my chain'
content_type: 'reference'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Configuration: fast block times'
sidebar_label: 'Configuration: fast block times'
description: 'Learn about Orbit fast block times'
author: 'anegg0'
sme: 'anegg0'
taget_audience: 'Prospective chain owners, and operators'
sidebar_position: '6'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand how to configure my chain for fast block times'
content_type: 'reference'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Orbit chains: sequencer configuration parameters'
sidebar_label: 'Sequencer configuration parameters'
description: 'Learn how to configure a sequencer on your Orbit chain'
author: 'anegg0'
sme: 'anegg0'
target_audience: 'Prospective chain owners, and operators'
sidebar_position: '6'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand how to configure my chains sequencer'
content_type: 'reference'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Smart contract size limit'
sidebar_label: 'Smart contract size limit'
description: 'Learn about Orbit Smart contract size limit'
author: 'anegg0'
sme: 'anegg0'
taget_audience: 'Prospective chain owners, and operators'
sidebar_position: '2'
user_story: 'As a current or prospective Orbit chain owner or operator, I need to understand smart contracts size limits'
content_type: 'reference'
---
Loading