Skip to content

Commit bdbcc0b

Browse files
authored
Merge pull request #823 from richardgreg/span-batches
docs: Add Chain Operator Feature: Span Batches
2 parents 02d6cc1 + 8ff6f85 commit bdbcc0b

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

pages/builders/chain-operators/features/_meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"preinstalls": "Preinstalls",
33
"alt-da-mode": "Run an Alt-DA Mode Chain",
44
"custom-gas-token": "Run a Custom Gas Token Chain",
5+
"span-batches": "Use and Enable Span Batches on your Chain",
56
"bridged-usdc-standard": "Bridged USDC Standard for the OP Stack"
67
}
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Span Batches
3+
lang: en-US
4+
description: Learn how to use and enable span batches on your chain.
5+
---
6+
7+
import { Callout, Steps } from 'nextra/components'
8+
9+
# Span Batches
10+
11+
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.
12+
13+
## Overview
14+
15+
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.
16+
17+
## Enabling Span Batches
18+
19+
To enable span batches, follow these steps:
20+
21+
<Steps>
22+
1. **Configuration**:
23+
24+
* Locate your chain configuration file.
25+
* Add or update the following settings to enable span batches:
26+
27+
```yaml
28+
span_batches:
29+
enabled: true
30+
max_batch_size: <desired_max_batch_size> # Set your desired maximum batch size
31+
batch_interval: <desired_batch_interval> # Set your desired batch interval in seconds
32+
```
33+
34+
2. **Deploy**:
35+
36+
* After updating the configuration, redeploy your chain node to apply the changes.
37+
38+
3. **Verify**:
39+
40+
* Check the logs to ensure that span batches are enabled and functioning correctly.
41+
* You should see log entries indicating that batches are being processed according to the configured settings.
42+
</Steps>
43+
44+
## Links to Related Pages
45+
46+
For more detailed information on the design and implementation of span batches, refer to the following resources:
47+
48+
* [Span Batches Specification](https://specs.optimism.io/protocol/delta/span-batches.html#span-batches)
49+
* [Span Batch Design Docs](https://op-tip.notion.site/Span-Batch-Design-Docs-b85e599a47774dcdb8171cc84cab2476)

0 commit comments

Comments
 (0)