Skip to content

Commit 71bdb73

Browse files
committed
update readme
1 parent 7b3f66f commit 71bdb73

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,36 @@ For the fastest execution `RPC` with unlimited number of requests should be used
3232
```bash
3333
yarn
3434
````
35-
- Run the calculating staking rewards process
35+
- Calculate initial nodes data
3636
```bash
37-
yarn process-staking-rewards
37+
yarn prepare-initial-data
38+
```
39+
- Calculate staking rewards
40+
```bash
41+
yarn calculate-staking-rewards
3842
```
43+
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).
44+
3945
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.
4046

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

4349
### Verifying the results
44-
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.
50+
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.
51+
4552
To verify the results for the reward epochs from 126 to 243 inclusive one needs to use branch `version-1`.
53+
To verify the results for the reward epochs from 244 to 264 inclusive one needs to use branch `version-2`.
54+
For both branches one should run the following process
55+
```bash
56+
yarn process-staking-rewards
57+
```
58+
59+
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
60+
```bash
61+
yarn prepare-initial-data
62+
yarn calculate-staking-rewards
63+
```
64+
4665

4766
### Data for distributing rewards
4867
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

0 commit comments

Comments
 (0)