Skip to content

Commit 6f51de1

Browse files
author
tac0turtle
committed
update docs
1 parent dbcdb13 commit 6f51de1

5 files changed

Lines changed: 56 additions & 17 deletions

File tree

docs/guides/da/celestia-da.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,20 +102,18 @@ The output of the command above will look similar to this:
102102
Your DA AUTH_TOKEN is eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJwdWJsaWMiLCJyZWFkIiwid3JpdGUiXX0.cSrJjpfUdTNFtzGho69V0D_8kyECn9Mzv8ghJSpKRDE
103103
```
104104

105-
Next, let's set up the namespace to be used for posting data on Celestia:
105+
Next, let's set up the namespace to be used for posting data on Celestia. Evolve supports separate namespaces for headers and data, but for simplicity, we'll use a single namespace for both:
106106

107107
```bash
108-
DA_NAMESPACE=00000000000000000000000000000000000000000008e5f679bf7116cb
108+
DA_NAMESPACE="fancy_namespace"
109109
```
110110

111-
:::tip
112-
`00000000000000000000000000000000000000000008e5f679bf7116cb` is a default namespace for Mocha testnet. You can set your own by using a command similar to this (or, you could get creative 😎):
113111

114-
```bash
115-
openssl rand -hex 10
116-
```
112+
**Advanced Configuration:** For production deployments, you can use separate namespaces for headers and data to optimize syncing:
113+
- `--evolve.da.header_namespace` for block headers
114+
- `--evolve.da.data_namespace` for transaction data
117115

118-
Replace the last 20 characters (10 bytes) in `00000000000000000000000000000000000000000008e5f679bf7116cb` with the newly generated 10 bytes.
116+
The namespace values are automatically encoded by the node to ensure compatibility with Celestia.
119117

120118
[Learn more about namespaces](https://docs.celestia.org/tutorials/node-tutorial#namespaces).
121119
:::
@@ -135,7 +133,8 @@ Finally, let's initiate the chain node with all the flags:
135133
gmd start \
136134
--evolve.node.aggregator \
137135
--evolve.da.auth_token $AUTH_TOKEN \
138-
--evolve.da.namespace $DA_NAMESPACE \
136+
--evolve.da.header_namespace $DA_NAMESPACE \
137+
--evolve.da.data_namespace $DA_NAMESPACE \
139138
--evolve.da.start_height $DA_BLOCK_HEIGHT \
140139
--evolve.da.address $DA_ADDRESS
141140
```

docs/guides/deploy/testnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ Both sequencer and full node Evolve services need to communicate with the celest
248248
#### 🔑 Common Integration Points
249249

250250
1. **Authentication**: Evolve requires an auth token generated by the celestia-node so that Evolve can send transactions on its behalf. Both sequencer and full node types use these JWT tokens for secure communication with celestia-node
251-
2. **Namespace Isolation**: Data is organized using Celestia namespaces
251+
2. **Namespace Isolation**: Data is organized using Celestia namespaces (automatically encoded by the node for proper formatting)
252252
3. **API Endpoints**: Both sequencer and full nodes use the same celestia-node API interface
253253
4. **Network Configuration**: All nodes must be configured to connect to the same Celestia network
254254

