Skip to content

Commit

Permalink
Merge pull request #15 from zenodeapp/genesis-v1.0.0
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
zenodeapp authored Jan 14, 2024
2 parents 9f986ab + 4e4ac13 commit 18b10d5
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ sh utils/create-key.sh <key_alias>

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.
Expand All @@ -42,6 +46,14 @@ sh utils/import-key.sh <key_alias> <private_eth_key>

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.
Expand All @@ -59,14 +71,6 @@ sh utils/recalibrate-state-sync.sh [height_interval] [rpc_server_1] [rpc_server_
> [!NOTE]
> Leaving the _<rpc_server>_-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.
Expand Down

0 comments on commit 18b10d5

Please sign in to comment.