docs: introduce ADR for permissionless ICS #2001
Conversation
github-actions
bot
added
C:Testing
insumity
force-pushed
the
insumity/permissionless-ADR
branch
2 times, most recently
from
117e938
to
815ca88
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| The information needed to set up a `ConsumerChainRecord` are stored in the corresponding `ConsumerAdditionProposal` (see `MsgLaunchConsumerChain` below). | ||
|
|
||
| ### New Messages | ||
| In what follows, we describe the new messages that Permissionless ICS introduces and on how those can be used. |
There was a problem hiding this comment.
Add a comma after 'introduces'.
Possible missing comma found.
- In what follows, we describe the new messages that Permissionless ICS introduces and on how those can be used.
+ In what follows, we describe the new messages that Permissionless ICS introduces, and on how those can be used.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In what follows, we describe the new messages that Permissionless ICS introduces and on how those can be used. | |
| In what follows, we describe the new messages that Permissionless ICS introduces, and on how those can be used. |
Tools
LanguageTool
[uncategorized] ~153-~153: Possible missing comma found.
Context: ...ntroduces and on how those can be used. We then, describe how we can utilize those...(AI_HYDRA_LEO_MISSING_COMMA)
There was a problem hiding this comment.
| In what follows, we describe the new messages that Permissionless ICS introduces and on how those can be used. | |
| In this section, we describe the new messages that Permissionless ICS introduces and how they can be used. |
There was a problem hiding this comment.
@mpoke, your suggested rephrasing improves the clarity of the sentence. I agree with your suggestion:
In this section, we describe the new messages that Permissionless ICS introduces and how they can be used.I'll update the documentation accordingly. Thank you for the suggestion!
There was a problem hiding this comment.
nit: this still needs to be addressed
There was a problem hiding this comment.
@mpoke, thank you for pointing that out. I'll ensure the documentation is updated with the rephrased sentence:
In this section, we describe the new messages that Permissionless ICS introduces and how they can be used.This change will enhance the clarity of the documentation. Thank you for your attention to detail!
Learnings used
Learnt from: p-offtermatt
PR: cosmos/interchain-security#2001
File: docs/docs/adrs/adr-018-permissionless-ics.md:195-195
Timestamp: 2024-07-03T10:36:06.506Z
Learning: When reviewing documentation for the Interchain Security project, remember that the `ConsumerAdditionProposal`s should use the `consumerID` instead of using both `chainID` and `consumerID`.
There was a problem hiding this comment.
Actionable comments posted: 15
Outside diff range and nitpick comments (10)
docs/docs/adrs/adr-018-permissionless-ics.md (10)
14-14: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ## Context + ## ContextTools
Markdownlint
14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
26-26: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ### The Phases of a Consumer Chain + ### The Phases of a Consumer ChainTools
Markdownlint
26-26: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
53-53: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ### From `chainID` to `consumerID` + ### From `chainID` to `consumerID`Tools
Markdownlint
53-53: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
62-62: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- #### State + #### StateTools
Markdownlint
62-62: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
152-152: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ### New Messages + ### New MessagesTools
Markdownlint
152-152: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
156-156: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- #### Launch a Consumer Chain + #### Launch a Consumer ChainTools
Markdownlint
156-156: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
199-199: Consider a more expressive alternative.Consider a more expressive alternative for the phrase "To do this."
- to avoid having consumer chains lingering for too long before they get added. To do this, we introduce a `maxSpawnTime` limit in [`ConsumerAdditionProposal`](https://github.com/cosmos/interchain-security/blob/v4.3.0/proto/interchain_security/ccv/provider/v1/provider.proto#L29). + to avoid having consumer chains lingering for too long before they get added. Therefore, we introduce a `maxSpawnTime` limit in [`ConsumerAdditionProposal`](https://github.com/cosmos/interchain-security/blob/v4.3.0/proto/interchain_security/ccv/provider/v1/provider.proto#L29).Tools
LanguageTool
[style] ~199-~199: Consider a more expressive alternative.
Context: ... for too long before they get added. To do this, we introduce amaxSpawnTimelim...(DO_ACHIEVE)
253-253: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ### Additional Modifications + ### Additional ModificationsTools
Markdownlint
253-253: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
256-256: Replace 'at the moment' with 'currently'.For conciseness, consider replacing this expression with an adverb.
- Because we only have two consumer chains at the moment, this is not going to be an expensive migration even if we have some + Because we currently only have two consumer chains, this is not going to be an expensive migration even if we have someUse 'will' instead of 'going to'.
Use ‘will’ instead of ‘going to’ if the following action is certain.
- this is not going to be an expensive migration even if we have some consumer chains that are being voted upon. + this will not be an expensive migration even if we have some consumer chains that are being voted upon.Tools
LanguageTool
[style] ~256-~256: For conciseness, consider replacing this expression with an adverb.
Context: ...ecause we only have two consumer chains at the moment, this is not going to be an expensive m...(AT_THE_MOMENT)
[style] ~256-~256: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...two consumer chains at the moment, this is not going to be an expensive migration even if we ha...(GOING_TO_WILL)
[uncategorized] ~256-~256: Possible missing comma found.
Context: ...t, this is not going to be an expensive migration even if we have some consumer chains th...(AI_HYDRA_LEO_MISSING_COMMA)
262-262: Add a blank line below the heading.Headings should be surrounded by blank lines for better readability.
- ## Consequences + ## ConsequencesTools
Markdownlint
262-262: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
|
@coderabbitai pause |
This comment was marked as spam.
This comment was marked as spam.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
|
@coderabbitai resolve |
|
@insumity: I have resolved all comments, stopped, and paused the bot as requested. Learnings usedActions performedComments resolved. Reviews paused. |
insumity
force-pushed
the
insumity/permissionless-ADR
branch
from
7134fe8
to
50233f9
Compare
insumity
force-pushed
the
insumity/permissionless-ADR
branch
from
0c66486
to
ac34a98
Compare
Description
Closes: #XXXX
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...
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)Summary by CodeRabbit
New Features
MsgRegisterConsumerChain,MsgInitializeConsumerChain,MsgUpdateConsumerChain, andMsgStopConsumerChain.Documentation