Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/network/0-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Discover suitable options for your needs on the [Flare Wallets](https://flare.ne

## Consensus mechanism

- **Consensus Protocol:** Snowman++ (from [Avalanche](https://build.avax.network/docs/quick-start)) provides a high-throughput, totally ordered consensus with fast finality. Learn more on the [Consensus](/network/consensus) page.
- **Consensus Protocol:** Snowman++ (from [Avalanche](https://build.avax.network/docs/primary-network)) provides a high-throughput, totally ordered consensus with fast finality. Learn more on the [Consensus](/network/consensus) page.

- **Sybil resistance mechanism:** Proof-of-Stake (PoS)

Expand Down
2 changes: 1 addition & 1 deletion docs/network/4-consensus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import CodeBlock from "@theme/CodeBlock";
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";

The consensus protocol running on all Flare networks is Snowman++, introduced by [Avalanche](https://build.avax.network/docs/quick-start).
The consensus protocol running on all Flare networks is Snowman++, introduced by [Avalanche](https://build.avax.network/docs/primary-network).
This runs on both the P- and C-chains.

<div style={{ textAlign: "center", margin: "30px 0" }}>
Expand Down
16 changes: 8 additions & 8 deletions docs/run-node/1-system-requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ These requirements represent a baseline for running a stable go-flare node.
| :------------------------ | :------------------------------ |
| **CPU** | 4 cores |
| **RAM** | 16 GB |
| **Disk space (pruned)** | 500 GB SSD |
| **Disk space (archival)** | 3.5 TB SSD |
| **Disk space (pruned)** | 1 TB SSD |
| **Disk space (archival)** | 5.7 TB SSD |
| **Disk growth** | 30 GB/month |
| **Disk speed** | 1200 MB/s read + 600 MB/s write |

Expand All @@ -50,8 +50,8 @@ These requirements represent a baseline for running a stable go-flare node.
| :------------------------ | :------------------------------ |
| **CPU** | 4 cores |
| **RAM** | 16 GB |
| **Disk space (pruned)** | 150 GB SSD |
| **Disk space (archival)** | 1 TB SSD |
| **Disk space (pruned)** | 250 GB SSD |
| **Disk space (archival)** | 1.2 TB SSD |
| **Disk growth** | 5 GB/month |
| **Disk speed** | 1200 MB/s read + 600 MB/s write |

Expand All @@ -62,8 +62,8 @@ These requirements represent a baseline for running a stable go-flare node.
| :------------------------ | :------------------------------ |
| **CPU** | 4 cores |
| **RAM** | 16 GB |
| **Disk space (pruned)** | 2 TB SSD |
| **Disk space (archival)** | 8 TB SSD |
| **Disk space (pruned)** | 2.7 TB SSD |
| **Disk space (archival)** | 11.2 TB SSD |
| **Disk growth** | 120 GB/month |
| **Disk speed** | 1200 MB/s read + 600 MB/s write |

Expand All @@ -74,8 +74,8 @@ These requirements represent a baseline for running a stable go-flare node.
| :------------------------ | :------------------------------ |
| **CPU** | 4 cores |
| **RAM** | 16 GB |
| **Disk space (pruned)** | 150 GB SSD |
| **Disk space (archival)** | 1 TB SSD |
| **Disk space (pruned)** | 300 GB SSD |
| **Disk space (archival)** | 1.6 TB SSD |
| **Disk growth** | 11 GB/month |
| **Disk speed** | 1200 MB/s read + 600 MB/s write |

Expand Down
6 changes: 3 additions & 3 deletions docs/run-node/2-from-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Make sure to check the [hardware requirements](/run-node/system-requirements) be
# 1. Find the latest stable release tag from:
# https://github.com/flare-foundation/go-flare/releases
# 2. Set the tag name in the variable below:
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
```

2. Clone and build the binary:
Expand Down Expand Up @@ -202,7 +202,7 @@ These are some of the most relevant CLI parameters you can use. Read more about

#### Sample JSON configuration:

Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/c-chain).
Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/avalanche-l1s/subnet-evm).
Note that the default values are overridden only if specified in the given config file.
Only provide values which differ from the defaults to avoid issues with future updates.

Expand Down Expand Up @@ -250,7 +250,7 @@ To update your node to a newer version of go-flare:
# 1. Find the latest stable release tag from:
# https://github.com/flare-foundation/go-flare/releases
# 2. Set the tag name in the variable below:
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
git checkout ${LATEST_TAG}
```

Expand Down
14 changes: 7 additions & 7 deletions docs/run-node/3-using-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Mounting these allows you to manage them directly without entering the container
```

2. **Create configuration file:** Create a `config.json` file. This example provides a standard configuration for a public RPC node.
Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/c-chain).
Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/avalanche-l1s/subnet-evm).
Note that the default values are overridden only if specified in the given config file.
Only provide values which differ from the defaults to avoid issues with future updates.

Expand Down Expand Up @@ -147,7 +147,7 @@ You can run your node using either the [Docker CLI](#using-docker-cli) directly
# 1. Find the latest stable release tag from:
# https://hub.docker.com/r/flarefoundation/go-flare/tags
# 2. Set the tag name in the variable below (only use versioned tags):
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
LATEST_TAG="vX.Y.Z" # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
```

2. **Start the container:**
Expand Down Expand Up @@ -365,7 +365,7 @@ Docker Compose simplifies node management by defining the entire configuration i
# 1. Find the latest stable release tag from:
# https://hub.docker.com/r/flarefoundation/go-flare/tags
# 2. Set the tag name in the variable below (only use versioned tags):
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
restart: on-failure
environment:
- NETWORK_ID=flare
Expand All @@ -392,7 +392,7 @@ Docker Compose simplifies node management by defining the entire configuration i
# 1. Find the latest stable release tag from:
# https://hub.docker.com/r/flarefoundation/go-flare/tags
# 2. Set the tag name in the variable below (only use versioned tags):
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
restart: on-failure
environment:
- NETWORK_ID=costwo
Expand All @@ -419,7 +419,7 @@ Docker Compose simplifies node management by defining the entire configuration i
# 1. Find the latest stable release tag from:
# https://hub.docker.com/r/flarefoundation/go-flare/tags
# 2. Set the tag name in the variable below (only use versioned tags):
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
restart: on-failure
environment:
- NETWORK_ID=songbird
Expand All @@ -446,7 +446,7 @@ Docker Compose simplifies node management by defining the entire configuration i
# 1. Find the latest stable release tag from:
# https://hub.docker.com/r/flarefoundation/go-flare/tags
# 2. Set the tag name in the variable below (only use versioned tags):
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.11.0
image: flarefoundation/go-flare:vX.Y.Z # <-- REPLACE vX.Y.Z WITH THE ACTUAL LATEST TAG e.g. v1.12.0
restart: on-failure
environment:
- NETWORK_ID=coston
Expand Down Expand Up @@ -604,7 +604,7 @@ Keep your node up-to-date with the latest stable release of `go-flare` for secur
3. Update the `docker-compose.yaml` file with the new tag and start the new container:

```bash
LATEST_TAG="vX.Y.Z" # <-- Replace with the actual latest tag e.g v1.11.0
LATEST_TAG="vX.Y.Z" # <-- Replace with the actual latest tag e.g v1.12.0
yq -i ".services.node.image = flarefoundation/go-flare:${LATEST_TAG}" /opt/node/docker-compose.yaml
docker compose -f /opt/node/docker-compose.yaml up -d
```
Expand Down
4 changes: 2 additions & 2 deletions docs/run-node/4-register-validator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Failure to implement these measures significantly increases the risk to your nod

As described in [Secure the node](#secure-the-node), a validator node should have minimal APIs enabled.
Below is a sample `config.json` demonstrating a secure configuration with limited `eth-apis` and disabled admin APIs:
Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/c-chain).
Most of the C-Chain configuration options can be found in the [Avalanche C-Chain Configuration docs](https://build.avax.network/docs/nodes/chain-configs/avalanche-l1s/subnet-evm).
Note that the default values are overridden only if specified in the given config file.
Only provide values which differ from the defaults to avoid issues with future updates.

Expand Down Expand Up @@ -185,7 +185,7 @@ This ensures your node always starts with the correct `Node-ID`.

```bash
# Find the latest tag at [https://hub.docker.com/r/flarefoundation/go-flare/tags](https://hub.docker.com/r/flarefoundation/go-flare/tags)
LATEST_TAG="vX.Y.Z" # e.g., v1.11.0
LATEST_TAG="vX.Y.Z" # e.g., v1.12.0

# Mount the staking volume and set the staking path environment variables
docker run -d --name flare-node \
Expand Down