Skip to content

Commit 7b86fed

Browse files
committed
adjustments
1 parent 6a3fe65 commit 7b86fed

11 files changed

Lines changed: 48 additions & 16 deletions

File tree

docs/concepts/block-lifecycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ For more details on DA integration, see the [Data Availability specification](./
433433
#### Out-of-Order Chain Blocks on DA
434434

435435
Evolve should support blocks arriving out-of-order on DA, like so:
436-
![out-of-order blocks](./out-of-order-blocks.png)
436+
![out-of-order blocks](../reference/specs/out-of-order-blocks.png)
437437

438438
### Block Sync Service (Syncer Component)
439439

@@ -650,7 +650,7 @@ The components communicate through well-defined interfaces:
650650

651651
### P2P and Synchronization
652652

653-
- Block sync over the P2P network works only when a full node is connected to the P2P network by specifying the initial seeds to connect to via `P2PConfig.Seeds` configuration parameter when starting the full node
653+
- Block sync over the P2P network works only when a full node is connected to the P2P network by specifying peers via the `P2PConfig.Peers` configuration parameter when starting the full node
654654
- Node's context is passed down to all components to support graceful shutdown and cancellation
655655

656656
## Metrics

docs/concepts/data-availability.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Evolve uses external DA layers to provide these guarantees, rather than storing
1414

1515
## How Evolve Handles Data Availability
1616

17-
Evolve is DA-agnostic and can integrate with different DA layers:
17+
Evolve currently supports two DA modes:
1818

1919
### Local DA
2020

@@ -28,10 +28,6 @@ Evolve is DA-agnostic and can integrate with different DA layers:
2828
- **Guarantee**: Data availability sampling (DAS)
2929
- **Latency**: ~12 seconds to finality
3030

31-
### Custom DA
32-
33-
Implement the [DA interface](/reference/interfaces/da) to integrate any DA layer.
34-
3531
## DA Flow
3632

3733
```

docs/getting-started/choose-your-path.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Evolve supports three execution environments. Your choice depends on your existing codebase, target users, and development resources.
44

5+
Use this as a decision page, then jump into the selected quickstart.
6+
57
## Quick Comparison
68

79
| | EVM (ev-reth) | Cosmos SDK (ev-abci) | Custom Executor |

docs/getting-started/custom/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Build a minimal custom executor to understand how ev-node integrates with execution layers.
44

5+
This page is a fast entry point. For a method-by-method implementation walkthrough, continue with [Implement Executor Interface](/getting-started/custom/implement-executor).
6+
57
## Prerequisites
68

79
- Go 1.22+

docs/guides/advanced/forced-inclusion.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ If a sequencer fails to include forced inclusion transactions past their epoch b
9191

9292
When a malicious sequencer is detected (censoring forced inclusion transactions):
9393

94-
**All nodes must restart the chain in based sequencing mode:**
94+
Nodes may require a coordinated restart into based sequencing mode, depending on governance and operator policy.
9595

9696
```bash
97-
# Restart with based sequencing enabled
98-
./evnode start --node.aggregator --node.based_sequencer
97+
# One possible coordinated recovery action
98+
./evnode start --evnode.node.aggregator --evnode.node.based_sequencer
9999
```
100100

101101
**In based sequencing mode:**
@@ -107,10 +107,11 @@ When a malicious sequencer is detected (censoring forced inclusion transactions)
107107

108108
**Important considerations:**
109109

110+
- Operators should agree on the last valid state and restart timing before the cutover.
110111
- All full nodes should coordinate the switch to based mode
111112
- The chain continues from the last valid state
112113
- Users submit transactions directly to the DA layer going forward
113-
- This is a one-way transition - moving back to single sequencer requires social consensus
114+
- Returning to single sequencer mode requires explicit governance and operational coordination
114115

115116
See [Based Sequencing documentation](./based.md) for details on operating in this mode.
116117

docs/guides/da-layers/celestia.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,19 @@ Follow the [Celestia documentation](https://docs.celestia.org/how-to-guides/ligh
1717

1818
**Quick start:**
1919

20+
> Warning: Piping a remote script directly into a shell is a supply-chain risk. Review and verify the installer before execution in production environments.
21+
2022
```bash
2123
# Install celestia-node
2224
curl -sL https://docs.celestia.org/install.sh | bash
25+
```
26+
27+
Safer flow (download, inspect, then execute):
28+
29+
```bash
30+
curl -fsSL -o install-celestia.sh https://docs.celestia.org/install.sh
31+
less install-celestia.sh
32+
bash install-celestia.sh
2333

2434
# Initialize (choose your network)
2535
celestia light init --p2p.network mocha
@@ -137,7 +147,7 @@ Search by your namespace or account address to see submitted blobs.
137147

138148
### Gas Price
139149

140-
By default, ev-node uses automatic gas price detection. You can override this with a manual value if needed:
150+
By default, ev-node uses automatic gas price detection. Keep the default unless you have an operational reason to override it:
141151

142152
```bash
143153
--evnode.da.gas_price 0.01

docs/guides/operations/deployment.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: This page provides an overview of some common ways to deploy chains
44

55
# 🚀 Deploying Your Chain
66

7+
This page is a deployment index. Use it to choose the right deployment guide for your current stage, then follow the linked step-by-step guide.
8+
79
One of the benefits of building chains with Evolve is the flexibility you have as a developer to choose things like the DA layer, the settlement scheme, and the execution environment.
810

911
You can learn more about Evolve architecture [here](../../learn/specs/overview.md).
@@ -40,6 +42,15 @@ Choose the deployment approach that matches your current needs:
4042

4143
- [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks
4244

45+
## ✅ Before You Deploy
46+
47+
Use this checklist before moving from local development to shared environments:
48+
49+
1. Confirm DA connectivity and funding.
50+
2. Configure monitoring and alerting.
51+
3. Validate backup and recovery procedures.
52+
4. Run a multi-node failover drill.
53+
4354
:::warning Disclaimer
4455
These examples are for educational purposes only. Before deploying your chain for production use you should fully understand the services you are deploying and your choice in deployment method.
4556
:::

docs/guides/operations/troubleshooting.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ curl http://localhost:26657/status
1717

1818
### View Logs
1919

20-
If running ev-node as a systemd service:
20+
Use the log command that matches your runtime:
2121

2222
```bash
23+
# systemd service
2324
journalctl -u evnode -f
25+
26+
# foreground process
27+
./evnode start ... 2>&1 | tee evnode.log
28+
29+
# docker container
30+
docker logs -f <container_name>
2431
```
2532

2633
## Common Issues

docs/guides/running-nodes/full-node.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Key points about this command:
8383
- `chain_id` is generally the `$CHAIN_ID`, which is `gm` in this case.
8484
- The ports and addresses are different from the sequencer node to avoid conflicts. Not everything may be necessary for your setup.
8585
- We use the `P2P_ID` environment variable to set the seed node.
86+
- You can set the same values in your app config file instead of passing every option via CLI flags.
8687

8788
## Verifying Full Node Operation
8889

docs/overview/what-is-evolve.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Built on Celestia, Evolve offers L1-level control with L2-level performance.
66

77
This isn't a toolkit. It's a launch stack.
88

9-
No fees. No middlemen. No revenue share.
9+
No fees, no middlemen, no revenue share.
1010

1111
## What is Evolve
1212

1313
Evolve is a launch stack for L1s. It gives you full control over execution — without CometBFT, validator ops, or lock-in.
1414

15-
It's [open-source](https://github.com/evstack/ev-node), production-ready, and fully composable.
15+
Evolve is [open-source](https://github.com/evstack/ev-node), production-ready, and fully composable.
1616

1717
At its core is \`ev-node\`, a modular node that exposes an [Execution interface](https://github.com/evstack/ev-node/blob/main/core/execution/execution.go), — letting you bring any VM or execution logic, including Cosmos SDK or custom-built runtimes.
1818

@@ -60,7 +60,7 @@ With Evolve, developers can benefit from:
6060

6161
- **Scalability:** Evolve chains are deployed on specialized data availability layers like Celestia, which directly leverages the scalability of the DA layer. Additionally, chain transactions are executed off-chain rather than on the data availability layer. This means chains have their own dedicated computational resources, rather than sharing computational resources with other applications.
6262

63-
- **Customizability:** Evolve is built as an open source modular framework, to make it easier for developers to reuse the four main components and customize their chains. These components are data availability layers, execution environments, proof systems, and sequencer schemes.
63+
- **Customizability:** Evolve is built as an open-source modular framework, to make it easier for developers to reuse the four main components and customize their chains. These components are data availability layers, execution environments, proof systems, and sequencer schemes.
6464

6565
- **Faster time-to-market:** Evolve eliminates the need to bootstrap a validator set, manage a consensus network, incur high economic costs, and face other trade-offs that come with deploying a legacy layer 1\. Evolve's goal is to make deploying a chain as easy as it is to deploy a smart contract, cutting the time it takes to bring blockchain products to market from months (or even years) to just minutes.
6666

0 commit comments

Comments
 (0)