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

doc: adding staking parameters explanation #11

Merged
merged 4 commits into from
Nov 13, 2023
Merged

doc: adding staking parameters explanation #11

merged 4 commits into from
Nov 13, 2023

Conversation

kupermind
Copy link
Collaborator

  • Adding staking parameters explanation.

scripts/deployment/README.md Outdated Show resolved Hide resolved
scripts/deployment/README.md Outdated Show resolved Hide resolved
- `livenessRatio`: number of service multisig transactions per second (in 1e18 value) 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. Assuming the number of required tx-s per day is 10, the liveness ratio is calculated by
[this formula](https://www.wolframalpha.com/input?i=%28115740740740740+*+60+*+60+*+24%29+%2F+10%5E18).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[this formula](https://www.wolframalpha.com/input?i=%28115740740740740+*+60+*+60+*+24%29+%2F+10%5E18).
[this formula](https://www.wolframalpha.com/input?i=%28115740740740740+*+86400%29%2F10%5E18).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the previous one was better for understanding - seconds, minutes, hours

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, then let's keep your :-)

@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `rewardsPerSecond`: amount of token (in wei) per second credited to a service if the service is active enough. Assuming the maximum
- `rewardsPerSecond`: amount of token (in wei) per second credited to a service if the service is active enough. The formula cn be obtained as follows`7days_rewards_per_service/7days_in_seconds` Assuming the maximum

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's some issues with formatting, please check for spaces and names, as I am not sure how to correct that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's ignore this. Later we can add more details if more info are required

scripts/deployment/README.md Outdated Show resolved Hide resolved
@kupermind kupermind merged commit e9a9c7b into main Nov 13, 2023
1 check passed
@kupermind kupermind deleted the readme branch November 13, 2023 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants