You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/1-intro.mdx
+25-10Lines changed: 25 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,37 @@ sidebar_position: 1
3
3
slug: /
4
4
title: Flare Developer Hub ☀️
5
5
sidebar_label: Home
6
-
description: Introduction to Flare, the blockchain for data.
6
+
description: Build on Flare, the EVM Layer 1 engineered for a data-rich, interconnected future
7
7
keywords:
8
8
[
9
9
flare-network,
10
10
blockchain,
11
-
data,
12
-
smart contracts,
11
+
evm-compatible,
12
+
solidity,
13
+
layer-1,
14
+
data-rich,
15
+
cross-chain-interoperability,
16
+
smart-contracts,
17
+
ftso,
13
18
flare-time-series-oracle,
19
+
fdc,
14
20
flare-data-connector,
21
+
fassets,
22
+
defi,
23
+
ai,
24
+
identity,
25
+
tradfi,
26
+
oracle,
15
27
]
16
28
---
17
29
18
30
importThemedImagefrom"@theme/ThemedImage";
19
31
importuseBaseUrlfrom"@docusaurus/useBaseUrl";
20
32
importDocCardfrom"@theme/DocCard";
21
33
34
+
Flare is the only EVM L1 with enshrined data, enabling intelligent, chain-agnostic applications.
35
+
Experience fast finality, robust developer tooling, interoperability, and soon, verifiable compute - all engineered for a data-rich, interconnected future.
36
+
22
37
## Getting Started
23
38
24
39
<divclassName="row">
@@ -53,7 +68,7 @@ import DocCard from "@theme/DocCard";
@@ -164,7 +179,7 @@ Gain a deep understanding of the core concepts that differentiate Flare from oth
164
179
Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flare Data Connector](/fdc/overview) - are enshrined directly into the core [Flare Systems Protocol](/network/fsp), inheriting the full economic security of the Flare network.
165
180
166
181
<ThemedImage
167
-
alt="Flare Architecture"
182
+
alt="Diagram of Flare's architecture, illustrating the Flare Systems Protocol with its enshrined data protocols including the Flare Time Series Oracle and Flare Data Connector."
Copy file name to clipboardExpand all lines: docs/run-node/5-flare-entity.mdx
+39-29Lines changed: 39 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,13 @@ A Flare Entity consists of the following six components:
29
29
5.**Feed Value Provider**: Retrieves data from exchanges and supplies current feed values (prices).
30
30
6.**FDC Client**: Provides FDC protocol voting round data to the System Client.
31
31
32
+
:::warning[Rewards and Minimal conditions]
33
+
34
+
After the introduction of [minimal conditions](/network/fsp/rewarding#minimal-conditions) in [FIP.10](https://proposals.flare.network/FIP/FIP_10.html), a Flare Entity needs to be both **available** and **performant** across all Flare protocols in order to be eligible for rewards.
35
+
Learn how to check if your Flare Entity meets minimal conditions and the rewards it accrued in the [FAQs](#faqs) section (see **FAQ F1** and **FAQ F2**).
36
+
37
+
:::
38
+
32
39
## Prerequisites
33
40
34
41
- A machine meeting the [minimum hardware requirements](/run-node/system-requirements).
@@ -51,21 +58,6 @@ Log out and log back in or restart your system for the changes to take effect.
51
58
52
59
:::
53
60
54
-
## Rewards
55
-
56
-
:::warning[Minimal conditions]
57
-
58
-
After the introduction of [minimal conditions](/network/fsp/rewarding#minimal-conditions) in [FIP.10](https://proposals.flare.network/FIP/FIP_10.html), a Flare Entity needs to be both **available** and **performant** across all Flare protocols in order to be eligible for rewards.
59
-
60
-
:::
61
-
62
-
-[FSP rewards](https://github.com/flare-foundation/FTSO-Scaling/blob/main/scripts/rewards/README.md#claiming-rewards) information is available at [flare-foundation/fsp-rewards](https://github.com/flare-foundation/fsp-rewards/tree/main/flare) and on the [Discourse Forum](https://forum.flare.network/t/fsp-rewards-data) (see XLSX file for historical reward data).
63
-
Updated every reward epoch (3.5 days).
64
-
-[Validator staking rewards](/network/guides/using-flare-stake-tool#claiming-rewards) information is available at [flare-foundation/reward-scripts](https://github.com/flare-foundation/reward-scripts/tree/main/generated-files).
65
-
Updated every 4 reward epochs (14 days).
66
-
67
-
Learn how to check your Flare Entity rewards in the [FAQs](#faqs) section.
68
-
69
61
## Registration
70
62
71
63
Before deploying the Flare Entity components, several one-time registration steps must be completed onchain.
@@ -711,28 +703,28 @@ To get your validator logo and name listed on the explorers, open a PR on [TowoL
711
703
:::
712
704
713
705
<details>
714
-
<summary>`system-client` is not doing anything</summary>
706
+
<summary>T1. `system-client` is not doing anything</summary>
715
707
716
708
Likely, your entity is not registered as a voter for the current reward epoch. There is a time window for voter registration on every reward epoch, and if you leave things running you should eventually see `RegisterVoter success` in the logs. It should then start submitting data successfully in the **following** reward epoch.
717
709
718
710
</details>
719
711
720
712
<details>
721
-
<summary>`system-client` fails to fetch sub-protocol data</summary>
713
+
<summary>T2. `system-client` fails to fetch sub-protocol data</summary>
722
714
723
715
The `c-chain-indexer` may still be indexing data, once it's finished you should see `Indexer at block x` in the logs. If it's still processing blocks you will see various errors across all services.
724
716
725
717
</details>
726
718
727
719
<details>
728
-
<summary>`fast-updates` client is not doing anything</summary>
720
+
<summary>T3. `fast-updates` client is not doing anything</summary>
729
721
730
722
If you have low weight it may take some time until you are selected to submit an update.
731
723
732
724
</details>
733
725
734
726
<details>
735
-
<summary>Insufficient funds errors on `fast-updates` client</summary>
727
+
<summary>T4. Insufficient funds errors on `fast-updates` client</summary>
736
728
737
729
If your Fast Updates client is showing the following error, it means that the account you are using to submit transactions does not have enough funds to cover the gas fees.
738
730
@@ -745,7 +737,7 @@ You need to fund [all Fast Updates accounts](#create-fast-updates-accounts) acco
745
737
</details>
746
738
747
739
<details>
748
-
<summary>Icon and logo don't show up on Flare explorers</summary>
740
+
<summary>T5. Icon and logo don't show up on Flare explorers</summary>
749
741
750
742
To get your validator logo and name listed on the explorers, open a PR on [TowoLabs/ftso-signal-providers](https://github.com/TowoLabs/ftso-signal-providers).
751
743
@@ -754,7 +746,7 @@ To get your validator logo and name listed on the explorers, open a PR on [TowoL
754
746
## FAQs
755
747
756
748
<details>
757
-
<summary>How do I check if my Flare Entity meets Minimal Conditions?</summary>
749
+
<summary>F1. How do I check if my Flare Entity meets Minimal Conditions?</summary>
758
750
759
751
Meeting [minimal conditions](/network/fsp/rewarding#minimal-conditions) for availability and performance in each reward epoch is necessary for FSP reward eligibility.
760
752
You can check your entity's status using two primary methods:
@@ -805,14 +797,14 @@ You can query the API that powers the explorer for programmatic access.
805
797
</details>
806
798
807
799
<details>
808
-
<summary>Where can I find calculated rewards data and my specific rewards?</summary>
800
+
<summary>F2. Where can I find calculated rewards data and my specific rewards?</summary>
809
801
810
802
Reward amounts for both staking and FSP participation are calculated and published periodically.
811
803
Always refer to official Flare sources for the latest data locations.
812
804
813
805
**Validator Staking Rewards:**
814
806
815
-
Calculated per reward epoch (every 3.5 days, starting Mon/Thu) and claimable every 4 reward epochs (approx. every 14 days).
807
+
Calculated every 4 reward epochs (every 14 days, starting Mon/Thu).
816
808
Check the `validator-rewards` directory within the **[flare-foundation/reward-scripts](https://github.com/flare-foundation/reward-scripts/tree/main/generated-files/validator-rewards)** repository on GitHub.
817
809
818
810
To inspect your entity's validator rewards for a specific epoch via CLI:
@@ -866,16 +858,34 @@ To inspect your entity's FSP rewards for a specific epoch via CLI:
866
858
</details>
867
859
868
860
<details>
869
-
<summary>How does the pass system work with minimal conditions?</summary>
861
+
<summary>F3. How does the pass system work with minimal conditions?</summary>
862
+
863
+
The pass system is an incentive mechanism for Flare Entities.
864
+
Each entity has a number of passes, which can be gained or lost based on their performance in meeting the minimum participation requirements for each protocol within a reward epoch.
865
+
866
+
Here's how it works:
870
867
871
-
Successfully meeting minimal conditions in an epoch typically earns your entity a "pass" (you can hold up to 3 passes).
872
-
These act as a buffer - if your entity occasionally fails to meet conditions (e.g., due to minor submission issues or downtime), a pass is automatically consumed to maintain reward eligibility for that epoch.
873
-
If conditions are not met and you have zero passes remaining, FSP rewards for that epoch are forfeited. [Learn more](/network/fsp/rewarding#passes).
868
+
-**Starting Passes:** Newly registered entities begin with zero passes.
869
+
-**Gaining Passes:** When an entity successfully meets all the [minimum conditions](/network/fsp/rewarding#minimal-conditions) in a reward epoch, they gain one pass.
870
+
-**Maximum Passes:** An entity can hold a maximum of three passes.
871
+
-**Losing Passes:** If an entity fails to meet the minimum condition for a protocol in a reward epoch, they will lose one pass.
872
+
It's important to note that entities can lose multiple passes for failing across multiple protocols within that reward epoch.
873
+
-**Consequences of Losing Passes:**
874
+
- If an entity has one pass and fails to meet one minimal condition, they will be reduced to zero passes but will still receive FSP rewards for that epoch.
875
+
- However, if an entity has zero passes and fails to meet a minimal condition, they will forfeit all FSP rewards for that epoch. For information on where to find reward data, see **FAQ F2**.
876
+
877
+
Refer to **FAQ F1** to check how many passes your Flare Entity has.
878
+
879
+
:::warning[Missing registration]
880
+
881
+
If you are fail to register for a reward epoch your Flare Entity will lose all passes, as well as all FSP rewards for that reward epoch.
882
+
883
+
:::
874
884
875
885
</details>
876
886
877
887
<details>
878
-
<summary>How can I monitor the health of my Flare Entity?</summary>
888
+
<summary>F4. How can I monitor the health of my Flare Entity?</summary>
879
889
880
890
Consistent monitoring is key to maintaining performance and reward eligibility. Here are primary areas and methods:
881
891
@@ -927,7 +937,7 @@ Consistent monitoring is key to maintaining performance and reward eligibility.
927
937
</details>
928
938
929
939
<details>
930
-
<summary>How can I opt-out of receiving FlareDrops?</summary>
940
+
<summary>F5. How can I opt-out of receiving FlareDrops?</summary>
931
941
932
942
To opt-out of receiving all future FlareDrops, you need to call the [`optOutOfAirdrop`](/network/solidity-reference/IDistributionToDelegators#optoutofairdrop) method on the [`DistributionToDelegators`](/network/solidity-reference) contract with your `Identity` address.
0 commit comments