From 93df83df85feb414c5734ca654035058fcf789e6 Mon Sep 17 00:00:00 2001 From: Richard Gregory Date: Thu, 8 Aug 2024 01:18:02 +0100 Subject: [PATCH 1/2] docs: Add Chain Operator Feature: Span Batches --- .../chain-operators/features/_meta.json | 3 +- .../chain-operators/features/span-batches.mdx | 48 +++++++++++++++++++ 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 pages/builders/chain-operators/features/span-batches.mdx diff --git a/pages/builders/chain-operators/features/_meta.json b/pages/builders/chain-operators/features/_meta.json index ac2c0e054..c6eab2b88 100644 --- a/pages/builders/chain-operators/features/_meta.json +++ b/pages/builders/chain-operators/features/_meta.json @@ -1,5 +1,6 @@ { "preinstalls": "Preinstalls", "alt-da-mode": "Run an Alt-DA Mode Chain", - "custom-gas-token": "Run a Custom Gas Token Chain" + "custom-gas-token": "Run a Custom Gas Token Chain", + "span-batches": "Use and Enable Span Batches on your Chain" } \ No newline at end of file diff --git a/pages/builders/chain-operators/features/span-batches.mdx b/pages/builders/chain-operators/features/span-batches.mdx new file mode 100644 index 000000000..9e4b5837e --- /dev/null +++ b/pages/builders/chain-operators/features/span-batches.mdx @@ -0,0 +1,48 @@ +--- +title: Span Batches +lang: en-US +description: Learn how to use and enable span batches on your chain. +--- + +import { Callout, Steps } from 'nextra/components' + +# Span Batches + +Span batches are an important feature that optimizes batch processing within the chain. This section provides an overview of span batches, instructions on how to enable them, and links to detailed design documents. + +## Overview + +Span batches allow for efficient processing of multiple batches in a single operation, reducing overhead and improving performance. By grouping transactions together, span batches can help optimize the throughput of the network. + +## Enabling Span Batches + +To enable span batches, follow these steps: + + + +1. **Configuration**: + * Locate your chain configuration file. + * Add or update the following settings to enable span batches: + + ```yaml + span_batches: + enabled: true + max_batch_size: # Set your desired maximum batch size + batch_interval: # Set your desired batch interval in seconds + ``` +2. **Deploy**: + + * After updating the configuration, redeploy your chain node to apply the changes. + +3. **Verify**: + + * Check the logs to ensure that span batches are enabled and functioning correctly. + * You should see log entries indicating that batches are being processed according to the configured settings. + + + +## Links to Related Pages + +For more detailed information on the design and implementation of span batches, refer to the following resources: +* [Span Batches Specification](https://specs.optimism.io/protocol/delta/span-batches.html#span-batches) +* [Span Batch Design Docs](https://op-tip.notion.site/Span-Batch-Design-Docs-b85e599a47774dcdb8171cc84cab2476) From 78c0d5f97e89183523a32fc3d4fb65441bc540a2 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Tue, 27 Aug 2024 14:00:05 +0100 Subject: [PATCH 2/2] fix liniting issues --- .../chain-operators/features/span-batches.mdx | 33 ++++++++++--------- words.txt | 1 - 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/pages/builders/chain-operators/features/span-batches.mdx b/pages/builders/chain-operators/features/span-batches.mdx index 9e4b5837e..ccddabd3c 100644 --- a/pages/builders/chain-operators/features/span-batches.mdx +++ b/pages/builders/chain-operators/features/span-batches.mdx @@ -19,30 +19,31 @@ Span batches allow for efficient processing of multiple batches in a single oper To enable span batches, follow these steps: + 1. **Configuration**: -1. **Configuration**: - * Locate your chain configuration file. - * Add or update the following settings to enable span batches: + * Locate your chain configuration file. + * Add or update the following settings to enable span batches: - ```yaml - span_batches: - enabled: true - max_batch_size: # Set your desired maximum batch size - batch_interval: # Set your desired batch interval in seconds - ``` -2. **Deploy**: + ```yaml + span_batches: + enabled: true + max_batch_size: # Set your desired maximum batch size + batch_interval: # Set your desired batch interval in seconds + ``` - * After updating the configuration, redeploy your chain node to apply the changes. + 2. **Deploy**: -3. **Verify**: + * After updating the configuration, redeploy your chain node to apply the changes. - * Check the logs to ensure that span batches are enabled and functioning correctly. - * You should see log entries indicating that batches are being processed according to the configured settings. + 3. **Verify**: + * Check the logs to ensure that span batches are enabled and functioning correctly. + * You should see log entries indicating that batches are being processed according to the configured settings. ## Links to Related Pages For more detailed information on the design and implementation of span batches, refer to the following resources: -* [Span Batches Specification](https://specs.optimism.io/protocol/delta/span-batches.html#span-batches) -* [Span Batch Design Docs](https://op-tip.notion.site/Span-Batch-Design-Docs-b85e599a47774dcdb8171cc84cab2476) + +* [Span Batches Specification](https://specs.optimism.io/protocol/delta/span-batches.html#span-batches) +* [Span Batch Design Docs](https://op-tip.notion.site/Span-Batch-Design-Docs-b85e599a47774dcdb8171cc84cab2476) diff --git a/words.txt b/words.txt index 9504ff5e9..e8cd4990e 100644 --- a/words.txt +++ b/words.txt @@ -25,7 +25,6 @@ BLOBPOOL blobpool blobspace blockhash -blockheaders blocklists BLOCKLOGS blocklogs