docs/learn/config.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ This document provides a comprehensive reference for all configuration options a
2525
- [DA Gas Multiplier](#da-gas-multiplier)
2626
- [DA Submit Options](#da-submit-options)
2727
- [DA Namespace](#da-namespace)
28+
- [DA Header Namespace](#da-header-namespace)
29+
- [DA Data Namespace](#da-data-namespace)
2830
- [DA Block Time](#da-block-time)
2931
- [DA Start Height](#da-start-height)
3032
- [DA Mempool TTL](#da-mempool-ttl)
@@ -395,19 +397,57 @@ da:
395397
**Description:**
396398
The namespace ID used when submitting blobs (block data) to the DA layer. This helps segregate data from different chains or applications on a shared DA layer.
397399

400+
**Note:** This configuration is deprecated in favor of separate header and data namespaces (see below). If only `namespace` is provided, it will be used for both headers and data for backward compatibility.
401+
398402
**YAML:**
399403

400404
```yaml
401405
da:
402-
namespace: "MY_UNIQUE_NAMESPACE_ID"
406+
namespace: "MY_UNIQUE_NAMESPACE_ID" # Deprecated - use header_namespace and data_namespace instead
403407
```
404408

405409
**Command-line Flag:**
406410
`--rollkit.da.namespace <string>`
407411
*Example:* `--rollkit.da.namespace 0x1234567890abcdef`
408-
*Default:* `""` (empty, must be configured)
412+
*Default:* `""` (empty)
409413
*Constant:* `FlagDANamespace`
410414

415+
### DA Header Namespace
416+
417+
**Description:**
418+
The namespace ID specifically for submitting block headers to the DA layer. Headers are submitted separately from transaction data. The namespace value is encoded by the node to ensure proper formatting and compatibility with the DA layer.
419+
420+
**YAML:**
421+
422+
```yaml
423+
da:
424+
header_namespace: "HEADER_NAMESPACE_ID"
425+
```
426+
427+
**Command-line Flag:**
428+
`--rollkit.da.header_namespace <string>`
429+
*Example:* `--rollkit.da.header_namespace my_header_namespace`
430+
*Default:* Falls back to `namespace` if not set
431+
*Constant:* `FlagDAHeaderNamespace`
432+
433+
### DA Data Namespace
434+
435+
**Description:**
436+
The namespace ID specifically for submitting transaction data to the DA layer. Transaction data is submitted separately from headers, enabling nodes to sync only the data they need. The namespace value is encoded by the node to ensure proper formatting and compatibility with the DA layer.
437+
438+
**YAML:**
439+
440+
```yaml
441+
da:
442+
data_namespace: "DATA_NAMESPACE_ID"
443+
```
444+
445+
**Command-line Flag:**
446+
`--rollkit.da.data_namespace <string>`
447+
*Example:* `--rollkit.da.data_namespace my_data_namespace`
448+
*Default:* Falls back to `namespace` if not set
449+
*Constant:* `FlagDADataNamespace`
450+
411451
### DA Block Time
412452

413453
**Description:**

docs/learn/specs/block-manager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ Block manager configuration options:
121121
|GasPrice|float64|gas price for DA submissions (-1 for automatic/default)|
122122
|GasMultiplier|float64|multiplier for gas price on DA submission retries (default: 1.3)|
123123
|Namespace|da.Namespace|DA namespace ID for block submissions (deprecated, use HeaderNamespace and DataNamespace instead)|
124-
|HeaderNamespace|string|namespace ID for submitting headers to DA layer|
125-
|DataNamespace|string|namespace ID for submitting data to DA layer|
124+
|HeaderNamespace|string|namespace ID for submitting headers to DA layer (automatically encoded by the node)|
125+
|DataNamespace|string|namespace ID for submitting data to DA layer (automatically encoded by the node)|
126126

127127
### Block Production
128128

docs/src/openapi-rpc.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -680,20 +680,20 @@
680680
},
681681
"GetNamespaceResponse": {
682682
"type": "object",
683-
"description": "Response containing namespace configuration",
683+
"description": "Response containing namespace configuration. Namespaces are encoded by the node to ensure proper formatting and compatibility with the DA layer.",
684684
"required": [
685685
"header_namespace",
686686
"data_namespace"
687687
],
688688
"properties": {
689689
"header_namespace": {
690690
"type": "string",
691-
"description": "The namespace identifier for block headers",
691+
"description": "The namespace identifier for block headers. This namespace is used exclusively for storing and retrieving block header data on the DA layer. The value is pre-encoded by the node.",
692692
"example": "0x01234567890abcdef"
693693
},
694694
"data_namespace": {
695695
"type": "string",
696-
"description": "The namespace identifier for block data",
696+
"description": "The namespace identifier for block data (transactions). This namespace is used exclusively for storing and retrieving transaction data on the DA layer, separate from headers. The value is pre-encoded by the node.",
697697
"example": "0xfedcba9876543210"
698698
}
699699
}

0 commit comments

Comments
 (0)