docs: update docs to capture Permissionless ICS #2289
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
C:Docs
insumity
commented
Sep 19, 2024
| @@ -171,7 +171,7 @@ message MsgCreateConsumer { | |||
| } | |||
| ``` | |||
|
|
|||
| Note that `metadata` is a required field, while the `initialization_parameterrs` and `power_shaping_parameters` are optional and can later be set using `MsgUpdateConsumer`. | |||
| Note that `metadata` is a required field, while the `initialization_parameters` and `power_shaping_parameters` are optional and can later be set using `MsgUpdateConsumer`. | |||
There was a problem hiding this comment.
Took into account older comments that were added after the PR got merged.
insumity
commented
Sep 19, 2024
| @@ -28,9 +29,10 @@ A major feature of Interchain Security (also referred to as "Interchain Security | |||
| This subset can be determined by the top N% validators by voting power, or by validators opting in to validate the consumer chain. | |||
| PSS allows for more flexible security tradeoffs than Replicated Security. | |||
|
|
|||
| ## Mesh Security | |||
There was a problem hiding this comment.
We do not talk about Mesh security anywhere else so I think we can remove.
insumity
commented
Sep 19, 2024
| This is a security measure that makes it harder for a single large validator to take over a consumer chain: | ||
| It mitigates the risk of an Opt In chain with only a few validators being dominated by a validator with a large amount of stake. | ||
| For example, setting this fraction to 33% would mean that no single validator can have more than 33% of the total voting power on the consumer, and thus no single validator would be able to stop the consumer by going offline. | ||
| The consumer chain can specify a _power cap_ which corresponds to the maximum power (percentage-wise) a validator can have on the consumer chain. |
There was a problem hiding this comment.
People seemed to have difficulty understanding the validators power cap, so adding more examples here to make it more accessible. (cc @ve6a)
insumity
commented
Sep 19, 2024
| To avoid spam, the provider must whitelist denoms before accepting them as ICS rewards. | ||
|
|
||
| ## Reward distribution with power capping | ||
|
|
||
| If a consumer chain has set a [validators-power cap](./power-shaping#capping-the-validator-powers), then the total received |
There was a problem hiding this comment.
@ve6a, I'm adding more information here on the reward distribution to hopefully make it more understandable to users. Let me know if there are any concerns.
insumity
force-pushed
the
insumity/work-on-docs
branch
from
456d6a3
to
f6a9c10
Compare
insumity
commented
Sep 20, 2024
| To avoid spam, the provider must whitelist denoms before accepting them as ICS rewards. | ||
|
|
||
| ## Reward distribution with power capping |
MSalopek
approved these changes
Oct 1, 2024
sainoe
approved these changes
Oct 2, 2024
mergify bot
pushed a commit
that referenced
this pull request
Oct 2, 2024
init commit (cherry picked from commit c630c28)
12 tasks
mpoke
pushed a commit
that referenced
this pull request
Oct 2, 2024
docs: update docs to capture Permissionless ICS (#2289) init commit (cherry picked from commit c630c28) Co-authored-by: insumity <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is a first attempt at updating the docs to capture the latest Permissionless ICS changes.
This PR does not yet change the docs under:
docs/docs/validators/changeover-procedure.mddocs/docs/validators/joining-neutron.mddocs/docs/validators/joining-stride.mdAuthor Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:prefix in the PR titlemake build-docs)