From 30ad8e65543b16c770093495eaf356c396a197cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Tue, 12 Nov 2024 17:00:14 -0800 Subject: [PATCH 01/88] feat: tmp structure --- website/sidebars.js | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 4c4b45f5f7..25a35c4b46 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -257,28 +257,6 @@ const sidebars = { id: 'launch-orbit-chain/orbit-gentle-introduction', label: 'A gentle introduction', }, - { - type: 'doc', - id: 'launch-orbit-chain/orbit-quickstart', - label: 'Quickstart', - }, - { - type: 'category', - label: 'Guidance for Orbit chain operators', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-managing-state-growth', - label: `Manage gas state growth`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit', - label: `Manage gas speed limit`, - }, - ], - }, { type: 'category', label: 'Production Orbit chain setup', From 27722ee3ef8b4e5addc15cc0514c95df85cda074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Wed, 13 Nov 2024 11:38:54 -0800 Subject: [PATCH 02/88] fix: sidebar adjustments --- website/sidebars.js | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 25a35c4b46..5c76a92911 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -329,16 +329,6 @@ const sidebars = { id: 'launch-orbit-chain/how-tos/customize-stf', label: `Customize your chain's behavior`, }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-chain-finality', - label: `Configure delayed inbox finality`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/manage-fee-collectors', - label: `Manage the fee collectors`, - }, { type: 'doc', id: 'launch-orbit-chain/how-tos/customize-arbos', From ab04a24e9816159eca390be82807a946a2b44380 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Wed, 13 Nov 2024 14:37:51 -0800 Subject: [PATCH 03/88] fix: readjust sidebar categories --- website/sidebars.js | 91 +++++++++++---------------------------------- 1 file changed, 22 insertions(+), 69 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 5c76a92911..fe297d9a29 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -259,112 +259,65 @@ const sidebars = { }, { type: 'category', - label: 'Production Orbit chain setup', + label: 'Configure your chain', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/orbit-sdk-introduction', - label: `Introduction`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain', - label: `Rollup Orbit Deployment`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain', - label: `AnyTrust Orbit Deployment`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain', - label: `Custom Gas Token Orbit Deployment`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-preparing-node-config', - label: `Node Config Generation`, + id: 'launch-orbit-chain/how-tos/customize-precompile', + label: `Customize your chain's precompiles`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge', - label: `Token bridge deployment`, + id: 'launch-orbit-chain/how-tos/customize-stf', + label: `Customize your chain's behavior`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain', - label: `Orbit Chain Configuration`, + id: 'launch-orbit-chain/how-tos/customize-arbos', + label: `Customize ArbOS version`, }, ], }, { type: 'category', - label: 'Customize your chain', + label: 'Production Orbit chain setup', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-deployment-configuration', - label: `Customize your chain's deployment`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/reference/additional-configuration-parameters', - label: `Additional configuration parameters`, + id: 'launch-orbit-chain/orbit-sdk-introduction', + label: `Introduction`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/use-a-custom-gas-token', - label: `Use a custom gas token`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain', + label: `Rollup Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-precompile', - label: `Customize your chain's precompiles`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain', + label: `AnyTrust Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-stf', - label: `Customize your chain's behavior`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain', + label: `Custom Gas Token Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-arbos', - label: `Customize ArbOS version`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-preparing-node-config', + label: `Node Config Generation`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/usdc-standard-bridge', - label: `Implement Circle bridged USDC`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge', + label: `Token bridge deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/fast-withdrawals', - label: `Enable fast withdrawals`, - }, - { - type: 'category', - label: 'AEP fee router', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/aep-fee-router-introduction', - label: `AEP fee router overview`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', - label: `Set up AEP fee router`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/calculate-aep-fees', - label: `Calculate AEP license fees`, - }, - ], + id: 'launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain', + label: `Orbit Chain Configuration`, }, ], }, From ceb318c388d0bf9f7dd724b83e09b2bfb343d809 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 14 Nov 2024 15:24:26 -0800 Subject: [PATCH 04/88] feat: add stub article "start your journey" --- .../orbit-start-your-journey.mdx | 10 ++++++++++ website/sidebars.js | 18 +++++++++++++++--- 2 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx b/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx new file mode 100644 index 0000000000..04adc1044b --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx @@ -0,0 +1,10 @@ +--- +title: 'Start your journey into Orbit' +sidebar_label: 'Orbit: get started' +description: '' +sidebar_position: 2 +author: +sme: +editor: anegg0 +target_audience: +--- diff --git a/website/sidebars.js b/website/sidebars.js index 062e3506b6..bd22d2e44f 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -236,9 +236,21 @@ const sidebars = { collapsed: true, items: [ { - type: 'doc', - id: 'launch-orbit-chain/orbit-gentle-introduction', - label: 'A gentle introduction', + type: 'category', + label: 'Introduction', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/orbit-gentle-introduction', + label: 'A gentle introduction', + }, + { + type: 'doc', + id: 'launch-orbit-chain/orbit-start-your-journey', + label: 'Start your journey', + }, + ], }, { type: 'category', From 8e7d03807c8d443cb9b3cd5372caa63dd14b706c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 14 Nov 2024 15:39:48 -0800 Subject: [PATCH 05/88] feat: add Supported parent chains and configurations --- ...rbit-supported-parent-chains-and-configurations.mdx | 10 ++++++++++ website/sidebars.js | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx new file mode 100644 index 0000000000..8d16ae1090 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx @@ -0,0 +1,10 @@ +--- +title: 'Supported parent chains and configurations' +sidebar_label: 'Supported parent chains and configurations' +description: '' +sidebar_position: 2 +author: +sme: +editor: anegg0 +target_audience: +--- diff --git a/website/sidebars.js b/website/sidebars.js index bd22d2e44f..c6b51b993b 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -247,8 +247,8 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/orbit-start-your-journey', - label: 'Start your journey', + id: 'launch-orbit-chain/orbit-supported-parent-chains-and-configurations', + label: 'Supported parent chains and configurations', }, ], }, From 5d57a4f69e406ee1b60c778c4960011b09ff699e Mon Sep 17 00:00:00 2001 From: Mahsa Moosavi Date: Fri, 15 Nov 2024 12:09:39 -0500 Subject: [PATCH 06/88] Add supported parent chain page --- ...orted-parent-chains-and-configurations.mdx | 10 --- .../orbit-supported-parent-chains.mdx | 63 +++++++++++++++++++ website/sidebars.js | 4 +- 3 files changed, 65 insertions(+), 12 deletions(-) delete mode 100644 arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx deleted file mode 100644 index 8d16ae1090..0000000000 --- a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains-and-configurations.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: 'Supported parent chains and configurations' -sidebar_label: 'Supported parent chains and configurations' -description: '' -sidebar_position: 2 -author: -sme: -editor: anegg0 -target_audience: ---- diff --git a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx new file mode 100644 index 0000000000..428a8b42b0 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx @@ -0,0 +1,63 @@ +--- +title: 'Supported parent chains' +sidebar_label: 'Supported parent chains' +description: '' +sidebar_position: 2 +author: mahsamoosavi +sme: mahsamoosavi +editor: anegg0 +target_audience: +--- + +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 + +
+ +- **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` + +
+ +### 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. diff --git a/website/sidebars.js b/website/sidebars.js index c6b51b993b..44ff5d02fb 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -247,8 +247,8 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/orbit-supported-parent-chains-and-configurations', - label: 'Supported parent chains and configurations', + id: 'launch-orbit-chain/orbit-supported-parent-chains', + label: 'Supported parent chains', }, ], }, From 8d0b2564a78076141b9eb62ade960e0566b58298 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 12:34:41 -0800 Subject: [PATCH 07/88] feat: readjust sidebar --- website/sidebars.js | 122 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 97 insertions(+), 25 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 44ff5d02fb..ef5b52027f 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -236,41 +236,34 @@ const sidebars = { collapsed: true, items: [ { - type: 'category', - label: 'Introduction', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/orbit-gentle-introduction', - label: 'A gentle introduction', - }, - { - type: 'doc', - id: 'launch-orbit-chain/orbit-supported-parent-chains', - label: 'Supported parent chains', - }, - ], + type: 'doc', + id: 'launch-orbit-chain/orbit-gentle-introduction', + label: 'A gentle introduction', + }, + { + type: 'doc', + id: 'launch-orbit-chain/orbit-start-your-journey', + label: 'Start your journey', + }, + { + type: 'doc', + id: 'launch-orbit-chain/orbit-start-your-journey', + label: 'Start your journey', }, { type: 'category', - label: 'Configure your chain', + label: 'Guidance for Orbit chain operators', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-precompile', - label: `Customize your chain's precompiles`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-stf', - label: `Customize your chain's behavior`, + id: 'launch-orbit-chain/how-tos/orbit-managing-state-growth', + label: `Manage gas state growth`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-arbos', - label: `Customize ArbOS version`, + id: 'launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit', + label: `Manage gas speed limit`, }, ], }, @@ -316,6 +309,85 @@ const sidebars = { }, ], }, + { + type: 'category', + label: 'Customize your chain', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-deployment-configuration', + label: `Customize your chain's deployment`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/additional-configuration-parameters', + label: `Additional configuration parameters`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/use-a-custom-gas-token', + label: `Use a custom gas token`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-precompile', + label: `Customize your chain's precompiles`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-stf', + label: `Customize your chain's behavior`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/orbit-chain-finality', + label: `Configure delayed inbox finality`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/manage-fee-collectors', + label: `Manage the fee collectors`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-arbos', + label: `Customize ArbOS version`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/usdc-standard-bridge', + label: `Implement Circle bridged USDC`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/fast-withdrawals', + label: `Enable fast withdrawals`, + }, + { + type: 'category', + label: 'AEP fee router', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/aep-fee-router-introduction', + label: `AEP fee router overview`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', + label: `Set up AEP fee router`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/calculate-aep-fees', + label: `Calculate AEP license fees`, + }, + ], + }, + ], + }, { type: 'category', label: 'ArbOS', From 9753160293b0855ee264653829c9fca8ad8e11f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 13:54:49 -0800 Subject: [PATCH 08/88] fix: remove malformed stub-article --- .../launch-orbit-chain/orbit-start-your-journey.mdx | 12 ++++++------ .../orbit-supported-parent-chains.mdx | 10 +++++----- website/sidebars.js | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx b/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx index 04adc1044b..0268252031 100644 --- a/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx +++ b/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx @@ -1,10 +1,10 @@ --- title: 'Start your journey into Orbit' sidebar_label: 'Orbit: get started' -description: '' -sidebar_position: 2 -author: -sme: -editor: anegg0 -target_audience: +description: 'Learn how to get started with Orbit' +sidebar_position: '2' +author: 'anegg0' +sme: 'mahsamoosavi' +editor: 'anegg0' +target_audience: 'Prospective chain owners, and operators' --- diff --git a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx index 428a8b42b0..7736b296c7 100644 --- a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx +++ b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx @@ -1,12 +1,12 @@ --- title: 'Supported parent chains' sidebar_label: 'Supported parent chains' -description: '' +description: 'List of chains officially supported in Orbit' sidebar_position: 2 -author: mahsamoosavi -sme: mahsamoosavi -editor: anegg0 -target_audience: +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. diff --git a/website/sidebars.js b/website/sidebars.js index ef5b52027f..5c384be0f6 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -247,8 +247,8 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/orbit-start-your-journey', - label: 'Start your journey', + id: 'launch-orbit-chain/orbit-license', + label: 'Orbit license', }, { type: 'category', From 3c02f3170d62a878324d654eddbbcfacab31f221 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 13:55:45 -0800 Subject: [PATCH 09/88] fix: add orbit license stub article --- arbitrum-docs/launch-orbit-chain/orbit-license.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 arbitrum-docs/launch-orbit-chain/orbit-license.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-license.mdx b/arbitrum-docs/launch-orbit-chain/orbit-license.mdx new file mode 100644 index 0000000000..4c11294383 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/orbit-license.mdx @@ -0,0 +1,10 @@ +--- +title: 'The Orbit license' +sidebar_label: 'Orbit license' +description: '' +sidebar_position: 2 +author: +sme: +editor: anegg0 +target_audience: +--- From 0ae3f6df3a88f097069e3bff4136ef0f6670be56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 14:32:29 -0800 Subject: [PATCH 10/88] feat: add "how to configure your chain" --- .../how-tos/how-to-configure-your-chain.mdx | 12 ++++++ website/sidebars.js | 39 +++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx b/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx new file mode 100644 index 0000000000..e4d524f01d --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx @@ -0,0 +1,12 @@ +--- +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' +--- + diff --git a/website/sidebars.js b/website/sidebars.js index 5c384be0f6..c6fb42b467 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -250,6 +250,45 @@ const sidebars = { id: 'launch-orbit-chain/orbit-license', label: 'Orbit license', }, + { + type: 'category', + label: 'Configure your chain', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/how-to-configure-your-chain', + label: 'how-to-configure-your-chain', + }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/configuration-parameters', + label: 'Configuration parameters', + }, + { + type: 'category', + label: 'AEP fee router', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/aep-fee-router-introduction', + label: `AEP fee router overview`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', + label: `Set up AEP fee router`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/calculate-aep-fees', + label: `Calculate AEP license fees`, + }, + ], + }, + ], + }, { type: 'category', label: 'Guidance for Orbit chain operators', From 493e09ff7292c41903c19b3e31ce76753ade3baf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 14:33:42 -0800 Subject: [PATCH 11/88] feat: add "additional configuration parameters" --- ...-parameters.md => additional-configuration-parameters.mdx} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename arbitrum-docs/launch-orbit-chain/reference/{additional-configuration-parameters.md => additional-configuration-parameters.mdx} (69%) diff --git a/arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.md b/arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.mdx similarity index 69% rename from arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.md rename to arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.mdx index 8b76ef8a17..7e8a2a25a3 100644 --- a/arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.md +++ b/arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.mdx @@ -1,6 +1,6 @@ --- -title: 'Additional configuration parameters: Orbit chains' -sidebar_label: Additional configuration parameters +title: 'Configuration parameters: Orbit chains' +sidebar_label: 'Configuration parameters' --- The following configuration parameters can be used when deploying or managing your Orbit chain: From 4dfc3a8b3c1cc11e578b4628bb11317eee32b243 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 14:38:52 -0800 Subject: [PATCH 12/88] feat: rename config parameters --- ...-configuration-parameters.mdx => configuration-parameters.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename arbitrum-docs/launch-orbit-chain/reference/{additional-configuration-parameters.mdx => configuration-parameters.mdx} (100%) diff --git a/arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.mdx b/arbitrum-docs/launch-orbit-chain/reference/configuration-parameters.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.mdx rename to arbitrum-docs/launch-orbit-chain/reference/configuration-parameters.mdx From c59a130921b19c606ef5f768608410ebf4691cd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 14:41:24 -0800 Subject: [PATCH 13/88] fix: format + rename configuration parameters --- .../how-tos/how-to-configure-your-chain.mdx | 1 - website/sidebars.js | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx b/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx index e4d524f01d..c36e79389f 100644 --- a/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx +++ b/arbitrum-docs/launch-orbit-chain/how-tos/how-to-configure-your-chain.mdx @@ -9,4 +9,3 @@ 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' --- - diff --git a/website/sidebars.js b/website/sidebars.js index c6fb42b467..7e741d5772 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -360,8 +360,8 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/reference/additional-configuration-parameters', - label: `Additional configuration parameters`, + id: 'launch-orbit-chain/reference/configuration-parameters', + label: `Orbit configuration parameters`, }, { type: 'doc', From ebd6d199ddfc072c1b2f0cf2d578365cfd97a0da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 14:46:28 -0800 Subject: [PATCH 14/88] feat: rename orbit configuration parameters --- ...n-parameters.mdx => orbit-configuration-parameters.mdx} | 0 website/sidebars.js | 7 +------ 2 files changed, 1 insertion(+), 6 deletions(-) rename arbitrum-docs/launch-orbit-chain/reference/{configuration-parameters.mdx => orbit-configuration-parameters.mdx} (100%) diff --git a/arbitrum-docs/launch-orbit-chain/reference/configuration-parameters.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/reference/configuration-parameters.mdx rename to arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx diff --git a/website/sidebars.js b/website/sidebars.js index 7e741d5772..f294e0c622 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -260,11 +260,6 @@ const sidebars = { id: 'launch-orbit-chain/how-tos/how-to-configure-your-chain', label: 'how-to-configure-your-chain', }, - { - type: 'doc', - id: 'launch-orbit-chain/reference/configuration-parameters', - label: 'Configuration parameters', - }, { type: 'category', label: 'AEP fee router', @@ -360,7 +355,7 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/reference/configuration-parameters', + id: 'launch-orbit-chain/reference/orbit-configuration-parameters', label: `Orbit configuration parameters`, }, { From 3addd0d7b53cbfd42eb7324fb9fc17506fb98f41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Sun, 17 Nov 2024 15:02:54 -0800 Subject: [PATCH 15/88] feat: add fast block times stub article --- .../reference/orbit-fast-block-times.mdx | 11 +++++++ website/sidebars.js | 32 ++++++++++++++++--- 2 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx new file mode 100644 index 0000000000..e4a4b5d62b --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx @@ -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' +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 for fast block times' +content_type: 'how-to' +--- diff --git a/website/sidebars.js b/website/sidebars.js index f294e0c622..7f2ea243e2 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -260,6 +260,33 @@ const sidebars = { id: 'launch-orbit-chain/how-tos/how-to-configure-your-chain', label: 'how-to-configure-your-chain', }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/orbit-configuration-parameters', + label: `Orbit configuration parameters`, + }, + { + type: 'category', + label: 'Core configuration', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/reference/orbit-fast-block-times', + label: 'orbit-fast-block-times', + }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/smart-contract-size-limit', + label: 'smart-contract-size-limit', + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/calculate-aep-fees', + label: `Calculate AEP license fees`, + }, + ], + }, { type: 'category', label: 'AEP fee router', @@ -353,11 +380,6 @@ const sidebars = { id: 'launch-orbit-chain/how-tos/customize-deployment-configuration', label: `Customize your chain's deployment`, }, - { - type: 'doc', - id: 'launch-orbit-chain/reference/orbit-configuration-parameters', - label: `Orbit configuration parameters`, - }, { type: 'doc', id: 'launch-orbit-chain/how-tos/use-a-custom-gas-token', From 30580d6f3597161be213b06d20f9d587b54f725f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Mon, 18 Nov 2024 11:12:17 -0800 Subject: [PATCH 16/88] fix: add smart contract size limit --- .../orbit-supported-parent-chains.mdx | 2 +- .../reference/orbit-configuration-parameters.mdx | 13 +++++++------ .../reference/orbit-fast-block-times.mdx | 4 ++-- website/sidebars.js | 4 ++-- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx index 7736b296c7..2499d3d99b 100644 --- a/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx +++ b/arbitrum-docs/launch-orbit-chain/orbit-supported-parent-chains.mdx @@ -2,7 +2,7 @@ title: 'Supported parent chains' sidebar_label: 'Supported parent chains' description: 'List of chains officially supported in Orbit' -sidebar_position: 2 +sidebar_position: '2' author: 'mahsamoosavi' sme: 'mahsamoosavi' editor: 'anegg0' diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx index 7e8a2a25a3..dae6cca158 100644 --- a/arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-configuration-parameters.mdx @@ -1,10 +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' --- - -The following configuration parameters can be used when deploying or managing your Orbit chain: - -import OptionalOrbitCompatibleCLIFlagsPartial from '../../partials/_additional-config-params.mdx'; - - diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx index e4a4b5d62b..f54c868a12 100644 --- a/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-fast-block-times.mdx @@ -4,8 +4,8 @@ sidebar_label: 'Configuration: fast block times' description: 'Learn about Orbit fast block times' author: 'anegg0' sme: 'anegg0' -target_audience: 'Prospective chain owners, and operators' +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: 'how-to' +content_type: 'reference' --- diff --git a/website/sidebars.js b/website/sidebars.js index 7f2ea243e2..5292870d47 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -277,8 +277,8 @@ const sidebars = { }, { type: 'doc', - id: 'launch-orbit-chain/reference/smart-contract-size-limit', - label: 'smart-contract-size-limit', + id: 'launch-orbit-chain/reference/orbit-smart-contract-size-limit', + label: 'smart contract size limit', }, { type: 'doc', From ed48cd285af16dbe901073cea0dc66d754acccbc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Mon, 18 Nov 2024 14:58:28 -0800 Subject: [PATCH 17/88] feat: add orbit-smart-contract-size-limits --- .../reference/orbit-smart-contract-size-limit.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 arbitrum-docs/launch-orbit-chain/reference/orbit-smart-contract-size-limit.mdx diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-smart-contract-size-limit.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-smart-contract-size-limit.mdx new file mode 100644 index 0000000000..76e283a51f --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-smart-contract-size-limit.mdx @@ -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' +--- From b15dc4078380de4de66ef6364ed60d4920b31ba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Mon, 18 Nov 2024 15:19:05 -0800 Subject: [PATCH 18/88] fix: fix link --- .../how-tos/customize-deployment-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/customize-deployment-configuration.md b/arbitrum-docs/launch-orbit-chain/how-tos/customize-deployment-configuration.md index b0c6fb7cff..0a4847644b 100644 --- a/arbitrum-docs/launch-orbit-chain/how-tos/customize-deployment-configuration.md +++ b/arbitrum-docs/launch-orbit-chain/how-tos/customize-deployment-configuration.md @@ -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. From 3930c0c74b914b1ecb660094f25504801e8ff7cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 21 Nov 2024 23:00:24 -0800 Subject: [PATCH 19/88] feat: add batch post stub article --- .../reference/orbit-batch-poster-configuration.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 arbitrum-docs/launch-orbit-chain/reference/orbit-batch-poster-configuration.mdx diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-batch-poster-configuration.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-batch-poster-configuration.mdx new file mode 100644 index 0000000000..2ebcad36ce --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-batch-poster-configuration.mdx @@ -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' +--- From 66a4373edea3de0eae54b483f3462be24d3c28d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 21 Nov 2024 23:00:44 -0800 Subject: [PATCH 20/88] feat: add orbit sequencer config stub --- .../reference/orbit-sequencer-configuration.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 arbitrum-docs/launch-orbit-chain/reference/orbit-sequencer-configuration.mdx diff --git a/arbitrum-docs/launch-orbit-chain/reference/orbit-sequencer-configuration.mdx b/arbitrum-docs/launch-orbit-chain/reference/orbit-sequencer-configuration.mdx new file mode 100644 index 0000000000..039828733c --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/reference/orbit-sequencer-configuration.mdx @@ -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' +--- From b10c1d5888d031822f9dc081623fa0060756837d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Blanchemain?= Date: Thu, 21 Nov 2024 23:01:04 -0800 Subject: [PATCH 21/88] feat: add stubs to sidebar --- website/sidebars.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/website/sidebars.js b/website/sidebars.js index 120e2e659f..61941e555e 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -270,6 +270,16 @@ const sidebars = { label: 'Core configuration', collapsed: true, items: [ + { + type: 'doc', + id: 'launch-orbit-chain/reference/orbit-sequencer-configuration', + label: 'orbit-sequencer-configuration', + }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/orbit-batch-poster-configuration', + label: 'orbit-batch-poster-configuration', + }, { type: 'doc', id: 'launch-orbit-chain/reference/orbit-fast-block-times', From 3051705e08ec265f1741824ff4f9a7aaf9135549 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 11 Dec 2024 11:20:48 -0600 Subject: [PATCH 22/88] structure & organizational changes, gitignore (vercel, DS_Store) --- .gitignore | 2 ++ ...orbit-gentle-introduction.md => 01-a-gentle-introduction.md} | 0 .../use-a-custom-gas-token.mdx | 0 .../{orbit-start-your-journey.mdx => 02-start-your-journey.mdx} | 0 .../{orbit-license.mdx => 03-orbit-license.mdx} | 0 .../troubleshooting-building-orbit.md | 0 6 files changed, 2 insertions(+) rename arbitrum-docs/launch-orbit-chain/{orbit-gentle-introduction.md => 01-a-gentle-introduction.md} (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 02-configure-your-chain}/use-a-custom-gas-token.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{orbit-start-your-journey.mdx => 02-start-your-journey.mdx} (100%) rename arbitrum-docs/launch-orbit-chain/{orbit-license.mdx => 03-orbit-license.mdx} (100%) rename arbitrum-docs/launch-orbit-chain/{ => 09-faq-troubleshooting}/troubleshooting-building-orbit.md (100%) diff --git a/.gitignore b/.gitignore index 8bd9cafc27..83be1e7d70 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .vscode arbitrum-docs/sdk arbitrum-docs/stylus-by-example +.vercel +.DS_Store diff --git a/arbitrum-docs/launch-orbit-chain/orbit-gentle-introduction.md b/arbitrum-docs/launch-orbit-chain/01-a-gentle-introduction.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/orbit-gentle-introduction.md rename to arbitrum-docs/launch-orbit-chain/01-a-gentle-introduction.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/use-a-custom-gas-token.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/use-a-custom-gas-token.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/use-a-custom-gas-token.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/use-a-custom-gas-token.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx b/arbitrum-docs/launch-orbit-chain/02-start-your-journey.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/orbit-start-your-journey.mdx rename to arbitrum-docs/launch-orbit-chain/02-start-your-journey.mdx diff --git a/arbitrum-docs/launch-orbit-chain/orbit-license.mdx b/arbitrum-docs/launch-orbit-chain/03-orbit-license.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/orbit-license.mdx rename to arbitrum-docs/launch-orbit-chain/03-orbit-license.mdx diff --git a/arbitrum-docs/launch-orbit-chain/troubleshooting-building-orbit.md b/arbitrum-docs/launch-orbit-chain/09-faq-troubleshooting/troubleshooting-building-orbit.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/troubleshooting-building-orbit.md rename to arbitrum-docs/launch-orbit-chain/09-faq-troubleshooting/troubleshooting-building-orbit.md From 47c60f39fe149350cbfc47f41f087b1fb89eba92 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 11 Dec 2024 13:22:22 -0600 Subject: [PATCH 23/88] finished structure/organization based on outline --- ...m-gas-token.mdx => 01-use-a-custom-gas-token.mdx} | 0 .../02-customizable-challenge-period.mdx | 11 +++++++++++ .../03-stake-and-validator-configurations.mdx | 12 ++++++++++++ .../04-arbos-configuration.mdx | 8 ++++++++ .../05-gas-optimization-tools.mdx | 7 +++++++ .../02-configure-your-chain/06-fee-management.mdx | 7 +++++++ .../07-batch-posting-assertion-control.mdx | 7 +++++++ .../08-sequencer-timing-adjustments.mdx | 7 +++++++ .../09-per-batch-gas-cost.mdx | 7 +++++++ .../10-smart-contract-size-limit.mdx | 7 +++++++ .../11-customizing-anytrust.mdx | 7 +++++++ .../advanced-configurations/01-layer-leap.mdx | 7 +++++++ .../advanced-configurations/02-fast-withdrawals.mdx | 7 +++++++ .../advanced-configurations/03-aep-fee-router.mdx | 7 +++++++ .../arbos-upgrade.md | 0 .../calculate-aep-fees.mdx | 0 .../set-up-aep-fee-router.mdx | 0 .../01-configuring-orbit-chain.md} | 0 .../02-deploying-rollup-chain.md} | 0 .../03-deploying-anytrust-chain.md} | 0 .../04-deploying-custom-gas-token-chain.md} | 0 .../05-deploying-token-bridge.md} | 0 .../06-monitoring-tools-and-considerations.mdx} | 0 .../07-canonical-factory-contracts.mdx | 7 +++++++ .../04-maintain-your-chain/01-bridging.mdx | 7 +++++++ .../04-maintain-your-chain/02-monitoring.mdx | 7 +++++++ .../03-ownership-structure-access-control.mdx | 7 +++++++ .../04-maintain-your-chain/04-guidance.mdx | 7 +++++++ .../orbit-managing-gas-speed-limit.mdx | 0 .../orbit-managing-state-growth.mdx | 0 .../customize-arbos.mdx | 0 .../customize-precompile.mdx | 0 .../customize-stf.mdx | 0 .../01-usdc-standard-bridge.md} | 0 .../02-infra-options-orbit-chains.md} | 0 .../06-third-party-integrations/03-integrations.mdx | 7 +++++++ .../08-ecosystem-support/01-orbit-portal.mdx | 7 +++++++ .../03-get-listed-orbit-platforms.mdx | 7 +++++++ .../add-orbit-chain-to-bridge-ui.md | 0 39 files changed, 157 insertions(+) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{use-a-custom-gas-token.mdx => 01-use-a-custom-gas-token.mdx} (100%) create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx rename arbitrum-docs/launch-orbit-chain/{how-tos => 02-configure-your-chain}/arbos-upgrade.md (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 02-configure-your-chain}/calculate-aep-fees.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 02-configure-your-chain}/set-up-aep-fee-router.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/orbit-sdk-configuring-orbit-chain.md => 03-deploy-an-orbit-chain/01-configuring-orbit-chain.md} (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/orbit-sdk-deploying-rollup-chain.md => 03-deploy-an-orbit-chain/02-deploying-rollup-chain.md} (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/orbit-sdk-deploying-anytrust-chain.md => 03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md} (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/orbit-sdk-deploying-custom-gas-token-chain.md => 03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md} (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/orbit-sdk-deploying-token-bridge.md => 03-deploy-an-orbit-chain/05-deploying-token-bridge.md} (100%) rename arbitrum-docs/launch-orbit-chain/{reference/monitoring-tools-and-considerations.mdx => 03-deploy-an-orbit-chain/06-monitoring-tools-and-considerations.mdx} (100%) create mode 100644 arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx rename arbitrum-docs/launch-orbit-chain/{how-tos => 04-maintain-your-chain}/orbit-managing-gas-speed-limit.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 04-maintain-your-chain}/orbit-managing-state-growth.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 05-customize-your-chain}/customize-arbos.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 05-customize-your-chain}/customize-precompile.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 05-customize-your-chain}/customize-stf.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos/usdc-standard-bridge.md => 06-third-party-integrations/01-usdc-standard-bridge.md} (100%) rename arbitrum-docs/launch-orbit-chain/{infra-options-orbit-chains.md => 06-third-party-integrations/02-infra-options-orbit-chains.md} (100%) create mode 100644 arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx create mode 100644 arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx rename arbitrum-docs/launch-orbit-chain/{how-tos => 08-ecosystem-support}/add-orbit-chain-to-bridge-ui.md (100%) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/use-a-custom-gas-token.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/01-use-a-custom-gas-token.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/use-a-custom-gas-token.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/01-use-a-custom-gas-token.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx new file mode 100644 index 0000000000..3155febeef --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx @@ -0,0 +1,11 @@ +--- +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. + diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx new file mode 100644 index 0000000000..4a0e959796 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx @@ -0,0 +1,12 @@ +--- +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. \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx new file mode 100644 index 0000000000..5f99d1d1a6 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx @@ -0,0 +1,8 @@ +--- +title: 'ArbOS configuration' +description: 'Learn how to configure ArbOS on your Orbit chain' +author: jose-franco +sme: jose-franco +content_type: how-to +--- + diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx new file mode 100644 index 0000000000..2f28c322c6 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx new file mode 100644 index 0000000000..ccae6a1d93 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx @@ -0,0 +1,7 @@ +--- +title: 'Fee Management' +description: 'Learn how to configure fee management for your Orbit chain' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx new file mode 100644 index 0000000000..450d2b9b8e --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx new file mode 100644 index 0000000000..976f6e394a --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx new file mode 100644 index 0000000000..c45647fd83 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx new file mode 100644 index 0000000000..7b30ab37fc --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx new file mode 100644 index 0000000000..1383c4a5ca --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx @@ -0,0 +1,7 @@ +--- +title: 'Customizing AnyTrust' +description: 'Learn how to customize AnyTrust on your Orbit chain' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx new file mode 100644 index 0000000000..7ad4751fda --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx @@ -0,0 +1,7 @@ +--- +title: 'Layer leap' +description: 'Learn how to configure Layer Leap on your Orbit chain' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx new file mode 100644 index 0000000000..873b923774 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx @@ -0,0 +1,7 @@ +--- +title: 'Fast withdrawals' +description: 'Learn how to configure fast withdrawals on your Orbit chain' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx new file mode 100644 index 0000000000..b3a3953b48 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx @@ -0,0 +1,7 @@ +--- +title: 'AEP fee router' +description: 'Learn how to configure your Orbit chain's AEP fee router.' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/arbos-upgrade.md b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/arbos-upgrade.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/arbos-upgrade.md rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/arbos-upgrade.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/calculate-aep-fees.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/calculate-aep-fees.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/calculate-aep-fees.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/calculate-aep-fees.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/set-up-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/set-up-aep-fee-router.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/set-up-aep-fee-router.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/set-up-aep-fee-router.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/01-configuring-orbit-chain.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain.md rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/01-configuring-orbit-chain.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/02-deploying-rollup-chain.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain.md rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/02-deploying-rollup-chain.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain.md rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain.md rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/05-deploying-token-bridge.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge.md rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/05-deploying-token-bridge.md diff --git a/arbitrum-docs/launch-orbit-chain/reference/monitoring-tools-and-considerations.mdx b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/06-monitoring-tools-and-considerations.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/reference/monitoring-tools-and-considerations.mdx rename to arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/06-monitoring-tools-and-considerations.mdx diff --git a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx new file mode 100644 index 0000000000..995ec78521 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx new file mode 100644 index 0000000000..2fa09dce2e --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx @@ -0,0 +1,7 @@ +--- +title: 'Bridging' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx new file mode 100644 index 0000000000..f9e57f15f5 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx @@ -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 +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx new file mode 100644 index 0000000000..9f1a4c797c --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx @@ -0,0 +1,7 @@ +--- +title: 'Ownership Structure and Access Control' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx new file mode 100644 index 0000000000..570aa494b7 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx @@ -0,0 +1,7 @@ +--- +title: 'Guidance' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-gas-speed-limit.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit.mdx rename to arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-gas-speed-limit.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/orbit-managing-state-growth.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-state-growth.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/orbit-managing-state-growth.mdx rename to arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-state-growth.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/customize-arbos.mdx b/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-arbos.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/customize-arbos.mdx rename to arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-arbos.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx b/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx rename to arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/customize-stf.mdx b/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-stf.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/customize-stf.mdx rename to arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-stf.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/usdc-standard-bridge.md b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-usdc-standard-bridge.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/usdc-standard-bridge.md rename to arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-usdc-standard-bridge.md diff --git a/arbitrum-docs/launch-orbit-chain/infra-options-orbit-chains.md b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-infra-options-orbit-chains.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/infra-options-orbit-chains.md rename to arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-infra-options-orbit-chains.md diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx new file mode 100644 index 0000000000..bdff4ed702 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx @@ -0,0 +1,7 @@ +--- +title: 'Integrations' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx new file mode 100644 index 0000000000..d9d5c4cb43 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx @@ -0,0 +1,7 @@ +--- +title: 'Orbit Portal' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx new file mode 100644 index 0000000000..2b944d224c --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx @@ -0,0 +1,7 @@ +--- +title: 'Get listed on Orbit platforms' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/add-orbit-chain-to-bridge-ui.md b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/add-orbit-chain-to-bridge-ui.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/add-orbit-chain-to-bridge-ui.md rename to arbitrum-docs/launch-orbit-chain/08-ecosystem-support/add-orbit-chain-to-bridge-ui.md From 8304c95d61115bb018ef4536a2918fe49e937438 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 11 Dec 2024 15:17:51 -0600 Subject: [PATCH 24/88] structure and outline draft ready --- .../01-use-a-custom-gas-token.mdx | 0 .../02-customizable-challenge-period.mdx | 0 .../03-stake-and-validator-configurations.mdx | 0 .../04-arbos-configuration.mdx | 0 .../05-gas-optimization-tools.mdx | 0 .../{ => common-configurations}/06-fee-management.mdx | 0 .../07-batch-posting-assertion-control.mdx | 0 .../08-sequencer-timing-adjustments.mdx | 0 .../09-per-batch-gas-cost.mdx | 0 .../10-smart-contract-size-limit.mdx | 0 .../11-customizing-anytrust.mdx | 0 .../aep-fee-router-introduction.mdx | 0 .../{ => common-configurations}/arbos-upgrade.md | 0 .../calculate-aep-fees.mdx | 0 .../common-configurations}/fast-withdrawals.mdx | 0 .../set-up-aep-fee-router.mdx | 0 .../guidance/01-decentralization-security.mdx | 7 +++++++ .../02-guidance-on-altda.mdx} | 2 +- .../03-state-growth.mdx} | 0 .../04-state-size-limit.mdx} | 0 ...standard-bridge.md => 01-bridged-usdc-standard.md} | 0 ...ns-orbit-chains.md => 02-third-party-providers.md} | 0 .../06-third-party-integrations/03-integrations.mdx | 11 ++++++++++- .../07-orbit-node-runners/orbit-node-providers.mdx | 7 +++++++ 24 files changed, 25 insertions(+), 2 deletions(-) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/01-use-a-custom-gas-token.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/02-customizable-challenge-period.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/03-stake-and-validator-configurations.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/04-arbos-configuration.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/05-gas-optimization-tools.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/06-fee-management.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/07-batch-posting-assertion-control.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/08-sequencer-timing-adjustments.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/09-per-batch-gas-cost.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/10-smart-contract-size-limit.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/11-customizing-anytrust.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{ => 02-configure-your-chain/common-configurations}/aep-fee-router-introduction.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/arbos-upgrade.md (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/calculate-aep-fees.mdx (100%) rename arbitrum-docs/launch-orbit-chain/{how-tos => 02-configure-your-chain/common-configurations}/fast-withdrawals.mdx (100%) rename arbitrum-docs/launch-orbit-chain/02-configure-your-chain/{ => common-configurations}/set-up-aep-fee-router.mdx (100%) create mode 100644 arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx rename arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/{04-guidance.mdx => guidance/02-guidance-on-altda.mdx} (72%) rename arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/{orbit-managing-state-growth.mdx => guidance/03-state-growth.mdx} (100%) rename arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/{orbit-managing-gas-speed-limit.mdx => guidance/04-state-size-limit.mdx} (100%) rename arbitrum-docs/launch-orbit-chain/06-third-party-integrations/{01-usdc-standard-bridge.md => 01-bridged-usdc-standard.md} (100%) rename arbitrum-docs/launch-orbit-chain/06-third-party-integrations/{02-infra-options-orbit-chains.md => 02-third-party-providers.md} (100%) create mode 100644 arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/01-use-a-custom-gas-token.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/01-use-a-custom-gas-token.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/01-use-a-custom-gas-token.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/01-use-a-custom-gas-token.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/02-customizable-challenge-period.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/03-stake-and-validator-configurations.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/04-arbos-configuration.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/05-gas-optimization-tools.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/06-fee-management.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/07-batch-posting-assertion-control.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/08-sequencer-timing-adjustments.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/09-per-batch-gas-cost.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/10-smart-contract-size-limit.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/11-customizing-anytrust.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx diff --git a/arbitrum-docs/launch-orbit-chain/aep-fee-router-introduction.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/aep-fee-router-introduction.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/arbos-upgrade.md b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/arbos-upgrade.md rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/calculate-aep-fees.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/calculate-aep-fees.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/calculate-aep-fees.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/calculate-aep-fees.mdx diff --git a/arbitrum-docs/launch-orbit-chain/how-tos/fast-withdrawals.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/fast-withdrawals.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/how-tos/fast-withdrawals.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/fast-withdrawals.mdx diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/set-up-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/02-configure-your-chain/set-up-aep-fee-router.mdx rename to arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx new file mode 100644 index 0000000000..220cb477d8 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx @@ -0,0 +1,7 @@ +--- +title: 'Decentralization and Security' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx similarity index 72% rename from arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx rename to arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx index 570aa494b7..57597978af 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/04-guidance.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx @@ -1,5 +1,5 @@ --- -title: 'Guidance' +title: 'Guidance on AltDA' description: 'PLACEHOLDER' author: sme: diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-state-growth.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/03-state-growth.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-state-growth.mdx rename to arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/03-state-growth.mdx diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-gas-speed-limit.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/04-state-size-limit.mdx similarity index 100% rename from arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/orbit-managing-gas-speed-limit.mdx rename to arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/04-state-size-limit.mdx diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-usdc-standard-bridge.md b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-usdc-standard-bridge.md rename to arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-infra-options-orbit-chains.md b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-third-party-providers.md similarity index 100% rename from arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-infra-options-orbit-chains.md rename to arbitrum-docs/launch-orbit-chain/06-third-party-integrations/02-third-party-providers.md diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx index bdff4ed702..110ed170fc 100644 --- a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx +++ b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx @@ -4,4 +4,13 @@ description: 'PLACEHOLDER' author: sme: content_type: how-to ---- \ No newline at end of file +--- + + +## Compatible third-party integrations + + +## LayerZero OFT + + +## xERC20 Gateway \ No newline at end of file diff --git a/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx b/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx new file mode 100644 index 0000000000..218bb756b9 --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx @@ -0,0 +1,7 @@ +--- +title: 'Orbit Node Providers' +description: 'PLACEHOLDER' +author: +sme: +content_type: how-to +--- \ No newline at end of file From 2d29fdc7c36b0468d0f9b73448836e524f7eff5d Mon Sep 17 00:00:00 2001 From: Pete Date: Thu, 12 Dec 2024 08:00:17 -0600 Subject: [PATCH 25/88] fixing escape issue --- .../advanced-configurations/03-aep-fee-router.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx index b3a3953b48..9545d17551 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx @@ -1,6 +1,6 @@ --- title: 'AEP fee router' -description: 'Learn how to configure your Orbit chain's AEP fee router.' +description: 'Learn how to configure your Orbit chain AEP fee router.' author: sme: content_type: how-to From 2b947d08fa9ca345f751ed9b5cff55c5be9a6cb9 Mon Sep 17 00:00:00 2001 From: Pete Date: Thu, 12 Dec 2024 08:01:03 -0600 Subject: [PATCH 26/88] yarn format fixes --- .../advanced-configurations/01-layer-leap.mdx | 6 +++--- .../advanced-configurations/02-fast-withdrawals.mdx | 6 +++--- .../advanced-configurations/03-aep-fee-router.mdx | 6 +++--- .../02-customizable-challenge-period.mdx | 1 - .../03-stake-and-validator-configurations.mdx | 7 +++---- .../common-configurations/04-arbos-configuration.mdx | 1 - .../common-configurations/05-gas-optimization-tools.mdx | 6 +++--- .../common-configurations/06-fee-management.mdx | 6 +++--- .../07-batch-posting-assertion-control.mdx | 6 +++--- .../08-sequencer-timing-adjustments.mdx | 6 +++--- .../common-configurations/09-per-batch-gas-cost.mdx | 6 +++--- .../10-smart-contract-size-limit.mdx | 6 +++--- .../common-configurations/11-customizing-anytrust.mdx | 6 +++--- .../07-canonical-factory-contracts.mdx | 6 +++--- .../04-maintain-your-chain/01-bridging.mdx | 6 +++--- .../04-maintain-your-chain/02-monitoring.mdx | 6 +++--- .../03-ownership-structure-access-control.mdx | 6 +++--- .../guidance/01-decentralization-security.mdx | 6 +++--- .../guidance/02-guidance-on-altda.mdx | 6 +++--- .../06-third-party-integrations/03-integrations.mdx | 9 +++------ .../07-orbit-node-runners/orbit-node-providers.mdx | 6 +++--- .../08-ecosystem-support/01-orbit-portal.mdx | 6 +++--- .../03-get-listed-orbit-platforms.mdx | 6 +++--- 23 files changed, 63 insertions(+), 69 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx index 7ad4751fda..2595ab9ee5 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/01-layer-leap.mdx @@ -1,7 +1,7 @@ --- title: 'Layer leap' description: 'Learn how to configure Layer Leap on your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx index 873b923774..d09ae63b2f 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/02-fast-withdrawals.mdx @@ -1,7 +1,7 @@ --- title: 'Fast withdrawals' description: 'Learn how to configure fast withdrawals on your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx index 9545d17551..69fa946e42 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/advanced-configurations/03-aep-fee-router.mdx @@ -1,7 +1,7 @@ --- title: 'AEP fee router' description: 'Learn how to configure your Orbit chain AEP fee router.' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx index 3155febeef..d0ad2ce724 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx @@ -8,4 +8,3 @@ 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. - diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx index 4a0e959796..11389a9c44 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/03-stake-and-validator-configurations.mdx @@ -1,12 +1,11 @@ --- title: 'Stake and validator configurations' description: 'Learn how to configure your Orbit chain with a custom stake and validator configurations' -author: -sme: +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. \ No newline at end of file +- **Loser Stake Escrow**: Address for escrowed funds from losing validators. diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx index 5f99d1d1a6..69cdd9dbe8 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/04-arbos-configuration.mdx @@ -5,4 +5,3 @@ author: jose-franco sme: jose-franco content_type: how-to --- - diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx index 2f28c322c6..f9c6d4890d 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/05-gas-optimization-tools.mdx @@ -1,7 +1,7 @@ --- title: 'Gas Optimization Tools' description: 'Learn how to configure gas optimization tools for your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx index ccae6a1d93..ae9a30d6eb 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/06-fee-management.mdx @@ -1,7 +1,7 @@ --- title: 'Fee Management' description: 'Learn how to configure fee management for your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx index 450d2b9b8e..8cd1005c18 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/07-batch-posting-assertion-control.mdx @@ -1,7 +1,7 @@ --- title: 'Batch Posting and Assertion Control' description: 'Learn how to configure batch posting and assertion control for your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx index 976f6e394a..93458e9dc4 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/08-sequencer-timing-adjustments.mdx @@ -1,7 +1,7 @@ --- title: 'Sequencer Timing Adjustments' description: 'Learn how to configure sequencer timing adjustments for your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx index c45647fd83..7913f9d7b2 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/09-per-batch-gas-cost.mdx @@ -1,7 +1,7 @@ --- title: 'Per batch gas cost' description: 'Learn how to configure per batch gas cost for your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx index 7b30ab37fc..dd1ef999e9 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/10-smart-contract-size-limit.mdx @@ -1,7 +1,7 @@ --- title: 'Smart contract size limit' description: 'Learn how to configure smart contract size limits on your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx index 1383c4a5ca..4d1522e540 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/11-customizing-anytrust.mdx @@ -1,7 +1,7 @@ --- title: 'Customizing AnyTrust' description: 'Learn how to customize AnyTrust on your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx index 995ec78521..eef0a94b3a 100644 --- a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx +++ b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/07-canonical-factory-contracts.mdx @@ -1,7 +1,7 @@ --- title: 'Canonical Factory Contracts' description: 'Learn how to deploy Canonical factory contracts on your Orbit chain' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx index 2fa09dce2e..2cf2c42211 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/01-bridging.mdx @@ -1,7 +1,7 @@ --- title: 'Bridging' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx index f9e57f15f5..365652dba8 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/02-monitoring.mdx @@ -1,7 +1,7 @@ --- title: 'Monitoring' description: 'Learn how to configure your Orbit chain with a custom stake and validator configurations' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx index 9f1a4c797c..1fd384425e 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/03-ownership-structure-access-control.mdx @@ -1,7 +1,7 @@ --- title: 'Ownership Structure and Access Control' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx index 220cb477d8..d2ea509bfd 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/01-decentralization-security.mdx @@ -1,7 +1,7 @@ --- title: 'Decentralization and Security' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx index 57597978af..9173110028 100644 --- a/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx +++ b/arbitrum-docs/launch-orbit-chain/04-maintain-your-chain/guidance/02-guidance-on-altda.mdx @@ -1,7 +1,7 @@ --- title: 'Guidance on AltDA' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx index 110ed170fc..6cc3387420 100644 --- a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx +++ b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/03-integrations.mdx @@ -1,16 +1,13 @@ --- title: 'Integrations' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to --- - ## Compatible third-party integrations - ## LayerZero OFT - -## xERC20 Gateway \ No newline at end of file +## xERC20 Gateway diff --git a/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx b/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx index 218bb756b9..332355f399 100644 --- a/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx +++ b/arbitrum-docs/launch-orbit-chain/07-orbit-node-runners/orbit-node-providers.mdx @@ -1,7 +1,7 @@ --- title: 'Orbit Node Providers' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx index d9d5c4cb43..d204e3af79 100644 --- a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx +++ b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/01-orbit-portal.mdx @@ -1,7 +1,7 @@ --- title: 'Orbit Portal' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- diff --git a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx index 2b944d224c..fc78418e36 100644 --- a/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx +++ b/arbitrum-docs/launch-orbit-chain/08-ecosystem-support/03-get-listed-orbit-platforms.mdx @@ -1,7 +1,7 @@ --- title: 'Get listed on Orbit platforms' description: 'PLACEHOLDER' -author: -sme: +author: +sme: content_type: how-to ---- \ No newline at end of file +--- From 181ba285e0777009f91c0734b5c8fd6b147613e8 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 18 Dec 2024 15:53:12 -0600 Subject: [PATCH 27/88] modified sidebars.js --- .../02-customizable-challenge-period.mdx | 2 +- website/sidebars.js | 315 ++++++++---------- 2 files changed, 147 insertions(+), 170 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx index d0ad2ce724..8e30e8075a 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx @@ -1,6 +1,6 @@ --- title: 'Customizable Challenge Period' -description: 'Learn how to customize your Orbit chain's challenge period' +description: "Learn how to customize your Orbit chain's challenge period" author: sme: content_type: how-to diff --git a/website/sidebars.js b/website/sidebars.js index 61941e555e..fa5881b925 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -237,12 +237,12 @@ const sidebars = { items: [ { type: 'doc', - id: 'launch-orbit-chain/orbit-gentle-introduction', + id: 'launch-orbit-chain/a-gentle-introduction', label: 'A gentle introduction', }, { type: 'doc', - id: 'launch-orbit-chain/orbit-start-your-journey', + id: 'launch-orbit-chain/start-your-journey', label: 'Start your journey', }, { @@ -255,67 +255,87 @@ const sidebars = { label: 'Configure your chain', collapsed: true, items: [ - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/how-to-configure-your-chain', - label: 'how-to-configure-your-chain', - }, - { - type: 'doc', - id: 'launch-orbit-chain/reference/orbit-configuration-parameters', - label: `Orbit configuration parameters`, - }, { type: 'category', - label: 'Core configuration', + label: 'Common configuration', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/reference/orbit-sequencer-configuration', - label: 'orbit-sequencer-configuration', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/use-a-custom-gas-token', + label: `Use a custom gas token`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/customizable-challenge-period', + label: `Customizable challenge period`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/stake-and-validator-configurations', + label: `Stake and validator configurations`, }, { type: 'doc', - id: 'launch-orbit-chain/reference/orbit-batch-poster-configuration', - label: 'orbit-batch-poster-configuration', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/arbos-configuration', + label: `ArbOS configuration`, }, { type: 'doc', - id: 'launch-orbit-chain/reference/orbit-fast-block-times', - label: 'orbit-fast-block-times', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/gas-optimization-tools', + label: `Gas optimization tools`, }, { type: 'doc', - id: 'launch-orbit-chain/reference/orbit-smart-contract-size-limit', - label: 'smart contract size limit', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/fee-management', + label: `Fee management`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/calculate-aep-fees', - label: `Calculate AEP license fees`, + id: 'launch-orbit-chain/configure-your-chain/common-configurations/batch-posting-assertion-control', + label: `Batch posting and assertion control`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/sequencer-timing-adjustments', + label: `Sequencer timing adjustments`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/per-batch-gas-cost', + label: `Per batch gas cost`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/smart-contract-size-limit', + label: `Smart contract size limit`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/configure-your-chain/common-configurations/customizing-anytrust', + label: `Customizing AnyTrust`, }, ], }, { type: 'category', - label: 'AEP fee router', + label: 'Advanced configuration', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/aep-fee-router-introduction', - label: `AEP fee router overview`, + id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/layer-leap', + label: `Layer Leap`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', - label: `Set up AEP fee router`, + id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/fast-withdrawals', + label: `Fast withdrawals`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/calculate-aep-fees', - label: `Calculate AEP license fees`, + id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/aep-fee-router', + label: `AEP fee router`, }, ], }, @@ -323,230 +343,187 @@ const sidebars = { }, { type: 'category', - label: 'Guidance for Orbit chain operators', + label: 'Deploy an orbit Chain', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-managing-state-growth', - label: `Manage gas state growth`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/configuring-orbit-chain', + label: `Configuring an Orbit chain`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit', - label: `Manage gas speed limit`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-rollup-chain', + label: `Deploying a Rollup chain`, }, - ], - }, - { - type: 'category', - label: 'Production Orbit chain setup', - collapsed: true, - items: [ { type: 'doc', - id: 'launch-orbit-chain/orbit-sdk-introduction', - label: `Introduction`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-anytrust-chain', + label: `Deploying an AnyTrust chain`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain', - label: `Rollup Orbit Deployment`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-custom-gas-token-chain', + label: `Deploying a custom gas token chain`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain', - label: `AnyTrust Orbit Deployment`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-token-bridge', + label: `Deploying a token bridge`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain', - label: `Custom Gas Token Orbit Deployment`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/monitoring-tools-and-considerations', + label: `Monitoring tools and considerations`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-preparing-node-config', - label: `Node Config Generation`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge', - label: `Token bridge deployment`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain', - label: `Orbit Chain Configuration`, + id: 'launch-orbit-chain/deploy-an-orbit-chain/canonical-factory-contracts', + label: `Canonical factory contracts`, }, ], }, { type: 'category', - label: 'Customize your chain', + label: 'Maintain your chain', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-deployment-configuration', - label: `Customize your chain's deployment`, + id: 'launch-orbit-chain/maintain-your-chain/bridging', + label: `Bridging`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/use-a-custom-gas-token', - label: `Use a custom gas token`, + id: 'launch-orbit-chain/maintain-your-chain/monitoring', + label: `Monitoring`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-precompile', - label: `Customize your chain's precompiles`, + id: 'launch-orbit-chain/maintain-your-chain/ownership-structure-access-control', + label: `Ownership structure access control`, }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-stf', - label: `Customize your chain's behavior`, + { + type: 'category', + label: 'Guidance', + collapsed: true, + items: [ + { + type: 'doc', + id: 'launch-orbit-chain/maintain-your-chain/guidance/decentralization-security', + label: `Decentralization security`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/maintain-your-chain/guidance/guidance-on-altda', + label: `Guidance on AltDA`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/maintain-your-chain/guidance/state-growth', + label: `State growth`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/maintain-your-chain/guidance/state-size-limit', + label: `State size limit`, + }, + ], }, + ], + }, + { + type: 'category', + label: 'Customize your chain', + collapsed: true, + items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/orbit-chain-finality', - label: `Configure delayed inbox finality`, + id: 'launch-orbit-chain/customize-your-chain/customize-arbos', + label: `Customize ArbOS`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/manage-fee-collectors', - label: `Manage the fee collectors`, + id: 'launch-orbit-chain/customize-your-chain/customize-precompile', + label: `Customize precompiles`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/customize-arbos', - label: `Customize ArbOS version`, + id: 'launch-orbit-chain/customize-your-chain/customize-stf', + label: `Customize STF`, }, + ], + }, + { + type: 'category', + label: 'Third-party Integrations', + collapsed: true, + items: [ { type: 'doc', - id: 'launch-orbit-chain/how-tos/usdc-standard-bridge', - label: `Implement Circle bridged USDC`, + id: 'launch-orbit-chain/third-party-integrations/bridged-usdc-standard', + label: `Bridged USDC standard`, }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/fast-withdrawals', - label: `Enable fast withdrawals`, + id: 'launch-orbit-chain/third-party-integrations/third-party-providers', + label: `Third party providers`, }, { - type: 'category', - label: 'AEP fee router', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/aep-fee-router-introduction', - label: `AEP fee router overview`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', - label: `Set up AEP fee router`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/calculate-aep-fees', - label: `Calculate AEP license fees`, - }, - ], + type: 'doc', + id: 'launch-orbit-chain/third-party-integrations/integrations', + label: `Integrations`, }, ], }, { type: 'category', - label: 'ArbOS', + label: 'Orbit node runners', collapsed: true, items: [ - { - type: 'html', - value: - 'ArbOS software releases', - // q: why use an anchor html tag here? - // a: see note at end of file - }, { type: 'doc', - id: 'launch-orbit-chain/how-tos/arbos-upgrade', - label: `Upgrade ArbOS`, + id: 'launch-orbit-chain/orbit-node-runners/orbit-node-providers', + label: `Orbit node providers`, }, ], }, { type: 'category', - label: 'Data Availability Committees', + label: 'Ecosystem support', collapsed: true, items: [ { type: 'doc', - id: 'run-arbitrum-node/data-availability-committees/get-started', - label: 'Get started', + id: 'launch-orbit-chain/ecosystem-support/orbit-portal', + label: `Orbit portal`, }, { type: 'doc', - id: 'run-arbitrum-node/data-availability-committees/deploy-das', - label: 'Deploy a Data Availability Server (DAS)', + id: 'launch-orbit-chain/ecosystem-support/add-orbit-chain-to-bridge-ui', + label: `Add Orbit chain to bridge UI`, }, { type: 'doc', - id: 'run-arbitrum-node/data-availability-committees/deploy-mirror-das', - label: 'Deploy a mirror Data Availability Server', + id: 'launch-orbit-chain/ecosystem-support/get-listed-orbit-platforms', + label: `Get listed Orbit platforms`, }, + ], + }, + { + type: 'category', + label: 'FAQ and Troubleshooting', + collapsed: true, + items: [ { type: 'doc', - id: 'run-arbitrum-node/data-availability-committees/configure-dac', - label: 'Configure a Data Availability Committee (DAC)', + id: 'launch-orbit-chain/faq-troubleshooting/troubleshooting-building-orbit', + label: `Troubleshooting building Orbit`, }, ], }, - { - type: 'html', - value: - 'Add new validators to Orbit chain ↓', - // q: why use an anchor html tag here? - // a: see note at end of file - }, - { - type: 'doc', - id: 'launch-orbit-chain/reference/monitoring-tools-and-considerations', - label: 'Monitoring tools and considerations', - }, - { - type: 'doc', - id: 'node-running/how-tos/running-an-orbit-node', - label: 'Run a full Orbit node', - }, - { - type: 'doc', - id: 'launch-orbit-chain/how-tos/add-orbit-chain-to-bridge-ui', - label: `Add your chain to the bridge`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/concepts/chain-ownership', - label: 'Orbit chain ownership', - }, - { - type: 'doc', - id: 'launch-orbit-chain/concepts/custom-gas-token-sdk', - label: 'Custom gas token SDK', - }, - { - type: 'doc', - id: 'launch-orbit-chain/concepts/public-preview-expectations', - label: 'Public preview', - }, - { - type: 'doc', - id: 'launch-orbit-chain/infra-options-orbit-chains', - label: 'Third-party infrastructure providers', - }, - { - type: 'doc', - id: 'launch-orbit-chain/troubleshooting-building-orbit', - label: 'FAQ', - }, + + ], }, { From 3698c7d0a326522f880ad658209009c8c6032dde Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 18 Dec 2024 16:09:27 -0600 Subject: [PATCH 28/88] fixing some broken links --- .../03-deploying-anytrust-chain.md | 2 +- .../04-deploying-custom-gas-token-chain.md | 2 +- .../05-customize-your-chain/customize-precompile.mdx | 2 +- .../01-bridged-usdc-standard.md | 2 +- arbitrum-docs/launch-orbit-chain/orbit-quickstart.md | 4 ++-- .../launch-orbit-chain/orbit-sdk-introduction.md | 8 ++++---- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md index 5585432344..ddc762a804 100644 --- a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md +++ b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md @@ -30,7 +30,7 @@ AnyTrust chains implement the Arbitrum AnyTrust protocol, an alternative to the ### Deployment steps -The deployment process of AnyTrust chains is very similar to that of [Rollup chains](orbit-sdk-deploying-rollup-chain.md#rollup-config-param), but with some differences that we'll discuss in this guide. +The deployment process of AnyTrust chains is very similar to that of [Rollup chains](02-deploying-a-rollup-chain.md#rollup-config-param), but with some differences that we'll discuss in this guide. Here are the steps involved in the deployment process: diff --git a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md index 05751ecf55..bb1be432c8 100644 --- a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md +++ b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md @@ -24,7 +24,7 @@ See the ["create a rollup custom fee token" example](https://github.com/Offchain This guide will help you configure and deploy a custom gas token Orbit chain. -Custom gas token orbit chains let participants pay transaction fees in `ERC-20` token instead of `ETH`, which is ideal for use cases requiring this feature and low transaction fees. You can learn more on our page covering [custom gas token requirements and configuration](use-a-custom-gas-token.mdx). +Custom gas token orbit chains let participants pay transaction fees in `ERC-20` token instead of `ETH`, which is ideal for use cases requiring this feature and low transaction fees. You can learn more on our page covering [custom gas token requirements and configuration](./launch-orbit-chain/configure-your-chain/common-configurations/01-use-a-custom-gas-token.mdx). Deploying a custom gas token Orbit chain is similar to deploying an AnyTrust Orbit chain but with additional steps. To take advantage of all the chains configurations supported by Orbit, we recommend reading our short guides about [Rollup](orbit-sdk-deploying-rollup-chain.md) and [AnyTrust](orbit-sdk-deploying-anytrust-chain.md) configuration. diff --git a/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx b/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx index 717953e6f8..2ccd1059c7 100644 --- a/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx +++ b/arbitrum-docs/launch-orbit-chain/05-customize-your-chain/customize-precompile.mdx @@ -14,7 +14,7 @@ import CustomizeCautionBannerPartial from '../partials/_orbit-customize-caution- The guidance in this document will only work if you use `eth_call` to call the new precompiles. If you call them from other contracts or add non-view/pure methods, this approach will break the block validation. -To support these additional use-cases, follow the instructions described in [How to customize your Orbit chain's behavior](/launch-orbit-chain/how-tos/customize-stf.mdx). +To support these additional use-cases, follow the instructions described in [How to customize your Orbit chain's behavior](/launch-orbit-chain/customize-your-chain/customize-stf.mdx). ::: diff --git a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md index 40a3c97144..7a5949dadf 100644 --- a/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md +++ b/arbitrum-docs/launch-orbit-chain/06-third-party-integrations/01-bridged-usdc-standard.md @@ -40,7 +40,7 @@ Other requirements: - It is assumed there is already a USDC token deployed and used on the parent chain. - Also, it is assumed that the standard Orbit chain ownership system is used, i.e., `UpgradeExecutor` is the owner of the `ownable` contracts, and there is an EOA or multi-sig that has the executor role on the `UpgradeExecutor`. -- Refer to the [token bridge overview page](/launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge.md) for more information about the token bridge design and operational dynamics. You can learn more in our [overview of gateways operating models](/build-decentralized-apps/token-bridging/token-bridge-erc20#other-flavors-of-gateways). +- Refer to the [token bridge overview page](/launch-orbit-chain/deploy-an-orbit-chain/deploying-token-bridge.md) for more information about the token bridge design and operational dynamics. You can learn more in our [overview of gateways operating models](/build-decentralized-apps/token-bridging/token-bridge-erc20#other-flavors-of-gateways). ## Deployment steps diff --git a/arbitrum-docs/launch-orbit-chain/orbit-quickstart.md b/arbitrum-docs/launch-orbit-chain/orbit-quickstart.md index 134650ec0b..1d1365e350 100644 --- a/arbitrum-docs/launch-orbit-chain/orbit-quickstart.md +++ b/arbitrum-docs/launch-orbit-chain/orbit-quickstart.md @@ -18,7 +18,7 @@ This quickstart is intended for development purposes only and is not suitable fo By the end of this quickstart, you'll have a **local devnet chain** that hosts EVM-compatible smart contracts. Your chain will process transactions locally while settling to the public **Arbitrum Sepolia testnet**. Familiarity with Ethereum, Ethereum's testnets, and Arbitrum is expected. -If you're looking for a conceptual introduction to Orbit chains, see the [Gentle introduction to Orbit chains](/launch-orbit-chain/orbit-gentle-introduction.md). +If you're looking for a conceptual introduction to Orbit chains, see the [Gentle introduction to Orbit chains](/launch-orbit-chain/01-a-gentle-introduction.md). ## Prerequisites @@ -64,7 +64,7 @@ import { PlaceholderForm } from '/src/components/PlaceholderForm/PlaceholderForm -The below table provides a brief description of each of these configuration parameters. We recommend sticking to the defaults; to learn more about customizing your Orbit chain's deployment configuration, visit [How (and when) to customize your Orbit chain's deployment config](./how-tos/customize-deployment-configuration.md): +The below table provides a brief description of each of these configuration parameters. We recommend sticking to the defaults; to learn more about customizing your Orbit chain's deployment configuration, visit [How (and when) to customize your Orbit chain's deployment config](/configure-your-chain/use-a-custom-gas-token.mdx): diff --git a/arbitrum-docs/launch-orbit-chain/orbit-sdk-introduction.md b/arbitrum-docs/launch-orbit-chain/orbit-sdk-introduction.md index d739fa6900..bd80b55e30 100644 --- a/arbitrum-docs/launch-orbit-chain/orbit-sdk-introduction.md +++ b/arbitrum-docs/launch-orbit-chain/orbit-sdk-introduction.md @@ -27,9 +27,9 @@ There are three types of Orbit chains. Review the following table to determine w After selecting a chain type, you need to deploy your Orbit chain. Visit the deployment guide for your selected chain type: -- [Deploy a Rollup Orbit chain](/launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain.md) -- [Deploy an AnyTrust Orbit chain](/launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain.md) -- [Deploy a Custom Gas Token Orbit chain](/launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain.md) +- [Deploy a Rollup Orbit chain](/launch-orbit-chain/deploy-an-orbit-chain/02-deploying-rollup-chain.md) +- [Deploy an AnyTrust Orbit chain](/launch-orbit-chain/deploy-an-orbit-chain/03-deploying-anytrust-chain.md) +- [Deploy a Custom Gas Token Orbit chain](/launch-orbit-chain/deploy-an-orbit-chain/04-deploying-custom-gas-token-chain.md) ## 3. Configure your Orbit chain's node @@ -37,7 +37,7 @@ After selecting a chain type, you need to specify your Orbit chain's node config ## 4. Deploy your Orbit chain's token bridge -Your Orbit chain's token bridge contracts allow ERC-20 tokens to move between your Orbit chain and its underlying parent chain. See [Deploy your Orbit chain's token bridge](/launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge.md), then proceed to the next step. +Your Orbit chain's token bridge contracts allow ERC-20 tokens to move between your Orbit chain and its underlying parent chain. See [Deploy your Orbit chain's token bridge](/launch-orbit-chain/deploy-an-orbit-chain/05-deploying-token-bridge.md), then proceed to the next step. ## 5. Configure your Orbit chain From 425f0e9069ea7c9066b3a67a3dd87cc95d9db010 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 18 Dec 2024 16:09:52 -0600 Subject: [PATCH 29/88] yarn format --- .../02-customizable-challenge-period.mdx | 4 ++-- website/sidebars.js | 12 +++++------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx index 8e30e8075a..eb25ed688c 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx @@ -1,8 +1,8 @@ --- title: 'Customizable Challenge Period' description: "Learn how to customize your Orbit chain's challenge period" -author: -sme: +author: +sme: content_type: how-to --- diff --git a/website/sidebars.js b/website/sidebars.js index fa5881b925..fcb4a445c4 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -403,11 +403,11 @@ const sidebars = { id: 'launch-orbit-chain/maintain-your-chain/ownership-structure-access-control', label: `Ownership structure access control`, }, - { - type: 'category', - label: 'Guidance', - collapsed: true, - items: [ + { + type: 'category', + label: 'Guidance', + collapsed: true, + items: [ { type: 'doc', id: 'launch-orbit-chain/maintain-your-chain/guidance/decentralization-security', @@ -522,8 +522,6 @@ const sidebars = { }, ], }, - - ], }, { From fc4fe7e32ae0668a520e07a13aeb8fc1f5191748 Mon Sep 17 00:00:00 2001 From: Mahsa Moosavi Date: Mon, 6 Jan 2025 15:16:01 -0500 Subject: [PATCH 30/88] customizable challenge period --- .../02-customizable-challenge-period.mdx | 59 +++++++++++++++++-- 1 file changed, 54 insertions(+), 5 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx index eb25ed688c..8f776035b0 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx @@ -1,10 +1,59 @@ --- -title: 'Customizable Challenge Period' +title: 'Customizable challenge period' description: "Learn how to customize your Orbit chain's challenge period" -author: -sme: +author: 'mahsamoosavi' +sme: 'mahsamoosavi' 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. +The challenge period defines the time frame during which state updates (assertions) submitted to a child chain remain open for scrutiny and potential challenges before they are finalized. This mechanism ensures that participants in the system—whether on a rollup or an AnyTrust Orbit chain—have the opportunity to verify the validity of state updates and raise challenges if necessary. + +The length of the challenge period is measured in parent chain blocks, allowing for a predictable and flexible configuration regardless of the use case. + +In addition to the main challenge period, an **extra challenge period** provides a buffer that allows for the resolution of any pending challenges after the main period ends. Together, these parameters form the foundation for balancing security and transaction finality. + +### Default challenge period and extra challenge period + +By default, the challenge period lasts approximately one week, corresponding to 45,818 blocks on the parent chain. This default is designed to provide sufficient time for validators to detect and challenge fraudulent assertions. + +The extra challenge period, on the other hand, adds a buffer of 200 parent chain blocks (approximately 40 minutes). This ensures that any last-minute challenges or ongoing dispute resolution processes can be completed before the rollup finalizes its state. + +These default values are carefully chosen to balance security and performance for most rollup use cases. However, developers and Orbit chain owners may wish to customize these parameters to suit their specific requirements. + +### Customizing the challenge period + +#### Challenge period blocks + +The main challenge period is configured using the `confirmPeriodBlocks` parameter, which specifies the duration of the challenge window in terms of parent chain blocks. This parameter can be customized in two ways: + +1. **During deployment**: Developers can specify the desired value in the `confirmPeriodBlocks` field of the RollupCreator configuration when deploying the rollup. +2. **Post-deployment**: The rollup admin can update this value dynamically by calling the `Rollup.setConfirmPeriodBlocks(newValue)` function. + +For example, setting `confirmPeriodBlocks` to 30,000 blocks reduces the challenge period to approximately 4.5 days. This might be suitable for applications prioritizing faster finality, while increasing the value would extend the challenge period, enhancing security. + + +#### Extra challenge period blocks + +The extra challenge period is governed by the `extraChallengeTimeBlocks` parameter, which defines the additional buffer duration after the main challenge period. This parameter ensures that any pending challenges are processed before the rollup state is finalized. Like the main challenge period, it can be customized in two ways: + +1. **During deployment**: The value can be set in the `extraChallengeTimeBlocks` field of the RollupCreator configuration. +2. **Post-deployment**: The rollup admin can dynamically adjust the parameter using the `Rollup.setExtraChallengeTimeBlocks(newExtraTimeBlocks)` function. For example: + + ```solidity + RollupAdminLogic.setExtraChallengeTimeBlocks(300); + ``` + This would set the extra challenge period to 300 parent chain blocks. + +The default value of 200 blocks provides a short but sufficient buffer for most networks. However, developers may increase this value for applications that require additional time for dispute resolution or operate in environments with higher latency between the parent and child chain. + +### Recommended values and best practices + +For Orbit chaibs aligned with Arbitrum One's configuration, the recommended settings are: + +- **Challenge period blocks**: 45,818 parent chain blocks (approximately one week). +- **Extra challenge period blocks**: 200 parent chain blocks (approximately 40 minutes). + +These values offer a robust and balanced setup for most rollup use cases. Developers should consider their application’s requirements when adjusting these parameters: + +- **Shorter periods**: Suitable for use cases demanding faster transaction finality, such as high-frequency trading or gaming platforms. +- **Longer periods**: Recommended for applications that require higher security, such as cross-chain asset transfers or large-value transactions. \ No newline at end of file From 7e022e58c6982577aea78138678e0e435ef01e94 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 8 Jan 2025 11:06:23 -0600 Subject: [PATCH 31/88] restoring to sidebars.js from master --- website/sidebars.js | 720 +++++++++++++++++++------------------------- 1 file changed, 308 insertions(+), 412 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index fcb4a445c4..137084e690 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,7 +1,8 @@ // @ts-check const sdkDocsSidebar = require('../arbitrum-docs/sdk/sidebar.js'); -const stylusByExampleDocsSidebar = require('../arbitrum-docs/stylus-by-example/sidebar.js'); +const stylusByExampleDocsSidebarSDK = require('../arbitrum-docs/stylus-by-example/basic_examples/sidebar.js'); +const stylusByExampleDocsSidebarExamples = require('../arbitrum-docs/stylus-by-example/applications/sidebar.js'); /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { @@ -237,196 +238,152 @@ const sidebars = { items: [ { type: 'doc', - id: 'launch-orbit-chain/a-gentle-introduction', + id: 'launch-orbit-chain/orbit-gentle-introduction', label: 'A gentle introduction', }, { type: 'doc', - id: 'launch-orbit-chain/start-your-journey', - label: 'Start your journey', + id: 'launch-orbit-chain/orbit-quickstart', + label: 'Quickstart', }, { type: 'doc', - id: 'launch-orbit-chain/orbit-license', - label: 'Orbit license', + id: 'launch-orbit-chain/aep-license', + label: 'Orbit licensing', }, { type: 'category', - label: 'Configure your chain', + label: 'Guidance for Orbit chain operators', collapsed: true, items: [ { - type: 'category', - label: 'Common configuration', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/use-a-custom-gas-token', - label: `Use a custom gas token`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/customizable-challenge-period', - label: `Customizable challenge period`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/stake-and-validator-configurations', - label: `Stake and validator configurations`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/arbos-configuration', - label: `ArbOS configuration`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/gas-optimization-tools', - label: `Gas optimization tools`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/fee-management', - label: `Fee management`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/batch-posting-assertion-control', - label: `Batch posting and assertion control`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/sequencer-timing-adjustments', - label: `Sequencer timing adjustments`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/per-batch-gas-cost', - label: `Per batch gas cost`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/smart-contract-size-limit', - label: `Smart contract size limit`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/common-configurations/customizing-anytrust', - label: `Customizing AnyTrust`, - }, - ], + type: 'doc', + id: 'launch-orbit-chain/how-tos/orbit-managing-state-growth', + label: `Manage gas state growth`, }, { - type: 'category', - label: 'Advanced configuration', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/layer-leap', - label: `Layer Leap`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/fast-withdrawals', - label: `Fast withdrawals`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/configure-your-chain/advanced-configurations/aep-fee-router', - label: `AEP fee router`, - }, - ], + type: 'doc', + id: 'launch-orbit-chain/how-tos/orbit-managing-gas-speed-limit', + label: `Manage gas speed limit`, }, ], }, { type: 'category', - label: 'Deploy an orbit Chain', + label: 'Production Orbit chain setup', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/configuring-orbit-chain', - label: `Configuring an Orbit chain`, + id: 'launch-orbit-chain/orbit-sdk-introduction', + label: `Introduction`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-rollup-chain', - label: `Deploying a Rollup chain`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain', + label: `Rollup Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-anytrust-chain', - label: `Deploying an AnyTrust chain`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-anytrust-chain', + label: `AnyTrust Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-custom-gas-token-chain', - label: `Deploying a custom gas token chain`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-custom-gas-token-chain', + label: `Custom Gas Token Orbit Deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/deploying-token-bridge', - label: `Deploying a token bridge`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-preparing-node-config', + label: `Node Config Generation`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/monitoring-tools-and-considerations', - label: `Monitoring tools and considerations`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-deploying-token-bridge', + label: `Token bridge deployment`, }, { type: 'doc', - id: 'launch-orbit-chain/deploy-an-orbit-chain/canonical-factory-contracts', - label: `Canonical factory contracts`, + id: 'launch-orbit-chain/how-tos/orbit-sdk-configuring-orbit-chain', + label: `Orbit Chain Configuration`, }, ], }, { type: 'category', - label: 'Maintain your chain', + label: 'Customize your chain', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/bridging', - label: `Bridging`, + id: 'launch-orbit-chain/how-tos/customize-deployment-configuration', + label: `Customize your chain's deployment`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/reference/additional-configuration-parameters', + label: `Additional configuration parameters`, }, { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/monitoring', - label: `Monitoring`, + id: 'launch-orbit-chain/how-tos/use-a-custom-gas-token', + label: `Use a custom gas token`, }, { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/ownership-structure-access-control', - label: `Ownership structure access control`, + id: 'launch-orbit-chain/how-tos/customize-precompile', + label: `Customize your chain's precompiles`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-stf', + label: `Customize your chain's behavior`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/orbit-chain-finality', + label: `Configure delayed inbox finality`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/manage-fee-collectors', + label: `Manage the fee collectors`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/customize-arbos', + label: `Customize ArbOS version`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/usdc-standard-bridge', + label: `Implement Circle bridged USDC`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/fast-withdrawals', + label: `Enable fast withdrawals`, }, { type: 'category', - label: 'Guidance', + label: 'AEP fee router', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/guidance/decentralization-security', - label: `Decentralization security`, + id: 'launch-orbit-chain/aep-fee-router-introduction', + label: `AEP fee router overview`, }, { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/guidance/guidance-on-altda', - label: `Guidance on AltDA`, + id: 'launch-orbit-chain/how-tos/set-up-aep-fee-router', + label: `Set up AEP fee router`, }, { type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/guidance/state-growth', - label: `State growth`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/maintain-your-chain/guidance/state-size-limit', - label: `State size limit`, + id: 'launch-orbit-chain/how-tos/calculate-aep-fees', + label: `Calculate AEP license fees`, }, ], }, @@ -434,99 +391,107 @@ const sidebars = { }, { type: 'category', - label: 'Customize your chain', + label: 'ArbOS', collapsed: true, items: [ { - type: 'doc', - id: 'launch-orbit-chain/customize-your-chain/customize-arbos', - label: `Customize ArbOS`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/customize-your-chain/customize-precompile', - label: `Customize precompiles`, + type: 'html', + value: + 'ArbOS software releases', + // q: why use an anchor html tag here? + // a: see note at end of file }, { type: 'doc', - id: 'launch-orbit-chain/customize-your-chain/customize-stf', - label: `Customize STF`, + id: 'launch-orbit-chain/how-tos/arbos-upgrade', + label: `Upgrade ArbOS`, }, ], }, { type: 'category', - label: 'Third-party Integrations', + label: 'Data Availability Committees', collapsed: true, items: [ { type: 'doc', - id: 'launch-orbit-chain/third-party-integrations/bridged-usdc-standard', - label: `Bridged USDC standard`, + id: 'run-arbitrum-node/data-availability-committees/get-started', + label: 'Get started', }, { type: 'doc', - id: 'launch-orbit-chain/third-party-integrations/third-party-providers', - label: `Third party providers`, + id: 'run-arbitrum-node/data-availability-committees/deploy-das', + label: 'Deploy a Data Availability Server (DAS)', }, { type: 'doc', - id: 'launch-orbit-chain/third-party-integrations/integrations', - label: `Integrations`, + id: 'run-arbitrum-node/data-availability-committees/deploy-mirror-das', + label: 'Deploy a mirror Data Availability Server', }, - ], - }, - { - type: 'category', - label: 'Orbit node runners', - collapsed: true, - items: [ { type: 'doc', - id: 'launch-orbit-chain/orbit-node-runners/orbit-node-providers', - label: `Orbit node providers`, + id: 'run-arbitrum-node/data-availability-committees/configure-dac', + label: 'Configure a Data Availability Committee (DAC)', }, ], }, { - type: 'category', - label: 'Ecosystem support', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/ecosystem-support/orbit-portal', - label: `Orbit portal`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/ecosystem-support/add-orbit-chain-to-bridge-ui', - label: `Add Orbit chain to bridge UI`, - }, - { - type: 'doc', - id: 'launch-orbit-chain/ecosystem-support/get-listed-orbit-platforms', - label: `Get listed Orbit platforms`, - }, - ], + type: 'html', + value: + 'Add new validators to Orbit chain ↓', + // q: why use an anchor html tag here? + // a: see note at end of file }, { - type: 'category', - label: 'FAQ and Troubleshooting', - collapsed: true, - items: [ - { - type: 'doc', - id: 'launch-orbit-chain/faq-troubleshooting/troubleshooting-building-orbit', - label: `Troubleshooting building Orbit`, - }, - ], + type: 'doc', + id: 'launch-orbit-chain/reference/monitoring-tools-and-considerations', + label: 'Monitoring tools and considerations', + }, + { + type: 'doc', + id: 'node-running/how-tos/running-an-orbit-node', + label: 'Run a full Orbit node', + }, + { + type: 'doc', + id: 'launch-orbit-chain/how-tos/add-orbit-chain-to-bridge-ui', + label: `Add your chain to the bridge`, + }, + { + type: 'doc', + id: 'launch-orbit-chain/concepts/chain-ownership', + label: 'Orbit chain ownership', + }, + { + type: 'doc', + id: 'launch-orbit-chain/concepts/custom-gas-token-sdk', + label: 'Custom gas token SDK', + }, + { + type: 'doc', + id: 'launch-orbit-chain/bold-adoption-for-orbit-chains', + label: 'BoLD for Orbit chains', + }, + { + type: 'doc', + id: 'launch-orbit-chain/concepts/public-preview-expectations', + label: 'Public preview', + }, + { + type: 'doc', + id: 'launch-orbit-chain/infra-options-orbit-chains', + label: 'Third-party infrastructure providers', + }, + { + type: 'doc', + id: 'launch-orbit-chain/troubleshooting-building-orbit', + label: 'FAQ', }, ], }, { type: 'category', - label: 'Write Stylus contracts', + label: 'Write Stylus Contracts', collapsed: true, link: { type: 'doc', @@ -535,27 +500,17 @@ const sidebars = { items: [ { type: 'doc', - id: 'stylus/stylus-gentle-introduction', + id: 'stylus/gentle-introduction', label: 'A gentle introduction', }, { type: 'doc', - id: 'stylus/stylus-quickstart', - label: 'Quickstart (Rust)', - }, - { - type: 'doc', - id: 'for-devs/dev-tools-and-resources/chain-info', - label: 'Chain info', - }, - { - type: 'doc', - label: 'Arbiscan contract verification', - id: 'stylus/how-tos/verifying-contracts-arbiscan', + id: 'stylus/quickstart', + label: 'Quickstart', }, { type: 'category', - label: 'Stylus Rust SDK', + label: 'Rust SDK', collapsed: true, items: [ { @@ -563,120 +518,127 @@ const sidebars = { id: 'stylus/reference/overview', label: 'Overview', }, - ...stylusByExampleDocsSidebar, - { - type: 'doc', - id: 'stylus/recommended-libraries', - label: 'Recommended libraries', - }, + ...stylusByExampleDocsSidebarSDK, { type: 'doc', id: 'stylus/reference/rust-sdk-guide', label: 'Advanced features', }, - { - type: 'link', - label: 'Rust crate docs', - href: 'https://docs.rs/stylus-sdk/latest/stylus_sdk/index.html', - }, - { - type: 'link', - label: 'Stylus by example', - href: 'https://stylus-by-example.org/', - }, ], }, { type: 'category', - label: 'Gas, ink and caching', + label: 'Rust CLI', collapsed: true, items: [ { type: 'doc', + id: 'stylus/using-cli', label: 'Overview', - id: 'stylus/concepts/stylus-gas', }, { type: 'doc', - id: 'stylus/reference/opcode-hostio-pricing', - label: 'Gas and ink costs', + id: 'stylus/how-tos/debugging-tx', + label: 'Debug transactions', }, { type: 'doc', - id: 'stylus/concepts/stylus-cache-manager', - label: 'Caching strategy', + id: 'stylus/how-tos/verifying-contracts', + label: 'Verify contracts', }, - ], - }, - { - type: 'category', - label: 'CLI tools (cargo-stylus)', - collapsed: true, - items: [ { type: 'doc', - label: 'Overview', - id: 'stylus/cli-tools-overview', + id: 'stylus/how-tos/caching-contracts', + label: 'Cache contracts', }, { type: 'doc', - label: 'Optimize WASM binaries', - id: 'stylus/how-tos/optimizing-binaries', + id: 'stylus/how-tos/verifying-contracts-arbiscan', + label: 'Verify on Arbiscan', }, { type: 'doc', - label: 'Debug Stylus transactions', - id: 'stylus/how-tos/debugging-stylus-tx', + id: 'stylus/how-tos/optimizing-binaries', + label: 'Optimize WASM binaries', }, + ], + }, + { + type: 'html', + value: + 'Run a local dev node↑', + }, + { + type: 'category', + label: 'Concepts', + collapsed: true, + items: [ { type: 'doc', - label: 'Verify Stylus contracts', - id: 'stylus/how-tos/verifying-contracts', + id: 'stylus/concepts/how-it-works', + label: 'Architecture overview', }, { - type: 'link', - label: 'cargo-stylus repository', - href: 'https://github.com/OffchainLabs/cargo-stylus', + type: 'doc', + id: 'stylus/concepts/gas-metering', + label: 'Gas metering', }, ], }, { - type: 'html', - value: - 'Run a Stylus dev node↑', - // q: why use an anchor html tag here?/node-running/how-tos/running-an-stylus-node - // a: see note at end of file + type: 'category', + label: 'Examples', + collapsed: true, + items: [ + ...stylusByExampleDocsSidebarExamples, + { + type: 'link', + label: 'Awesome Stylus', + href: 'https://github.com/OffchainLabs/awesome-stylus', + }, + ], }, { type: 'category', - label: 'Other supported languages', + label: 'Reference', collapsed: true, - link: { - type: 'doc', - id: 'stylus/reference/other-language-frameworks', - }, items: [ + { + type: 'html', + value: + 'Chain Info↑', + }, { type: 'doc', - label: 'Add a new smart contract language', - id: 'stylus/how-tos/adding-support-for-new-languages', + id: 'stylus/reference/opcode-hostio-pricing', + label: 'Gas & Ink Pricing', + }, + { + type: 'link', + label: 'Cargo Stylus CLI GitHub', + href: 'https://github.com/OffchainLabs/cargo-stylus', + }, + { + type: 'link', + label: 'Rust SDK Crate', + href: 'https://docs.rs/stylus-sdk/latest/stylus_sdk/index.html', + }, + { + type: 'link', + label: 'Source Code Repository', + href: 'https://github.com/OffchainLabs/stylus', }, ], }, { type: 'doc', - label: 'Troubleshooting', - id: 'stylus/troubleshooting-building-stylus', - }, - { - type: 'link', - label: 'Source code repository', - href: 'https://github.com/OffchainLabs/stylus', + id: 'stylus/how-tos/adding-support-for-new-languages', + label: 'Using other languages', }, { type: 'doc', - label: 'Public preview', - id: 'stylus/concepts/public-preview-expectations', + id: 'stylus/troubleshooting-building-stylus', + label: 'Troubleshooting', }, ], }, @@ -855,186 +817,120 @@ const sidebars = { collapsed: true, items: [ { - type: 'category', - label: 'Introductory concepts', - collapsed: true, - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/tx-lifecycle', - label: 'Transaction lifecycle', - }, - { - type: 'doc', - id: 'how-arbitrum-works/sequencer', - label: 'Sequencer', - }, - { - type: 'doc', - id: 'how-arbitrum-works/inside-anytrust', - label: 'AnyTrust protocol', - }, - { - type: 'category', - label: 'Gas / fees', - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/gas-fees', - label: 'L2 gas and fees', - }, - { - type: 'doc', - id: 'how-arbitrum-works/l1-gas-pricing', - label: 'L1 pricing', - }, - ], - }, - ], + type: 'doc', + id: 'how-arbitrum-works/a-gentle-introduction', + label: 'A gentle introduction', }, + { + type: 'doc', + id: 'how-arbitrum-works/transaction-lifecycle', + label: 'Sequencing, Followed by Deterministic Execution', + }, + { + type: 'doc', + id: 'how-arbitrum-works/sequencer', + label: 'The Sequencer and Censorship Resistance', + }, + { + type: 'doc', + id: 'how-arbitrum-works/geth-at-the-core', + label: 'Geth at the Core', + }, + { + type: 'doc', + id: 'how-arbitrum-works/separating-execution-from-proving', + label: 'Separating Execution from Proving', + }, + { + type: 'doc', + id: 'how-arbitrum-works/optimistic-rollup', + label: 'Optimistic Rollup', + }, + { + type: 'doc', + id: 'how-arbitrum-works/interactive-fraud-proofs', + label: 'Challenges: Interactive Fraud Proofs', + }, + { + type: 'doc', + id: 'how-arbitrum-works/anytrust-protocol', + label: 'AnyTrust protocol', + }, + { + type: 'doc', + id: 'how-arbitrum-works/gas-fees', + label: 'Gas and fees', + }, + { + type: 'doc', + id: 'how-arbitrum-works/l1-to-l2-messaging', + label: 'L1 to L2 messaging', + }, + { + type: 'doc', + id: 'how-arbitrum-works/l2-to-l1-messaging', + label: 'L2 to L1 messaging', + }, + { + type: 'link', + href: 'https://github.com/OffchainLabs/nitro/blob/master/docs/Nitro-whitepaper.pdf', + label: 'Nitro whitepaper', + }, + { type: 'category', - label: 'Advanced concepts', - collapsed: true, + label: 'The BoLD dispute protocol', items: [ { type: 'doc', - id: 'how-arbitrum-works/inside-arbitrum-nitro', - label: 'Deep dive: Inside Arbitrum', + id: 'how-arbitrum-works/bold/gentle-introduction', + label: 'A gentle introduction', + }, + { + type: 'link', + href: 'https://github.com/offchainlabs/bold-validator-starter-kit', + label: 'Deploy a validator on testnet', }, { type: 'link', - href: 'https://github.com/OffchainLabs/nitro/blob/master/docs/Nitro-whitepaper.pdf', - label: 'Deeper dive: Whitepaper', + href: 'https://arxiv.org/abs/2404.10491', + label: 'BoLD Whitepaper', }, { type: 'doc', - id: 'how-arbitrum-works/assertion-tree', - label: 'Assertion tree', + id: 'bold/concepts/bold-technical-deep-dive', + label: 'Technical deep dive', }, { type: 'doc', - id: 'how-arbitrum-works/why-nitro', - label: 'Nitro vs. Classic', + id: 'how-arbitrum-works/bold/bold-economics-of-disputes', + label: 'Economics of disputes', }, { - type: 'category', - label: 'Cross-chain messaging', - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/arbos/l1-l2-messaging', - label: 'L1-to-L2 messaging', - }, - { - type: 'doc', - id: 'how-arbitrum-works/arbos/l2-l1-messaging', - label: 'L2-to-L1 messaging', - }, - ], + type: 'link', + href: 'https://github.com/OffchainLabs/bold', + label: 'Specification on Github', }, { - type: 'category', - label: 'ArbOS', - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/arbos/introduction', - label: 'ArbOS', - }, - { - type: 'doc', - id: 'how-arbitrum-works/arbos/geth', - label: 'Geth', - }, - ], + type: 'link', + href: 'https://github.com/trailofbits/publications/blob/master/reviews/2024-04-offchainbold-securityreview.pdf', + label: 'Audit Report by Trail of Bits', }, { - type: 'category', - label: 'Fraud proofs', - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/challenge-manager', - label: 'Interactive challenges', - }, - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/osp-assumptions', - label: 'One step proof assumptions', - }, - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/wasm-wavm', - label: 'Wasm To WAVM', - }, - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/wavm-custom-opcodes', - label: 'Custom WAVM opcodes', - }, - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/wavm-floats', - label: 'WAVM floats', - }, - { - type: 'doc', - id: 'how-arbitrum-works/fraud-proofs/wavm-modules', - label: 'WAVM modules', - }, - ], + type: 'link', + href: 'https://code4rena.com/reports/2024-05-arbitrum-foundation', + label: 'Audit Report by Code4rena', }, + ], + }, + { + type: 'category', + label: 'Timeboost', + items: [ { - type: 'category', - label: 'The BoLD dispute protocol', - items: [ - { - type: 'doc', - id: 'how-arbitrum-works/bold/gentle-introduction', - label: 'A gentle introduction', - }, - { - type: 'link', - href: 'https://github.com/offchainlabs/bold-validator-starter-kit', - label: 'Deploy a validator on testnet', - }, - { - type: 'link', - href: 'https://arxiv.org/abs/2404.10491', - label: 'BoLD Whitepaper', - }, - { - type: 'doc', - id: 'bold/concepts/bold-technical-deep-dive', - label: 'Technical deep dive', - }, - { - type: 'doc', - id: 'how-arbitrum-works/bold/bold-economics-of-disputes', - label: 'Economics of disputes', - }, - { - type: 'link', - href: 'https://github.com/OffchainLabs/bold', - label: 'Specification on Github', - }, - { - type: 'link', - href: 'https://github.com/trailofbits/publications/blob/master/reviews/2024-04-offchainbold-securityreview.pdf', - label: 'Audit Report by Trail of Bits', - }, - { - type: 'link', - href: 'https://code4rena.com/reports/2024-05-arbitrum-foundation', - label: 'Audit Report by Code4rena', - }, - { - type: 'doc', - id: 'how-arbitrum-works/bold/public-preview-expectations', - label: 'Public preview', - }, - ], + type: 'doc', + id: 'how-arbitrum-works/timeboost/gentle-introduction', + label: 'Public preview', }, ], }, @@ -1132,4 +1028,4 @@ module.exports = sidebars; // because the linked page lives in multiple sidebar sections, we pick one to be the "canonical" location for the page in the sidebar // if we link to them both via id or standard href, multiple sections of the sidebar will be opened at once when the user visits this page; we don't want that // if we use a fully qualified link, the remote/published page will display when visiting from localhost or preview deployments -// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" +// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" \ No newline at end of file From cbfa0442f9546ff129fbe8183b4a58d72b236184 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 8 Jan 2025 11:07:03 -0600 Subject: [PATCH 32/88] yarn format --- .../02-customizable-challenge-period.mdx | 10 +++++----- website/sidebars.js | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx index 8f776035b0..cb8aac2f3a 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/02-customizable-challenge-period.mdx @@ -6,7 +6,7 @@ sme: 'mahsamoosavi' content_type: how-to --- -The challenge period defines the time frame during which state updates (assertions) submitted to a child chain remain open for scrutiny and potential challenges before they are finalized. This mechanism ensures that participants in the system—whether on a rollup or an AnyTrust Orbit chain—have the opportunity to verify the validity of state updates and raise challenges if necessary. +The challenge period defines the time frame during which state updates (assertions) submitted to a child chain remain open for scrutiny and potential challenges before they are finalized. This mechanism ensures that participants in the system—whether on a rollup or an AnyTrust Orbit chain—have the opportunity to verify the validity of state updates and raise challenges if necessary. The length of the challenge period is measured in parent chain blocks, allowing for a predictable and flexible configuration regardless of the use case. @@ -14,7 +14,7 @@ In addition to the main challenge period, an **extra challenge period** provides ### Default challenge period and extra challenge period -By default, the challenge period lasts approximately one week, corresponding to 45,818 blocks on the parent chain. This default is designed to provide sufficient time for validators to detect and challenge fraudulent assertions. +By default, the challenge period lasts approximately one week, corresponding to 45,818 blocks on the parent chain. This default is designed to provide sufficient time for validators to detect and challenge fraudulent assertions. The extra challenge period, on the other hand, adds a buffer of 200 parent chain blocks (approximately 40 minutes). This ensures that any last-minute challenges or ongoing dispute resolution processes can be completed before the rollup finalizes its state. @@ -31,17 +31,17 @@ The main challenge period is configured using the `confirmPeriodBlocks` paramete For example, setting `confirmPeriodBlocks` to 30,000 blocks reduces the challenge period to approximately 4.5 days. This might be suitable for applications prioritizing faster finality, while increasing the value would extend the challenge period, enhancing security. - #### Extra challenge period blocks The extra challenge period is governed by the `extraChallengeTimeBlocks` parameter, which defines the additional buffer duration after the main challenge period. This parameter ensures that any pending challenges are processed before the rollup state is finalized. Like the main challenge period, it can be customized in two ways: 1. **During deployment**: The value can be set in the `extraChallengeTimeBlocks` field of the RollupCreator configuration. 2. **Post-deployment**: The rollup admin can dynamically adjust the parameter using the `Rollup.setExtraChallengeTimeBlocks(newExtraTimeBlocks)` function. For example: - + ```solidity RollupAdminLogic.setExtraChallengeTimeBlocks(300); ``` + This would set the extra challenge period to 300 parent chain blocks. The default value of 200 blocks provides a short but sufficient buffer for most networks. However, developers may increase this value for applications that require additional time for dispute resolution or operate in environments with higher latency between the parent and child chain. @@ -56,4 +56,4 @@ For Orbit chaibs aligned with Arbitrum One's configuration, the recommended sett These values offer a robust and balanced setup for most rollup use cases. Developers should consider their application’s requirements when adjusting these parameters: - **Shorter periods**: Suitable for use cases demanding faster transaction finality, such as high-frequency trading or gaming platforms. -- **Longer periods**: Recommended for applications that require higher security, such as cross-chain asset transfers or large-value transactions. \ No newline at end of file +- **Longer periods**: Recommended for applications that require higher security, such as cross-chain asset transfers or large-value transactions. diff --git a/website/sidebars.js b/website/sidebars.js index 137084e690..0f82fad147 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1028,4 +1028,4 @@ module.exports = sidebars; // because the linked page lives in multiple sidebar sections, we pick one to be the "canonical" location for the page in the sidebar // if we link to them both via id or standard href, multiple sections of the sidebar will be opened at once when the user visits this page; we don't want that // if we use a fully qualified link, the remote/published page will display when visiting from localhost or preview deployments -// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" \ No newline at end of file +// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" From ffaf3974cfd62dfa7e73a9334a8229c962e77f67 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 8 Jan 2025 11:13:03 -0600 Subject: [PATCH 33/88] adjusting sidebars.js --- website/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/sidebars.js b/website/sidebars.js index 0f82fad147..137084e690 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1028,4 +1028,4 @@ module.exports = sidebars; // because the linked page lives in multiple sidebar sections, we pick one to be the "canonical" location for the page in the sidebar // if we link to them both via id or standard href, multiple sections of the sidebar will be opened at once when the user visits this page; we don't want that // if we use a fully qualified link, the remote/published page will display when visiting from localhost or preview deployments -// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" +// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" \ No newline at end of file From f8338eff290f6f63c58687404cb386287cf76e71 Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 8 Jan 2025 11:17:32 -0600 Subject: [PATCH 34/88] post-merge yarn format --- .../03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md | 1 - website/sidebars.js | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md index 5651cfe26e..64f56802cc 100644 --- a/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md +++ b/arbitrum-docs/launch-orbit-chain/03-deploy-an-orbit-chain/03-deploying-anytrust-chain.md @@ -30,7 +30,6 @@ AnyTrust chains implement the Arbitrum AnyTrust protocol, an alternative to the ### Deployment steps - The deployment process of AnyTrust chains is very similar to that of [Rollup chains](/launch-orbit-chain/how-tos/orbit-sdk-deploying-rollup-chain.md#rollup-configuration-parameters), but with some differences that we'll discuss in this guide. Here are the steps involved in the deployment process: diff --git a/website/sidebars.js b/website/sidebars.js index 137084e690..0f82fad147 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1028,4 +1028,4 @@ module.exports = sidebars; // because the linked page lives in multiple sidebar sections, we pick one to be the "canonical" location for the page in the sidebar // if we link to them both via id or standard href, multiple sections of the sidebar will be opened at once when the user visits this page; we don't want that // if we use a fully qualified link, the remote/published page will display when visiting from localhost or preview deployments -// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" \ No newline at end of file +// we also want to include a unicode arrow to indicate that we're routing the user to another section, in a way that's distinct from the icon that indicates "this href pulls you out of docs" From ca821a5cd0c4eb7fe472666afb6228aff5a8c17f Mon Sep 17 00:00:00 2001 From: Pete Date: Wed, 8 Jan 2025 14:29:32 -0600 Subject: [PATCH 35/88] fixing broken links --- .../aep-fee-router-introduction.mdx | 2 +- .../common-configurations/arbos-upgrade.md | 4 +- .../set-up-aep-fee-router.mdx | 2 +- .../01-configuring-orbit-chain.md | 8 ++-- .../03-deploying-anytrust-chain.md | 4 +- .../04-deploying-custom-gas-token-chain.md | 10 ++--- .../customize-arbos.mdx | 2 +- .../customize-precompile.mdx | 2 +- .../01-bridged-usdc-standard.md | 2 +- .../troubleshooting-building-orbit.md | 2 +- .../orbit-sdk-preparing-node-config.md | 20 ++++----- .../launch-orbit-chain/orbit-quickstart.md | 2 +- .../orbit-sdk-introduction.md | 10 ++--- .../additional-configuration-parameters.md | 10 +++++ .../partials/_contribute-docs-partial.mdx | 2 +- .../partials/_gentle-intro-partial.mdx | 2 +- .../arbos-releases/01-overview.mdx | 4 +- .../arbos-releases/arbos20.mdx | 4 +- .../arbos-releases/arbos32.mdx | 4 +- arbitrum-docs/welcome/get-started.mdx | 8 ++-- website/sidebars.js | 44 +++++++++---------- 21 files changed, 79 insertions(+), 69 deletions(-) create mode 100644 arbitrum-docs/launch-orbit-chain/reference/additional-configuration-parameters.md diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx index 737394af6d..525c07d622 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/aep-fee-router-introduction.mdx @@ -39,4 +39,4 @@ The Arbitrum Foundation will track compliance based on fees received through the ## How can I set up an AEP fee router on my Orbit chain? -You can learn how to set up your AEP fee router in [implementation guide](/launch-orbit-chain/how-tos/set-up-aep-fee-router.mdx). +You can learn how to set up your AEP fee router in [implementation guide](/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx). diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md index a75c83eaf3..0746b19986 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/arbos-upgrade.md @@ -8,7 +8,7 @@ target_audience: 'Developers maintaining Orbit chains.' sidebar_position: 3 --- -This how-to provides step-by-step instructions for Orbit chain operators who want to upgrade ArbOS on their Orbit chain(s). Familiarity with ArbOS, Orbit, and [chain ownership](../concepts/chain-ownership.md) is expected. Note that Orbit chain owners have full discretion over when and whether to upgrade their ArbOS version. +This how-to provides step-by-step instructions for Orbit chain operators who want to upgrade ArbOS on their Orbit chain(s). Familiarity with ArbOS, Orbit, and [chain ownership](../../concepts/chain-ownership.md) is expected. Note that Orbit chain owners have full discretion over when and whether to upgrade their ArbOS version. The specific upgrade requirements for each ArbOS release are located under each reference page for that specific [ArbOS release](/run-arbitrum-node/arbos-releases/01-overview.mdx#list-of-available-arbos-releases). @@ -24,7 +24,7 @@ Note that upgrading your node version _must occur_ before the deadline establish While every ArbOS upgrade will require an update to the Wasm module root, not every ArbOS upgrade will require an upgrade to the chain's `nitro-contracts` version. -If necessary, as defined in the release notes for each ArbOS release ([example of ArbOS 20](../../run-arbitrum-node/arbos-releases/arbos20.mdx)), you may need to deploy new versions of some (or all) of the Nitro contracts to the parent chain of your Orbit chain. These contracts include the rollup logic, bridging logic, fraud-proof contracts, and interfaces for interacting with Nitro precompiles. To verify the current version of your Nitro contracts, follow [these instructions](https://github.com/OffchainLabs/orbit-actions/blob/main/README.md#check-version-and-upgrade-path) while replacing the inbox contract address and network name with that of your Orbit chain. This information will allow you to find the correct upgrade path for your Nitro contracts. +If necessary, as defined in the release notes for each ArbOS release ([example of ArbOS 20](/run-arbitrum-node/arbos-releases/arbos20.mdx)), you may need to deploy new versions of some (or all) of the Nitro contracts to the parent chain of your Orbit chain. These contracts include the rollup logic, bridging logic, fraud-proof contracts, and interfaces for interacting with Nitro precompiles. To verify the current version of your Nitro contracts, follow [these instructions](https://github.com/OffchainLabs/orbit-actions/blob/main/README.md#check-version-and-upgrade-path) while replacing the inbox contract address and network name with that of your Orbit chain. This information will allow you to find the correct upgrade path for your Nitro contracts. To update the Wasm module root and deploy your chain's Nitro contracts to the parent chain for the most recent ArbOS release, you will need the following inputs (obtained from the [requirements for the targeted ArbOS release](/run-arbitrum-node/arbos-releases/01-overview.mdx)): diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx index b28b645f2c..d6d00d871c 100644 --- a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/set-up-aep-fee-router.mdx @@ -49,7 +49,7 @@ This includes: In the event that a `ChildToParentRouter` does not connect to the address controlled by the Arbitrum Foundation on Ethereum, an Orbit chain must deploy successive `ChildToParentRouter` contracts until a connection to such address is established. Additional `ChildToParentRouter` contracts configured to route ETH have been deployed in certain networks and can be leveraged by chains created on top of these networks. You can see which networks have a router deployed [here](#canonical-contracts). -Optionally, an Orbit chain can decide to deduct assertion costs by following the instructions in the [Deducting Assertion Costs](/launch-orbit-chain/how-tos/calculate-aep-fees#assertion-costs) section: +Optionally, an Orbit chain can decide to deduct assertion costs by following the instructions in the [Deducting Assertion Costs](/launch-orbit-chain/02-configure-your-chain/common-configurations/calculate-aep-fees.mdx#assertion-costs) section: