Skip to content

Commit

Permalink
chore: typo corrections (a16z#389)
Browse files Browse the repository at this point in the history
* chore: typo corrections config.md

Typo corrections

* chore: typo corrections README.md

typo corrections
  • Loading branch information
cypherpepe authored Oct 31, 2024
1 parent 09d5036 commit 14ffef0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Currently supported network values are `optimism` and `base`, with more to come

`--rpc-port` or `-p` sets the port that the local RPC should run on. The default value is `8545`.

`--rpc-bind-ip` or `-b` sets the ip that binds to the JSON-RPC server. Be default, Helios will use `127.0.0.1`. Use `0.0.0.0` to allow remote access.
`--rpc-bind-ip` or `-b` sets the ip that binds to the JSON-RPC server. By default, Helios will use `127.0.0.1`. Use `0.0.0.0` to allow remote access.

`--data-dir` or `-d` sets the directory that Helios should use to store cached weak subjectivity checkpoints in. Each network only stores the latest checkpoint, which is just 32 bytes.

Expand All @@ -65,7 +65,7 @@ For example, you can specify the fallback like so: `helios --fallback "https://s
`--load-external-fallback` or `-l` enables weak subjectivity checkpoint fallback (no value needed).
For example, say you set a checkpoint value that is too outdated and Helios cannot sync to it.
If this flag is set, Helios will query all network apis in the community-maintained list
at [ethpandaops/checkpoint-synz-health-checks](https://github.com/ethpandaops/checkpoint-sync-health-checks/blob/master/_data/endpoints.yaml) for their latest slots.
at [ethpandaops/checkpoint-sync-health-checks](https://github.com/ethpandaops/checkpoint-sync-health-checks/blob/master/_data/endpoints.yaml) for their latest slots.
The list of slots is filtered for healthy apis and the most frequent checkpoint occurring in the latest epoch will be returned.
Note: this is a community-maintained list and thus no security guarantees are provided. Use this as a last resort if your checkpoint passed into `--checkpoint` fails.
This is not recommended as malicious checkpoints can be returned from the listed apis, even if they are considered _healthy_.
Expand Down
6 changes: 3 additions & 3 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ consensus_rpc = "https://www.lightclientdata.org"
execution_rpc = "https://eth-mainnet.g.alchemy.com/v2/XXXXX"
# The port to run the JSON-RPC server on. By default, Helios will use port 8545.
rpc_port = 8545
# The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
# The ip that binds to the JSON-RPC server. By default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
rpc_bind_ip = "127.0.0.1"
# The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old.
# If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.
Expand All @@ -36,7 +36,7 @@ consensus_rpc = "http://testing.prater.beacon-api.nimbus.team"
execution_rpc = "https://eth-goerli.g.alchemy.com/v2/XXXXX"
# The port to run the JSON-RPC server on. By default, Helios will use port 8545.
rpc_port = 8545
# The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
# The ip that binds to the JSON-RPC server. By default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
rpc_bind_ip = "127.0.0.1"
# The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old.
# If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.
Expand Down Expand Up @@ -66,7 +66,7 @@ All configuration options below are available on a per-network level, where netw

- `rpc_port` - The port to run the JSON-RPC server on. By default, Helios will use port 8545.

- `rpc_bind_ip` - The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
- `rpc_bind_ip` - The ip that binds to the JSON-RPC server. By default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.

- `checkpoint` - The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old. If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.

Expand Down

0 comments on commit 14ffef0

Please sign in to comment.