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

docs: Add PSS docs (backport #1859) #1881

Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 14, 2024

Description

(Partially) Closes: #1785

Adds:

  • high level explainer of PSS and power shaping
  • new consumer addition parameters (in Onboarding)

Author 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...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers 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...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

Summary by CodeRabbit

  • Documentation
    • Added new fields (top_N, validators_power_cap, validator_set_cap, allowlist, denylist) to ConsumerAdditionProposal.
    • Introduced Partial Set Security (PSS) for consumer chains, enabling flexible validator set usage.
    • Detailed "power shaping" mechanisms in Interchain Security v2 for consumer chains.
    • Updated proposals with new configuration fields.
    • Clarified validator jailing rules for downtime on consumer chains.
    • Enhanced FAQ with detailed explanations of consumer chains, ICS protocol, and Partial Set Security.
    • Rebranded "Replicated security" to "Interchain Security" and refined its description.
    • Introduced the concept of Partial Set Security in terminology.
    • Provided guidelines for validators on opting in/out and setting commission rates for consumer chains.

This is an automatic backport of pull request #1859 done by [Mergify](https://mergify.com).

* Add params to proposals

* Start rewriting intro

* Finish overview and terminology

* Write up generics about PSS and power shaping

* Add more info about top N and optin

* Nit: apostrophe

* Clarify governance proposal process for Opt In chains

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Add missing newlines

* Update docs/docs/features/partial-set-security.md

Co-authored-by: insumity <[email protected]>

* Update docs/docs/features/power-shaping.md

Co-authored-by: insumity <[email protected]>

* Use Interchain Security instead of ICSv2

* docs: Add PSS docs (Part 2) (#1861)

* first version

* first commit

* one more warning on having all validators opt out

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: Philip Offtermatt <[email protected]>

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: Philip Offtermatt <[email protected]>

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: Philip Offtermatt <[email protected]>

* Update docs/docs/frequently-asked-questions.md

Co-authored-by: Philip Offtermatt <[email protected]>

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: Philip Offtermatt <[email protected]>

* Update docs/docs/frequently-asked-questions.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update docs/docs/validators/partial-set-security-for-validators.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* took into account some comments

* small comment changes

---------

Co-authored-by: Philip Offtermatt <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Add warning that vals have to manually opt out if going out of top N

* Add short PSS FAQ

* Add FAQ on how many chains vals can opt in on

* Change first to third person

* Fix typo

* Add missing comma

* added a warning

* Add more guidelines to 'how to choose the power shaping parameters'

* Mention list-consumer-chains query

* Add tip about default commission rate

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: insumity <[email protected]>
(cherry picked from commit 1294f90)
@mergify mergify bot requested a review from a team as a code owner May 14, 2024 13:09
Copy link
Contributor

coderabbitai bot commented May 14, 2024

Important

Auto Review Skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the C:Docs Assigned automatically by the PR labeler label May 14, 2024
@p-offtermatt p-offtermatt merged commit 3e0dd07 into release/v4.2.x-lsm May 14, 2024
15 checks passed
@p-offtermatt p-offtermatt deleted the mergify/bp/release/v4.2.x-lsm/pr-1859 branch May 14, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Docs Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant