Skip to content

Commit

Permalink
Add documentation to run a ignition node in readme (#2363)
Browse files Browse the repository at this point in the history
## Description
Add documentation to run a mainnet node in readme

### Before requesting review
- [x] I have reviewed the code myself

---------

Co-authored-by: Green Baneling <XgreenX9999@gmail.com>
Co-authored-by: Aaryamann Challani <43716372+rymnc@users.noreply.github.com>
  • Loading branch information
3 people authored Oct 17, 2024
1 parent 5215abd commit f10b428
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,47 @@ $ ./target/debug/fuel-core run --poa-instant=false
2023-06-13T12:44:12.857763Z INFO fuel_core::cli::run: 232: Block production disabled
```

## Running a Ignition node

If you want to participate in the Ignition network with your own node you can launch it following these simple commands.

Install the latest fuelup :
```bash
curl -fsSL https://install.fuel.network/ | sh
fuelup toolchain install latest
```

Clone the chain configuration folder :
```
git clone https://github.com/FuelLabs/chain-configuration
```

Generate a keypair for your node:
```bash
fuel-core-keygen new --key-type peering
```
and copy the secret key displayed.

Run your node (change all variable with `{}` to your own personal variables):
```bash
fuel-core run \
--enable-relayer \
--service-name fuel-ignition-node \
--keypair {KEYGEN_SECRET_KEY} \
--relayer {ETHEREUM_RPC_ENDPOINT} \
--ip=0.0.0.0 --port 4000 --peering-port 30333 \
--db-path ~/.fuel-ignition \
--snapshot {PATH_TO_CHAIN_CONFIGURATION_FOLDER}/ignition \
--utxo-validation --poa-instant false --enable-p2p \
--bootstrap-nodes /dnsaddr/mainnet.fuel.network \
--sync-header-batch-size 100 \
--relayer-v2-listening-contracts=0xAEB0c00D0125A8a788956ade4f4F12Ead9f65DDf \
--relayer-da-deploy-height=20620434 \
--relayer-log-page-size=100 \
--sync-block-stream-buffer-size 30
```
Instead of directly placing your personal values on the command we advise you to use, for example, environment variables.

### Troubleshooting

#### Publishing
Expand Down

0 comments on commit f10b428

Please sign in to comment.