Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rzmahmood committed Dec 22, 2024
1 parent e8f447f commit 7dbd629
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,23 @@ A helper script that builds the submodules, saving the binaries in a known path
## Running
Start the Node. Make sure you've already finished the installation. If a node was previously started, it will continue from there.

Logs are stored in `beaconkit.log` and `geth.log`

```bash
./node.sh
```

By default, this will start a sync from genesis without bootstrapping from a snapshot. For long running networks, this can take a long time depending on your network latency and geography

To run with a snapshot - note that will involve downloading large snapshot files from third party sites which will take several hours to download. It also introduces a trust assumption on the snapshot provider
```bash
USE_SNAPSHOT=true ./node.sh
```

## Coming Soon
- State Sync (if possible)

## FAQ / Common Issues
- Downloading snapshot is too slow
- Try changing the CL_SNAPSHOT_SOURCE or EL_SNAPSHOT_SOURCE snapshot sources in `node.sh` to a source from https://github.com/berachain/beacon-kit/blob/main/testing/networks/80084/snapshots.md that is geographically closer

4 changes: 2 additions & 2 deletions node.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ GETH_BINARY=./dependencies/go-ethereum/build/bin/geth
MONIKER_NAME=BIG_BERA_DEFAULT_QUICKSTART_NODE_$(date +"%s")

# If USE_SNAPSHOT is true, then a snapshot will be downloaded to bootstrap the state, allowing for faster sync time.
# Introduces a trust assumption that the snapshot provider is trustworthy
USE_SNAPSHOT=false
# Introduces a trust assumption that the snapshot provider is trustworthy. Defaults to false
USE_SNAPSHOT=${USE_SNAPSHOT:-false}
SNAPSHOTS_DIRECTORY=./snapshots

# Update to use a source closer to your geography.
Expand Down

0 comments on commit 7dbd629

Please sign in to comment.