From 638121d384fa839bbcc01261c35f87bd119afea2 Mon Sep 17 00:00:00 2001 From: Richard Gregory Date: Thu, 18 Jul 2024 16:33:05 +0100 Subject: [PATCH 1/5] Improve op-conductor docs. --- .../chain-operators/tools/op-challenger.mdx | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 376fff38b..0d5dc30c0 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -82,6 +82,33 @@ This guide provides a walkthrough of setting up the configuration and monitoring #### `--rollup-rpc` * This needs to be an`op-node` archive node because challenger needs access to output roots from back when the games start. + + #### Important Configuration Details + + 1. Safe Head Database (SafeDB) Configuration for op-node: + * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. + * **How to Enable SafeDB:** + * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. + * Example: + ``` + --safedb.path # Replace with your actual path + ``` + * If this path is not set, the SafeDB feature will be disabled. + + 2. Ensuring Historical Data Availability: + * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. + * For `op-node`: + * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. + * For `op-geth`: + * Similarly, configure to store or access historical data. + + **Example Configuration** + ``` + op-node \ + --rollup-rpc \ + --safedb.path + ``` + Replace `` with the URL of your archive node and `` with the desired path for storing SafeDB data. #### `--private-key` From e7dc5fd07216808e7963acd27dc4ec383e1a4d6b Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 26 Jul 2024 10:23:08 -0700 Subject: [PATCH 2/5] lint fixes --- .../chain-operators/tools/op-challenger.mdx | 54 ++++++++++--------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 0d5dc30c0..7f8217720 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -82,32 +82,38 @@ This guide provides a walkthrough of setting up the configuration and monitoring #### `--rollup-rpc` * This needs to be an`op-node` archive node because challenger needs access to output roots from back when the games start. - + #### Important Configuration Details - 1. Safe Head Database (SafeDB) Configuration for op-node: - * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. - * **How to Enable SafeDB:** - * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. - * Example: - ``` - --safedb.path # Replace with your actual path - ``` - * If this path is not set, the SafeDB feature will be disabled. - - 2. Ensuring Historical Data Availability: - * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. - * For `op-node`: - * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. - * For `op-geth`: - * Similarly, configure to store or access historical data. - - **Example Configuration** - ``` - op-node \ - --rollup-rpc \ - --safedb.path - ``` + 1. Safe Head Database (SafeDB) Configuration for op-node: + + * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. + * **How to Enable SafeDB:** + * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. + + * Example: + ``` + --safedb.path # Replace with your actual path + ``` + + * If this path is not set, the SafeDB feature will be disabled. + + 2. Ensuring Historical Data Availability: + + * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. + * For `op-node`: + * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. + * For `op-geth`: + * Similarly, configure to store or access historical data. + + **Example Configuration** + + ``` + op-node \ + --rollup-rpc \ + --safedb.path + ``` + Replace `` with the URL of your archive node and `` with the desired path for storing SafeDB data. #### `--private-key` From 69c3442c80ed5049aaa0c9090072124a239706af Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 26 Jul 2024 10:55:40 -0700 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- .../chain-operators/tools/op-challenger.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 7f8217720..0acf4ea20 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -85,9 +85,9 @@ This guide provides a walkthrough of setting up the configuration and monitoring #### Important Configuration Details - 1. Safe Head Database (SafeDB) Configuration for op-node: +1. Safe Head Database (SafeDB) Configuration for op-node: - * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. + * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. * **How to Enable SafeDB:** * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. @@ -100,11 +100,11 @@ This guide provides a walkthrough of setting up the configuration and monitoring 2. Ensuring Historical Data Availability: - * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. - * For `op-node`: - * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. - * For `op-geth`: - * Similarly, configure to store or access historical data. + * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. + * For `op-node`: + * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. + * For `op-geth`: + * Similarly, configure to store or access historical data. **Example Configuration** From 381ddcdfd1245b7a4533472dc1767925ef0c89a4 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:00:14 -0700 Subject: [PATCH 4/5] lint fixes --- pages/builders/chain-operators/tools/op-challenger.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 0acf4ea20..7ae5457e5 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -85,9 +85,9 @@ This guide provides a walkthrough of setting up the configuration and monitoring #### Important Configuration Details -1. Safe Head Database (SafeDB) Configuration for op-node: + 1. Safe Head Database (SafeDB) Configuration for op-node: - * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. + * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. * **How to Enable SafeDB:** * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. @@ -100,10 +100,10 @@ This guide provides a walkthrough of setting up the configuration and monitoring 2. Ensuring Historical Data Availability: - * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. - * For `op-node`: + * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. + * For `op-node`: * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. - * For `op-geth`: + * For `op-geth`: * Similarly, configure to store or access historical data. **Example Configuration** From 09a05910323b10b07ed18fc9f037445df9b42d19 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:20:12 -0700 Subject: [PATCH 5/5] lint fixes --- .../chain-operators/tools/op-challenger.mdx | 40 +++++++++---------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/pages/builders/chain-operators/tools/op-challenger.mdx b/pages/builders/chain-operators/tools/op-challenger.mdx index 7ae5457e5..68ad0079f 100644 --- a/pages/builders/chain-operators/tools/op-challenger.mdx +++ b/pages/builders/chain-operators/tools/op-challenger.mdx @@ -81,40 +81,38 @@ This guide provides a walkthrough of setting up the configuration and monitoring #### `--rollup-rpc` - * This needs to be an`op-node` archive node because challenger needs access to output roots from back when the games start. - - #### Important Configuration Details + * This needs to be an`op-node` archive node because challenger needs access to output roots from back when the games start. See below for important configuration details: 1. Safe Head Database (SafeDB) Configuration for op-node: * The `op-node` behind the `op-conductor` must have the SafeDB enabled to ensure it is not stateless. - * **How to Enable SafeDB:** - * Set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. + * To Enable SafeDB, set the `--safedb.path` value in your configuration. This specifies the file path used to persist safe head update data. + * Example Configuration: - * Example: - ``` - --safedb.path # Replace with your actual path - ``` + ``` + --safedb.path # Replace with your actual path + ``` - * If this path is not set, the SafeDB feature will be disabled. + + If this path is not set, the SafeDB feature will be disabled. + 2. Ensuring Historical Data Availability: * Both `op-node` and `op-geth` must have data from the start of the games to maintain network consistency and allow nodes to reference historical state and transactions. - * For `op-node`: - * Configure it to maintain a sufficient history of blockchain data locally or use an archive node. - * For `op-geth`: - * Similarly, configure to store or access historical data. - - **Example Configuration** + * For `op-node`: Configure it to maintain a sufficient history of blockchain data locally or use an archive node. + * For `op-geth`: Similarly, configure to store or access historical data. + * Example Configuration: - ``` - op-node \ - --rollup-rpc \ - --safedb.path - ``` + ``` + op-node \ + --rollup-rpc \ + --safedb.path + ``` + Replace `` with the URL of your archive node and `` with the desired path for storing SafeDB data. + #### `--private-key`