diff --git a/utils/README.md b/utils/README.md index 679b2820a8..73444025d6 100644 --- a/utils/README.md +++ b/utils/README.md @@ -26,6 +26,10 @@ sh utils/create-key.sh This script fetches the (most recent) seeds and peers list for the chain-id configured in the [\_variables.sh](/utils/_variables.sh) file and adds it to the config.toml file residing in the node's directory. This script leverages the [`genesis-parameters`](https://github.com/zenodeapp/genesis-parameters) repo. +## fetch-rpcs.sh + +This script fetches the (most recent) rpc_servers (state sync) for the chain-id configured in the [\_variables.sh](/utils/_variables.sh) file. This script leverages the [`genesis-parameters`](https://github.com/zenodeapp/genesis-parameters) repo. + ## fetch-state.sh This script fetches the (most recent) `genesis.json` file for the chain-id configured in the [\_variables.sh](/utils/_variables.sh) file. This script leverages the [`genesis-parameters`](https://github.com/zenodeapp/genesis-parameters) repo. @@ -42,6 +46,14 @@ sh utils/import-key.sh This script installs the daemon as a service, which will automatically start the node whenever the device reboots (see [tgenesisd.service](/services/tgenesisd.service)). The setup scripts usually already call this, therefore it is not required to run this yourself. +## my-peer-id.sh + +This script will print out your peer-id: _node-id@ip-address:port_. This is useful for sharing your node with others so that they can add you as a persistent peer. + +Bear in mind that the _port_ being echo'd is extracted from the _config.toml_-file. So if you start the node on a different port without explicitly stating this in the _config.toml_-file, then the outputted port may not represent the actual port this node uses. + +> Add a --local flag to echo a local IP address, instead of your (public) external address. + ## recalibrate-state-sync.sh This script is useful if you want to recalibrate your state-sync configurations to a more recent height. **WARNING: this wipes your entire data folder, but will backup and restore the priv_validator_state.json file**. It uses the script(s) from the [`restate-sync`](https://github.com/zenodeapp/restate-sync/tree/v1.0.0) repository (`v1.0.0`). If in doubt whether this is safe, you could always check the repository to see how it works. @@ -59,14 +71,6 @@ sh utils/recalibrate-state-sync.sh [height_interval] [rpc_server_1] [rpc_server_ > [!NOTE] > Leaving the __-arguments empty will leave the rpc_servers field in your config.toml untouched. -## my-peer-id.sh - -This script will print out your peer-id: _node-id@ip-address:port_. This is useful for sharing your node with others so that they can add you as a persistent peer. - -Bear in mind that the _port_ being echo'd is extracted from the _config.toml_-file. So if you start the node on a different port without explicitly stating this in the _config.toml_-file, then the outputted port may not represent the actual port this node uses. - -> Add a --local flag to echo a local IP address, instead of your (public) external address. - ## shift-ports.sh This script is useful if you quickly want to replace the ports in the `client.toml`, `config.toml` and `app.toml` files. It uses the script(s) from the [`port-shifter`](https://github.com/zenodeapp/port-shifter/tree/v1.0.1) repository (`v1.0.1`). If in doubt whether this is safe, you could always check the repository to see how it works.