Skip to content

Commit

Permalink
Merge pull request #11 from valory-xyz/readme
Browse files Browse the repository at this point in the history
doc: adding staking parameters explanation
  • Loading branch information
kupermind authored Nov 13, 2023
2 parents f955186 + f2b1a03 commit e9a9c7b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions scripts/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Parameters of the `globals.json` file:
- `useLedger`: a flag whether to use the hardware wallet (`true`) or proceed with the seed-phrase accounts (`false`);
- `derivationPath`: a string with the derivation path;
- `providerName`: a network type (see `hardhat.config.js` for the network configurations);
- `serviceStakingParams`: a set of service staking parameters, which include:
- `rewardsPerSecond`: amount of token (in wei) per second credited to a service if the service is active enough. Assuming the maximum
number of reward per week is 1 OLAS (in ETH), then the reward per second is calculated by
[this formula](https://www.wolframalpha.com/input?i=1+*+10%5E18+%2F+%283600+*+24+*+7%29);
- `livenessRatio`: number of service multisig transactions per second (with 18 decimals) that are used to measure the service
liveness (activity). In other words, it's the minimum number of transactions the service multisig needs to perform in order
to pass the liveness check. To check this `rewardsPerSecond* livenessPeriod/1e18` should approximate the number of txs required per livenessPeriod. Assuming the number of required tx-s per day is 10, the liveness ratio can be checked by means of
[this formula](https://www.wolframalpha.com/input?i=%28115740740740740+*+60+*+60+*+24%29+%2F+10%5E18).

The script file name identifies the number of deployment steps taken from / to the number in the file name. For example:
- `deploy_01_service_staking_token_mech_usage.js` will complete step 1.
Expand Down

0 comments on commit e9a9c7b

Please sign in to comment.