Skip to content

Commit

Permalink
docs(config): add additional bullets
Browse files Browse the repository at this point in the history
  • Loading branch information
powerslider committed Jan 23, 2025
1 parent 48ec07b commit d7c7e09
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
9 changes: 7 additions & 2 deletions docs/content/operate/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The fastest and preferred way is to download node snapshots provided by Omni.
mkdir -p ~/.omni/<network>
cd ~/.omni/<network>
```
2. Download and extract node snapshots for `geth` and `halo`:
2. Download and extract latest node snapshots for `geth` and `halo`:
```bash
# Create output directories.
mkdir geth halo
Expand All @@ -38,14 +38,19 @@ The fastest and preferred way is to download node snapshots provided by Omni.
# Download and extract halo snapshot.
curl -L https://storage.googleapis.com/omni-staging-snapshots/halo_data.tar.lz4 | tar --use-compress-program=lz4 -xvf - -C ./halo
```
> **NOTE**: If you are using macOS there are some additional steps in order make the above commands work correctly.
> **NOTE**
>
> If you are using macOS there are some additional steps in order make the above commands work correctly.
> ```bash
> # Install gnu-tar and lz4
> brew install gnu-tar lz4
> # Set an alias for tar, otherwise you have to use gtar instead of tar.
> alias tar=gtar
> ```
**IMPORTANT**: [CometBFT State Sync](#configure-cometbft-state-sync) should not be configured when restoring node snapshots.
## Configure halo
Halo is a CosmosSDK application. Configuring it is therefore very similar to any
Expand Down
24 changes: 13 additions & 11 deletions docs/content/operate/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,23 @@ Although Geth technically supports ["ethereum full sync" and "ethereum snap sync

The following three options are currently supported:
1. Halo "fast sync" + Geth "full sync"
- Syncs both chains from genesis.
- This is the slowest option.
- Syncs both chains from genesis.
- This is the slowest option.

2. Halo "state sync" + Geth "full sync"
- CometBFT state sync protocol is configured which syncs the consensus chain from a recent snapshot.
- This provides a "full sync" target to Geth, which then performs a full sync from genesis.
- This is faster than option 1.
- See mode details [here](config.md#configure-cometbft-state-sync).
- CometBFT state sync protocol is configured which syncs the consensus chain from a recent snapshot.
- This provides a "full sync" target to Geth, which then performs a full sync from genesis.
- This is faster than option 1.
- See mode details [here](config.md#configure-cometbft-state-sync).

3. Restoring Node Snapshots
- Omni provides node snapshot (tarballs) which are disk backups of both halo and geth data directories.
- These node snapshots are taken daily from Omni's archive nodes.
- The nodes will replay blocks from the snapshot to the current block height.
- This is the fastest option.
- See more details [here](config.md#restoring-node-snapshots).
- Omni provides node snapshot (tarballs) which are disk backups of both `halo` and `geth` data directories.
- These node snapshots are taken daily from Omni's archive nodes and have a larger memory footprint (see [Hardware Requirements](run-full-node.md#hardware-requirements)).
- This results in the `geth` snapshots utilizing the legacy `hash` state scheme instead of the newer and more memory efficient `path` state scheme.
- When spinning up a full node pruning of the archive data (intermediate historical states) is to be expected.
- The nodes will replay blocks from the snapshot to the current block height.
- This is the fastest option.
- See more details [here](config.md#restoring-node-snapshots).

### How long does Geth fullsync take?
The time it takes for Geth to do a fullsync (snapsync is not supported yet) depends largely on your disk write throughput.
Expand Down

0 comments on commit d7c7e09

Please sign in to comment.