Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Min conditions #8

Merged
merged 34 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
77bc7eb
split script to two parts
timotejvesel Nov 15, 2024
7761aac
update ftso list
timotejvesel Dec 16, 2024
ebf2b40
merge
timotejvesel Dec 17, 2024
e3e672e
read data from chain
timotejvesel Dec 19, 2024
22e3496
minimal conditions info 251
timotejvesel Dec 21, 2024
4c0c360
initial data epoch 252
timotejvesel Dec 23, 2024
624842a
min conditions info epoch 252
timotejvesel Dec 23, 2024
718cbda
initial nodes data epoch 253
timotejvesel Dec 26, 2024
11c4cad
min conditions epoch 253
timotejvesel Dec 27, 2024
21557f1
initial data 254
timotejvesel Dec 30, 2024
55fe9c3
min conditiosn info epoch 254
timotejvesel Dec 30, 2024
1fc3cd6
initial data epoch 255
timotejvesel Jan 3, 2025
12c2afb
min conditions info epoch 255
timotejvesel Jan 3, 2025
532cdaf
initial data epoch 256
timotejvesel Jan 6, 2025
57c4602
min conditions info epoch 256
timotejvesel Jan 6, 2025
2d70899
initial nodes data 257
timotejvesel Jan 9, 2025
e041fda
min conditiosn data epoch 257
timotejvesel Jan 11, 2025
d80dc71
initial nodes data epoch 258
timotejvesel Jan 13, 2025
1c412e0
min conditions info epoch 258
timotejvesel Jan 13, 2025
b103213
nodes initial data epoch 259
timotejvesel Jan 16, 2025
afbdb86
min conditions info 259
timotejvesel Jan 17, 2025
33c7239
initial nodes data 260
timotejvesel Jan 20, 2025
697b8ef
min conditions info 260
timotejvesel Jan 20, 2025
90362ea
initial data 261
timotejvesel Jan 23, 2025
30209c0
min conditions info 261
timotejvesel Jan 24, 2025
a83471f
initial nodes data 262
timotejvesel Jan 27, 2025
3bbea28
min conditions initial data epoch 262
timotejvesel Jan 27, 2025
b8a486a
initial nodes data 263
timotejvesel Jan 31, 2025
17d039d
min conditions info 263
timotejvesel Jan 31, 2025
9ea16d2
initial data 264
timotejvesel Feb 3, 2025
7b3f66f
min conditions info epoch 264
timotejvesel Feb 3, 2025
71bdb73
update readme
timotejvesel Feb 4, 2025
05f9d4c
rename generated files
timotejvesel Feb 4, 2025
5ac7fd3
merge
timotejvesel Feb 4, 2025
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
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,36 @@ For the fastest execution `RPC` with unlimited number of requests should be used
```bash
yarn
````
- Run the calculating staking rewards process
- Calculate initial nodes data
```bash
yarn process-staking-rewards
yarn prepare-initial-data
```
- Calculate staking rewards
```bash
yarn calculate-staking-rewards
```
Note that for the second part of process to succeed `reward-distribution-data.json` for a given reward epoch should be present in the [FSP Rewards repository](https://github.com/flare-foundation/fsp-rewards/tree/main).

You can also run it with optional parameters from [file](./src/processProviders.ts) (e.g. `yarn process-staking-rewards -b 8 -f 111`), which will override parameters set in the configuration file.

For each run output of the process is in folder `generated-files/reward-epochs-<REWARD_EPOCH>`.

### Verifying the results
To verify the official results posted in this repository one needs to update its configuration file with values from the `configFileData` object of a `data.json` file for some reward epoch.
To verify the official results posted in this repository one needs to update configuration file with values from the `configFileData` object of a `data.json` file for a chosen reward epoch.

To verify the results for the reward epochs from 126 to 243 inclusive one needs to use branch `version-1`.
To verify the results for the reward epochs from 244 to 264 inclusive one needs to use branch `version-2`.
For both branches one should run the following process
```bash
yarn process-staking-rewards
```

To replicate minimal conditions info files for reward epochs from 251 to 264 inclusive one should use branch `min-conditions-info` and run the following processes
```bash
yarn prepare-initial-data
yarn calculate-staking-rewards
```


### Data for distributing rewards
Rewards will be distributed every four reward epochs, which means that every 14 days reward amounts from the past four reward epochs will be summed. This is achieved by running the process
Expand Down
Loading