Skip to content

normalise options style #7663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2025
Merged

normalise options style #7663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/the_nimbus_book/src/developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,5 +247,6 @@ build/block_sim --slots=384 --validators=20000 --attesterRatio=0.66
## Sync from a specific peer

```sh
build/nimbus_beacon_node --no-el --discv5:off --tcp-port=9876 --direct-peer="/ip4/127.0.0.1/tcp/9000/p2p/$(curl -s -X 'GET' 'http://localhost:5052/eth/v1/node/identity' -H 'accept: application/json' | jq -r .data.peer_id)"
build/nimbus_beacon_node --no-el --discv5=off --tcp-port=9876 \
--direct-peer="/ip4/127.0.0.1/tcp/9000/p2p/$(curl -s -X 'GET' 'http://localhost:5052/eth/v1/node/identity' -H 'accept: application/json' | jq -r .data.peer_id)"
```
4 changes: 2 additions & 2 deletions docs/the_nimbus_book/src/era-store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ mkdir -p era
cd era

# Launch the era export
../../../ncli_db exportEra --db:../db
../../../ncli_db exportEra --db=../db
```

The first time the export is run, full history is exported which may take some time.
Expand All @@ -77,7 +77,7 @@ Era files can be shared directly from the `era` folder using a web server, or si
You can pass a custom era store location to Nimbus using `--era-dir`:

```sh
nimbus_beacon_node --era-dir:/path/to/era
nimbus_beacon_node --era-dir=/path/to/era
```

!!! tip
Expand Down
4 changes: 2 additions & 2 deletions docs/the_nimbus_book/src/log-rotate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ The final step is to redirect logs to `rotatelogs` using a pipe when starting Ni

```bash
build/nimbus_beacon_node \
--network:hoodi \
--network=hoodi \
--web3-url="$WEB3URL" \
--data-dir:$DATADIR 2>&1 | rotatelogs -L "$DATADIR/nbc_bn.log" -p "/path/to/rotatelogs-compress.sh" -D -f -c "$DATADIR/log/nbc_bn_%Y%m%d%H%M%S.log" 3600
--data-dir=$DATADIR 2>&1 | rotatelogs -L "$DATADIR/nbc_bn.log" -p "/path/to/rotatelogs-compress.sh" -D -f -c "$DATADIR/log/nbc_bn_%Y%m%d%H%M%S.log" 3600
```

The options used in this example do the following:
Expand Down
6 changes: 3 additions & 3 deletions docs/the_nimbus_book/src/networking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If there are no `dir=in` ChronosStreams, incoming connections are not working.

## Set an explicit external IP

If you have a static public IP address, use the `--nat:extip:$EXT_IP_ADDRESS` option to pass it to the client, where `$EXT_IP_ADDRESS` is your public IP.
If you have a static public IP address, use the `--nat=extip:$EXT_IP_ADDRESS` option to pass it to the client, where `$EXT_IP_ADDRESS` is your public IP.
See [here](./networking.md#determine-your-public-ip-address) for how to determine your public IP address.

!!! note
Expand All @@ -71,7 +71,7 @@ See [here](./networking.md#determine-your-public-ip-address) for how to determin
The `--enr-auto-update` feature keeps your external IP address up to date based on information received from other peers on the network.
This option is useful with ISPs that assign IP addresses dynamically.

In practice this means relaunching the beacon node with `--enr-auto-update:true` (pass it as an option in the command line).
In practice this means relaunching the beacon node with `--enr-auto-update` (pass it as an option in the command line).

## Set up port forwarding

Expand Down Expand Up @@ -147,7 +147,7 @@ Use the [open ports tool](https://www.yougetsignal.com/tools/open-ports/) to che
- `Discovered new external address but ENR auto update is off...`

It's possible that your ISP has changed your IP address without you knowing.
The first thing to do it to try relaunching the beacon node with with `--enr-auto-update:true` (pass it as an option in the command line).
The first thing to do it to try relaunching the beacon node with with `--enr-auto-update` (pass it as an option in the command line).

If this doesn't fix the problem, the next thing to do is to check your external (public) IP address and detect open ports on your connection - you can use [this site](https://www.yougetsignal.com/tools/open-ports/ ).
Note that Nimbus `TCP` and `UDP` ports are both set to `9000` by default.
Expand Down
4 changes: 2 additions & 2 deletions docs/the_nimbus_book/src/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Peer count low, no new peers discovered...

Your node is finding it hard to find peers.
It's possible that you may be behind a firewall.
Try restarting your client and passing `--nat:extip:$EXT_IP_ADDRESS` as an option to `./run-mainnet-beacon-node.sh`, where `$EXT_IP_ADDRESS` is your real IP. For example, if your real IP address is `1.2.3.4`, you'd run:
Try restarting your client and passing `--nat=extip:$EXT_IP_ADDRESS` as an option to `./run-mainnet-beacon-node.sh`, where `$EXT_IP_ADDRESS` is your real IP. For example, if your real IP address is `1.2.3.4`, you'd run:

```
./run-mainnet-beacon-node.sh --nat:extip:1.2.3.4
./run-mainnet-beacon-node.sh --nat=extip:1.2.3.4
```

If this doesn't improve things, you may need to [set enr-auto-update](./networking.md#set-enr-auto-update) and/or [set up port forwarding](./networking.md#set-up-port-forwarding).
Expand Down
10 changes: 5 additions & 5 deletions docs/the_nimbus_book/src/trusted-node-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ To start trusted node sync, run:
=== "Mainnet"
```sh
build/nimbus_beacon_node trustedNodeSync \
--network:mainnet \
--network=mainnet \
--data-dir=build/data/shared_mainnet_0 \
--trusted-node-url=http://localhost:5052
```

=== "Hoodi"
```sh
build/nimbus_beacon_node trustedNodeSync \
--network:hoodi \
--network=hoodi \
--data-dir=build/data/shared_hoodi_0 \
--trusted-node-url=http://localhost:5052
```
Expand Down Expand Up @@ -122,9 +122,9 @@ While you can choose a different sync point using a state hash or a slot number,

```sh
build/nimbus_beacon_node trustedNodeSync \
--network:mainnet \
--network=mainnet \
--data-dir=build/data/shared_mainnet_0 \
--state-id:1024
--state-id=1024
```

### Sync from checkpoint files
Expand All @@ -151,7 +151,7 @@ To recreate a historical index from before the checkpoint, it is necessary to fi

```sh
build/nimbus_beacon_node trustedNodeSync \
--network:mainnet \
--network=mainnet \
--data-dir=build/data/shared_mainnet_0 \
--reindex=true
```
4 changes: 2 additions & 2 deletions docs/the_nimbus_book/src/validator-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Next, choose a data directory for the validator client and import the keys there

```sh
build/nimbus_beacon_node deposits import \
--data-dir:build/data/vc_shared_hoodi_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
--data-dir=build/data/vc_shared_hoodi_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
```

!!! warning
Expand All @@ -35,7 +35,7 @@ With the keys imported, you are ready to start validator client:

```sh
build/nimbus_validator_client \
--data-dir:build/data/vc_shared_hoodi_0
--data-dir=build/data/vc_shared_hoodi_0
```

# Options
Expand Down