Skip to content

Commit 4139264

Browse files
authored
refactor(docs): updated running a node documentation (#679)
2 parents 093b628 + eb1c5a0 commit 4139264

25 files changed

+2107
-1828
lines changed

docs/1-intro.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,9 @@ Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flar
176176
<DocCard
177177
item={{
178178
type: "link",
179-
label: "Run a Validator Node",
180-
href: "/run-node/validator-node",
181-
description: "Earn rewards by helping secure Flare.",
179+
label: "Run an RPC Node",
180+
href: "/run-node#rpc-node",
181+
description: "Service application requests locally or publicly.",
182182
docId: undefined,
183183
}}
184184
/>
@@ -187,10 +187,9 @@ Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flar
187187
<DocCard
188188
item={{
189189
type: "link",
190-
label: "Run a Flare Entity",
191-
href: "/run-node/flare-entity",
192-
description:
193-
"Validate blocks and provide data for Flare's enshrined oracles.",
190+
label: "Run a Validator Node",
191+
href: "/run-node#validator-node",
192+
description: "Earn rewards by helping secure Flare.",
194193
docId: undefined,
195194
}}
196195
/>
@@ -199,9 +198,10 @@ Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flar
199198
<DocCard
200199
item={{
201200
type: "link",
202-
label: "Run an RPC Node",
203-
href: "/run-node/rpc-node",
204-
description: "Service application requests locally or publicly.",
201+
label: "Run a Flare Entity",
202+
href: "/run-node#flare-entity",
203+
description:
204+
"Validate blocks and provide data for Flare's enshrined oracles.",
205205
docId: undefined,
206206
}}
207207
/>

docs/2-run-node.mdx

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Run a Node
3+
description: Run a node on Flare.
4+
keywords: [rpc, validator, nodes, flare-network, flare-entity]
5+
---
6+
7+
import Tabs from "@theme/Tabs";
8+
import TabItem from "@theme/TabItem";
9+
import DocCardList from "@theme/DocCardList";
10+
11+
Running your own node is the most direct way to connect to and interact with the Flare network.
12+
Whether you need to query blockchain data for your application, want to help secure the network by validating transactions, or aim to participate fully in Flare's data protocols, setting up a node is the first step.
13+
14+
This guide covers the different types of nodes you can run - RPC, Validator, and Flare Entity - and provides links to detailed setup instructions for each.
15+
16+
## RPC Node
17+
18+
Allows applications to read blockchain data and submit transactions.
19+
Does not participate in consensus.
20+
21+
<DocCardList
22+
items={[
23+
{
24+
type: "link",
25+
label: "Check System requirements",
26+
href: "run-node/system-requirements",
27+
description: "Minimum hardware requirements for running a node.",
28+
},
29+
{
30+
type: "link",
31+
label: "Run Node from source",
32+
href: "run-node/from-source",
33+
description: "Run a Flare node from go-flare source code.",
34+
},
35+
{
36+
type: "link",
37+
label: "Run Node using Docker",
38+
href: "run-node/using-docker",
39+
description: "Run a Flare node using Docker.",
40+
},
41+
]}
42+
/>
43+
44+
## Validator Node
45+
46+
Secures the network by validating transactions and participating in consensus.
47+
Setting up a validator starts with installing a standard node (see [RPC Node](#rpc-node)).
48+
Once your node is running, proceed with the registration:
49+
50+
<DocCardList
51+
items={[
52+
{
53+
type: "link",
54+
label: "Register as Validator",
55+
href: "run-node/register-validator",
56+
description: "Register your node as a validator.",
57+
},
58+
]}
59+
/>
60+
61+
## Flare Entity
62+
63+
Runs alongside a Validator to provide crucial data for Flare's FTSO and FDC protocols.
64+
Required for full reward eligibility.
65+
Requires a running [Validator Node](#validator-node). To set up a Flare Entity:
66+
67+
<DocCardList
68+
items={[
69+
{
70+
type: "link",
71+
label: "Set Up Flare Entity",
72+
href: "run-node/flare-entity",
73+
description: "Provide data for Flare's enshrined FTSO and FDC protocols.",
74+
},
75+
]}
76+
/>
77+
78+
:::tip[Systems Explorer]
79+
80+
All registered Flare Entities, alongside voting and reward epoch, and finalization data can be viewed on the [Flare Systems Explorer](https://flare-systems-explorer.flare.network/providers).
81+
82+
:::

docs/fassets/guides/8-infrastructure.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ This guide explains how to configure it to utilize your own infrastructure for e
1515

1616
## Prerequisites
1717

18-
- [Running an RPC node](/run-node/rpc-node)
19-
- [Configure FTSO data provider](/run-node/ftso-data-provider)
20-
- [Configuring FDC attestation provider](/run-node/fdc-attestation-provider)
18+
- [Running an RPC node](/run-node#rpc-node)
19+
- [Configure a Flare Entity](/run-node#flare-entity)
2120
- [Setting up DAL](https://github.com/flare-foundation/data-availability)
2221

2322
## Setting Up

docs/fdc/1-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For a detailed explanation of the FDC mechanism, read the [FDC whitepaper](/pdf/
4747
The Data Availability Layer (DA Layer) provides API endpoints for querying offchain attestation data.
4848
Accessing this data is trustless, as users can independently compute and compare Merkle roots against the onchain version.
4949

50-
Operating a DA Layer is permissionless—anyone can run a DA Layer service by sourcing data from an [FTSOv2 data provider](/run-node/ftso-data-provider) and [FDC attestation provider](/run-node/fdc-attestation-provider).
50+
Operating a DA Layer is permissionless—anyone can run a DA Layer service by sourcing data from an [Flare Entity](/run-node/flare-entity).
5151

5252
<ThemedImage
5353
alt="DA Layer Diagram"

docs/ftso/guides/make-volatility-incentive.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before reading this guide, make sure you understand [FTSOv2's Volatility Incenti
3434

3535
This guide provides code examples demonstrating how to make an FTSOv2 volatility incentive offer using various programming languages. To make a volatility incentive offer, you need three key pieces of information:
3636

37-
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node/rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
37+
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node#rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
3838

3939
2. **Contract Address:** The address for the `FastUpdateIncentiveManager` contract varies by network. You can obtain this address in two ways:
4040

docs/ftso/guides/query-feed-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import FtsoConfigGo from "!!raw-loader!/examples/developer-hub-go/ftsov2_config_
2828

2929
This guide provides code examples demonstrating how to read FTSOv2 feed configurations offchain using various programming languages. To achieve this, you need two key pieces of information:
3030

31-
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can either use a node provider service or point to your [own RPC node](/run-node/rpc-node). A list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
31+
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can either use a node provider service or point to your [own RPC node](/run-node#rpc-node). A list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
3232

3333
2. **Contract Address:** The address for the `FastUpdatesConfiguration` contract varies by network. You can obtain this address in two ways:
3434

docs/ftso/guides/read-feeds-offchain.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import ReadOffhainGo from "!!raw-loader!/examples/developer-hub-go/ftsov2_consum
2828

2929
This guide provides code examples demonstrating how to read FTSOv2 feeds offchain using various programming languages. To read a block-latency feed offchain, you need three key pieces of information:
3030

31-
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node/rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
31+
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node#rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
3232

3333
2. **Contract Address:** Feeds are served on the `FtsoV2` contract, whose address varies by network. You can obtain this address in two ways:
3434

docs/network/0-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ Discover suitable options for your needs on the [Flare Wallets](https://flare.ne
325325
:::note[Adding Flare (FLR) to your exchange]
326326

327327
Integrating Flare is similar to integrating Ethereum or other EVM chains.
328-
To add it to your exchange set up an [RPC node](/run-node/rpc-node) and use the appropriate [network configuration](#configuration) for Flare Mainnet.
328+
To add it to your exchange set up an [RPC node](/run-node#rpc-node) and use the appropriate [network configuration](#configuration) for Flare Mainnet.
329329

330330
Additional resources: [Flare Brand assets](https://flare.network/media/), [go-flare Source Code](https://github.com/flare-foundation/go-flare)
331331

docs/network/guides/secure-random-numbers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Participants can enter the lottery, and the winner is drawn using the secure ran
153153

154154
To obtain a secure random number offchain, you need two key pieces of information:
155155

156-
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node/rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
156+
1. **RPC Endpoint URL:** The RPC Endpoint URL determines which network your code will interact with. You can use a node provider service or point to your [own RPC node](/run-node#rpc-node). A comprehensive list of public and private RPC endpoints for all Flare networks is available on the [Network Configuration](/network/overview#configuration) page.
157157

158158
2. **Contract Address:** The address for the `RandomNumberV2` contract varies by network. You can obtain this address in two ways:
159159

0 commit comments

Comments
 (0)